Chatbot / Client / describe_chime_webhook_configurations

describe_chime_webhook_configurations#

Chatbot.Client.describe_chime_webhook_configurations(**kwargs)#

Lists Amazon 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 Amazon Resource Name (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',
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'State': 'string',
            'StateReason': '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 Amazon Chime webhooks associated with the account.

      • (dict) –

        An AWS Chatbot configuration for Amazon Chime.

        • WebhookDescription (string) –

          A description of the webhook. We recommend using the convention RoomName/WebhookName.

          For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

        • ChatConfigurationArn (string) –

          The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

        • IamRoleArn (string) –

          A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

          For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

        • SnsTopicArns (list) –

          The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

          • (string) –

        • ConfigurationName (string) –

          The name of the configuration.

        • LoggingLevel (string) –

          Logging levels include ERROR, INFO, or NONE.

        • Tags (list) –

          A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

          • (dict) –

            A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

            Warning

            Do not include confidential or sensitive information in this field.

            For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

            • TagKey (string) –

              The key of the tag.

            • TagValue (string) –

              The value of the tag.

        • State (string) –

          Either ENABLED or DISABLED. The resource returns DISABLED if the organization’s AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.

        • StateReason (string) –

          Provided if State is DISABLED. Provides context as to why the resource is disabled.

Exceptions

  • Chatbot.Client.exceptions.InvalidParameterException

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.DescribeChimeWebhookConfigurationsException