amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexV2Models.DescribeBotRecommendation

Description

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Synopsis

Creating a Request

data DescribeBotRecommendation Source #

See: newDescribeBotRecommendation smart constructor.

Constructors

DescribeBotRecommendation' 

Fields

  • botId :: Text

    The unique identifier of the bot associated with the bot recommendation.

  • botVersion :: Text

    The version of the bot associated with the bot recommendation.

  • localeId :: Text

    The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.

  • botRecommendationId :: Text

    The identifier of the bot recommendation to describe.

Instances

Instances details
ToHeaders DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

toHeaders :: DescribeBotRecommendation -> [Header] #

ToPath DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

toPath :: DescribeBotRecommendation -> ByteString #

ToQuery DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

toQuery :: DescribeBotRecommendation -> QueryString #

AWSRequest DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Associated Types

type AWSResponse DescribeBotRecommendation #

Methods

request :: (Service -> Service) -> DescribeBotRecommendation -> Request DescribeBotRecommendation #

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

Generic DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Associated Types

type Rep DescribeBotRecommendation :: Type -> Type #

Methods

from :: DescribeBotRecommendation -> Rep DescribeBotRecommendation x #

to :: Rep DescribeBotRecommendation x -> DescribeBotRecommendation #

Read DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

readsPrec :: Int -> ReadS DescribeBotRecommendation #

readList :: ReadS [DescribeBotRecommendation] #

readPrec :: ReadPrec DescribeBotRecommendation #

readListPrec :: ReadPrec [DescribeBotRecommendation] #

Show DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

showsPrec :: Int -> DescribeBotRecommendation -> ShowS #

show :: DescribeBotRecommendation -> String #

showList :: [DescribeBotRecommendation] -> ShowS #

NFData DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

rnf :: DescribeBotRecommendation -> () #

Eq DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

(==) :: DescribeBotRecommendation -> DescribeBotRecommendation -> Bool #

(/=) :: DescribeBotRecommendation -> DescribeBotRecommendation -> Bool #

Hashable DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

hashWithSalt :: Int -> DescribeBotRecommendation -> Int #

hash :: DescribeBotRecommendation -> Int #

type AWSResponse DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

type AWSResponse DescribeBotRecommendation = DescribeBotRecommendationResponse
type Rep DescribeBotRecommendation Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

type Rep DescribeBotRecommendation = D1 ('MetaData "DescribeBotRecommendation" "Amazonka.LexV2Models.DescribeBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotRecommendation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "botRecommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeBotRecommendation Source #

Arguments

:: Text

DescribeBotRecommendation

-> Text

DescribeBotRecommendation

-> Text

DescribeBotRecommendation

-> Text

DescribeBotRecommendation

-> DescribeBotRecommendation 

Create a value of DescribeBotRecommendation 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:

DescribeBotRecommendation, describeBotRecommendation_botId - The unique identifier of the bot associated with the bot recommendation.

DescribeBotRecommendation, describeBotRecommendation_botVersion - The version of the bot associated with the bot recommendation.

DescribeBotRecommendation, describeBotRecommendation_localeId - The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.

DescribeBotRecommendation, describeBotRecommendation_botRecommendationId - The identifier of the bot recommendation to describe.

Request Lenses

describeBotRecommendation_botId :: Lens' DescribeBotRecommendation Text Source #

The unique identifier of the bot associated with the bot recommendation.

describeBotRecommendation_botVersion :: Lens' DescribeBotRecommendation Text Source #

The version of the bot associated with the bot recommendation.

describeBotRecommendation_localeId :: Lens' DescribeBotRecommendation Text Source #

The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.

describeBotRecommendation_botRecommendationId :: Lens' DescribeBotRecommendation Text Source #

The identifier of the bot recommendation to describe.

Destructuring the Response

data DescribeBotRecommendationResponse Source #

See: newDescribeBotRecommendationResponse smart constructor.

Constructors

DescribeBotRecommendationResponse' 

Fields

Instances

Instances details
Generic DescribeBotRecommendationResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Associated Types

type Rep DescribeBotRecommendationResponse :: Type -> Type #

Methods

from :: DescribeBotRecommendationResponse -> Rep DescribeBotRecommendationResponse x #

to :: Rep DescribeBotRecommendationResponse x -> DescribeBotRecommendationResponse #

Show DescribeBotRecommendationResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

showsPrec :: Int -> DescribeBotRecommendationResponse -> ShowS #

show :: DescribeBotRecommendationResponse -> String #

showList :: [DescribeBotRecommendationResponse] -> ShowS #

NFData DescribeBotRecommendationResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

rnf :: DescribeBotRecommendationResponse -> () #

Eq DescribeBotRecommendationResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

Methods

(==) :: DescribeBotRecommendationResponse -> DescribeBotRecommendationResponse -> Bool #

(/=) :: DescribeBotRecommendationResponse -> DescribeBotRecommendationResponse -> Bool #

type Rep DescribeBotRecommendationResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.DescribeBotRecommendation

type Rep DescribeBotRecommendationResponse = D1 ('MetaData "DescribeBotRecommendationResponse" "Amazonka.LexV2Models.DescribeBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotRecommendationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "botRecommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "botRecommendationResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotRecommendationResults)))) :*: (S1 ('MetaSel ('Just "botRecommendationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotRecommendationStatus)) :*: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "encryptionSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionSetting)) :*: (S1 ('MetaSel ('Just "failureReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "transcriptSourceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptSourceSetting)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeBotRecommendationResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeBotRecommendationResponse'

-> DescribeBotRecommendationResponse 

Create a value of DescribeBotRecommendationResponse 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:

DescribeBotRecommendation, describeBotRecommendationResponse_botId - The identifier of the bot associated with the bot recommendation.

DescribeBotRecommendation, describeBotRecommendationResponse_botRecommendationId - The identifier of the bot recommendation being described.

$sel:botRecommendationResults:DescribeBotRecommendationResponse', describeBotRecommendationResponse_botRecommendationResults - The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

DescribeBotRecommendationResponse, describeBotRecommendationResponse_botRecommendationStatus - The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

DescribeBotRecommendation, describeBotRecommendationResponse_botVersion - The version of the bot associated with the bot recommendation.

DescribeBotRecommendationResponse, describeBotRecommendationResponse_creationDateTime - The date and time that the bot recommendation was created.

$sel:encryptionSetting:DescribeBotRecommendationResponse', describeBotRecommendationResponse_encryptionSetting - The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

$sel:failureReasons:DescribeBotRecommendationResponse', describeBotRecommendationResponse_failureReasons - If botRecommendationStatus is Failed, Amazon Lex explains why.

DescribeBotRecommendationResponse, describeBotRecommendationResponse_lastUpdatedDateTime - The date and time that the bot recommendation was last updated.

DescribeBotRecommendation, describeBotRecommendationResponse_localeId - The identifier of the language and locale of the bot recommendation to describe.

$sel:transcriptSourceSetting:DescribeBotRecommendationResponse', describeBotRecommendationResponse_transcriptSourceSetting - The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

$sel:httpStatus:DescribeBotRecommendationResponse', describeBotRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

describeBotRecommendationResponse_botId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot associated with the bot recommendation.

describeBotRecommendationResponse_botRecommendationId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot recommendation being described.

describeBotRecommendationResponse_botRecommendationResults :: Lens' DescribeBotRecommendationResponse (Maybe BotRecommendationResults) Source #

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

describeBotRecommendationResponse_botRecommendationStatus :: Lens' DescribeBotRecommendationResponse (Maybe BotRecommendationStatus) Source #

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

describeBotRecommendationResponse_botVersion :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The version of the bot associated with the bot recommendation.

describeBotRecommendationResponse_creationDateTime :: Lens' DescribeBotRecommendationResponse (Maybe UTCTime) Source #

The date and time that the bot recommendation was created.

describeBotRecommendationResponse_encryptionSetting :: Lens' DescribeBotRecommendationResponse (Maybe EncryptionSetting) Source #

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

describeBotRecommendationResponse_failureReasons :: Lens' DescribeBotRecommendationResponse (Maybe [Text]) Source #

If botRecommendationStatus is Failed, Amazon Lex explains why.

describeBotRecommendationResponse_lastUpdatedDateTime :: Lens' DescribeBotRecommendationResponse (Maybe UTCTime) Source #

The date and time that the bot recommendation was last updated.

describeBotRecommendationResponse_localeId :: Lens' DescribeBotRecommendationResponse (Maybe Text) Source #

The identifier of the language and locale of the bot recommendation to describe.

describeBotRecommendationResponse_transcriptSourceSetting :: Lens' DescribeBotRecommendationResponse (Maybe TranscriptSourceSetting) Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

describeBotRecommendationResponse_httpStatus :: Lens' DescribeBotRecommendationResponse Int Source #

The response's http status code.