Class: Aws::LexModelBuildingService::Types::CreateBotVersionResponse

Inherits:

Struct

Object
Struct
Aws::LexModelBuildingService::Types::CreateBotVersionResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#abort_statement ⇒ Types::Statement

The message that Amazon Lex uses to cancel a conversation.
#checksum ⇒ String

Checksum identifying the version of the bot that was created.
#child_directed ⇒ Boolean

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying ‘true` or `false` in the `childDirected` field.
#clarification_prompt ⇒ Types::Prompt

The message that Amazon Lex uses when it doesn’t understand the user’s request.
#created_date ⇒ Time

The date when the bot version was created.
#description ⇒ String

A description of the bot.
#detect_sentiment ⇒ Boolean

Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
#enable_model_improvements ⇒ Boolean

Indicates whether the bot uses accuracy improvements.
#failure_reason ⇒ String

If ‘status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.
#idle_session_ttl_in_seconds ⇒ Integer

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
#intents ⇒ Array<Types::Intent>

An array of ‘Intent` objects.
#last_updated_date ⇒ Time

The date when the ‘$LATEST` version of this bot was updated.
#locale ⇒ String

Specifies the target locale for the bot.
#name ⇒ String

The name of the bot.
#status ⇒ String

When you send a request to create or update a bot, Amazon Lex sets the ‘status` response element to `BUILDING`.
#version ⇒ String

The version of the bot.
#voice_id ⇒ String

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

Instance Attribute Details

#abort_statement ⇒ `Types::Statement`

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Returns:

(Types::Statement)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#checksum ⇒ `String`

Checksum identifying the version of the bot that was created.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#child_directed ⇒ `Boolean`

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying ‘true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ.]

[1]: aws.amazon.com/lex/faqs#data-security

Returns:

(Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#clarification_prompt ⇒ `Types::Prompt`

The message that Amazon Lex uses when it doesn’t understand the user’s request. For more information, see PutBot.

Returns:

(Types::Prompt)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ `Time`

The date when the bot version was created.

Returns:

(Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the bot.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#detect_sentiment ⇒ `Boolean`

Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.

Returns:

(Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#enable_model_improvements ⇒ `Boolean`

Indicates whether the bot uses accuracy improvements. ‘true` indicates that the bot is using the improvements, otherwise, `false`.

Returns:

(Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

If ‘status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ `Integer`

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

Returns:

(Integer)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#intents ⇒ `Array<Types::Intent>`

An array of ‘Intent` objects. For more information, see PutBot.

Returns:

(Array<Types::Intent>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ `Time`

The date when the ‘$LATEST` version of this bot was updated.

Returns:

(Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ `String`

Specifies the target locale for the bot.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the bot.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

When you send a request to create or update a bot, Amazon Lex sets the ‘status` response element to `BUILDING`. After Amazon Lex builds the bot, it sets `status` to `READY`. If Amazon Lex can’t build the bot, it sets ‘status` to `FAILED`. Amazon Lex returns the reason for the failure in the `failureReason` response element.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

The version of the bot.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ `String`

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

Returns:

(String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 491

class CreateBotVersionResponse < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :enable_model_improvements,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::LexModelBuildingService::Types::CreateBotVersionResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#abort_statement ⇒ Types::Statement

#checksum ⇒ String

#child_directed ⇒ Boolean

#clarification_prompt ⇒ Types::Prompt

#created_date ⇒ Time

#description ⇒ String

#detect_sentiment ⇒ Boolean

#enable_model_improvements ⇒ Boolean

#failure_reason ⇒ String

#idle_session_ttl_in_seconds ⇒ Integer

#intents ⇒ Array<Types::Intent>

#last_updated_date ⇒ Time

#locale ⇒ String

#name ⇒ String

#status ⇒ String

#version ⇒ String

#voice_id ⇒ String

#abort_statement ⇒ `Types::Statement`

#checksum ⇒ `String`

#child_directed ⇒ `Boolean`

#clarification_prompt ⇒ `Types::Prompt`

#created_date ⇒ `Time`

#description ⇒ `String`

#detect_sentiment ⇒ `Boolean`

#enable_model_improvements ⇒ `Boolean`

#failure_reason ⇒ `String`

#idle_session_ttl_in_seconds ⇒ `Integer`

#intents ⇒ `Array<Types::Intent>`

#last_updated_date ⇒ `Time`

#locale ⇒ `String`

#name ⇒ `String`

#status ⇒ `String`

#version ⇒ `String`

#voice_id ⇒ `String`