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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides metadata about a version of a bot.

Synopsis

data DescribeBotVersion = DescribeBotVersion' {
- botId :: Text
- botVersion :: Text
}
newDescribeBotVersion :: Text -> Text -> DescribeBotVersion
describeBotVersion_botId :: Lens' DescribeBotVersion Text
describeBotVersion_botVersion :: Lens' DescribeBotVersion Text
data DescribeBotVersionResponse = DescribeBotVersionResponse' {
- botId :: Maybe Text
- botName :: Maybe Text
- botStatus :: Maybe BotStatus
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- dataPrivacy :: Maybe DataPrivacy
- description :: Maybe Text
- failureReasons :: Maybe [Text]
- idleSessionTTLInSeconds :: Maybe Natural
- roleArn :: Maybe Text
- httpStatus :: Int
}
newDescribeBotVersionResponse :: Int -> DescribeBotVersionResponse
describeBotVersionResponse_botId :: Lens' DescribeBotVersionResponse (Maybe Text)
describeBotVersionResponse_botName :: Lens' DescribeBotVersionResponse (Maybe Text)
describeBotVersionResponse_botStatus :: Lens' DescribeBotVersionResponse (Maybe BotStatus)
describeBotVersionResponse_botVersion :: Lens' DescribeBotVersionResponse (Maybe Text)
describeBotVersionResponse_creationDateTime :: Lens' DescribeBotVersionResponse (Maybe UTCTime)
describeBotVersionResponse_dataPrivacy :: Lens' DescribeBotVersionResponse (Maybe DataPrivacy)
describeBotVersionResponse_description :: Lens' DescribeBotVersionResponse (Maybe Text)
describeBotVersionResponse_failureReasons :: Lens' DescribeBotVersionResponse (Maybe [Text])
describeBotVersionResponse_idleSessionTTLInSeconds :: Lens' DescribeBotVersionResponse (Maybe Natural)
describeBotVersionResponse_roleArn :: Lens' DescribeBotVersionResponse (Maybe Text)
describeBotVersionResponse_httpStatus :: Lens' DescribeBotVersionResponse Int

Creating a Request

data DescribeBotVersion Source #

See: newDescribeBotVersion smart constructor.

Constructors

DescribeBotVersion'
Fields botId :: Text The identifier of the bot containing the version to return metadata for. botVersion :: Text The version of the bot to return metadata for.

Instances

Instances details

ToHeaders DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods toHeaders :: DescribeBotVersion -> [Header] #
ToPath DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods toPath :: DescribeBotVersion -> ByteString #
ToQuery DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods toQuery :: DescribeBotVersion -> QueryString #
AWSRequest DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Associated Types type AWSResponse DescribeBotVersion # Methods request :: (Service -> Service) -> DescribeBotVersion -> Request DescribeBotVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBotVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBotVersion))) #
Generic DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Associated Types type Rep DescribeBotVersion :: Type -> Type # Methods from :: DescribeBotVersion -> Rep DescribeBotVersion x # to :: Rep DescribeBotVersion x -> DescribeBotVersion #
Read DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods readsPrec :: Int -> ReadS DescribeBotVersion # readList :: ReadS [DescribeBotVersion] # readPrec :: ReadPrec DescribeBotVersion # readListPrec :: ReadPrec [DescribeBotVersion] #
Show DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods showsPrec :: Int -> DescribeBotVersion -> ShowS # show :: DescribeBotVersion -> String # showList :: [DescribeBotVersion] -> ShowS #
NFData DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods rnf :: DescribeBotVersion -> () #
Eq DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods (==) :: DescribeBotVersion -> DescribeBotVersion -> Bool # (/=) :: DescribeBotVersion -> DescribeBotVersion -> Bool #
Hashable DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods hashWithSalt :: Int -> DescribeBotVersion -> Int # hash :: DescribeBotVersion -> Int #
type AWSResponse DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion type AWSResponse DescribeBotVersion = DescribeBotVersionResponse
type Rep DescribeBotVersion Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion type Rep DescribeBotVersion = D1 ('MetaData "DescribeBotVersion" "Amazonka.LexV2Models.DescribeBotVersion" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeBotVersion Source #

Arguments

:: Text	`DescribeBotVersion`
-> Text	`DescribeBotVersion`
-> DescribeBotVersion

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

DescribeBotVersion, describeBotVersion_botId - The identifier of the bot containing the version to return metadata for.

DescribeBotVersion, describeBotVersion_botVersion - The version of the bot to return metadata for.

Request Lenses

describeBotVersion_botId :: Lens' DescribeBotVersion Text Source #

The identifier of the bot containing the version to return metadata for.

describeBotVersion_botVersion :: Lens' DescribeBotVersion Text Source #

The version of the bot to return metadata for.

Destructuring the Response

data DescribeBotVersionResponse Source #

See: newDescribeBotVersionResponse smart constructor.

Constructors

DescribeBotVersionResponse'

Fields

botId :: Maybe Text
The identifier of the bot that contains the version.
botName :: Maybe Text
The name of the bot that contains the version.
botStatus :: Maybe BotStatus
The current status of the bot. When the status is Available, the bot version is ready for use.
botVersion :: Maybe Text
The version of the bot to describe.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the bot version was created.
dataPrivacy :: Maybe DataPrivacy
Data privacy settings for the bot version.
description :: Maybe Text
The description specified for the bot.
failureReasons :: Maybe [Text]
If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.
idleSessionTTLInSeconds :: Maybe Natural
The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Associated Types type Rep DescribeBotVersionResponse :: Type -> Type # Methods from :: DescribeBotVersionResponse -> Rep DescribeBotVersionResponse x # to :: Rep DescribeBotVersionResponse x -> DescribeBotVersionResponse #
Read DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods readsPrec :: Int -> ReadS DescribeBotVersionResponse # readList :: ReadS [DescribeBotVersionResponse] # readPrec :: ReadPrec DescribeBotVersionResponse # readListPrec :: ReadPrec [DescribeBotVersionResponse] #
Show DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods showsPrec :: Int -> DescribeBotVersionResponse -> ShowS # show :: DescribeBotVersionResponse -> String # showList :: [DescribeBotVersionResponse] -> ShowS #
NFData DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods rnf :: DescribeBotVersionResponse -> () #
Eq DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion Methods (==) :: DescribeBotVersionResponse -> DescribeBotVersionResponse -> Bool # (/=) :: DescribeBotVersionResponse -> DescribeBotVersionResponse -> Bool #
type Rep DescribeBotVersionResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotVersion type Rep DescribeBotVersionResponse = D1 ('MetaData "DescribeBotVersionResponse" "Amazonka.LexV2Models.DescribeBotVersion" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotVersionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "botStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotStatus)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "dataPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataPrivacy)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "failureReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "idleSessionTTLInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeBotVersionResponse Source #

Arguments

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

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

DescribeBotVersion, describeBotVersionResponse_botId - The identifier of the bot that contains the version.

DescribeBotVersionResponse, describeBotVersionResponse_botName - The name of the bot that contains the version.

DescribeBotVersionResponse, describeBotVersionResponse_botStatus - The current status of the bot. When the status is Available, the bot version is ready for use.

DescribeBotVersion, describeBotVersionResponse_botVersion - The version of the bot to describe.

DescribeBotVersionResponse, describeBotVersionResponse_creationDateTime - A timestamp of the date and time that the bot version was created.

DescribeBotVersionResponse, describeBotVersionResponse_dataPrivacy - Data privacy settings for the bot version.

DescribeBotVersionResponse, describeBotVersionResponse_description - The description specified for the bot.

$sel:failureReasons:DescribeBotVersionResponse', describeBotVersionResponse_failureReasons - If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

DescribeBotVersionResponse, describeBotVersionResponse_idleSessionTTLInSeconds - The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

DescribeBotVersionResponse, describeBotVersionResponse_roleArn - The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

$sel:httpStatus:DescribeBotVersionResponse', describeBotVersionResponse_httpStatus - The response's http status code.

Response Lenses

describeBotVersionResponse_botId :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The identifier of the bot that contains the version.

describeBotVersionResponse_botName :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The name of the bot that contains the version.

describeBotVersionResponse_botStatus :: Lens' DescribeBotVersionResponse (Maybe BotStatus) Source #

The current status of the bot. When the status is Available, the bot version is ready for use.

describeBotVersionResponse_botVersion :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The version of the bot to describe.

describeBotVersionResponse_creationDateTime :: Lens' DescribeBotVersionResponse (Maybe UTCTime) Source #

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

describeBotVersionResponse_dataPrivacy :: Lens' DescribeBotVersionResponse (Maybe DataPrivacy) Source #

Data privacy settings for the bot version.

describeBotVersionResponse_description :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The description specified for the bot.

describeBotVersionResponse_failureReasons :: Lens' DescribeBotVersionResponse (Maybe [Text]) Source #

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

describeBotVersionResponse_idleSessionTTLInSeconds :: Lens' DescribeBotVersionResponse (Maybe Natural) Source #

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

describeBotVersionResponse_roleArn :: Lens' DescribeBotVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

describeBotVersionResponse_httpStatus :: Lens' DescribeBotVersionResponse Int Source #

The response's http status code.