libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LexModels.GetBotVersions

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.

Synopsis

Creating a Request

data GetBotVersions Source #

See: newGetBotVersions smart constructor.

Constructors

GetBotVersions' 

Fields

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

  • maxResults :: Maybe Natural

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

  • name :: Text

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

Instances

Instances details
Eq GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Read GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Show GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Generic GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Associated Types

type Rep GetBotVersions :: Type -> Type #

NFData GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Methods

rnf :: GetBotVersions -> () #

Hashable GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

AWSPager GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

AWSRequest GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Associated Types

type AWSResponse GetBotVersions #

ToHeaders GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

ToPath GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

ToQuery GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

type Rep GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

type Rep GetBotVersions = D1 ('MetaData "GetBotVersions" "Amazonka.LexModels.GetBotVersions" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetBotVersions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetBotVersions Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

newGetBotVersions Source #

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:nextToken: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.

$sel:maxResults:GetBotVersions', getBotVersions_maxResults - The maximum number of bot versions to return in the response. The default is 10.

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

Request Lenses

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_maxResults :: Lens' GetBotVersions (Maybe Natural) Source #

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

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
Eq GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Read GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Show GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Generic GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Associated Types

type Rep GetBotVersionsResponse :: Type -> Type #

NFData GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

Methods

rnf :: GetBotVersionsResponse -> () #

type Rep GetBotVersionsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBotVersions

type Rep GetBotVersionsResponse = D1 ('MetaData "GetBotVersionsResponse" "Amazonka.LexModels.GetBotVersions" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" '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 #

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.

$sel:nextToken: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.