AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::LexModelBuildingService::Types::PutBotAliasRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutBotAliasRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "AliasName", # required
  description: "Description",
  bot_version: "Version", # required
  bot_name: "BotName", # required
  checksum: "String",
  conversation_logs: {
    log_settings: [ # required
      {
        log_type: "AUDIO", # required, accepts AUDIO, TEXT
        destination: "CLOUDWATCH_LOGS", # required, accepts CLOUDWATCH_LOGS, S3
        kms_key_arn: "KmsKeyArn",
        resource_arn: "ResourceArn", # required
      },
    ],
    iam_role_arn: "IamRoleArn", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#bot_nameString

The name of the bot.

Returns:

  • (String)

    The name of the bot.

#bot_versionString

The version of the bot.

Returns:

  • (String)

    The version of the bot.

#checksumString

Identifies a specific revision of the $LATEST version.

When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don\'t specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Returns:

  • (String)

    Identifies a specific revision of the $LATEST version.

#conversation_logsTypes::ConversationLogsRequest

Settings for conversation logs for the alias.

Returns:

#descriptionString

A description of the alias.

Returns:

  • (String)

    A description of the alias.

#nameString

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

Returns:

  • (String)

    The name of the alias.

#tagsArray<Types::Tag>

A list of tags to add to the bot alias. You can only add tags when you create an alias, you can\'t use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

Returns:

  • (Array<Types::Tag>)

    A list of tags to add to the bot alias.