/AWS1/CL_LXBGETBOTRESPONSE

GetBotResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/LXBBOTNAME /AWS1/LXBBOTNAME

The name of the bot.

iv_description TYPE /AWS1/LXBDESCRIPTION /AWS1/LXBDESCRIPTION

A description of the bot.

it_intents TYPE /AWS1/CL_LXBINTENT=>TT_INTENTLIST TT_INTENTLIST

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

iv_enablemodelimprovements TYPE /AWS1/LXBBOOLEAN /AWS1/LXBBOOLEAN

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

iv_nluintentconfidencethresh TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

io_clarificationprompt TYPE REF TO /AWS1/CL_LXBPROMPT /AWS1/CL_LXBPROMPT

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

io_abortstatement TYPE REF TO /AWS1/CL_LXBSTATEMENT /AWS1/CL_LXBSTATEMENT

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

iv_status TYPE /AWS1/LXBSTATUS /AWS1/LXBSTATUS

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

iv_failurereason TYPE /AWS1/LXBSTRING /AWS1/LXBSTRING

If status is FAILED, Amazon Lex explains why it failed to build the bot.

iv_lastupdateddate TYPE /AWS1/LXBTIMESTAMP /AWS1/LXBTIMESTAMP

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

iv_createddate TYPE /AWS1/LXBTIMESTAMP /AWS1/LXBTIMESTAMP

The date that the bot was created.

iv_idlesessionttlinseconds TYPE /AWS1/LXBSESSIONTTL /AWS1/LXBSESSIONTTL

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

iv_voiceid TYPE /AWS1/LXBSTRING /AWS1/LXBSTRING

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

iv_checksum TYPE /AWS1/LXBSTRING /AWS1/LXBSTRING

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

iv_version TYPE /AWS1/LXBVERSION /AWS1/LXBVERSION

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

iv_locale TYPE /AWS1/LXBLOCALE /AWS1/LXBLOCALE

The target locale for the bot.

iv_childdirected TYPE /AWS1/LXBBOOLEAN /AWS1/LXBBOOLEAN

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.

iv_detectsentiment TYPE /AWS1/LXBBOOLEAN /AWS1/LXBBOOLEAN

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

---

Queryable Attributes

name

The name of the bot.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

description

A description of the bot.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

intents

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

Accessible with the following methods

Method	Description
GET_INTENTS()	Getter for INTENTS, with configurable default
ASK_INTENTS()	Getter for INTENTS w/ exceptions if field has no value
HAS_INTENTS()	Determine if INTENTS has a value

enableModelImprovements

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

Accessible with the following methods

Method	Description
GET_ENABLEMODELIMPROVEMENTS()	Getter for ENABLEMODELIMPROVEMENTS, with configurable defaul
ASK_ENABLEMODELIMPROVEMENTS()	Getter for ENABLEMODELIMPROVEMENTS w/ exceptions if field ha
HAS_ENABLEMODELIMPROVEMENTS()	Determine if ENABLEMODELIMPROVEMENTS has a value

nluIntentConfidenceThreshold

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

Accessible with the following methods

Method	Description
GET_NLUINTENTCONFIDENCETHRSH()	Getter for NLUINTENTCONFIDENCETHRESHOLD, with configurable d
ASK_NLUINTENTCONFIDENCETHRSH()	Getter for NLUINTENTCONFIDENCETHRESHOLD w/ exceptions if fie
STR_NLUINTENTCONFIDENCETHRSH()	String format for NLUINTENTCONFIDENCETHRESHOLD, with configu
HAS_NLUINTENTCONFIDENCETHRSH()	Determine if NLUINTENTCONFIDENCETHRESHOLD has a value

clarificationPrompt

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

Accessible with the following methods

Method	Description
GET_CLARIFICATIONPROMPT()	Getter for CLARIFICATIONPROMPT

abortStatement

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Accessible with the following methods

Method	Description
GET_ABORTSTATEMENT()	Getter for ABORTSTATEMENT

status

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

failureReason

If status is FAILED, Amazon Lex explains why it failed to build the bot.

Accessible with the following methods

Method	Description
GET_FAILUREREASON()	Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON()	Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON()	Determine if FAILUREREASON has a value

lastUpdatedDate

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

Accessible with the following methods

Method	Description
GET_LASTUPDATEDDATE()	Getter for LASTUPDATEDDATE, with configurable default
ASK_LASTUPDATEDDATE()	Getter for LASTUPDATEDDATE w/ exceptions if field has no val
HAS_LASTUPDATEDDATE()	Determine if LASTUPDATEDDATE has a value

createdDate

The date that the bot was created.

Accessible with the following methods

Method	Description
GET_CREATEDDATE()	Getter for CREATEDDATE, with configurable default
ASK_CREATEDDATE()	Getter for CREATEDDATE w/ exceptions if field has no value
HAS_CREATEDDATE()	Determine if CREATEDDATE has a value

idleSessionTTLInSeconds

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

Accessible with the following methods

Method	Description
GET_IDLESESSIONTTLINSECONDS()	Getter for IDLESESSIONTTLINSECONDS, with configurable defaul
ASK_IDLESESSIONTTLINSECONDS()	Getter for IDLESESSIONTTLINSECONDS w/ exceptions if field ha
HAS_IDLESESSIONTTLINSECONDS()	Determine if IDLESESSIONTTLINSECONDS has a value

voiceId

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

Accessible with the following methods

Method	Description
GET_VOICEID()	Getter for VOICEID, with configurable default
ASK_VOICEID()	Getter for VOICEID w/ exceptions if field has no value
HAS_VOICEID()	Determine if VOICEID has a value

checksum

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Accessible with the following methods

Method	Description
GET_CHECKSUM()	Getter for CHECKSUM, with configurable default
ASK_CHECKSUM()	Getter for CHECKSUM w/ exceptions if field has no value
HAS_CHECKSUM()	Determine if CHECKSUM has a value

version

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

Accessible with the following methods

Method	Description
GET_VERSION()	Getter for VERSION, with configurable default
ASK_VERSION()	Getter for VERSION w/ exceptions if field has no value
HAS_VERSION()	Determine if VERSION has a value

locale

The target locale for the bot.

Accessible with the following methods

Method	Description
GET_LOCALE()	Getter for LOCALE, with configurable default
ASK_LOCALE()	Getter for LOCALE w/ exceptions if field has no value
HAS_LOCALE()	Determine if LOCALE has a value

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.

Accessible with the following methods

Method	Description
GET_CHILDDIRECTED()	Getter for CHILDDIRECTED, with configurable default
ASK_CHILDDIRECTED()	Getter for CHILDDIRECTED w/ exceptions if field has no value
HAS_CHILDDIRECTED()	Determine if CHILDDIRECTED has a value

detectSentiment

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

Accessible with the following methods

Method	Description
GET_DETECTSENTIMENT()	Getter for DETECTSENTIMENT, with configurable default
ASK_DETECTSENTIMENT()	Getter for DETECTSENTIMENT w/ exceptions if field has no val
HAS_DETECTSENTIMENT()	Determine if DETECTSENTIMENT has a value