Class: Aws::LexModelsV2::Types::CreateBotRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::CreateBotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_members ⇒ Array<Types::BotMember>

  The list of bot members in a network to be created.

• #bot_name ⇒ String

  The name of the bot.

• #bot_tags ⇒ Hash<String,String>

  A list of tags to add to the bot.

• #bot_type ⇒ String

  The type of a bot to create.

• #data_privacy ⇒ Types::DataPrivacy

  Provides information on additional privacy protections Amazon Lex should use with the bot’s data.

• #description ⇒ String

  A description of the bot.

• #idle_session_ttl_in_seconds ⇒ Integer

  The time, in seconds, that Amazon Lex should keep information about a user’s conversation with the bot.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

• #test_bot_alias_tags ⇒ Hash<String,String>

  A list of tags to add to the test alias for a bot.

Instance Attribute Details

#bot_members ⇒ Array<Types::BotMember>

The list of bot members in a network to be created.

Returns:

• (Array<Types::BotMember>)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#bot_name ⇒ String

The name of the bot. The bot name must be unique in the account that creates the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#bot_tags ⇒ Hash<String,String>

A list of tags to add to the bot. You can only add tags when you create a bot. You can’t use the ‘UpdateBot` operation to update tags. To update tags, use the `TagResource` operation.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#bot_type ⇒ String

The type of a bot to create.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#data_privacy ⇒ Types::DataPrivacy

Provides information on additional privacy protections Amazon Lex should use with the bot’s data.

Returns:

• (Types::DataPrivacy)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the bot. It appears in lists to help you identify a particular bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

The time, in seconds, that Amazon Lex should keep information about a user’s conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Returns:

• (Integer)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end

#test_bot_alias_tags ⇒ Hash<String,String>

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can’t use the ‘UpdateAlias` operation to update tags. To update tags on the test alias, use the `TagResource` operation.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 3697

class CreateBotRequest < Struct.new(
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_tags,
  :test_bot_alias_tags,
  :bot_type,
  :bot_members)
  SENSITIVE = []
  include Aws::Structure
end