Chatbot / Client / update_chime_webhook_configuration

update_chime_webhook_configuration#

Chatbot.Client.update_chime_webhook_configuration(**kwargs)#

Updates a Chime Webhook Configuration

See also: AWS API Documentation

Request Syntax

response = client.update_chime_webhook_configuration(
    ChatConfigurationArn='string',
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string'
)
Parameters:

  • ChatConfigurationArn (string) – [REQUIRED] The ARN of the ChimeWebhookConfiguration to update.

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

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

  • SnsTopicArns (list) –

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

    • (string) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': '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.

Exceptions

  • Chatbot.Client.exceptions.ResourceNotFoundException

  • Chatbot.Client.exceptions.InvalidParameterException

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.UpdateChimeWebhookConfigurationException