amazonka-workmail-2.0: Amazon WorkMail 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.WorkMail.ListGroupMembers

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

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

ToHeaders ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

ToPath ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

ToQuery ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

AWSPager ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

AWSRequest ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Associated Types

type AWSResponse ListGroupMembers #

Generic ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Associated Types

type Rep ListGroupMembers :: Type -> Type #

Read ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Show ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

NFData ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Methods

rnf :: ListGroupMembers -> () #

Eq ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Hashable ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

type AWSResponse ListGroupMembers Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

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 #

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

Instances

Instances details
Generic ListGroupMembersResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Associated Types

type Rep ListGroupMembersResponse :: Type -> Type #

Read ListGroupMembersResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Show ListGroupMembersResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

NFData ListGroupMembersResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

Eq ListGroupMembersResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroupMembers

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 #

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_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.