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.WorkMail.ListGroupMembers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an overview of the members of a group. Users and groups can be members of a group.

This operation returns paginated results.

Synopsis

data ListGroupMembers = ListGroupMembers' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- organizationId :: Text
- groupId :: Text
}
newListGroupMembers :: Text -> Text -> ListGroupMembers
listGroupMembers_maxResults :: Lens' ListGroupMembers (Maybe Natural)
listGroupMembers_nextToken :: Lens' ListGroupMembers (Maybe Text)
listGroupMembers_organizationId :: Lens' ListGroupMembers Text
listGroupMembers_groupId :: Lens' ListGroupMembers Text
data ListGroupMembersResponse = ListGroupMembersResponse' {
- members :: Maybe [Member]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListGroupMembersResponse :: Int -> ListGroupMembersResponse
listGroupMembersResponse_members :: Lens' ListGroupMembersResponse (Maybe [Member])
listGroupMembersResponse_nextToken :: Lens' ListGroupMembersResponse (Maybe Text)
listGroupMembersResponse_httpStatus :: Lens' ListGroupMembersResponse Int

Creating a Request

data ListGroupMembers Source #

See: newListGroupMembers smart constructor.

Constructors

ListGroupMembers'

Fields

maxResults :: Maybe Natural
The maximum number of results to return in a single call.
nextToken :: Maybe Text
The token to use to retrieve the next page of results. The first call does not contain any tokens.
organizationId :: Text
The identifier for the organization under which the group exists.
groupId :: Text
The identifier for the group to which the members (users or groups) are associated.

Instances

Instances details

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

newListGroupMembers Source #

Arguments

:: Text	`ListGroupMembers`
-> Text	`$sel:groupId:ListGroupMembers'`
-> ListGroupMembers

Create a value of ListGroupMembers 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:ListGroupMembers', listGroupMembers_maxResults - The maximum number of results to return in a single call.

ListGroupMembers, listGroupMembers_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

ListGroupMembers, listGroupMembers_organizationId - The identifier for the organization under which the group exists.

$sel:groupId:ListGroupMembers', listGroupMembers_groupId - The identifier for the group to which the members (users or groups) are associated.

Request Lenses

listGroupMembers_maxResults :: Lens' ListGroupMembers (Maybe Natural) Source #

The maximum number of results to return in a single call.

listGroupMembers_nextToken :: Lens' ListGroupMembers (Maybe Text) Source #

The token to use to retrieve the next page of results. The first call does not contain any tokens.

listGroupMembers_organizationId :: Lens' ListGroupMembers Text Source #

The identifier for the organization under which the group exists.

listGroupMembers_groupId :: Lens' ListGroupMembers Text Source #

The identifier for the group to which the members (users or groups) are associated.

Destructuring the Response

data ListGroupMembersResponse Source #

See: newListGroupMembersResponse smart constructor.

Constructors

ListGroupMembersResponse'
Fields members :: Maybe [Member] The members associated to the group. nextToken :: Maybe Text The token to use to retrieve the next page of results. The first call does not contain any tokens. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListGroupMembersResponse Source #

Arguments

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

Create a value of ListGroupMembersResponse 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:members:ListGroupMembersResponse', listGroupMembersResponse_members - The members associated to the group.

ListGroupMembers, listGroupMembersResponse_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

$sel:httpStatus:ListGroupMembersResponse', listGroupMembersResponse_httpStatus - The response's http status code.

Response Lenses

listGroupMembersResponse_members :: Lens' ListGroupMembersResponse (Maybe [Member]) Source #

The members associated to the group.

listGroupMembersResponse_nextToken :: Lens' ListGroupMembersResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The first call does not contain any tokens.

listGroupMembersResponse_httpStatus :: Lens' ListGroupMembersResponse Int Source #

The response's http status code.