You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::LexModelBuildingService::Types::PutBotResponse

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#abort_statementTypes::Statement

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

Returns:



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#checksumString

Checksum of the bot that you created.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#child_directedBoolean

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.

Returns:

  • (Boolean)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#clarification_promptTypes::Prompt

The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

Returns:



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#created_dateTime

The date that the bot was created.

Returns:

  • (Time)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#descriptionString

A description of the bot.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#failure_reasonString

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

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#idle_session_ttl_in_secondsInteger

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

Returns:

  • (Integer)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#intentsArray<Types::Intent>

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

Returns:



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#last_updated_dateTime

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Returns:

  • (Time)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#localeString

The target locale for the bot.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#nameString

The name of the bot.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#statusString

When you send a request to create a bot with processBehavior set to BUILD, 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, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehaviorto SAVE, Amazon Lex sets the status code to NOT BUILT.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#versionString

The version of the bot. For a new bot, the version is always $LATEST.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end

#voice_idString

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Returns:

  • (String)


2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2610

class PutBotResponse < 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)
  include Aws::Structure
end