Package software.amazon.awssdk.services.lexmodelbuilding.model

Class PutBotResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.lexmodelbuilding.model.PutBotResponse

All Implemented Interfaces:

ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>

@Generated("software.amazon.awssdk:codegen")
public class PutBotResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutBotResponse.Builder

Method Summary

Modifier and Type	Method	Description
Statement	abortStatement()	The message that Amazon Lex uses to abort a conversation.
static PutBotResponse.Builder	builder()
String	checksum()	Checksum of the bot that you created.
Boolean	childDirected()	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.
Prompt	clarificationPrompt()	The prompts that Amazon Lex uses when it doesn't understand the user's intent.
Date	createdDate()	The date that the bot was created.
String	description()	A description of the bot.
boolean	equals(Object obj)
String	failureReason()	If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
int	hashCode()
Integer	idleSessionTTLInSeconds()	The maximum length of time that Amazon Lex retains the data gathered in a conversation.
List<Intent>	intents()	An array of Intent objects.
Date	lastUpdatedDate()	The date that the bot was updated.
String	locale()	The target locale for the bot.
String	name()	The name of the bot.
static Class<? extends PutBotResponse.Builder>	serializableBuilderClass()
String	status()	When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.
PutBotResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	version()	The version of the bot.
String	voiceId()	The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

The name of the bot.

Returns:

The name of the bot.

description

public String description()

A description of the bot.

Returns:

A description of the bot.

intents

public List<Intent> intents()

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

Returns:

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

clarificationPrompt

public Prompt clarificationPrompt()

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

Returns:

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

abortStatement

public Statement abortStatement()

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

Returns:

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

status

public String status()

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:

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.

See Also:

Status

failureReason

public String failureReason()

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

Returns:

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

lastUpdatedDate

public Date lastUpdatedDate()

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

Returns:

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

createdDate

public Date createdDate()

The date that the bot was created.

Returns:

The date that the bot was created.

idleSessionTTLInSeconds

public Integer idleSessionTTLInSeconds()

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

Returns:

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

voiceId

public String voiceId()

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

Returns:

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

checksum

public String checksum()

Checksum of the bot that you created.

Returns:

Checksum of the bot that you created.

version

public String version()

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

Returns:

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

locale

public String locale()

The target locale for the bot.

Returns:

The target locale for the bot.

See Also:

Locale

childDirected

public Boolean childDirected()

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:

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.

toBuilder

public PutBotResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>

Returns:

a builder for type T

builder

public static PutBotResponse.Builder builder()

serializableBuilderClass

public static Class<? extends PutBotResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object