| 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.ListBots
Description
Gets a list of available bots.
Synopsis
- data ListBots = ListBots' {}
- newListBots :: ListBots
- listBots_filters :: Lens' ListBots (Maybe (NonEmpty BotFilter))
- listBots_maxResults :: Lens' ListBots (Maybe Natural)
- listBots_nextToken :: Lens' ListBots (Maybe Text)
- listBots_sortBy :: Lens' ListBots (Maybe BotSortBy)
- data ListBotsResponse = ListBotsResponse' {
- botSummaries :: Maybe [BotSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListBotsResponse :: Int -> ListBotsResponse
- listBotsResponse_botSummaries :: Lens' ListBotsResponse (Maybe [BotSummary])
- listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text)
- listBotsResponse_httpStatus :: Lens' ListBotsResponse Int
Creating a Request
See: newListBots smart constructor.
Constructors
| ListBots' | |
Fields
| |
Instances
newListBots :: ListBots Source #
Create a value of ListBots 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:filters:ListBots', listBots_filters - Provides the specification of a filter used to limit the bots in the
response to only those that match the filter specification. You can only
specify one filter and one string to filter on.
$sel:maxResults:ListBots', listBots_maxResults - The maximum number of bots to return in each page of results. If there
are fewer results than the maximum page size, only the actual number of
results are returned.
ListBots, listBots_nextToken - If the response from the ListBots operation contains more results than
specified in the maxResults parameter, a token is returned in the
response.
Use the returned token in the nextToken parameter of a ListBots
request to return the next page of results. For a complete set of
results, call the ListBots operation until the nextToken returned in
the response is null.
$sel:sortBy:ListBots', listBots_sortBy - Specifies sorting parameters for the list of bots. You can specify that
the list be sorted by bot name in ascending or descending order.
Request Lenses
listBots_filters :: Lens' ListBots (Maybe (NonEmpty BotFilter)) Source #
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #
The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
listBots_nextToken :: Lens' ListBots (Maybe Text) Source #
If the response from the ListBots operation contains more results than
specified in the maxResults parameter, a token is returned in the
response.
Use the returned token in the nextToken parameter of a ListBots
request to return the next page of results. For a complete set of
results, call the ListBots operation until the nextToken returned in
the response is null.
listBots_sortBy :: Lens' ListBots (Maybe BotSortBy) Source #
Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
Destructuring the Response
data ListBotsResponse Source #
See: newListBotsResponse smart constructor.
Constructors
| ListBotsResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListBotsResponse |
Create a value of ListBotsResponse 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:botSummaries:ListBotsResponse', listBotsResponse_botSummaries - Summary information for the bots 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 bots available, the
nextToken field contains a token to the next page of results.
ListBots, listBotsResponse_nextToken - A token that indicates whether there are more results to return in a
response to the ListBots operation. If the nextToken field is
present, you send the contents as the nextToken parameter of a
ListBots operation request to get the next page of results.
$sel:httpStatus:ListBotsResponse', listBotsResponse_httpStatus - The response's http status code.
Response Lenses
listBotsResponse_botSummaries :: Lens' ListBotsResponse (Maybe [BotSummary]) Source #
Summary information for the bots 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 bots available, the
nextToken field contains a token to the next page of results.
listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #
A token that indicates whether there are more results to return in a
response to the ListBots operation. If the nextToken field is
present, you send the contents as the nextToken parameter of a
ListBots operation request to get the next page of results.
listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #
The response's http status code.