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.LexModels.GetBotVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about all of the versions of a bot.

The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetBotVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetBotVersions action.

This operation returns paginated results.

Creating a Request

data GetBotVersions Source #

See: newGetBotVersions smart constructor.

Constructors

GetBotVersions'

Fields

maxResults :: Maybe Natural
The maximum number of bot versions to return in the response. The default is 10.
nextToken :: Maybe Text
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
name :: Text
The name of the bot for which versions should be returned.

Instances

Instances details

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

newGetBotVersions Source #

Arguments

:: Text	`GetBotVersions`
-> GetBotVersions

Create a value of GetBotVersions 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:maxResults:GetBotVersions', getBotVersions_maxResults - The maximum number of bot versions to return in the response. The default is 10.

GetBotVersions, getBotVersions_nextToken - A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

GetBotVersions, getBotVersions_name - The name of the bot for which versions should be returned.

Request Lenses

getBotVersions_maxResults :: Lens' GetBotVersions (Maybe Natural) Source #

The maximum number of bot versions to return in the response. The default is 10.

getBotVersions_nextToken :: Lens' GetBotVersions (Maybe Text) Source #

A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

getBotVersions_name :: Lens' GetBotVersions Text Source #

The name of the bot for which versions should be returned.

Destructuring the Response

data GetBotVersionsResponse Source #

See: newGetBotVersionsResponse smart constructor.

Constructors

GetBotVersionsResponse'

Fields

bots :: Maybe [BotMetadata]
An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.
nextToken :: Maybe Text
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions Associated Types type Rep GetBotVersionsResponse :: Type -> Type # Methods from :: GetBotVersionsResponse -> Rep GetBotVersionsResponse x # to :: Rep GetBotVersionsResponse x -> GetBotVersionsResponse #
Read GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions Methods readsPrec :: Int -> ReadS GetBotVersionsResponse # readList :: ReadS [GetBotVersionsResponse] # readPrec :: ReadPrec GetBotVersionsResponse # readListPrec :: ReadPrec [GetBotVersionsResponse] #
Show GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions Methods showsPrec :: Int -> GetBotVersionsResponse -> ShowS # show :: GetBotVersionsResponse -> String # showList :: [GetBotVersionsResponse] -> ShowS #
NFData GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions Methods rnf :: GetBotVersionsResponse -> () #
Eq GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions Methods (==) :: GetBotVersionsResponse -> GetBotVersionsResponse -> Bool # (/=) :: GetBotVersionsResponse -> GetBotVersionsResponse -> Bool #
type Rep GetBotVersionsResponse Source #
Instance details Defined in Amazonka.LexModels.GetBotVersions type Rep GetBotVersionsResponse = D1 ('MetaData "GetBotVersionsResponse" "Amazonka.LexModels.GetBotVersions" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBotVersionsResponse Source #

Arguments

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

Create a value of GetBotVersionsResponse 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:bots:GetBotVersionsResponse', getBotVersionsResponse_bots - An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.

GetBotVersions, getBotVersionsResponse_nextToken - A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

$sel:httpStatus:GetBotVersionsResponse', getBotVersionsResponse_httpStatus - The response's http status code.

Response Lenses

getBotVersionsResponse_bots :: Lens' GetBotVersionsResponse (Maybe [BotMetadata]) Source #

An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.

getBotVersionsResponse_nextToken :: Lens' GetBotVersionsResponse (Maybe Text) Source #

A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

getBotVersionsResponse_httpStatus :: Lens' GetBotVersionsResponse Int Source #

The response's http status code.