public static interface PutBotResponse.Builder extends LexModelBuildingResponse.Builder, CopyableBuilder<PutBotResponse.Builder,PutBotResponse>
Modifier and Type | Method and Description |
---|---|
default PutBotResponse.Builder |
abortStatement(Consumer<Statement.Builder> abortStatement)
The message that Amazon Lex uses to abort a conversation.
|
PutBotResponse.Builder |
abortStatement(Statement abortStatement)
The message that Amazon Lex uses to abort a conversation.
|
PutBotResponse.Builder |
checksum(String checksum)
Checksum of the bot that you created.
|
PutBotResponse.Builder |
childDirected(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. |
default PutBotResponse.Builder |
clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)
The prompts that Amazon Lex uses when it doesn't understand the user's intent.
|
PutBotResponse.Builder |
clarificationPrompt(Prompt clarificationPrompt)
The prompts that Amazon Lex uses when it doesn't understand the user's intent.
|
PutBotResponse.Builder |
createdDate(Instant createdDate)
The date that the bot was created.
|
PutBotResponse.Builder |
description(String description)
A description of the bot.
|
PutBotResponse.Builder |
failureReason(String failureReason)
If
status is FAILED , Amazon Lex provides the reason that it failed to build the
bot. |
PutBotResponse.Builder |
idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The maximum length of time that Amazon Lex retains the data gathered in a conversation.
|
PutBotResponse.Builder |
intents(Collection<Intent> intents)
An array of
Intent objects. |
PutBotResponse.Builder |
intents(Intent... intents)
An array of
Intent objects. |
PutBotResponse.Builder |
lastUpdatedDate(Instant lastUpdatedDate)
The date that the bot was updated.
|
PutBotResponse.Builder |
locale(Locale locale)
The target locale for the bot.
|
PutBotResponse.Builder |
locale(String locale)
The target locale for the bot.
|
PutBotResponse.Builder |
name(String name)
The name of the bot.
|
PutBotResponse.Builder |
status(Status 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 |
status(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 |
version(String version)
The version of the bot.
|
PutBotResponse.Builder |
voiceId(String voiceId)
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
|
build
copy
apply, build
PutBotResponse.Builder name(String name)
The name of the bot.
name
- The name of the bot.PutBotResponse.Builder description(String description)
A description of the bot.
description
- A description of the bot.PutBotResponse.Builder intents(Collection<Intent> intents)
An array of Intent
objects. For more information, see PutBot.
intents
- An array of Intent
objects. For more information, see PutBot.PutBotResponse.Builder intents(Intent... intents)
An array of Intent
objects. For more information, see PutBot.
intents
- An array of Intent
objects. For more information, see PutBot.PutBotResponse.Builder clarificationPrompt(Prompt clarificationPrompt)
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
clarificationPrompt
- The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information,
see PutBot.default PutBotResponse.Builder clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
This is a convenience that creates an instance of thePrompt.Builder
avoiding the need to create one
manually via Prompt.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to clarificationPrompt(Prompt)
.clarificationPrompt
- a consumer that will call methods on Prompt.Builder
clarificationPrompt(Prompt)
PutBotResponse.Builder abortStatement(Statement abortStatement)
The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
abortStatement
- The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.default PutBotResponse.Builder abortStatement(Consumer<Statement.Builder> abortStatement)
The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
This is a convenience that creates an instance of theStatement.Builder
avoiding the need to create
one manually via Statement.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to abortStatement(Statement)
.abortStatement
- a consumer that will call methods on Statement.Builder
abortStatement(Statement)
PutBotResponse.Builder status(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 processBehavior
to SAVE
, Amazon Lex sets the status code to
NOT BUILT
.
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 processBehavior
to SAVE
, Amazon Lex sets the status code to
NOT BUILT
.
Status
,
Status
PutBotResponse.Builder status(Status 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 processBehavior
to SAVE
, Amazon Lex sets the status code to
NOT BUILT
.
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 processBehavior
to SAVE
, Amazon Lex sets the status code to
NOT BUILT
.
Status
,
Status
PutBotResponse.Builder failureReason(String failureReason)
If status
is FAILED
, Amazon Lex provides the reason that it failed to build the
bot.
failureReason
- If status
is FAILED
, Amazon Lex provides the reason that it failed to build
the bot.PutBotResponse.Builder lastUpdatedDate(Instant lastUpdatedDate)
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
lastUpdatedDate
- The date that the bot was updated. When you create a resource, the creation date and last updated date
are the same.PutBotResponse.Builder createdDate(Instant createdDate)
The date that the bot was created.
createdDate
- The date that the bot was created.PutBotResponse.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
idleSessionTTLInSeconds
- The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more
information, see PutBot.PutBotResponse.Builder voiceId(String voiceId)
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
voiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more
information, see PutBot.PutBotResponse.Builder checksum(String checksum)
Checksum of the bot that you created.
checksum
- Checksum of the bot that you created.PutBotResponse.Builder version(String version)
The version of the bot. For a new bot, the version is always $LATEST
.
version
- The version of the bot. For a new bot, the version is always $LATEST
.PutBotResponse.Builder locale(String locale)
The target locale for the bot.
PutBotResponse.Builder locale(Locale locale)
The target locale for the bot.
PutBotResponse.Builder childDirected(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.
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.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.