LexModelBuildingService / Client / get_bot_alias

get_bot_alias#

LexModelBuildingService.Client.get_bot_alias(**kwargs)#

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:GetBotAlias action.

See also: AWS API Documentation

Request Syntax

response = client.get_bot_alias(
    name='string',
    botName='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the bot alias. The name is case sensitive.

  • botName (string) –

    [REQUIRED]

    The name of the bot.

Return type:

dict

Returns:

Response Syntax

{
    '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'
    }
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the bot alias.

    • description (string) –

      A description of the bot alias.

    • botVersion (string) –

      The version of the bot that the alias points to.

    • botName (string) –

      The name of the bot that the alias points to.

    • lastUpdatedDate (datetime) –

      The date that the bot alias was updated. When you create a resource, the creation date and the 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) –

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

Exceptions