Amazonka.WorkMail.ListOrganizations

Returns summaries of the customer's organizations.

This operation returns paginated results.

Creating a Request

data ListOrganizations

See: newListOrganizations smart constructor.

Constructors

ListOrganizations'

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.

Instances

ToJSON ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

toJSON :: ListOrganizations -> Value

toEncoding :: ListOrganizations -> Encoding

toJSONList :: [ListOrganizations] -> Value

toEncodingList :: [ListOrganizations] -> Encoding

ToHeaders ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

toHeaders :: ListOrganizations -> [Header]

ToPath ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

toPath :: ListOrganizations -> ByteString

ToQuery ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

toQuery :: ListOrganizations -> QueryString

AWSPager ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

page :: ListOrganizations -> AWSResponse ListOrganizations -> Maybe ListOrganizations

AWSRequest ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Associated Types

type AWSResponse ListOrganizations

Methods

request :: (Service -> Service) -> ListOrganizations -> Request ListOrganizations

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListOrganizations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOrganizations)))

Generic ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Associated Types

type Rep ListOrganizations :: Type -> Type

Methods

from :: ListOrganizations -> Rep ListOrganizations x

to :: Rep ListOrganizations x -> ListOrganizations

Read ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

readsPrec :: Int -> ReadS ListOrganizations

readList :: ReadS [ListOrganizations]

readPrec :: ReadPrec ListOrganizations

readListPrec :: ReadPrec [ListOrganizations]

Show ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

showsPrec :: Int -> ListOrganizations -> ShowS

show :: ListOrganizations -> String

showList :: [ListOrganizations] -> ShowS

NFData ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

rnf :: ListOrganizations -> ()

Eq ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

(==) :: ListOrganizations -> ListOrganizations -> Bool

(/=) :: ListOrganizations -> ListOrganizations -> Bool

Hashable ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

Methods

hashWithSalt :: Int -> ListOrganizations -> Int

hash :: ListOrganizations -> Int

type AWSResponse ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

type AWSResponse ListOrganizations = ListOrganizationsResponse

type Rep ListOrganizations

Defined in Amazonka.WorkMail.ListOrganizations

type Rep ListOrganizations = D1 ('MetaData "ListOrganizations" "Amazonka.WorkMail.ListOrganizations" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "ListOrganizations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListOrganizations :: ListOrganizations

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:maxResults:ListOrganizations', listOrganizations_maxResults - The maximum number of results to return in a single call.

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

Request Lenses

listOrganizations_maxResults :: Lens' ListOrganizations (Maybe Natural)

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

listOrganizations_nextToken :: Lens' ListOrganizations (Maybe Text)

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

Destructuring the Response

data ListOrganizationsResponse

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

Generic ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

Associated Types

type Rep ListOrganizationsResponse :: Type -> Type

Methods

from :: ListOrganizationsResponse -> Rep ListOrganizationsResponse x

to :: Rep ListOrganizationsResponse x -> ListOrganizationsResponse

Read ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

Methods

readsPrec :: Int -> ReadS ListOrganizationsResponse

readList :: ReadS [ListOrganizationsResponse]

readPrec :: ReadPrec ListOrganizationsResponse

readListPrec :: ReadPrec [ListOrganizationsResponse]

Show ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

Methods

showsPrec :: Int -> ListOrganizationsResponse -> ShowS

show :: ListOrganizationsResponse -> String

showList :: [ListOrganizationsResponse] -> ShowS

NFData ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

Methods

rnf :: ListOrganizationsResponse -> ()

Eq ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

Methods

(==) :: ListOrganizationsResponse -> ListOrganizationsResponse -> Bool

(/=) :: ListOrganizationsResponse -> ListOrganizationsResponse -> Bool

type Rep ListOrganizationsResponse

Defined in Amazonka.WorkMail.ListOrganizations

type Rep ListOrganizationsResponse = D1 ('MetaData "ListOrganizationsResponse" "Amazonka.WorkMail.ListOrganizations" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" '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

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:

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)

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])

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

listOrganizationsResponse_httpStatus :: Lens' ListOrganizationsResponse Int

The response's http status code.