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

Amazonka.Connect.ListUserHierarchyGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data ListUserHierarchyGroups Source #

See: newListUserHierarchyGroups smart constructor.

Constructors

ListUserHierarchyGroups'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page. The default MaxResult size is 100.
nextToken :: Maybe Text
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.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

ToHeaders ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods toHeaders :: ListUserHierarchyGroups -> [Header] #
ToPath ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods toPath :: ListUserHierarchyGroups -> ByteString #
ToQuery ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods toQuery :: ListUserHierarchyGroups -> QueryString #
AWSPager ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods page :: ListUserHierarchyGroups -> AWSResponse ListUserHierarchyGroups -> Maybe ListUserHierarchyGroups #
AWSRequest ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Associated Types type AWSResponse ListUserHierarchyGroups # Methods request :: (Service -> Service) -> ListUserHierarchyGroups -> Request ListUserHierarchyGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListUserHierarchyGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserHierarchyGroups))) #
Generic ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Associated Types type Rep ListUserHierarchyGroups :: Type -> Type # Methods from :: ListUserHierarchyGroups -> Rep ListUserHierarchyGroups x # to :: Rep ListUserHierarchyGroups x -> ListUserHierarchyGroups #
Read ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods readsPrec :: Int -> ReadS ListUserHierarchyGroups # readList :: ReadS [ListUserHierarchyGroups] # readPrec :: ReadPrec ListUserHierarchyGroups # readListPrec :: ReadPrec [ListUserHierarchyGroups] #
Show ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods showsPrec :: Int -> ListUserHierarchyGroups -> ShowS # show :: ListUserHierarchyGroups -> String # showList :: [ListUserHierarchyGroups] -> ShowS #
NFData ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods rnf :: ListUserHierarchyGroups -> () #
Eq ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods (==) :: ListUserHierarchyGroups -> ListUserHierarchyGroups -> Bool # (/=) :: ListUserHierarchyGroups -> ListUserHierarchyGroups -> Bool #
Hashable ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods hashWithSalt :: Int -> ListUserHierarchyGroups -> Int # hash :: ListUserHierarchyGroups -> Int #
type AWSResponse ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups type AWSResponse ListUserHierarchyGroups = ListUserHierarchyGroupsResponse
type Rep ListUserHierarchyGroups Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups type Rep ListUserHierarchyGroups = D1 ('MetaData "ListUserHierarchyGroups" "Amazonka.Connect.ListUserHierarchyGroups" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListUserHierarchyGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListUserHierarchyGroups Source #

Arguments

:: Text	`ListUserHierarchyGroups`
-> ListUserHierarchyGroups

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.

Constructors

ListUserHierarchyGroupsResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. userHierarchyGroupSummaryList :: Maybe [HierarchyGroupSummary] Information about the hierarchy groups. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Associated Types type Rep ListUserHierarchyGroupsResponse :: Type -> Type # Methods from :: ListUserHierarchyGroupsResponse -> Rep ListUserHierarchyGroupsResponse x # to :: Rep ListUserHierarchyGroupsResponse x -> ListUserHierarchyGroupsResponse #
Read ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods readsPrec :: Int -> ReadS ListUserHierarchyGroupsResponse # readList :: ReadS [ListUserHierarchyGroupsResponse] # readPrec :: ReadPrec ListUserHierarchyGroupsResponse # readListPrec :: ReadPrec [ListUserHierarchyGroupsResponse] #
Show ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods showsPrec :: Int -> ListUserHierarchyGroupsResponse -> ShowS # show :: ListUserHierarchyGroupsResponse -> String # showList :: [ListUserHierarchyGroupsResponse] -> ShowS #
NFData ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods rnf :: ListUserHierarchyGroupsResponse -> () #
Eq ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups Methods (==) :: ListUserHierarchyGroupsResponse -> ListUserHierarchyGroupsResponse -> Bool # (/=) :: ListUserHierarchyGroupsResponse -> ListUserHierarchyGroupsResponse -> Bool #
type Rep ListUserHierarchyGroupsResponse Source #
Instance details Defined in Amazonka.Connect.ListUserHierarchyGroups type Rep ListUserHierarchyGroupsResponse = D1 ('MetaData "ListUserHierarchyGroupsResponse" "Amazonka.Connect.ListUserHierarchyGroups" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListUserHierarchyGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userHierarchyGroupSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HierarchyGroupSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserHierarchyGroupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUserHierarchyGroupsResponse'`
-> ListUserHierarchyGroupsResponse

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.