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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Note:

When making an API call, you may pass PutBotAliasRequest data as a 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
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_nameString

The name of the bot.

Returns:

  • (String)


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#bot_versionString

The version of the bot.

Returns:

  • (String)


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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)


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_logsTypes::ConversationLogsRequest

Settings for conversation logs for the alias.



2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the alias.

Returns:

  • (String)


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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:



2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2991

class PutBotAliasRequest < Struct.new(
  :name,
  :description,
  :bot_version,
  :bot_name,
  :checksum,
  :conversation_logs,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end