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 |
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
This operation returns paginated results.
Synopsis
- data ListUserHierarchyGroups = ListUserHierarchyGroups' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
- newListUserHierarchyGroups :: Text -> ListUserHierarchyGroups
- listUserHierarchyGroups_maxResults :: Lens' ListUserHierarchyGroups (Maybe Natural)
- listUserHierarchyGroups_nextToken :: Lens' ListUserHierarchyGroups (Maybe Text)
- listUserHierarchyGroups_instanceId :: Lens' ListUserHierarchyGroups Text
- data ListUserHierarchyGroupsResponse = ListUserHierarchyGroupsResponse' {}
- newListUserHierarchyGroupsResponse :: Int -> ListUserHierarchyGroupsResponse
- listUserHierarchyGroupsResponse_nextToken :: Lens' ListUserHierarchyGroupsResponse (Maybe Text)
- listUserHierarchyGroupsResponse_userHierarchyGroupSummaryList :: Lens' ListUserHierarchyGroupsResponse (Maybe [HierarchyGroupSummary])
- listUserHierarchyGroupsResponse_httpStatus :: Lens' ListUserHierarchyGroupsResponse Int
Creating a Request
data ListUserHierarchyGroups Source #
See: newListUserHierarchyGroups
smart constructor.
ListUserHierarchyGroups' | |
|
Instances
newListUserHierarchyGroups Source #
Create a value of ListUserHierarchyGroups
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:ListUserHierarchyGroups'
, listUserHierarchyGroups_maxResults
- The maximum number of results to return per page. The default MaxResult
size is 100.
ListUserHierarchyGroups
, listUserHierarchyGroups_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.
ListUserHierarchyGroups
, listUserHierarchyGroups_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
Request Lenses
listUserHierarchyGroups_maxResults :: Lens' ListUserHierarchyGroups (Maybe Natural) Source #
The maximum number of results to return per page. The default MaxResult size is 100.
listUserHierarchyGroups_nextToken :: Lens' ListUserHierarchyGroups (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.
listUserHierarchyGroups_instanceId :: Lens' ListUserHierarchyGroups Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Destructuring the Response
data ListUserHierarchyGroupsResponse Source #
See: newListUserHierarchyGroupsResponse
smart constructor.
ListUserHierarchyGroupsResponse' | |
|
Instances
newListUserHierarchyGroupsResponse Source #
Create a value of ListUserHierarchyGroupsResponse
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:
ListUserHierarchyGroups
, listUserHierarchyGroupsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:userHierarchyGroupSummaryList:ListUserHierarchyGroupsResponse'
, listUserHierarchyGroupsResponse_userHierarchyGroupSummaryList
- Information about the hierarchy groups.
$sel:httpStatus:ListUserHierarchyGroupsResponse'
, listUserHierarchyGroupsResponse_httpStatus
- The response's http status code.
Response Lenses
listUserHierarchyGroupsResponse_nextToken :: Lens' ListUserHierarchyGroupsResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
listUserHierarchyGroupsResponse_userHierarchyGroupSummaryList :: Lens' ListUserHierarchyGroupsResponse (Maybe [HierarchyGroupSummary]) Source #
Information about the hierarchy groups.
listUserHierarchyGroupsResponse_httpStatus :: Lens' ListUserHierarchyGroupsResponse Int Source #
The response's http status code.