Class: Aws::LexModelsV2::Types::UpdateBotRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::UpdateBotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The unique identifier of the bot to update.

• #bot_members ⇒ Array<Types::BotMember>

  The list of bot members in the network associated with the update action.

• #bot_name ⇒ String

  The new name of the bot.

• #bot_type ⇒ String

  The type of the bot to be updated.

• #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.

• #error_log_settings ⇒ Types::ErrorLogSettings

  Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.

• #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 permissions to access the bot.

Instance Attribute Details

#bot_id ⇒ String

The unique identifier of the bot to update. This identifier is returned by the [CreateBot] operation.

[1]: docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html

Returns:

• (String)

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

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

#bot_members ⇒ Array<Types::BotMember>

The list of bot members in the network associated with the update action.

Returns:

• (Array<Types::BotMember>)

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

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

#bot_name ⇒ String

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

Returns:

• (String)

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

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

#bot_type ⇒ String

The type of the bot to be updated.

Returns:

• (String)

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

class UpdateBotRequest < Struct.new(
  :bot_id,
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_type,
  :bot_members,
  :error_log_settings)
  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 15456

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

#description ⇒ String

A description of the bot.

Returns:

• (String)

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

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

#error_log_settings ⇒ Types::ErrorLogSettings

Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.

Returns:

• (Types::ErrorLogSettings)

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

class UpdateBotRequest < Struct.new(
  :bot_id,
  :bot_name,
  :description,
  :role_arn,
  :data_privacy,
  :idle_session_ttl_in_seconds,
  :bot_type,
  :bot_members,
  :error_log_settings)
  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 15456

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

#role_arn ⇒ String

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

Returns:

• (String)

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

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