Amazonka.LexV2Models.ListBotVersions

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

Creating a Request

data ListBotVersions

See: newListBotVersions smart constructor.

Constructors

ListBotVersions'

Fields

• maxResults :: Maybe Natural

  The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

• nextToken :: Maybe Text

  If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

• sortBy :: Maybe BotVersionSortBy

  Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.

• botId :: Text

  The identifier of the bot to list versions for.

Instances

ToJSON ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

toJSON :: ListBotVersions -> Value

toEncoding :: ListBotVersions -> Encoding

toJSONList :: [ListBotVersions] -> Value

toEncodingList :: [ListBotVersions] -> Encoding

ToHeaders ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

toHeaders :: ListBotVersions -> [Header]

ToPath ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

toPath :: ListBotVersions -> ByteString

ToQuery ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

toQuery :: ListBotVersions -> QueryString

AWSRequest ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Associated Types

type AWSResponse ListBotVersions

Methods

request :: (Service -> Service) -> ListBotVersions -> Request ListBotVersions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBotVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBotVersions)))

Generic ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Associated Types

type Rep ListBotVersions :: Type -> Type

Methods

from :: ListBotVersions -> Rep ListBotVersions x

to :: Rep ListBotVersions x -> ListBotVersions

Read ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

readsPrec :: Int -> ReadS ListBotVersions

readList :: ReadS [ListBotVersions]

readPrec :: ReadPrec ListBotVersions

readListPrec :: ReadPrec [ListBotVersions]

Show ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

showsPrec :: Int -> ListBotVersions -> ShowS

show :: ListBotVersions -> String

showList :: [ListBotVersions] -> ShowS

NFData ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

rnf :: ListBotVersions -> ()

Eq ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

(==) :: ListBotVersions -> ListBotVersions -> Bool

(/=) :: ListBotVersions -> ListBotVersions -> Bool

Hashable ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

hashWithSalt :: Int -> ListBotVersions -> Int

hash :: ListBotVersions -> Int

type AWSResponse ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

type AWSResponse ListBotVersions = ListBotVersionsResponse

type Rep ListBotVersions

Defined in Amazonka.LexV2Models.ListBotVersions

type Rep ListBotVersions = D1 ('MetaData "ListBotVersions" "Amazonka.LexV2Models.ListBotVersions" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBotVersions'" '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 "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotVersionSortBy)) :*: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListBotVersions

Arguments

:: Text

ListBotVersions

-> ListBotVersions

Create a value of ListBotVersions 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:ListBotVersions', listBotVersions_maxResults - The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

ListBotVersions, listBotVersions_nextToken - If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

$sel:sortBy:ListBotVersions', listBotVersions_sortBy - Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.

ListBotVersions, listBotVersions_botId - The identifier of the bot to list versions for.

Request Lenses

listBotVersions_maxResults :: Lens' ListBotVersions (Maybe Natural)

The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

listBotVersions_nextToken :: Lens' ListBotVersions (Maybe Text)

If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

listBotVersions_sortBy :: Lens' ListBotVersions (Maybe BotVersionSortBy)

Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.

listBotVersions_botId :: Lens' ListBotVersions Text

The identifier of the bot to list versions for.

Destructuring the Response

data ListBotVersionsResponse

See: newListBotVersionsResponse smart constructor.

Constructors

ListBotVersionsResponse'

Fields

• botId :: Maybe Text

  The identifier of the bot to list versions for.

• botVersionSummaries :: Maybe [BotVersionSummary]

  Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more versions available, the nextToken field contains a token to get the next page of results.

• nextToken :: Maybe Text

  A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

Associated Types

type Rep ListBotVersionsResponse :: Type -> Type

Methods

from :: ListBotVersionsResponse -> Rep ListBotVersionsResponse x

to :: Rep ListBotVersionsResponse x -> ListBotVersionsResponse

Read ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

readsPrec :: Int -> ReadS ListBotVersionsResponse

readList :: ReadS [ListBotVersionsResponse]

readPrec :: ReadPrec ListBotVersionsResponse

readListPrec :: ReadPrec [ListBotVersionsResponse]

Show ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

showsPrec :: Int -> ListBotVersionsResponse -> ShowS

show :: ListBotVersionsResponse -> String

showList :: [ListBotVersionsResponse] -> ShowS

NFData ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

rnf :: ListBotVersionsResponse -> ()

Eq ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

Methods

(==) :: ListBotVersionsResponse -> ListBotVersionsResponse -> Bool

(/=) :: ListBotVersionsResponse -> ListBotVersionsResponse -> Bool

type Rep ListBotVersionsResponse

Defined in Amazonka.LexV2Models.ListBotVersions

type Rep ListBotVersionsResponse = D1 ('MetaData "ListBotVersionsResponse" "Amazonka.LexV2Models.ListBotVersions" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBotVersionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "botVersionSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotVersionSummary]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBotVersionsResponse

Arguments

:: Int

$sel:httpStatus:ListBotVersionsResponse'

-> ListBotVersionsResponse

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

ListBotVersions, listBotVersionsResponse_botId - The identifier of the bot to list versions for.

$sel:botVersionSummaries:ListBotVersionsResponse', listBotVersionsResponse_botVersionSummaries - Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more versions available, the nextToken field contains a token to get the next page of results.

ListBotVersions, listBotVersionsResponse_nextToken - A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

$sel:httpStatus:ListBotVersionsResponse', listBotVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listBotVersionsResponse_botId :: Lens' ListBotVersionsResponse (Maybe Text)

The identifier of the bot to list versions for.

listBotVersionsResponse_botVersionSummaries :: Lens' ListBotVersionsResponse (Maybe [BotVersionSummary])

Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more versions available, the nextToken field contains a token to get the next page of results.

listBotVersionsResponse_nextToken :: Lens' ListBotVersionsResponse (Maybe Text)

A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

listBotVersionsResponse_httpStatus :: Lens' ListBotVersionsResponse Int

The response's http status code.