Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the lex:GetBot
action.
Synopsis
- getBot :: Text -> Text -> GetBot
- data GetBot
- gbName :: Lens' GetBot Text
- gbVersionOrAlias :: Lens' GetBot Text
- getBotResponse :: Int -> GetBotResponse
- data GetBotResponse
- gbrsFailureReason :: Lens' GetBotResponse (Maybe Text)
- gbrsStatus :: Lens' GetBotResponse (Maybe LexStatus)
- gbrsAbortStatement :: Lens' GetBotResponse (Maybe Statement)
- gbrsIntents :: Lens' GetBotResponse [Intent]
- gbrsChecksum :: Lens' GetBotResponse (Maybe Text)
- gbrsLocale :: Lens' GetBotResponse (Maybe Locale)
- gbrsCreatedDate :: Lens' GetBotResponse (Maybe UTCTime)
- gbrsName :: Lens' GetBotResponse (Maybe Text)
- gbrsVersion :: Lens' GetBotResponse (Maybe Text)
- gbrsIdleSessionTTLInSeconds :: Lens' GetBotResponse (Maybe Natural)
- gbrsClarificationPrompt :: Lens' GetBotResponse (Maybe Prompt)
- gbrsVoiceId :: Lens' GetBotResponse (Maybe Text)
- gbrsLastUpdatedDate :: Lens' GetBotResponse (Maybe UTCTime)
- gbrsChildDirected :: Lens' GetBotResponse (Maybe Bool)
- gbrsDescription :: Lens' GetBotResponse (Maybe Text)
- gbrsResponseStatus :: Lens' GetBotResponse Int
Creating a Request
Creates a value of GetBot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbName
- The name of the bot. The name is case sensitive.gbVersionOrAlias
- The version or alias of the bot.
See: getBot
smart constructor.
Instances
Request Lenses
Destructuring the Response
Creates a value of GetBotResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbrsFailureReason
- Ifstatus
isFAILED
, Amazon Lex explains why it failed to build the bot.gbrsStatus
- The status of the bot. If the bot is ready to run, the status isREADY
. If there was a problem with building the bot, the status isFAILED
and thefailureReason
explains why the bot did not build. If the bot was saved but not built, the status isNOT BUILT
.gbrsAbortStatement
- The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, seePutBot
.gbrsIntents
- An array ofintent
objects. For more information, seePutBot
.gbrsChecksum
- Checksum of the bot used to identify a specific revision of the bot's> LATEST
version.gbrsLocale
- The target locale for the bot.gbrsCreatedDate
- The date that the bot was created.gbrsName
- The name of the bot.gbrsVersion
- The version of the bot. For a new bot, the version is always> LATEST
.gbrsIdleSessionTTLInSeconds
- The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, seePutBot
.gbrsClarificationPrompt
- The message Amazon Lex uses when it doesn't understand the user's request. For more information, seePutBot
.gbrsVoiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, seePutBot
.gbrsLastUpdatedDate
- The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.gbrsChildDirected
- 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 specifyingtrue
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.gbrsDescription
- A description of the bot.gbrsResponseStatus
- -- | The response status code.
data GetBotResponse Source #
See: getBotResponse
smart constructor.
Instances
Response Lenses
gbrsFailureReason :: Lens' GetBotResponse (Maybe Text) Source #
If status
is FAILED
, Amazon Lex explains why it failed to build the bot.
gbrsStatus :: Lens' GetBotResponse (Maybe LexStatus) Source #
The status of the bot. If the bot is ready to run, the status is READY
. If there was a problem with building the bot, the status is FAILED
and the failureReason
explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT
.
gbrsAbortStatement :: Lens' GetBotResponse (Maybe Statement) Source #
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot
.
gbrsIntents :: Lens' GetBotResponse [Intent] Source #
An array of intent
objects. For more information, see PutBot
.
gbrsChecksum :: Lens' GetBotResponse (Maybe Text) Source #
Checksum of the bot used to identify a specific revision of the bot's > LATEST
version.
gbrsLocale :: Lens' GetBotResponse (Maybe Locale) Source #
The target locale for the bot.
gbrsCreatedDate :: Lens' GetBotResponse (Maybe UTCTime) Source #
The date that the bot was created.
gbrsVersion :: Lens' GetBotResponse (Maybe Text) Source #
The version of the bot. For a new bot, the version is always > LATEST
.
gbrsIdleSessionTTLInSeconds :: Lens' GetBotResponse (Maybe Natural) Source #
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot
.
gbrsClarificationPrompt :: Lens' GetBotResponse (Maybe Prompt) Source #
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot
.
gbrsVoiceId :: Lens' GetBotResponse (Maybe Text) Source #
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot
.
gbrsLastUpdatedDate :: Lens' GetBotResponse (Maybe UTCTime) Source #
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
gbrsChildDirected :: Lens' GetBotResponse (Maybe Bool) Source #
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.
gbrsDescription :: Lens' GetBotResponse (Maybe Text) Source #
A description of the bot.
gbrsResponseStatus :: Lens' GetBotResponse Int Source #
- - | The response status code.