Chatbot / Client / create_chime_webhook_configuration

create_chime_webhook_configuration#

Chatbot.Client.create_chime_webhook_configuration(**kwargs)#

Creates Chime Webhook Configuration

See also: AWS API Documentation

Request Syntax

response = client.create_chime_webhook_configuration(
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
Parameters:
  • WebhookDescription (string) – [REQUIRED] 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.

  • WebhookUrl (string) – [REQUIRED] URL for the Chime webhook.

  • SnsTopicArns (list) –

    [REQUIRED] The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

    • (string) –

  • IamRoleArn (string) – [REQUIRED] 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.

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

  • LoggingLevel (string) – Logging levels include ERROR, INFO, or NONE.

  • Tags (list) –

    A list of tags to apply to the configuration.

    • (dict) – A tag applied to the configuration.

      • TagKey (string) – [REQUIRED] The tag key.

      • TagValue (string) – [REQUIRED] The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • WebhookConfiguration (dict) – Chime webhook configuration.

      • 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.

      • Tags (list) – A list of tags applied to the configuration.

        • (dict) – A tag applied to the configuration.

          • TagKey (string) – The tag key.

          • TagValue (string) – The tag value.

Exceptions

  • Chatbot.Client.exceptions.InvalidParameterException

  • Chatbot.Client.exceptions.LimitExceededException

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.CreateChimeWebhookConfigurationException

  • Chatbot.Client.exceptions.ConflictException