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 |
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.
Synopsis
- data ListBotVersions = ListBotVersions' {}
- newListBotVersions :: Text -> ListBotVersions
- listBotVersions_maxResults :: Lens' ListBotVersions (Maybe Natural)
- listBotVersions_nextToken :: Lens' ListBotVersions (Maybe Text)
- listBotVersions_sortBy :: Lens' ListBotVersions (Maybe BotVersionSortBy)
- listBotVersions_botId :: Lens' ListBotVersions Text
- data ListBotVersionsResponse = ListBotVersionsResponse' {}
- newListBotVersionsResponse :: Int -> ListBotVersionsResponse
- listBotVersionsResponse_botId :: Lens' ListBotVersionsResponse (Maybe Text)
- listBotVersionsResponse_botVersionSummaries :: Lens' ListBotVersionsResponse (Maybe [BotVersionSummary])
- listBotVersionsResponse_nextToken :: Lens' ListBotVersionsResponse (Maybe Text)
- listBotVersionsResponse_httpStatus :: Lens' ListBotVersionsResponse Int
Creating a Request
data ListBotVersions Source #
See: newListBotVersions
smart constructor.
ListBotVersions' | |
|
Instances
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) Source #
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) Source #
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) Source #
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 Source #
The identifier of the bot to list versions for.
Destructuring the Response
data ListBotVersionsResponse Source #
See: newListBotVersionsResponse
smart constructor.
ListBotVersionsResponse' | |
|
Instances
newListBotVersionsResponse Source #
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) Source #
The identifier of the bot to list versions for.
listBotVersionsResponse_botVersionSummaries :: Lens' ListBotVersionsResponse (Maybe [BotVersionSummary]) Source #
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) Source #
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 Source #
The response's http status code.