Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LexV2Models.StartBotRecommendation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this to provide your transcript data, and to start the bot recommendation process.

Synopsis

Creating a Request

data StartBotRecommendation Source #

See: newStartBotRecommendation smart constructor.

Constructors

StartBotRecommendation'

Fields

encryptionSetting :: Maybe EncryptionSetting
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
botId :: Text
The unique identifier of the bot containing the bot recommendation.
botVersion :: Text
The version of the bot containing the bot recommendation.
localeId :: Text
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
transcriptSourceSetting :: TranscriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Instances

Instances details

ToJSON StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods toJSON :: StartBotRecommendation -> Value # toEncoding :: StartBotRecommendation -> Encoding # toJSONList :: [StartBotRecommendation] -> Value # toEncodingList :: [StartBotRecommendation] -> Encoding #
ToHeaders StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods toHeaders :: StartBotRecommendation -> [Header] #
ToPath StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods toPath :: StartBotRecommendation -> ByteString #
ToQuery StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods toQuery :: StartBotRecommendation -> QueryString #
AWSRequest StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Associated Types type AWSResponse StartBotRecommendation # Methods request :: (Service -> Service) -> StartBotRecommendation -> Request StartBotRecommendation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartBotRecommendation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartBotRecommendation))) #
Generic StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Associated Types type Rep StartBotRecommendation :: Type -> Type # Methods from :: StartBotRecommendation -> Rep StartBotRecommendation x # to :: Rep StartBotRecommendation x -> StartBotRecommendation #
Show StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods showsPrec :: Int -> StartBotRecommendation -> ShowS # show :: StartBotRecommendation -> String # showList :: [StartBotRecommendation] -> ShowS #
NFData StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods rnf :: StartBotRecommendation -> () #
Eq StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods (==) :: StartBotRecommendation -> StartBotRecommendation -> Bool # (/=) :: StartBotRecommendation -> StartBotRecommendation -> Bool #
Hashable StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods hashWithSalt :: Int -> StartBotRecommendation -> Int # hash :: StartBotRecommendation -> Int #
type AWSResponse StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation type AWSResponse StartBotRecommendation = StartBotRecommendationResponse
type Rep StartBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation type Rep StartBotRecommendation = D1 ('MetaData "StartBotRecommendation" "Amazonka.LexV2Models.StartBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StartBotRecommendation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionSetting)) :: 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 "transcriptSourceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TranscriptSourceSetting)))))

newStartBotRecommendation Source #

Arguments

:: Text	`StartBotRecommendation`
-> Text	`StartBotRecommendation`
-> Text	`StartBotRecommendation`
-> TranscriptSourceSetting	`StartBotRecommendation`
-> StartBotRecommendation

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

StartBotRecommendation, startBotRecommendation_encryptionSetting - The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

StartBotRecommendation, startBotRecommendation_botId - The unique identifier of the bot containing the bot recommendation.

StartBotRecommendation, startBotRecommendation_botVersion - The version of the bot containing the bot recommendation.

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

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

Request Lenses

startBotRecommendation_encryptionSetting :: Lens' StartBotRecommendation (Maybe EncryptionSetting) Source #

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

startBotRecommendation_botId :: Lens' StartBotRecommendation Text Source #

The unique identifier of the bot containing the bot recommendation.

startBotRecommendation_botVersion :: Lens' StartBotRecommendation Text Source #

The version of the bot containing the bot recommendation.

startBotRecommendation_localeId :: Lens' StartBotRecommendation Text Source #

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

startBotRecommendation_transcriptSourceSetting :: Lens' StartBotRecommendation TranscriptSourceSetting Source #

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

Destructuring the Response

data StartBotRecommendationResponse Source #

See: newStartBotRecommendationResponse smart constructor.

Constructors

StartBotRecommendationResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot containing the bot recommendation.
botRecommendationId :: Maybe Text
The identifier of the bot recommendation that you have created.
botRecommendationStatus :: Maybe BotRecommendationStatus
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
botVersion :: Maybe Text
The version of the bot containing the bot recommendation.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the bot recommendation was created.
encryptionSetting :: Maybe 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.
localeId :: Maybe Text
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
transcriptSourceSetting :: Maybe TranscriptSourceSetting
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Associated Types type Rep StartBotRecommendationResponse :: Type -> Type # Methods from :: StartBotRecommendationResponse -> Rep StartBotRecommendationResponse x # to :: Rep StartBotRecommendationResponse x -> StartBotRecommendationResponse #
Show StartBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods showsPrec :: Int -> StartBotRecommendationResponse -> ShowS # show :: StartBotRecommendationResponse -> String # showList :: [StartBotRecommendationResponse] -> ShowS #
NFData StartBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods rnf :: StartBotRecommendationResponse -> () #
Eq StartBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation Methods (==) :: StartBotRecommendationResponse -> StartBotRecommendationResponse -> Bool # (/=) :: StartBotRecommendationResponse -> StartBotRecommendationResponse -> Bool #
type Rep StartBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartBotRecommendation type Rep StartBotRecommendationResponse = D1 ('MetaData "StartBotRecommendationResponse" "Amazonka.LexV2Models.StartBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StartBotRecommendationResponse'" '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 "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 "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))))))

newStartBotRecommendationResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartBotRecommendationResponse'`
-> StartBotRecommendationResponse

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

StartBotRecommendation, startBotRecommendationResponse_botId - The unique identifier of the bot containing the bot recommendation.

StartBotRecommendationResponse, startBotRecommendationResponse_botRecommendationId - The identifier of the bot recommendation that you have created.

StartBotRecommendationResponse, startBotRecommendationResponse_botRecommendationStatus - The status of the bot recommendation.

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

StartBotRecommendation, startBotRecommendationResponse_botVersion - The version of the bot containing the bot recommendation.

StartBotRecommendationResponse, startBotRecommendationResponse_creationDateTime - A timestamp of the date and time that the bot recommendation was created.

StartBotRecommendation, startBotRecommendationResponse_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.

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

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

$sel:httpStatus:StartBotRecommendationResponse', startBotRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

startBotRecommendationResponse_botId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot containing the bot recommendation.

startBotRecommendationResponse_botRecommendationId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The identifier of the bot recommendation that you have created.

startBotRecommendationResponse_botRecommendationStatus :: Lens' StartBotRecommendationResponse (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.

startBotRecommendationResponse_botVersion :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

The version of the bot containing the bot recommendation.

startBotRecommendationResponse_creationDateTime :: Lens' StartBotRecommendationResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the bot recommendation was created.

startBotRecommendationResponse_encryptionSetting :: Lens' StartBotRecommendationResponse (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.

startBotRecommendationResponse_localeId :: Lens' StartBotRecommendationResponse (Maybe Text) Source #

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

startBotRecommendationResponse_transcriptSourceSetting :: Lens' StartBotRecommendationResponse (Maybe TranscriptSourceSetting) Source #

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

startBotRecommendationResponse_httpStatus :: Lens' StartBotRecommendationResponse Int Source #

The response's http status code.