Class: Aws::LexModelsV2::Types::DescribeBotRecommendationResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::DescribeBotRecommendationResponse

Defined in:

gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The identifier of the bot associated with the bot recommendation.

• #bot_recommendation_id ⇒ String

  The identifier of the bot recommendation being described.

• #bot_recommendation_results ⇒ Types::BotRecommendationResults

  The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

• #bot_recommendation_status ⇒ String

  The status of the bot recommendation.

• #bot_version ⇒ String

  The version of the bot associated with the bot recommendation.

• #creation_date_time ⇒ Time

  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.

• #failure_reasons ⇒ Array<String>

  If botRecommendationStatus is Failed, Amazon Lex explains why.

• #last_updated_date_time ⇒ Time

  The date and time that the bot recommendation was last updated.

• #locale_id ⇒ String

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

• #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 identifier of the bot associated with the bot recommendation.

Returns:

• (String)

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

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

#bot_recommendation_id ⇒ String

The identifier of the bot recommendation being described.

Returns:

• (String)

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

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

#bot_recommendation_results ⇒ Types::BotRecommendationResults

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

Returns:

• (Types::BotRecommendationResults)

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

class DescribeBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :failure_reasons,
  :creation_date_time,
  :last_updated_date_time,
  :transcript_source_setting,
  :encryption_setting,
  :bot_recommendation_results)
  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 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5910

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

#bot_version ⇒ String

The version of the bot associated with the bot recommendation.

Returns:

• (String)

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

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

#creation_date_time ⇒ Time

The date and time that the bot recommendation was created.

Returns:

• (Time)

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

class DescribeBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :failure_reasons,
  :creation_date_time,
  :last_updated_date_time,
  :transcript_source_setting,
  :encryption_setting,
  :bot_recommendation_results)
  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 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5910

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

#failure_reasons ⇒ Array<String>

If botRecommendationStatus is Failed, Amazon Lex explains why.

Returns:

• (Array<String>)

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

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

#last_updated_date_time ⇒ Time

The date and time that the bot recommendation was last updated.

Returns:

• (Time)

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

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

#locale_id ⇒ String

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

Returns:

• (String)

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

class DescribeBotRecommendationResponse < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_status,
  :bot_recommendation_id,
  :failure_reasons,
  :creation_date_time,
  :last_updated_date_time,
  :transcript_source_setting,
  :encryption_setting,
  :bot_recommendation_results)
  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 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5910

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