Chatbot / Client / describe_chime_webhook_configurations

describe_chime_webhook_configurations#

Chatbot.Client.describe_chime_webhook_configurations(**kwargs)#

Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

response = client.describe_chime_webhook_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • ChatConfigurationArn (string) – An optional ARN of a ChimeWebhookConfiguration to describe.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'WebhookConfigurations': [
        {
            'WebhookDescription': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • WebhookConfigurations (list) – A list of Chime webhooks associated with the account.

      • (dict) – An AWS Chatbot configuration for Amazon Chime.

        • WebhookDescription (string) – Description of the webhook. Recommend using the convention RoomName/WebhookName. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.

        • ChatConfigurationArn (string) – The ARN of the ChimeWebhookConfiguration.

        • IamRoleArn (string) – The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

        • SnsTopicArns (list) – The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

          • (string) –

        • ConfigurationName (string) – The name of the configuration.

        • LoggingLevel (string) – Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

Exceptions