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 |
Gets the real-time active user data from the specified Amazon Connect instance.
Synopsis
- data GetCurrentUserData = GetCurrentUserData' {}
- newGetCurrentUserData :: Text -> UserDataFilters -> GetCurrentUserData
- getCurrentUserData_maxResults :: Lens' GetCurrentUserData (Maybe Natural)
- getCurrentUserData_nextToken :: Lens' GetCurrentUserData (Maybe Text)
- getCurrentUserData_instanceId :: Lens' GetCurrentUserData Text
- getCurrentUserData_filters :: Lens' GetCurrentUserData UserDataFilters
- data GetCurrentUserDataResponse = GetCurrentUserDataResponse' {}
- newGetCurrentUserDataResponse :: Int -> GetCurrentUserDataResponse
- getCurrentUserDataResponse_approximateTotalCount :: Lens' GetCurrentUserDataResponse (Maybe Integer)
- getCurrentUserDataResponse_nextToken :: Lens' GetCurrentUserDataResponse (Maybe Text)
- getCurrentUserDataResponse_userDataList :: Lens' GetCurrentUserDataResponse (Maybe [UserData])
- getCurrentUserDataResponse_httpStatus :: Lens' GetCurrentUserDataResponse Int
Creating a Request
data GetCurrentUserData Source #
See: newGetCurrentUserData
smart constructor.
GetCurrentUserData' | |
|
Instances
newGetCurrentUserData Source #
Create a value of GetCurrentUserData
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:GetCurrentUserData'
, getCurrentUserData_maxResults
- The maximum number of results to return per page.
GetCurrentUserData
, getCurrentUserData_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.
GetCurrentUserData
, getCurrentUserData_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
$sel:filters:GetCurrentUserData'
, getCurrentUserData_filters
- The filters to apply to returned user data. You can filter up to the
following limits:
- Queues: 100
- Routing profiles: 100
- Agents: 100
- Contact states: 9
- User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
Request Lenses
getCurrentUserData_maxResults :: Lens' GetCurrentUserData (Maybe Natural) Source #
The maximum number of results to return per page.
getCurrentUserData_nextToken :: Lens' GetCurrentUserData (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.
getCurrentUserData_instanceId :: Lens' GetCurrentUserData Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
getCurrentUserData_filters :: Lens' GetCurrentUserData UserDataFilters Source #
The filters to apply to returned user data. You can filter up to the following limits:
- Queues: 100
- Routing profiles: 100
- Agents: 100
- Contact states: 9
- User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
Destructuring the Response
data GetCurrentUserDataResponse Source #
See: newGetCurrentUserDataResponse
smart constructor.
GetCurrentUserDataResponse' | |
|
Instances
newGetCurrentUserDataResponse Source #
Create a value of GetCurrentUserDataResponse
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:GetCurrentUserDataResponse'
, getCurrentUserDataResponse_approximateTotalCount
- The total count of the result, regardless of the current page size.
GetCurrentUserData
, getCurrentUserDataResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:userDataList:GetCurrentUserDataResponse'
, getCurrentUserDataResponse_userDataList
- A list of the user data that is returned.
$sel:httpStatus:GetCurrentUserDataResponse'
, getCurrentUserDataResponse_httpStatus
- The response's http status code.
Response Lenses
getCurrentUserDataResponse_approximateTotalCount :: Lens' GetCurrentUserDataResponse (Maybe Integer) Source #
The total count of the result, regardless of the current page size.
getCurrentUserDataResponse_nextToken :: Lens' GetCurrentUserDataResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
getCurrentUserDataResponse_userDataList :: Lens' GetCurrentUserDataResponse (Maybe [UserData]) Source #
A list of the user data that is returned.
getCurrentUserDataResponse_httpStatus :: Lens' GetCurrentUserDataResponse Int Source #
The response's http status code.