libZSservicesZSamazonka-workmailZSamazonka-workmail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkMail.ListGroups

Description

Returns summaries of the organization's groups.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups' 

Fields

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

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

  • organizationId :: Text

    The identifier for the organization under which the groups exist.

Instances

Instances details
Eq ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool #

(/=) :: ListGroups -> ListGroups -> Bool #

Read ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroups #

readList :: ReadS [ListGroups] #

readPrec :: ReadPrec ListGroups #

readListPrec :: ReadPrec [ListGroups] #

Show ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS #

show :: ListGroups -> String #

showList :: [ListGroups] -> ShowS #

Generic ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type #

Methods

from :: ListGroups -> Rep ListGroups x #

to :: Rep ListGroups x -> ListGroups #

NFData ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

rnf :: ListGroups -> () #

Hashable ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int #

hash :: ListGroups -> Int #

ToJSON ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

toJSON :: ListGroups -> Value #

toEncoding :: ListGroups -> Encoding #

toJSONList :: [ListGroups] -> Value #

toEncodingList :: [ListGroups] -> Encoding #

AWSPager ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

page :: ListGroups -> AWSResponse ListGroups -> Maybe ListGroups #

AWSRequest ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Associated Types

type AWSResponse ListGroups #

Methods

request :: ListGroups -> Request ListGroups #

response :: MonadResource m => Logger -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups))) #

ToHeaders ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

toHeaders :: ListGroups -> [Header] #

ToPath ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

toPath :: ListGroups -> ByteString #

ToQuery ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

toQuery :: ListGroups -> QueryString #

type Rep ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.WorkMail.ListGroups" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListGroups Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

type AWSResponse ListGroups = ListGroupsResponse

newListGroups Source #

Arguments

:: Text

$sel:organizationId:ListGroups'

-> ListGroups 

Create a value of ListGroups 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:nextToken:ListGroups', listGroups_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

$sel:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to return in a single call.

$sel:organizationId:ListGroups', listGroups_organizationId - The identifier for the organization under which the groups exist.

Request Lenses

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

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

listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #

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

listGroups_organizationId :: Lens' ListGroups Text Source #

The identifier for the organization under which the groups exist.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse' 

Fields

  • groups :: Maybe [Group]

    The overview of groups for an organization.

  • nextToken :: Maybe Text

    The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool #

(/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool #

Read ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroupsResponse #

readList :: ReadS [ListGroupsResponse] #

readPrec :: ReadPrec ListGroupsResponse #

readListPrec :: ReadPrec [ListGroupsResponse] #

Show ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS #

show :: ListGroupsResponse -> String #

showList :: [ListGroupsResponse] -> ShowS #

Generic ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type #

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x #

to :: Rep ListGroupsResponse x -> ListGroupsResponse #

NFData ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

Methods

rnf :: ListGroupsResponse -> () #

type Rep ListGroupsResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.WorkMail.ListGroups" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Group])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListGroupsResponse'

-> ListGroupsResponse 

Create a value of ListGroupsResponse 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:groups:ListGroupsResponse', listGroupsResponse_groups - The overview of groups for an organization.

$sel:nextToken:ListGroups', listGroupsResponse_nextToken - The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [Group]) Source #

The overview of groups for an organization.

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #

The response's http status code.