Class: Aws::LexModelsV2::Types::StartBotRecommendationResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::StartBotRecommendationResponse

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 containing the bot recommendation.

• #bot_recommendation_id ⇒ String

  The identifier of the bot recommendation that you have created.

• #bot_recommendation_status ⇒ String

  The status of the bot recommendation.

• #bot_version ⇒ String

  The version of the bot containing the bot recommendation.

• #creation_date_time ⇒ Time

  A timestamp of the date and time that the bot recommendation was created.

• #encryption_setting ⇒ Types::EncryptionSetting

  The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

• #locale_id ⇒ String

  The identifier of the language and locale of the bot recommendation to start.

• #transcript_source_setting ⇒ Types::TranscriptSourceSetting

  The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Instance Attribute Details

#bot_id ⇒ String

The unique identifier of the bot containing the bot recommendation.

Returns:

• (String)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#bot_recommendation_id ⇒ String

The identifier of the bot recommendation that you have created.

Returns:

• (String)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#bot_recommendation_status ⇒ String

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

Returns:

• (String)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#bot_version ⇒ String

The version of the bot containing the bot recommendation.

Returns:

• (String)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ Time

A timestamp of the date and time that the bot recommendation was created.

Returns:

• (Time)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_setting ⇒ Types::EncryptionSetting

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

Returns:

• (Types::EncryptionSetting)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see [Supported languages]

[1]: docs.aws.amazon.com/lexv2/latest/dg/how-languages.html

Returns:

• (String)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end

#transcript_source_setting ⇒ Types::TranscriptSourceSetting

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Returns:

• (Types::TranscriptSourceSetting)

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

class StartBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :creation_date_time,
  :transcript_source_setting,
  :encryption_setting)
  SENSITIVE = []
  include Aws::Structure
end