LexModelsV2 / Client / list_bot_version_replicas

list_bot_version_replicas

LexModelsV2.Client.list_bot_version_replicas(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• botId (string) –

  [REQUIRED]

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

• replicaRegion (string) –

  [REQUIRED]

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

• maxResults (integer) – The maximum results given in the list of replicated bots.

• nextToken (string) – The next token given in the list of replicated bots.

• sortBy (dict) –

  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.

Return type:

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.

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ServiceQuotaExceededException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.InternalServerException