Amazonka.LexModels.GetBot

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.

Creating a Request

data GetBot

See: newGetBot smart constructor.

Constructors

GetBot'

Fields

• name :: Text

  The name of the bot. The name is case sensitive.

• versionOrAlias :: Text

  The version or alias of the bot.

Instances

ToHeaders GetBot

Defined in Amazonka.LexModels.GetBot

Methods

toHeaders :: GetBot -> [Header]

ToPath GetBot

Defined in Amazonka.LexModels.GetBot

Methods

toPath :: GetBot -> ByteString

ToQuery GetBot

Defined in Amazonka.LexModels.GetBot

Methods

toQuery :: GetBot -> QueryString

AWSRequest GetBot

Defined in Amazonka.LexModels.GetBot

Associated Types

type AWSResponse GetBot

Methods

request :: (Service -> Service) -> GetBot -> Request GetBot

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBot)))

Generic GetBot

Defined in Amazonka.LexModels.GetBot

Associated Types

type Rep GetBot :: Type -> Type

Methods

from :: GetBot -> Rep GetBot x

to :: Rep GetBot x -> GetBot

Read GetBot

Defined in Amazonka.LexModels.GetBot

Methods

readsPrec :: Int -> ReadS GetBot

readList :: ReadS [GetBot]

readPrec :: ReadPrec GetBot

readListPrec :: ReadPrec [GetBot]

Show GetBot

Defined in Amazonka.LexModels.GetBot

Methods

showsPrec :: Int -> GetBot -> ShowS

show :: GetBot -> String

showList :: [GetBot] -> ShowS

NFData GetBot

Defined in Amazonka.LexModels.GetBot

Methods

rnf :: GetBot -> ()

Eq GetBot

Defined in Amazonka.LexModels.GetBot

Methods

(==) :: GetBot -> GetBot -> Bool

(/=) :: GetBot -> GetBot -> Bool

Hashable GetBot

Defined in Amazonka.LexModels.GetBot

Methods

hashWithSalt :: Int -> GetBot -> Int

hash :: GetBot -> Int

type AWSResponse GetBot

Defined in Amazonka.LexModels.GetBot

type AWSResponse GetBot = GetBotResponse

type Rep GetBot

Defined in Amazonka.LexModels.GetBot

type Rep GetBot = D1 ('MetaData "GetBot" "Amazonka.LexModels.GetBot" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "versionOrAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetBot

Arguments

:: Text

GetBot

-> Text

$sel:versionOrAlias:GetBot'

-> GetBot

Create a value of GetBot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetBot, getBot_name - The name of the bot. The name is case sensitive.

$sel:versionOrAlias:GetBot', getBot_versionOrAlias - The version or alias of the bot.

Request Lenses

getBot_name :: Lens' GetBot Text

The name of the bot. The name is case sensitive.

getBot_versionOrAlias :: Lens' GetBot Text

The version or alias of the bot.

Destructuring the Response

data GetBotResponse

See: newGetBotResponse smart constructor.

Constructors

GetBotResponse'

Fields

• abortStatement :: Maybe Statement

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

• checksum :: Maybe Text

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

• childDirected :: Maybe Bool

  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.

• clarificationPrompt :: Maybe Prompt

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

• createdDate :: Maybe POSIX

  The date that the bot was created.

• description :: Maybe Text

  A description of the bot.

• detectSentiment :: Maybe Bool

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

• enableModelImprovements :: Maybe Bool

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

• failureReason :: Maybe Text

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

• idleSessionTTLInSeconds :: Maybe Natural

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

• intents :: Maybe [Intent]

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

• lastUpdatedDate :: Maybe POSIX

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

• locale :: Maybe Locale

  The target locale for the bot.

• name :: Maybe Text

  The name of the bot.

• nluIntentConfidenceThreshold :: Maybe Double

  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.

• status :: Maybe LexStatus

  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.

• version :: Maybe Text

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

• voiceId :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBotResponse

Defined in Amazonka.LexModels.GetBot

Associated Types

type Rep GetBotResponse :: Type -> Type

Methods

from :: GetBotResponse -> Rep GetBotResponse x

to :: Rep GetBotResponse x -> GetBotResponse

Read GetBotResponse

Defined in Amazonka.LexModels.GetBot

Methods

readsPrec :: Int -> ReadS GetBotResponse

readList :: ReadS [GetBotResponse]

readPrec :: ReadPrec GetBotResponse

readListPrec :: ReadPrec [GetBotResponse]

Show GetBotResponse

Defined in Amazonka.LexModels.GetBot

Methods

showsPrec :: Int -> GetBotResponse -> ShowS

show :: GetBotResponse -> String

showList :: [GetBotResponse] -> ShowS

NFData GetBotResponse

Defined in Amazonka.LexModels.GetBot

Methods

rnf :: GetBotResponse -> ()

Eq GetBotResponse

Defined in Amazonka.LexModels.GetBot

Methods

(==) :: GetBotResponse -> GetBotResponse -> Bool

(/=) :: GetBotResponse -> GetBotResponse -> Bool

type Rep GetBotResponse

Defined in Amazonka.LexModels.GetBot

type Rep GetBotResponse = D1 ('MetaData "GetBotResponse" "Amazonka.LexModels.GetBot" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "abortStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement)) :*: S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "childDirected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "clarificationPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Prompt)))) :*: ((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "detectSentiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "enableModelImprovements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "idleSessionTTLInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "intents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Intent]))) :*: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "nluIntentConfidenceThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LexStatus))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetBotResponse

Arguments

:: Int

$sel:httpStatus:GetBotResponse'

-> GetBotResponse

Create a value of GetBotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:abortStatement:GetBotResponse', getBotResponse_abortStatement - The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

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

$sel:childDirected:GetBotResponse', getBotResponse_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.

$sel:clarificationPrompt:GetBotResponse', getBotResponse_clarificationPrompt - The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

GetBotResponse, getBotResponse_createdDate - The date that the bot was created.

GetBotResponse, getBotResponse_description - A description of the bot.

$sel:detectSentiment:GetBotResponse', getBotResponse_detectSentiment - Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

$sel:enableModelImprovements:GetBotResponse', getBotResponse_enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

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

$sel:idleSessionTTLInSeconds:GetBotResponse', getBotResponse_idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

$sel:intents:GetBotResponse', getBotResponse_intents - An array of intent objects. For more information, see PutBot.

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

$sel:locale:GetBotResponse', getBotResponse_locale - The target locale for the bot.

GetBot, getBotResponse_name - The name of the bot.

$sel:nluIntentConfidenceThreshold:GetBotResponse', getBotResponse_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.

GetBotResponse, getBotResponse_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.

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

$sel:voiceId:GetBotResponse', getBotResponse_voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

$sel:httpStatus:GetBotResponse', getBotResponse_httpStatus - The response's http status code.

Response Lenses

getBotResponse_abortStatement :: Lens' GetBotResponse (Maybe Statement)

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

getBotResponse_checksum :: Lens' GetBotResponse (Maybe Text)

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

getBotResponse_childDirected :: Lens' GetBotResponse (Maybe Bool)

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.

getBotResponse_clarificationPrompt :: Lens' GetBotResponse (Maybe Prompt)

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

getBotResponse_createdDate :: Lens' GetBotResponse (Maybe UTCTime)

The date that the bot was created.

getBotResponse_description :: Lens' GetBotResponse (Maybe Text)

A description of the bot.

getBotResponse_detectSentiment :: Lens' GetBotResponse (Maybe Bool)

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

getBotResponse_enableModelImprovements :: Lens' GetBotResponse (Maybe Bool)

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

getBotResponse_failureReason :: Lens' GetBotResponse (Maybe Text)

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

getBotResponse_idleSessionTTLInSeconds :: Lens' GetBotResponse (Maybe Natural)

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

getBotResponse_intents :: Lens' GetBotResponse (Maybe [Intent])

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

getBotResponse_lastUpdatedDate :: Lens' GetBotResponse (Maybe UTCTime)

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

getBotResponse_locale :: Lens' GetBotResponse (Maybe Locale)

The target locale for the bot.

getBotResponse_name :: Lens' GetBotResponse (Maybe Text)

The name of the bot.

getBotResponse_nluIntentConfidenceThreshold :: Lens' GetBotResponse (Maybe Double)

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.

getBotResponse_status :: Lens' GetBotResponse (Maybe LexStatus)

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.

getBotResponse_version :: Lens' GetBotResponse (Maybe Text)

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

getBotResponse_voiceId :: Lens' GetBotResponse (Maybe Text)

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

getBotResponse_httpStatus :: Lens' GetBotResponse Int

The response's http status code.