AWS API Changes

2024/02/07 - Amazon Lex Model Building V2 - 6 new api methods

Changes This release introduces a new bot replication feature as part of Lex Global Resiliency offering. This feature leverages a new set of APIs that allow customers to create bot replicas and replicate changes to bots across regions.

ListBotReplicas (new)

Link ¶

The action to list the replicated bots.

See also: AWS API Documentation

Request Syntax

client.list_bot_replicas(
    botId='string'
)

type botId

string

param botId

[REQUIRED]

The request for the unique bot IDs in the list of replicated bots.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'sourceRegion': 'string',
    'botReplicaSummaries': [
        {
            'replicaRegion': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'botReplicaStatus': 'Enabling'|'Enabled'|'Deleting'|'Failed',
            'failureReasons': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) --
- botId (string) --
  
  the unique bot IDs in the list of replicated bots.
- sourceRegion (string) --
  
  The source region of the source bots in the list of replicated bots.
- botReplicaSummaries (list) --
  
  The summary details for the replicated bots.
  - (dict) --
    
    Contains summary information about all the replication statuses applicable for global resiliency.
    - replicaRegion (string) --
      
      The replica region used in the replication statuses summary.
    - creationDateTime (datetime) --
      
      The creation time and date for the replicated bots.
    - botReplicaStatus (string) --
      
      The operation status for the replicated bot applicable.
    - failureReasons (list) --
      
      The reasons for the failure for the replicated bot.
      - (string) --

DeleteBotReplica (new)

Link ¶

The action to delete the replicated bot in the secondary region.

See also: AWS API Documentation

Request Syntax

client.delete_bot_replica(
    botId='string',
    replicaRegion='string'
)

type botId

string

param botId

[REQUIRED]

The unique ID of the replicated bot to be deleted from the secondary region

type replicaRegion

string

param replicaRegion

[REQUIRED]

The secondary region of the replicated bot that will be deleted.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'replicaRegion': 'string',
    'botReplicaStatus': 'Enabling'|'Enabled'|'Deleting'|'Failed'
}

Response Structure

(dict) --
- botId (string) --
  
  The unique bot ID of the replicated bot generated.
- replicaRegion (string) --
  
  The region of the replicated bot generated.
- botReplicaStatus (string) --
  
  The operational status of the replicated bot generated.

ListBotAliasReplicas (new)

Link ¶

The action to list the replicated bots created from the source bot alias.

See also: AWS API Documentation

Request Syntax

client.list_bot_alias_replicas(
    botId='string',
    replicaRegion='string',
    maxResults=123,
    nextToken='string'
)

type botId

string

param botId

[REQUIRED]

The request for the unique bot ID of the replicated bot created from the source bot alias.

type replicaRegion

string

param replicaRegion

[REQUIRED]

The request for the secondary region of the replicated bot created from the source bot alias.

type maxResults

integer

param maxResults

The request for maximum results to list the replicated bots created from the source bot alias.

type nextToken

string

param nextToken

The request for the next token for the replicated bot created from the source bot alias.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'sourceRegion': 'string',
    'replicaRegion': 'string',
    'botAliasReplicaSummaries': [
        {
            'botAliasId': 'string',
            'botAliasReplicationStatus': 'Creating'|'Updating'|'Available'|'Deleting'|'Failed',
            'botVersion': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReasons': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- botId (string) --
  
  The unique bot ID of the replicated bot created from the source bot alias.
- sourceRegion (string) --
  
  The source region of the replicated bot created from the source bot alias.
- replicaRegion (string) --
  
  The secondary region of the replicated bot created from the source bot alias.
- botAliasReplicaSummaries (list) --
  
  The summary information of the replicated bot created from the source bot alias.
  - (dict) --
    
    Contains information about all the aliases replication statuses applicable for global resiliency.
    - botAliasId (string) --
      
      The bot alias ID for all the alias bot replications.
    - botAliasReplicationStatus (string) --
      
      The replication statuses for all the alias bot replications.
    - botVersion (string) --
      
      The bot version for all the alias bot replications.
    - creationDateTime (datetime) --
      
      The creation time and date for all the alias bot replications.
    - lastUpdatedDateTime (datetime) --
      
      The last time and date updated for all the alias bot replications.
    - failureReasons (list) --
      
      The reasons for failure for the aliases bot replications.
      - (string) --
- nextToken (string) --
  
  The next token for the replicated bots created from the source bot alias.

ListBotVersionReplicas (new)

Link ¶

Contains information about all the versions replication statuses applicable for Global Resiliency.

See also: AWS API Documentation

Request Syntax

client.list_bot_version_replicas(
    botId='string',
    replicaRegion='string',
    maxResults=123,
    nextToken='string',
    sortBy={
        'attribute': 'BotVersion',
        'order': 'Ascending'|'Descending'
    }
)

type botId

string

param botId

[REQUIRED]

The request for the unique ID in the list of replicated bots.

type replicaRegion

string

param replicaRegion

[REQUIRED]

The request for the region used in the list of replicated bots.

type maxResults

integer

param maxResults

The maximum results given in the list of replicated bots.

type nextToken

string

param nextToken

The next token given in the list of replicated bots.

type sortBy

dict

param sortBy

The requested sort category for the list of replicated bots.

attribute (string) -- [REQUIRED]

The attribute of the sort category for the version replicated bots.
order (string) -- [REQUIRED]

The order of the sort category for the version replicated bots.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'sourceRegion': 'string',
    'replicaRegion': 'string',
    'botVersionReplicaSummaries': [
        {
            'botVersion': 'string',
            'botVersionReplicationStatus': 'Creating'|'Available'|'Deleting'|'Failed',
            'creationDateTime': datetime(2015, 1, 1),
            'failureReasons': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- botId (string) --
  
  The unique ID of the bots in the list of replicated bots.
- sourceRegion (string) --
  
  The source region used for the bots in the list of replicated bots.
- replicaRegion (string) --
  
  The region used for the replicated bots in the list of replicated bots.
- botVersionReplicaSummaries (list) --
  
  The information summary used for the replicated bots in the list of replicated bots.
  - (dict) --
    
    Contains summary information for all the version replication statuses applicable for Global resiliency.
    - botVersion (string) --
      
      The bot version for the summary information for all the version replication statuses.
    - botVersionReplicationStatus (string) --
      
      The version replication status for all the replicated bots.
    - creationDateTime (datetime) --
      
      The creation date and time of the replication status for all the replicated bots.
    - failureReasons (list) --
      
      The reasons for replication failure for all the replicated bots.
      - (string) --
- nextToken (string) --
  
  The next token used for the replicated bots in the list of replicated bots.

CreateBotReplica (new)

Link ¶

Action to create a replication of the source bot in the secondary region.

See also: AWS API Documentation

Request Syntax

client.create_bot_replica(
    botId='string',
    replicaRegion='string'
)

type botId

string

param botId

[REQUIRED]

The request for the unique bot ID of the source bot to be replicated in the secondary region.

type replicaRegion

string

param replicaRegion

[REQUIRED]

The request for the secondary region that will be used in the replication of the source bot.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'replicaRegion': 'string',
    'sourceRegion': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'botReplicaStatus': 'Enabling'|'Enabled'|'Deleting'|'Failed'
}

Response Structure

(dict) --
- botId (string) --
  
  The unique bot ID of the replicated bot generated.
- replicaRegion (string) --
  
  The region of the replicated bot generated.
- sourceRegion (string) --
  
  The source region for the source bot used for the replicated bot generated.
- creationDateTime (datetime) --
  
  The creation date and time of the replicated bot generated.
- botReplicaStatus (string) --
  
  The operational status of the replicated bot generated.

DescribeBotReplica (new)

Link ¶

Monitors the bot replication status through the UI console.

See also: AWS API Documentation

Request Syntax

client.describe_bot_replica(
    botId='string',
    replicaRegion='string'
)

type botId

string

param botId

[REQUIRED]

The request for the unique bot ID of the replicated bot being monitored.

type replicaRegion

string

param replicaRegion

[REQUIRED]

The request for the region of the replicated bot being monitored.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'replicaRegion': 'string',
    'sourceRegion': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'botReplicaStatus': 'Enabling'|'Enabled'|'Deleting'|'Failed',
    'failureReasons': [
        'string',
    ]
}

Response Structure

(dict) --
- botId (string) --
  
  The unique bot ID of the replicated bot being monitored.
- replicaRegion (string) --
  
  The region of the replicated bot being monitored.
- sourceRegion (string) --
  
  The source region of the replicated bot being monitored.
- creationDateTime (datetime) --
  
  The creation date and time of the replicated bot being monitored.
- botReplicaStatus (string) --
  
  The operational status of the replicated bot being monitored.
- failureReasons (list) --
  
  The failure reasons the bot being monitored failed to replicate.
  - (string) --