| 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.Connect.ListLexBots
Description
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
This operation returns paginated results.
Synopsis
- data ListLexBots = ListLexBots' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
- newListLexBots :: Text -> ListLexBots
- listLexBots_maxResults :: Lens' ListLexBots (Maybe Natural)
- listLexBots_nextToken :: Lens' ListLexBots (Maybe Text)
- listLexBots_instanceId :: Lens' ListLexBots Text
- data ListLexBotsResponse = ListLexBotsResponse' {}
- newListLexBotsResponse :: Int -> ListLexBotsResponse
- listLexBotsResponse_lexBots :: Lens' ListLexBotsResponse (Maybe [LexBot])
- listLexBotsResponse_nextToken :: Lens' ListLexBotsResponse (Maybe Text)
- listLexBotsResponse_httpStatus :: Lens' ListLexBotsResponse Int
Creating a Request
data ListLexBots Source #
See: newListLexBots smart constructor.
Constructors
| ListLexBots' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListLexBots |
Create a value of ListLexBots 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:ListLexBots', listLexBots_maxResults - The maximum number of results to return per page. If no value is
specified, the default is 10.
ListLexBots, listLexBots_nextToken - The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
ListLexBots, listLexBots_instanceId - The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
Request Lenses
listLexBots_maxResults :: Lens' ListLexBots (Maybe Natural) Source #
The maximum number of results to return per page. If no value is specified, the default is 10.
listLexBots_nextToken :: Lens' ListLexBots (Maybe Text) Source #
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
listLexBots_instanceId :: Lens' ListLexBots Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Destructuring the Response
data ListLexBotsResponse Source #
See: newListLexBotsResponse smart constructor.
Constructors
| ListLexBotsResponse' | |
Instances
newListLexBotsResponse Source #
Arguments
| :: Int | |
| -> ListLexBotsResponse |
Create a value of ListLexBotsResponse 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:lexBots:ListLexBotsResponse', listLexBotsResponse_lexBots - The names and Amazon Web Services Regions of the Amazon Lex bots
associated with the specified instance.
ListLexBots, listLexBotsResponse_nextToken - If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListLexBotsResponse', listLexBotsResponse_httpStatus - The response's http status code.
Response Lenses
listLexBotsResponse_lexBots :: Lens' ListLexBotsResponse (Maybe [LexBot]) Source #
The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
listLexBotsResponse_nextToken :: Lens' ListLexBotsResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
listLexBotsResponse_httpStatus :: Lens' ListLexBotsResponse Int Source #
The response's http status code.