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.
Searches queues in an Amazon Connect instance, with optional filtering.
This operation returns paginated results.
Synopsis
- data SearchQueues = SearchQueues' {}
- newSearchQueues :: Text -> SearchQueues
- searchQueues_maxResults :: Lens' SearchQueues (Maybe Natural)
- searchQueues_nextToken :: Lens' SearchQueues (Maybe Text)
- searchQueues_searchCriteria :: Lens' SearchQueues (Maybe QueueSearchCriteria)
- searchQueues_searchFilter :: Lens' SearchQueues (Maybe QueueSearchFilter)
- searchQueues_instanceId :: Lens' SearchQueues Text
- data SearchQueuesResponse = SearchQueuesResponse' {}
- newSearchQueuesResponse :: Int -> SearchQueuesResponse
- searchQueuesResponse_approximateTotalCount :: Lens' SearchQueuesResponse (Maybe Integer)
- searchQueuesResponse_nextToken :: Lens' SearchQueuesResponse (Maybe Text)
- searchQueuesResponse_queues :: Lens' SearchQueuesResponse (Maybe [Queue])
- searchQueuesResponse_httpStatus :: Lens' SearchQueuesResponse Int
Creating a Request
data SearchQueues Source #
See: newSearchQueues
smart constructor.
SearchQueues' | |
|
Instances
Create a value of SearchQueues
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:SearchQueues'
, searchQueues_maxResults
- The maximum number of results to return per page.
SearchQueues
, searchQueues_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.
$sel:searchCriteria:SearchQueues'
, searchQueues_searchCriteria
- The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a
minimum of 2 characters and a maximum of 25 characters. Any queries with
character lengths outside of this range will throw invalid results.
$sel:searchFilter:SearchQueues'
, searchQueues_searchFilter
- Filters to be applied to search results.
SearchQueues
, searchQueues_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
Request Lenses
searchQueues_maxResults :: Lens' SearchQueues (Maybe Natural) Source #
The maximum number of results to return per page.
searchQueues_nextToken :: Lens' SearchQueues (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.
searchQueues_searchCriteria :: Lens' SearchQueues (Maybe QueueSearchCriteria) Source #
The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a
minimum of 2 characters and a maximum of 25 characters. Any queries with
character lengths outside of this range will throw invalid results.
searchQueues_searchFilter :: Lens' SearchQueues (Maybe QueueSearchFilter) Source #
Filters to be applied to search results.
searchQueues_instanceId :: Lens' SearchQueues Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Destructuring the Response
data SearchQueuesResponse Source #
See: newSearchQueuesResponse
smart constructor.
SearchQueuesResponse' | |
|
Instances
newSearchQueuesResponse Source #
Create a value of SearchQueuesResponse
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:approximateTotalCount:SearchQueuesResponse'
, searchQueuesResponse_approximateTotalCount
- The total number of queues which matched your search query.
SearchQueues
, searchQueuesResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
SearchQueuesResponse
, searchQueuesResponse_queues
- Information about the queues.
$sel:httpStatus:SearchQueuesResponse'
, searchQueuesResponse_httpStatus
- The response's http status code.
Response Lenses
searchQueuesResponse_approximateTotalCount :: Lens' SearchQueuesResponse (Maybe Integer) Source #
The total number of queues which matched your search query.
searchQueuesResponse_nextToken :: Lens' SearchQueuesResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
searchQueuesResponse_queues :: Lens' SearchQueuesResponse (Maybe [Queue]) Source #
Information about the queues.
searchQueuesResponse_httpStatus :: Lens' SearchQueuesResponse Int Source #
The response's http status code.