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.StopBotRecommendation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stop an already running Bot Recommendation request.

Synopsis

data StopBotRecommendation = StopBotRecommendation' {
- botId :: Text
- botVersion :: Text
- localeId :: Text
- botRecommendationId :: Text
}
newStopBotRecommendation :: Text -> Text -> Text -> Text -> StopBotRecommendation
stopBotRecommendation_botId :: Lens' StopBotRecommendation Text
stopBotRecommendation_botVersion :: Lens' StopBotRecommendation Text
stopBotRecommendation_localeId :: Lens' StopBotRecommendation Text
stopBotRecommendation_botRecommendationId :: Lens' StopBotRecommendation Text
data StopBotRecommendationResponse = StopBotRecommendationResponse' {
- botId :: Maybe Text
- botRecommendationId :: Maybe Text
- botRecommendationStatus :: Maybe BotRecommendationStatus
- botVersion :: Maybe Text
- localeId :: Maybe Text
- httpStatus :: Int
}
newStopBotRecommendationResponse :: Int -> StopBotRecommendationResponse
stopBotRecommendationResponse_botId :: Lens' StopBotRecommendationResponse (Maybe Text)
stopBotRecommendationResponse_botRecommendationId :: Lens' StopBotRecommendationResponse (Maybe Text)
stopBotRecommendationResponse_botRecommendationStatus :: Lens' StopBotRecommendationResponse (Maybe BotRecommendationStatus)
stopBotRecommendationResponse_botVersion :: Lens' StopBotRecommendationResponse (Maybe Text)
stopBotRecommendationResponse_localeId :: Lens' StopBotRecommendationResponse (Maybe Text)
stopBotRecommendationResponse_httpStatus :: Lens' StopBotRecommendationResponse Int

Creating a Request

data StopBotRecommendation Source #

See: newStopBotRecommendation smart constructor.

Constructors

StopBotRecommendation'

Fields

botId :: Text
The unique identifier of the bot containing the bot recommendation to be stopped.
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 stop. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationId :: Text
The unique identifier of the bot recommendation to be stopped.

Instances

Instances details

ToJSON StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods toJSON :: StopBotRecommendation -> Value # toEncoding :: StopBotRecommendation -> Encoding # toJSONList :: [StopBotRecommendation] -> Value # toEncodingList :: [StopBotRecommendation] -> Encoding #
ToHeaders StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods toHeaders :: StopBotRecommendation -> [Header] #
ToPath StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods toPath :: StopBotRecommendation -> ByteString #
ToQuery StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods toQuery :: StopBotRecommendation -> QueryString #
AWSRequest StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Associated Types type AWSResponse StopBotRecommendation # Methods request :: (Service -> Service) -> StopBotRecommendation -> Request StopBotRecommendation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopBotRecommendation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopBotRecommendation))) #
Generic StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Associated Types type Rep StopBotRecommendation :: Type -> Type # Methods from :: StopBotRecommendation -> Rep StopBotRecommendation x # to :: Rep StopBotRecommendation x -> StopBotRecommendation #
Read StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods readsPrec :: Int -> ReadS StopBotRecommendation # readList :: ReadS [StopBotRecommendation] # readPrec :: ReadPrec StopBotRecommendation # readListPrec :: ReadPrec [StopBotRecommendation] #
Show StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods showsPrec :: Int -> StopBotRecommendation -> ShowS # show :: StopBotRecommendation -> String # showList :: [StopBotRecommendation] -> ShowS #
NFData StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods rnf :: StopBotRecommendation -> () #
Eq StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods (==) :: StopBotRecommendation -> StopBotRecommendation -> Bool # (/=) :: StopBotRecommendation -> StopBotRecommendation -> Bool #
Hashable StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods hashWithSalt :: Int -> StopBotRecommendation -> Int # hash :: StopBotRecommendation -> Int #
type AWSResponse StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation type AWSResponse StopBotRecommendation = StopBotRecommendationResponse
type Rep StopBotRecommendation Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation type Rep StopBotRecommendation = D1 ('MetaData "StopBotRecommendation" "Amazonka.LexV2Models.StopBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StopBotRecommendation'" '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))))

newStopBotRecommendation Source #

Arguments

:: Text	`StopBotRecommendation`
-> Text	`StopBotRecommendation`
-> Text	`StopBotRecommendation`
-> Text	`StopBotRecommendation`
-> StopBotRecommendation

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

StopBotRecommendation, stopBotRecommendation_botId - The unique identifier of the bot containing the bot recommendation to be stopped.

StopBotRecommendation, stopBotRecommendation_botVersion - The version of the bot containing the bot recommendation.

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

StopBotRecommendation, stopBotRecommendation_botRecommendationId - The unique identifier of the bot recommendation to be stopped.

Request Lenses

stopBotRecommendation_botId :: Lens' StopBotRecommendation Text Source #

The unique identifier of the bot containing the bot recommendation to be stopped.

stopBotRecommendation_botVersion :: Lens' StopBotRecommendation Text Source #

The version of the bot containing the bot recommendation.

stopBotRecommendation_localeId :: Lens' StopBotRecommendation Text Source #

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

stopBotRecommendation_botRecommendationId :: Lens' StopBotRecommendation Text Source #

The unique identifier of the bot recommendation to be stopped.

Destructuring the Response

data StopBotRecommendationResponse Source #

See: newStopBotRecommendationResponse smart constructor.

Constructors

StopBotRecommendationResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot containing the bot recommendation that is being stopped.
botRecommendationId :: Maybe Text
The unique identifier of the bot recommendation that is being stopped.
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 recommendation that is being stopped.
localeId :: Maybe Text
The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Associated Types type Rep StopBotRecommendationResponse :: Type -> Type # Methods from :: StopBotRecommendationResponse -> Rep StopBotRecommendationResponse x # to :: Rep StopBotRecommendationResponse x -> StopBotRecommendationResponse #
Read StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods readsPrec :: Int -> ReadS StopBotRecommendationResponse # readList :: ReadS [StopBotRecommendationResponse] # readPrec :: ReadPrec StopBotRecommendationResponse # readListPrec :: ReadPrec [StopBotRecommendationResponse] #
Show StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods showsPrec :: Int -> StopBotRecommendationResponse -> ShowS # show :: StopBotRecommendationResponse -> String # showList :: [StopBotRecommendationResponse] -> ShowS #
NFData StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods rnf :: StopBotRecommendationResponse -> () #
Eq StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation Methods (==) :: StopBotRecommendationResponse -> StopBotRecommendationResponse -> Bool # (/=) :: StopBotRecommendationResponse -> StopBotRecommendationResponse -> Bool #
type Rep StopBotRecommendationResponse Source #
Instance details Defined in Amazonka.LexV2Models.StopBotRecommendation type Rep StopBotRecommendationResponse = D1 ('MetaData "StopBotRecommendationResponse" "Amazonka.LexV2Models.StopBotRecommendation" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StopBotRecommendationResponse'" '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 "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStopBotRecommendationResponse Source #

Arguments

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

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

StopBotRecommendation, stopBotRecommendationResponse_botId - The unique identifier of the bot containing the bot recommendation that is being stopped.

StopBotRecommendation, stopBotRecommendationResponse_botRecommendationId - The unique identifier of the bot recommendation that is being stopped.

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

StopBotRecommendation, stopBotRecommendationResponse_botVersion - The version of the bot containing the recommendation that is being stopped.

StopBotRecommendation, stopBotRecommendationResponse_localeId - The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages

$sel:httpStatus:StopBotRecommendationResponse', stopBotRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

stopBotRecommendationResponse_botId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot containing the bot recommendation that is being stopped.

stopBotRecommendationResponse_botRecommendationId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The unique identifier of the bot recommendation that is being stopped.

stopBotRecommendationResponse_botRecommendationStatus :: Lens' StopBotRecommendationResponse (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.

stopBotRecommendationResponse_botVersion :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

The version of the bot containing the recommendation that is being stopped.

stopBotRecommendationResponse_localeId :: Lens' StopBotRecommendationResponse (Maybe Text) Source #

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

stopBotRecommendationResponse_httpStatus :: Lens' StopBotRecommendationResponse Int Source #

The response's http status code.