Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
This operation returns paginated results.
Synopsis
- data ListAgentStatuses = ListAgentStatuses' {}
- newListAgentStatuses :: Text -> ListAgentStatuses
- listAgentStatuses_agentStatusTypes :: Lens' ListAgentStatuses (Maybe [AgentStatusType])
- listAgentStatuses_nextToken :: Lens' ListAgentStatuses (Maybe Text)
- listAgentStatuses_maxResults :: Lens' ListAgentStatuses (Maybe Natural)
- listAgentStatuses_instanceId :: Lens' ListAgentStatuses Text
- data ListAgentStatusesResponse = ListAgentStatusesResponse' {}
- newListAgentStatusesResponse :: Int -> ListAgentStatusesResponse
- listAgentStatusesResponse_nextToken :: Lens' ListAgentStatusesResponse (Maybe Text)
- listAgentStatusesResponse_agentStatusSummaryList :: Lens' ListAgentStatusesResponse (Maybe [AgentStatusSummary])
- listAgentStatusesResponse_httpStatus :: Lens' ListAgentStatusesResponse Int
Creating a Request
data ListAgentStatuses Source #
See: newListAgentStatuses
smart constructor.
ListAgentStatuses' | |
|
Instances
Create a value of ListAgentStatuses
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:agentStatusTypes:ListAgentStatuses'
, listAgentStatuses_agentStatusTypes
- Available agent status types.
$sel:nextToken:ListAgentStatuses'
, listAgentStatuses_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:maxResults:ListAgentStatuses'
, listAgentStatuses_maxResults
- The maximum number of results to return per page.
$sel:instanceId:ListAgentStatuses'
, listAgentStatuses_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
Request Lenses
listAgentStatuses_agentStatusTypes :: Lens' ListAgentStatuses (Maybe [AgentStatusType]) Source #
Available agent status types.
listAgentStatuses_nextToken :: Lens' ListAgentStatuses (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.
listAgentStatuses_maxResults :: Lens' ListAgentStatuses (Maybe Natural) Source #
The maximum number of results to return per page.
listAgentStatuses_instanceId :: Lens' ListAgentStatuses Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Destructuring the Response
data ListAgentStatusesResponse Source #
See: newListAgentStatusesResponse
smart constructor.
ListAgentStatusesResponse' | |
|
Instances
newListAgentStatusesResponse Source #
Create a value of ListAgentStatusesResponse
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:nextToken:ListAgentStatuses'
, listAgentStatusesResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:agentStatusSummaryList:ListAgentStatusesResponse'
, listAgentStatusesResponse_agentStatusSummaryList
- A summary of agent statuses.
$sel:httpStatus:ListAgentStatusesResponse'
, listAgentStatusesResponse_httpStatus
- The response's http status code.
Response Lenses
listAgentStatusesResponse_nextToken :: Lens' ListAgentStatusesResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
listAgentStatusesResponse_agentStatusSummaryList :: Lens' ListAgentStatusesResponse (Maybe [AgentStatusSummary]) Source #
A summary of agent statuses.
listAgentStatusesResponse_httpStatus :: Lens' ListAgentStatusesResponse Int Source #
The response's http status code.