SupportApp / Client / list_slack_channel_configurations

list_slack_channel_configurations#

SupportApp.Client.list_slack_channel_configurations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_slack_channel_configurations(
    nextToken='string'
)
Parameters:

nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'slackChannelConfigurations': [
        {
            'channelId': 'string',
            'channelName': 'string',
            'channelRoleArn': 'string',
            'notifyOnAddCorrespondenceToCase': True|False,
            'notifyOnCaseSeverity': 'none'|'all'|'high',
            'notifyOnCreateOrReopenCase': True|False,
            'notifyOnResolveCase': True|False,
            'teamId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • slackChannelConfigurations (list) –

      The configurations for a Slack channel.

      • (dict) –

        The configuration for a Slack channel that you added for your Amazon Web Services account.

        • channelId (string) –

          The channel ID in Slack. This ID identifies a channel within a Slack workspace.

        • channelName (string) –

          The name of the Slack channel that you configured with the Amazon Web Services Support App for your Amazon Web Services account.

        • channelRoleArn (string) –

          The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

        • notifyOnAddCorrespondenceToCase (boolean) –

          Whether you want to get notified when a support case has a new correspondence.

        • notifyOnCaseSeverity (string) –

          The case severity for a support case that you want to receive notifications.

        • notifyOnCreateOrReopenCase (boolean) –

          Whether you want to get notified when a support case is created or reopened.

        • notifyOnResolveCase (boolean) –

          Whether you want to get notified when a support case is resolved.

        • teamId (string) –

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

Exceptions