LexModelsV2 / Client / describe_bot_alias

describe_bot_alias#

LexModelsV2.Client.describe_bot_alias(**kwargs)#

Get information about a specific bot alias.

Request Syntax

response = client.describe_bot_alias(
    botAliasId='string',
    botId='string'
)

Parameters:

botAliasId (string) –
[REQUIRED]

The identifier of the bot alias to describe.
botId (string) –
[REQUIRED]

The identifier of the bot associated with the bot alias to describe.

Return type:

dict

Returns:

Response Syntax

{
    'botAliasId': 'string',
    'botAliasName': 'string',
    'description': 'string',
    'botVersion': 'string',
    'botAliasLocaleSettings': {
        'string': {
            'enabled': True|False,
            'codeHookSpecification': {
                'lambdaCodeHook': {
                    'lambdaARN': 'string',
                    'codeHookInterfaceVersion': 'string'
                }
            }
        }
    },
    'conversationLogSettings': {
        'textLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    'cloudWatch': {
                        'cloudWatchLogGroupArn': 'string',
                        'logPrefix': 'string'
                    }
                },
                'selectiveLoggingEnabled': True|False
            },
        ],
        'audioLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    's3Bucket': {
                        'kmsKeyArn': 'string',
                        's3BucketArn': 'string',
                        'logPrefix': 'string'
                    }
                },
                'selectiveLoggingEnabled': True|False
            },
        ]
    },
    'sentimentAnalysisSettings': {
        'detectSentiment': True|False
    },
    'botAliasHistoryEvents': [
        {
            'botVersion': 'string',
            'startDate': datetime(2015, 1, 1),
            'endDate': datetime(2015, 1, 1)
        },
    ],
    'botAliasStatus': 'Creating'|'Available'|'Deleting'|'Failed',
    'botId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1),
    'parentBotNetworks': [
        {
            'botId': 'string',
            'botVersion': 'string'
        },
    ]
}

Response Structure

(dict) –
- botAliasId (string) –
  
  The identifier of the bot alias.
- botAliasName (string) –
  
  The name of the bot alias.
- description (string) –
  
  The description of the bot alias.
- botVersion (string) –
  
  The version of the bot associated with the bot alias.
- botAliasLocaleSettings (dict) –
  
  The locale settings that are unique to the alias.
  - (string) –
    - (dict) –
      
      Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot’s locale.
      - enabled (boolean) –
        
        Determines whether the locale is enabled for the bot. If the value is false, the locale isn’t available for use.
      - codeHookSpecification (dict) –
        
        Specifies the Lambda function that should be used in the locale.
        
        lambdaCodeHook (dict) –
        
        Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.
        
        lambdaARN (string) –
        
        The Amazon Resource Name (ARN) of the Lambda function.
        
        codeHookInterfaceVersion (string) –
        
        The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- conversationLogSettings (dict) –
  
  Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
  - textLogSettings (list) –
    
    The Amazon CloudWatch Logs settings for logging text and metadata.
    - (dict) –
      
      Defines settings to enable text conversation logs.
      - enabled (boolean) –
        
        Determines whether conversation logs should be stored for an alias.
      - destination (dict) –
        
        Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
        
        cloudWatch (dict) –
        
        Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
        
        cloudWatchLogGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
        
        logPrefix (string) –
        
        The prefix of the log stream name within the log group that you specified
      - selectiveLoggingEnabled (boolean) –
        
        The option to enable selective conversation log capture for text.
  - audioLogSettings (list) –
    
    The Amazon S3 settings for logging audio to an S3 bucket.
    - (dict) –
      
      Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.
      - enabled (boolean) –
        
        Determines whether audio logging in enabled for the bot.
      - destination (dict) –
        
        The location of audio log files collected when conversation logging is enabled for a bot.
        
        s3Bucket (dict) –
        
        The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.
        
        kmsKeyArn (string) –
        
        The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
        
        s3BucketArn (string) –
        
        The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
        
        logPrefix (string) –
        
        The S3 prefix to assign to audio log files.
      - selectiveLoggingEnabled (boolean) –
        
        The option to enable selective conversation log capture for audio.
- sentimentAnalysisSettings (dict) –
  
  Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
  - detectSentiment (boolean) –
    
    Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
- botAliasHistoryEvents (list) –
  
  A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
  - (dict) –
    
    Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.
    - botVersion (string) –
      
      The version of the bot that was used in the event.
    - startDate (datetime) –
      
      The date and time that the event started.
    - endDate (datetime) –
      
      The date and time that the event ended.
- botAliasStatus (string) –
  
  The current status of the alias. When the alias is Available, the alias is ready for use with your bot.
- botId (string) –
  
  The identifier of the bot associated with the bot alias.
- creationDateTime (datetime) –
  
  A timestamp of the date and time that the alias was created.
- lastUpdatedDateTime (datetime) –
  
  A timestamp of the date and time that the alias was last updated.
- parentBotNetworks (list) –
  
  A list of the networks to which the bot alias you described belongs.
  - (dict) –
    
    A network of bots.
    - botId (string) –
      
      The identifier of the network of bots assigned by Amazon Lex.
    - botVersion (string) –
      
      The version of the network of bots.

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ServiceQuotaExceededException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.ResourceNotFoundException
LexModelsV2.Client.exceptions.InternalServerException