AWS Support App

Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.

If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:

• Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide .

• Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the organization.

After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.

To use the Amazon Web Services Support App, each account must then complete the following tasks:

• Create an Identity and Access Management (IAM) role with the required permission. For more information, see Managing access to the Amazon Web Services Support App.

• Configure a Slack channel to use the Amazon Web Services Support App for support cases for that account. For more information, see Configuring a Slack channel.

See also: AWS API Documentation

Request Syntax

client.register_slack_workspace_for_organization(
    teamId='string'
)

type teamId

string

param teamId

[REQUIRED]

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG . Specify the Slack workspace that you want to use for your organization.

rtype

dict

returns

Response Syntax

{
    'accountType': 'management'|'member',
    'teamId': 'string',
    'teamName': 'string'
}

Response Structure

• (dict) --

  • accountType (string) --

    Whether the Amazon Web Services account is a management or member account that's part of an organization in Organizations.

  • teamId (string) --

    The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG .

  • teamName (string) --

    The name of the Slack workspace.

{'slackWorkspaceConfigurations': {'allowOrganizationMemberAccount': 'boolean',
                                  'teamName': 'string'}}

Lists the Slack workspace configurations for an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_slack_workspace_configurations(
    nextToken='string'
)

type nextToken

string

param nextToken

If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'slackWorkspaceConfigurations': [
        {
            'allowOrganizationMemberAccount': True|False,
            'teamId': 'string',
            'teamName': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The point where pagination should resume when the response returns only partial results.

  • slackWorkspaceConfigurations (list) --

    The configurations for a Slack workspace.

    • (dict) --

      The configuration for a Slack workspace that you added to an Amazon Web Services account.

      • allowOrganizationMemberAccount (boolean) --

        Whether to allow member accounts to authorize Slack workspaces. Member accounts must be part of an organization in Organizations.

      • teamId (string) --

        The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG .

      • teamName (string) --

        The name of the Slack workspace.