Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.ListOrganizations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns summaries of the customer's organizations.

This operation returns paginated results.

Creating a Request

data ListOrganizations Source #

See: newListOrganizations smart constructor.

Constructors

ListOrganizations'
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.

Instances

Instances details

Eq ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods (==) :: ListOrganizations -> ListOrganizations -> Bool # (/=) :: ListOrganizations -> ListOrganizations -> Bool #
Read ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods readsPrec :: Int -> ReadS ListOrganizations # readList :: ReadS [ListOrganizations] # readPrec :: ReadPrec ListOrganizations # readListPrec :: ReadPrec [ListOrganizations] #
Show ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods showsPrec :: Int -> ListOrganizations -> ShowS # show :: ListOrganizations -> String # showList :: [ListOrganizations] -> ShowS #
Generic ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Associated Types type Rep ListOrganizations :: Type -> Type # Methods from :: ListOrganizations -> Rep ListOrganizations x # to :: Rep ListOrganizations x -> ListOrganizations #
NFData ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods rnf :: ListOrganizations -> () #
Hashable ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods hashWithSalt :: Int -> ListOrganizations -> Int # hash :: ListOrganizations -> Int #
ToJSON ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods toJSON :: ListOrganizations -> Value # toEncoding :: ListOrganizations -> Encoding # toJSONList :: [ListOrganizations] -> Value # toEncodingList :: [ListOrganizations] -> Encoding #
AWSPager ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods page :: ListOrganizations -> AWSResponse ListOrganizations -> Maybe ListOrganizations #
AWSRequest ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Associated Types type AWSResponse ListOrganizations # Methods request :: ListOrganizations -> Request ListOrganizations # response :: MonadResource m => Logger -> Service -> Proxy ListOrganizations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOrganizations))) #
ToHeaders ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods toHeaders :: ListOrganizations -> [Header] #
ToPath ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods toPath :: ListOrganizations -> ByteString #
ToQuery ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations Methods toQuery :: ListOrganizations -> QueryString #
type Rep ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations type Rep ListOrganizations = D1 ('MetaData "ListOrganizations" "Amazonka.WorkMail.ListOrganizations" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListOrganizations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListOrganizations Source #
Instance details Defined in Amazonka.WorkMail.ListOrganizations type AWSResponse ListOrganizations = ListOrganizationsResponse

newListOrganizations :: ListOrganizations Source #

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

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

Request Lenses

listOrganizations_nextToken :: Lens' ListOrganizations (Maybe Text) Source #

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

listOrganizations_maxResults :: Lens' ListOrganizations (Maybe Natural) Source #

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

Destructuring the Response

data ListOrganizationsResponse Source #

See: newListOrganizationsResponse smart constructor.

Constructors

ListOrganizationsResponse'
Fields 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. organizationSummaries :: Maybe [OrganizationSummary] The overview of owned organizations presented as a list of organization summaries. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListOrganizationsResponse Source #

Arguments

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

Create a value of ListOrganizationsResponse 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:ListOrganizations', listOrganizationsResponse_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:organizationSummaries:ListOrganizationsResponse', listOrganizationsResponse_organizationSummaries - The overview of owned organizations presented as a list of organization summaries.

$sel:httpStatus:ListOrganizationsResponse', listOrganizationsResponse_httpStatus - The response's http status code.

Response Lenses

listOrganizationsResponse_nextToken :: Lens' ListOrganizationsResponse (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.

listOrganizationsResponse_organizationSummaries :: Lens' ListOrganizationsResponse (Maybe [OrganizationSummary]) Source #

The overview of owned organizations presented as a list of organization summaries.

listOrganizationsResponse_httpStatus :: Lens' ListOrganizationsResponse Int Source #

The response's http status code.