update-bot-alias¶

Description¶

Updates the configuration of an existing bot alias.

Synopsis¶

  update-bot-alias
--bot-alias-id <value>
--bot-alias-name <value>
[--description <value>]
[--bot-version <value>]
[--bot-alias-locale-settings <value>]
[--conversation-log-settings <value>]
[--sentiment-analysis-settings <value>]
--bot-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--bot-alias-id (string)

The unique identifier of the bot alias.

--bot-alias-name (string)

The new name to assign to the bot alias.

--description (string)

The new description to assign to the bot alias.

--bot-version (string)

The new bot version to assign to the bot alias.

--bot-alias-locale-settings (map)

The new Lambda functions to use in each locale for the bot alias.

key -> (string)

value -> (structure)

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 -> (structure)

Specifies the Lambda function that should be used in the locale.

lambdaCodeHook -> (structure)

Specifies a Lambda function that verifies requests to a bot or fulfilles 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.

Shorthand Syntax:

KeyName1=enabled=boolean,codeHookSpecification={lambdaCodeHook={lambdaARN=string,codeHookInterfaceVersion=string}},KeyName2=enabled=boolean,codeHookSpecification={lambdaCodeHook={lambdaARN=string,codeHookInterfaceVersion=string}}

JSON Syntax:

{"string": {
      "enabled": true|false,
      "codeHookSpecification": {
        "lambdaCodeHook": {
          "lambdaARN": "string",
          "codeHookInterfaceVersion": "string"
        }
      }
    }
  ...}

--conversation-log-settings (structure)

The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

textLogSettings -> (list)

The Amazon CloudWatch Logs settings for logging text and metadata.

(structure)

Defines settings to enable text conversation logs.

enabled -> (boolean)

Determines whether conversation logs should be stored for an alias.

destination -> (structure)

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

cloudWatch -> (structure)

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

audioLogSettings -> (list)

The Amazon S3 settings for logging audio to an S3 bucket.

(structure)

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 -> (structure)

The location of audio log files collected when conversation logging is enabled for a bot.

s3Bucket -> (structure)

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

JSON Syntax:

{
  "textLogSettings": [
    {
      "enabled": true|false,
      "destination": {
        "cloudWatch": {
          "cloudWatchLogGroupArn": "string",
          "logPrefix": "string"
        }
      }
    }
    ...
  ],
  "audioLogSettings": [
    {
      "enabled": true|false,
      "destination": {
        "s3Bucket": {
          "kmsKeyArn": "string",
          "s3BucketArn": "string",
          "logPrefix": "string"
        }
      }
    }
    ...
  ]
}

--sentiment-analysis-settings (structure)

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.

Shorthand Syntax:

detectSentiment=boolean

JSON Syntax:

{
  "detectSentiment": true|false
}

--bot-id (string)

The identifier of the bot with the updated alias.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

botAliasId -> (string)

The identifier of the updated bot alias.

botAliasName -> (string)

The updated name of the bot alias.

description -> (string)

The updated description of the bot alias.

botVersion -> (string)

The updated version of the bot that the alias points to.

botAliasLocaleSettings -> (map)

The updated Lambda functions to use in each locale for the bot alias.

key -> (string)

value -> (structure)

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 -> (structure)

Specifies the Lambda function that should be used in the locale.

lambdaCodeHook -> (structure)

Specifies a Lambda function that verifies requests to a bot or fulfilles 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 -> (structure)

The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

textLogSettings -> (list)

The Amazon CloudWatch Logs settings for logging text and metadata.

(structure)

Defines settings to enable text conversation logs.

enabled -> (boolean)

Determines whether conversation logs should be stored for an alias.

destination -> (structure)

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

cloudWatch -> (structure)

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

audioLogSettings -> (list)

The Amazon S3 settings for logging audio to an S3 bucket.

(structure)

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 -> (structure)

The location of audio log files collected when conversation logging is enabled for a bot.

s3Bucket -> (structure)

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

sentimentAnalysisSettings -> (structure)

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.

botAliasStatus -> (string)

The current status of the bot alias. When the status is Available the alias is ready for use.

botId -> (string)

The identifier of the bot with the updated alias.

creationDateTime -> (timestamp)

A timestamp of the date and time that the bot was created.

lastUpdatedDateTime -> (timestamp)

A timestamp of the date and time that the bot was last updated.

Table of Contents

Feedback

User Guide

update-bot-alias¶

Description¶

Synopsis¶

Options¶

Output¶