Chime / Client / put_events_configuration

put_events_configuration#

Chime.Client.put_events_configuration(**kwargs)#

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

See also: AWS API Documentation

Request Syntax

response = client.put_events_configuration(
    AccountId='string',
    BotId='string',
    OutboundEventsHTTPSEndpoint='string',
    LambdaFunctionArn='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) –

    [REQUIRED]

    The bot ID.

  • OutboundEventsHTTPSEndpoint (string) – HTTPS endpoint that allows the bot to receive outgoing events.

  • LambdaFunctionArn (string) – Lambda function ARN that allows the bot to receive outgoing events.

Return type:

dict

Returns:

Response Syntax

{
    'EventsConfiguration': {
        'BotId': 'string',
        'OutboundEventsHTTPSEndpoint': 'string',
        'LambdaFunctionArn': 'string'
    }
}

Response Structure

  • (dict) –

    • EventsConfiguration (dict) –

      The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

      • BotId (string) –

        The bot ID.

      • OutboundEventsHTTPSEndpoint (string) –

        HTTPS endpoint that allows a bot to receive outgoing events.

      • LambdaFunctionArn (string) –

        Lambda function ARN that allows a bot to receive outgoing events.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.NotFoundException