amazonka-identitystore-2.0: Amazon SSO Identity Store SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IdentityStore.ListGroupMembershipsForMember

Description

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroupMembershipsForMember Source #

See: newListGroupMembershipsForMember smart constructor.

Constructors

ListGroupMembershipsForMember' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • nextToken :: Maybe Text

    The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • identityStoreId :: Text

    The globally unique identifier for the identity store.

  • memberId :: MemberId

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Instances

Instances details
ToJSON ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

ToHeaders ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

ToPath ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

ToQuery ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

AWSPager ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

AWSRequest ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Generic ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Associated Types

type Rep ListGroupMembershipsForMember :: Type -> Type #

Read ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Show ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

NFData ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Eq ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Hashable ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

type AWSResponse ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

type Rep ListGroupMembershipsForMember Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

type Rep ListGroupMembershipsForMember = D1 ('MetaData "ListGroupMembershipsForMember" "Amazonka.IdentityStore.ListGroupMembershipsForMember" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListGroupMembershipsForMember'" '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 "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MemberId))))

newListGroupMembershipsForMember Source #

Create a value of ListGroupMembershipsForMember 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:ListGroupMembershipsForMember', listGroupMembershipsForMember_maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

ListGroupMembershipsForMember, listGroupMembershipsForMember_nextToken - The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

ListGroupMembershipsForMember, listGroupMembershipsForMember_identityStoreId - The globally unique identifier for the identity store.

ListGroupMembershipsForMember, listGroupMembershipsForMember_memberId - An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Request Lenses

listGroupMembershipsForMember_maxResults :: Lens' ListGroupMembershipsForMember (Maybe Natural) Source #

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

listGroupMembershipsForMember_nextToken :: Lens' ListGroupMembershipsForMember (Maybe Text) Source #

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

listGroupMembershipsForMember_identityStoreId :: Lens' ListGroupMembershipsForMember Text Source #

The globally unique identifier for the identity store.

listGroupMembershipsForMember_memberId :: Lens' ListGroupMembershipsForMember MemberId Source #

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Destructuring the Response

data ListGroupMembershipsForMemberResponse Source #

Constructors

ListGroupMembershipsForMemberResponse' 

Fields

  • nextToken :: Maybe Text

    The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • httpStatus :: Int

    The response's http status code.

  • groupMemberships :: [GroupMembership]

    A list of GroupMembership objects in the group for a specified member.

Instances

Instances details
Generic ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Read ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Show ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

NFData ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

Eq ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

type Rep ListGroupMembershipsForMemberResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.ListGroupMembershipsForMember

type Rep ListGroupMembershipsForMemberResponse = D1 ('MetaData "ListGroupMembershipsForMemberResponse" "Amazonka.IdentityStore.ListGroupMembershipsForMember" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListGroupMembershipsForMemberResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "groupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GroupMembership]))))

newListGroupMembershipsForMemberResponse Source #

Create a value of ListGroupMembershipsForMemberResponse 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:

ListGroupMembershipsForMember, listGroupMembershipsForMemberResponse_nextToken - The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

$sel:httpStatus:ListGroupMembershipsForMemberResponse', listGroupMembershipsForMemberResponse_httpStatus - The response's http status code.

$sel:groupMemberships:ListGroupMembershipsForMemberResponse', listGroupMembershipsForMemberResponse_groupMemberships - A list of GroupMembership objects in the group for a specified member.

Response Lenses

listGroupMembershipsForMemberResponse_nextToken :: Lens' ListGroupMembershipsForMemberResponse (Maybe Text) Source #

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

listGroupMembershipsForMemberResponse_groupMemberships :: Lens' ListGroupMembershipsForMemberResponse [GroupMembership] Source #

A list of GroupMembership objects in the group for a specified member.