Class: Aws::LexModelsV2::Types::BotImportSpecification

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

Overview

Note:

When making an API call, you may pass BotImportSpecification data as a hash:

{
  bot_name: "Name", # required
  role_arn: "RoleArn", # required
  data_privacy: { # required
    child_directed: false, # required
  },
  idle_session_ttl_in_seconds: 1,
  bot_tags: {
    "TagKey" => "TagValue",
  },
  test_bot_alias_tags: {
    "TagKey" => "TagValue",
  },
}

Provides the bot parameters required for importing a bot.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_nameString

The name that Amazon Lex should use for the bot.

Returns:

  • (String)


429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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

#bot_tagsHash<String,String>

A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

Returns:

  • (Hash<String,String>)


429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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

#data_privacyTypes::DataPrivacy

By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Returns:



429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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

#idle_session_ttl_in_secondsInteger

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)


429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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

#role_arnString

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

Returns:

  • (String)


429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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

#test_bot_alias_tagsHash<String,String>

A list of tags to add to the test alias for a bot. You can only add tags when you import 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>)


429
430
431
432
433
434
435
436
437
438
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 429

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