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 |
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
This operation returns paginated results.
Synopsis
- data ListBots = ListBots' {}
- newListBots :: Text -> LexVersion -> ListBots
- listBots_maxResults :: Lens' ListBots (Maybe Natural)
- listBots_nextToken :: Lens' ListBots (Maybe Text)
- listBots_instanceId :: Lens' ListBots Text
- listBots_lexVersion :: Lens' ListBots LexVersion
- data ListBotsResponse = ListBotsResponse' {
- lexBots :: Maybe [LexBotConfig]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListBotsResponse :: Int -> ListBotsResponse
- listBotsResponse_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig])
- listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text)
- listBotsResponse_httpStatus :: Lens' ListBotsResponse Int
Creating a Request
See: newListBots
smart constructor.
ListBots' | |
|
Instances
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:maxResults:ListBots'
, listBots_maxResults
- The maximum number of results to return per page.
ListBots
, listBots_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.
ListBots
, listBots_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
$sel:lexVersion:ListBots'
, listBots_lexVersion
- The version of Amazon Lex or Amazon Lex V2.
Request Lenses
listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #
The maximum number of results to return per page.
listBots_nextToken :: Lens' ListBots (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.
listBots_instanceId :: Lens' ListBots Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
listBots_lexVersion :: Lens' ListBots LexVersion Source #
The version of Amazon Lex or Amazon Lex V2.
Destructuring the Response
data ListBotsResponse Source #
See: newListBotsResponse
smart constructor.
ListBotsResponse' | |
|
Instances
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:lexBots:ListBotsResponse'
, listBotsResponse_lexBots
- The names and Amazon Web Services Regions of the Amazon Lex or Amazon
Lex V2 bots associated with the specified instance.
ListBots
, listBotsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListBotsResponse'
, listBotsResponse_httpStatus
- The response's http status code.
Response Lenses
listBotsResponse_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig]) Source #
The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #
The response's http status code.