Amazon Connect Service

2021/06/15 - Amazon Connect Service - 3 new api methods

Changes  This release adds new sets of APIs: AssociateBot, DisassociateBot, and ListBots. You can use it to programmatically add an Amazon Lex bot or Amazon Lex V2 bot on the specified Amazon Connect instance

AssociateBot (new) Link ¶

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

See also: AWS API Documentation

Request Syntax

client.associate_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    },
    LexV2Bot={
        'AliasArn': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type LexBot:

dict

param LexBot:

Configuration information of an Amazon Lex bot.

  • Name (string) --

    The name of the Amazon Lex bot.

  • LexRegion (string) --

    The Region that the Amazon Lex bot was created in.

type LexV2Bot:

dict

param LexV2Bot:

The Amazon Lex V2 bot to associate with the instance.

  • AliasArn (string) --

    The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

returns:

None

ListBots (new) Link ¶

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

See also: AWS API Documentation

Request Syntax

client.list_bots(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    LexVersion='V1'|'V2'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

type LexVersion:

string

param LexVersion:

[REQUIRED]

The version of Amazon Lex or Amazon Lex V2.

rtype:

dict

returns:

Response Syntax

{
    'LexBots': [
        {
            'LexBot': {
                'Name': 'string',
                'LexRegion': 'string'
            },
            'LexV2Bot': {
                'AliasArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LexBots (list) --

      The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

      • (dict) --

        Configuration information of an Amazon Lex or Amazon Lex V2 bot.

        • LexBot (dict) --

          Configuration information of an Amazon Lex bot.

          • Name (string) --

            The name of the Amazon Lex bot.

          • LexRegion (string) --

            The Region that the Amazon Lex bot was created in.

        • LexV2Bot (dict) --

          Configuration information of an Amazon Lex V2 bot.

          • AliasArn (string) --

            The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

DisassociateBot (new) Link ¶

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

See also: AWS API Documentation

Request Syntax

client.disassociate_bot(
    InstanceId='string',
    LexBot={
        'Name': 'string',
        'LexRegion': 'string'
    },
    LexV2Bot={
        'AliasArn': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type LexBot:

dict

param LexBot:

Configuration information of an Amazon Lex bot.

  • Name (string) --

    The name of the Amazon Lex bot.

  • LexRegion (string) --

    The Region that the Amazon Lex bot was created in.

type LexV2Bot:

dict

param LexV2Bot:

The Amazon Lex V2 bot to disassociate from the instance.

  • AliasArn (string) --

    The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

returns:

None