LexModelBuildingService / Client / get_bot_aliases

get_bot_aliases#

LexModelBuildingService.Client.get_bot_aliases(**kwargs)#

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

See also: AWS API Documentation

Request Syntax

response = client.get_bot_aliases(
    botName='string',
    nextToken='string',
    maxResults=123,
    nameContains='string'
)
Parameters:

  • botName (string) –

    [REQUIRED]

    The name of the bot.

  • nextToken (string) – A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

  • maxResults (integer) – The maximum number of aliases to return in the response. The default is 50. .

  • nameContains (string) – Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

Return type:

dict

Returns:

Response Syntax

{
    'BotAliases': [
        {
            'name': 'string',
            'description': 'string',
            'botVersion': 'string',
            'botName': 'string',
            'lastUpdatedDate': datetime(2015, 1, 1),
            'createdDate': datetime(2015, 1, 1),
            'checksum': 'string',
            'conversationLogs': {
                'logSettings': [
                    {
                        'logType': 'AUDIO'|'TEXT',
                        'destination': 'CLOUDWATCH_LOGS'|'S3',
                        'kmsKeyArn': 'string',
                        'resourceArn': 'string',
                        'resourcePrefix': 'string'
                    },
                ],
                'iamRoleArn': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • BotAliases (list) –

      An array of BotAliasMetadata objects, each describing a bot alias.

      • (dict) –

        Provides information about a bot alias.

        • name (string) –

          The name of the bot alias.

        • description (string) –

          A description of the bot alias.

        • botVersion (string) –

          The version of the Amazon Lex bot to which the alias points.

        • botName (string) –

          The name of the bot to which the alias points.

        • lastUpdatedDate (datetime) –

          The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.

        • createdDate (datetime) –

          The date that the bot alias was created.

        • checksum (string) –

          Checksum of the bot alias.

        • conversationLogs (dict) –

          Settings that determine how Amazon Lex uses conversation logs for the alias.

          • logSettings (list) –

            The settings for your conversation logs. You can log text, audio, or both.

            • (dict) –

              The settings for conversation logs.

              • logType (string) –

                The type of logging that is enabled.

              • destination (string) –

                The destination where logs are delivered.

              • kmsKeyArn (string) –

                The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.

              • resourceArn (string) –

                The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.

              • resourcePrefix (string) –

                The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.

          • iamRoleArn (string) –

            The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.

    • nextToken (string) –

      A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

Exceptions