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.IdentityStore.ListGroupMemberships

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListGroupMemberships = ListGroupMemberships' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- identityStoreId :: Text
- groupId :: Text
}
newListGroupMemberships :: Text -> Text -> ListGroupMemberships
listGroupMemberships_maxResults :: Lens' ListGroupMemberships (Maybe Natural)
listGroupMemberships_nextToken :: Lens' ListGroupMemberships (Maybe Text)
listGroupMemberships_identityStoreId :: Lens' ListGroupMemberships Text
listGroupMemberships_groupId :: Lens' ListGroupMemberships Text
data ListGroupMembershipsResponse = ListGroupMembershipsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- groupMemberships :: [GroupMembership]
}
newListGroupMembershipsResponse :: Int -> ListGroupMembershipsResponse
listGroupMembershipsResponse_nextToken :: Lens' ListGroupMembershipsResponse (Maybe Text)
listGroupMembershipsResponse_httpStatus :: Lens' ListGroupMembershipsResponse Int
listGroupMembershipsResponse_groupMemberships :: Lens' ListGroupMembershipsResponse [GroupMembership]

Creating a Request

data ListGroupMemberships Source #

See: newListGroupMemberships smart constructor.

Constructors

ListGroupMemberships'

Fields

maxResults :: Maybe Natural
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
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.
groupId :: Text
The identifier for a group in the identity store.

Instances

Instances details

ToJSON ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods toJSON :: ListGroupMemberships -> Value # toEncoding :: ListGroupMemberships -> Encoding # toJSONList :: [ListGroupMemberships] -> Value # toEncodingList :: [ListGroupMemberships] -> Encoding #
ToHeaders ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods toHeaders :: ListGroupMemberships -> [Header] #
ToPath ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods toPath :: ListGroupMemberships -> ByteString #
ToQuery ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods toQuery :: ListGroupMemberships -> QueryString #
AWSPager ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods page :: ListGroupMemberships -> AWSResponse ListGroupMemberships -> Maybe ListGroupMemberships #
AWSRequest ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Associated Types type AWSResponse ListGroupMemberships # Methods request :: (Service -> Service) -> ListGroupMemberships -> Request ListGroupMemberships # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGroupMemberships -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroupMemberships))) #
Generic ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Associated Types type Rep ListGroupMemberships :: Type -> Type # Methods from :: ListGroupMemberships -> Rep ListGroupMemberships x # to :: Rep ListGroupMemberships x -> ListGroupMemberships #
Read ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods readsPrec :: Int -> ReadS ListGroupMemberships # readList :: ReadS [ListGroupMemberships] # readPrec :: ReadPrec ListGroupMemberships # readListPrec :: ReadPrec [ListGroupMemberships] #
Show ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods showsPrec :: Int -> ListGroupMemberships -> ShowS # show :: ListGroupMemberships -> String # showList :: [ListGroupMemberships] -> ShowS #
NFData ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods rnf :: ListGroupMemberships -> () #
Eq ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods (==) :: ListGroupMemberships -> ListGroupMemberships -> Bool # (/=) :: ListGroupMemberships -> ListGroupMemberships -> Bool #
Hashable ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods hashWithSalt :: Int -> ListGroupMemberships -> Int # hash :: ListGroupMemberships -> Int #
type AWSResponse ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships type AWSResponse ListGroupMemberships = ListGroupMembershipsResponse
type Rep ListGroupMemberships Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships type Rep ListGroupMemberships = D1 ('MetaData "ListGroupMemberships" "Amazonka.IdentityStore.ListGroupMemberships" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListGroupMemberships'" '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 "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListGroupMemberships Source #

Arguments

:: Text	`ListGroupMemberships`
-> Text	`ListGroupMemberships`
-> ListGroupMemberships

Create a value of ListGroupMemberships 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:ListGroupMemberships', listGroupMemberships_maxResults - The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

ListGroupMemberships, listGroupMemberships_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.

ListGroupMemberships, listGroupMemberships_identityStoreId - The globally unique identifier for the identity store.

ListGroupMemberships, listGroupMemberships_groupId - The identifier for a group in the identity store.

Request Lenses

listGroupMemberships_maxResults :: Lens' ListGroupMemberships (Maybe Natural) Source #

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

listGroupMemberships_nextToken :: Lens' ListGroupMemberships (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.

listGroupMemberships_identityStoreId :: Lens' ListGroupMemberships Text Source #

The globally unique identifier for the identity store.

listGroupMemberships_groupId :: Lens' ListGroupMemberships Text Source #

The identifier for a group in the identity store.

Destructuring the Response

data ListGroupMembershipsResponse Source #

See: newListGroupMembershipsResponse smart constructor.

Constructors

ListGroupMembershipsResponse'

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.

Instances

Instances details

Generic ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Associated Types type Rep ListGroupMembershipsResponse :: Type -> Type # Methods from :: ListGroupMembershipsResponse -> Rep ListGroupMembershipsResponse x # to :: Rep ListGroupMembershipsResponse x -> ListGroupMembershipsResponse #
Read ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods readsPrec :: Int -> ReadS ListGroupMembershipsResponse # readList :: ReadS [ListGroupMembershipsResponse] # readPrec :: ReadPrec ListGroupMembershipsResponse # readListPrec :: ReadPrec [ListGroupMembershipsResponse] #
Show ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods showsPrec :: Int -> ListGroupMembershipsResponse -> ShowS # show :: ListGroupMembershipsResponse -> String # showList :: [ListGroupMembershipsResponse] -> ShowS #
NFData ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods rnf :: ListGroupMembershipsResponse -> () #
Eq ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships Methods (==) :: ListGroupMembershipsResponse -> ListGroupMembershipsResponse -> Bool # (/=) :: ListGroupMembershipsResponse -> ListGroupMembershipsResponse -> Bool #
type Rep ListGroupMembershipsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroupMemberships type Rep ListGroupMembershipsResponse = D1 ('MetaData "ListGroupMembershipsResponse" "Amazonka.IdentityStore.ListGroupMemberships" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListGroupMembershipsResponse'" '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]))))

newListGroupMembershipsResponse Source #

Arguments

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

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

ListGroupMemberships, listGroupMembershipsResponse_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:ListGroupMembershipsResponse', listGroupMembershipsResponse_httpStatus - The response's http status code.

$sel:groupMemberships:ListGroupMembershipsResponse', listGroupMembershipsResponse_groupMemberships - A list of GroupMembership objects in the group.

Response Lenses

listGroupMembershipsResponse_nextToken :: Lens' ListGroupMembershipsResponse (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.

listGroupMembershipsResponse_httpStatus :: Lens' ListGroupMembershipsResponse Int Source #

The response's http status code.

listGroupMembershipsResponse_groupMemberships :: Lens' ListGroupMembershipsResponse [GroupMembership] Source #

A list of GroupMembership objects in the group.