Amazon Chime

2019/05/14 - Amazon Chime - 8 new api methods

Changes  Amazon Chime private bots GA release.

CreateBot (new) Link ¶

Creates a bot for an Amazon Chime Enterprise account.

See also: AWS API Documentation

Request Syntax

client.create_bot(
    AccountId='string',
    DisplayName='string',
    Domain='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type DisplayName

string

param DisplayName

[REQUIRED]

The bot display name.

type Domain

string

param Domain

The domain of the Amazon Chime Enterprise account.

rtype

dict

returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

GetEventsConfiguration (new) Link ¶

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

See also: AWS API Documentation

Request Syntax

client.get_events_configuration(
    AccountId='string',
    BotId='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • EventsConfiguration (dict) --

      The events configuration details.

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

ListBots (new) Link ¶

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

See also: AWS API Documentation

Request Syntax

client.list_bots(
    AccountId='string',
    MaxResults=123,
    NextToken='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Default is 10.

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'Bots': [
        {
            'BotId': 'string',
            'UserId': 'string',
            'DisplayName': 'string',
            'BotType': 'ChatBot',
            'Disabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'BotEmail': 'string',
            'SecurityToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Bots (list) --

      List of bots and bot details.

      • (dict) --

        A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

        • BotId (string) --

          The bot ID.

        • UserId (string) --

          The unique ID for the bot user.

        • DisplayName (string) --

          The bot display name.

        • BotType (string) --

          The bot type.

        • Disabled (boolean) --

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp (datetime) --

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail (string) --

          The bot email address.

        • SecurityToken (string) --

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

UpdateBot (new) Link ¶

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

See also: AWS API Documentation

Request Syntax

client.update_bot(
    AccountId='string',
    BotId='string',
    Disabled=True|False
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

type Disabled

boolean

param Disabled

When true, stops the specified bot from running in your account.

rtype

dict

returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The updated bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

PutEventsConfiguration (new) Link ¶

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

client.put_events_configuration(
    AccountId='string',
    BotId='string',
    OutboundEventsHTTPSEndpoint='string',
    LambdaFunctionArn='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

type OutboundEventsHTTPSEndpoint

string

param OutboundEventsHTTPSEndpoint

HTTPS endpoint that allows the bot to receive outgoing events.

type LambdaFunctionArn

string

param LambdaFunctionArn

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

rtype

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.

DeleteEventsConfiguration (new) Link ¶

Deletes the events configuration that allows a bot to receive outgoing events.

See also: AWS API Documentation

Request Syntax

client.delete_events_configuration(
    AccountId='string',
    BotId='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

returns

None

GetBot (new) Link ¶

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

See also: AWS API Documentation

Request Syntax

client.get_bot(
    AccountId='string',
    BotId='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

rtype

dict

returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The chat bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

RegenerateSecurityToken (new) Link ¶

Regenerates the security token for a bot.

See also: AWS API Documentation

Request Syntax

client.regenerate_security_token(
    AccountId='string',
    BotId='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type BotId

string

param BotId

[REQUIRED]

The bot ID.

rtype

dict

returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.