Network.AWS.WorkMail.ListOrganizations

Returns summaries of the customer's non-deleted organizations.

This operation returns paginated results.

Creating a Request

listOrganizations :: ListOrganizations

Creates a value of ListOrganizations with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• loNextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.
• loMaxResults - The maximum number of results to return in a single call.

data ListOrganizations

See: listOrganizations smart constructor.

Instances

Eq ListOrganizations

Methods

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

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

Data ListOrganizations

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListOrganizations -> c ListOrganizations

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListOrganizations

toConstr :: ListOrganizations -> Constr

dataTypeOf :: ListOrganizations -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListOrganizations)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListOrganizations)

gmapT :: (forall b. Data b => b -> b) -> ListOrganizations -> ListOrganizations

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListOrganizations -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListOrganizations -> r

gmapQ :: (forall d. Data d => d -> u) -> ListOrganizations -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListOrganizations -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListOrganizations -> m ListOrganizations

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOrganizations -> m ListOrganizations

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOrganizations -> m ListOrganizations

Read ListOrganizations

Methods

readsPrec :: Int -> ReadS ListOrganizations

readList :: ReadS [ListOrganizations]

readPrec :: ReadPrec ListOrganizations

readListPrec :: ReadPrec [ListOrganizations]

Show ListOrganizations

Methods

showsPrec :: Int -> ListOrganizations -> ShowS

show :: ListOrganizations -> String

showList :: [ListOrganizations] -> ShowS

Generic ListOrganizations

Associated Types

type Rep ListOrganizations :: * -> *

Methods

from :: ListOrganizations -> Rep ListOrganizations x

to :: Rep ListOrganizations x -> ListOrganizations

Hashable ListOrganizations

Methods

hashWithSalt :: Int -> ListOrganizations -> Int

hash :: ListOrganizations -> Int

ToJSON ListOrganizations

Methods

toJSON :: ListOrganizations -> Value

toEncoding :: ListOrganizations -> Encoding

toJSONList :: [ListOrganizations] -> Value

toEncodingList :: [ListOrganizations] -> Encoding

NFData ListOrganizations

Methods

rnf :: ListOrganizations -> ()

AWSPager ListOrganizations

Methods

page :: ListOrganizations -> Rs ListOrganizations -> Maybe ListOrganizations

AWSRequest ListOrganizations

Associated Types

type Rs ListOrganizations :: *

Methods

request :: ListOrganizations -> Request ListOrganizations

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListOrganizations -> ClientResponse -> m (Response ListOrganizations)

ToHeaders ListOrganizations

Methods

toHeaders :: ListOrganizations -> [Header]

ToPath ListOrganizations

Methods

toPath :: ListOrganizations -> ByteString

ToQuery ListOrganizations

Methods

toQuery :: ListOrganizations -> QueryString

type Rep ListOrganizations

type Rep ListOrganizations = D1 * (MetaData "ListOrganizations" "Network.AWS.WorkMail.ListOrganizations" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "ListOrganizations'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_loNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_loMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))

type Rs ListOrganizations

type Rs ListOrganizations = ListOrganizationsResponse

Request Lenses

loNextToken :: Lens' ListOrganizations (Maybe Text)

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

loMaxResults :: Lens' ListOrganizations (Maybe Natural)

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

Destructuring the Response

listOrganizationsResponse

Arguments

:: Int

lorsResponseStatus

-> ListOrganizationsResponse

Creates a value of ListOrganizationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lorsNextToken - The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
• lorsOrganizationSummaries - The overview of owned organizations presented as a list of organization summaries.
• lorsResponseStatus - -- | The response status code.

data ListOrganizationsResponse

See: listOrganizationsResponse smart constructor.

Instances

Eq ListOrganizationsResponse

Methods

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

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

Data ListOrganizationsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListOrganizationsResponse -> c ListOrganizationsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListOrganizationsResponse

toConstr :: ListOrganizationsResponse -> Constr

dataTypeOf :: ListOrganizationsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListOrganizationsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListOrganizationsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListOrganizationsResponse -> ListOrganizationsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListOrganizationsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListOrganizationsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListOrganizationsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListOrganizationsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListOrganizationsResponse -> m ListOrganizationsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOrganizationsResponse -> m ListOrganizationsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOrganizationsResponse -> m ListOrganizationsResponse

Read ListOrganizationsResponse

Methods

readsPrec :: Int -> ReadS ListOrganizationsResponse

readList :: ReadS [ListOrganizationsResponse]

readPrec :: ReadPrec ListOrganizationsResponse

readListPrec :: ReadPrec [ListOrganizationsResponse]

Show ListOrganizationsResponse

Methods

showsPrec :: Int -> ListOrganizationsResponse -> ShowS

show :: ListOrganizationsResponse -> String

showList :: [ListOrganizationsResponse] -> ShowS

Generic ListOrganizationsResponse

Associated Types

type Rep ListOrganizationsResponse :: * -> *

Methods

from :: ListOrganizationsResponse -> Rep ListOrganizationsResponse x

to :: Rep ListOrganizationsResponse x -> ListOrganizationsResponse

NFData ListOrganizationsResponse

Methods

rnf :: ListOrganizationsResponse -> ()

type Rep ListOrganizationsResponse

type Rep ListOrganizationsResponse = D1 * (MetaData "ListOrganizationsResponse" "Network.AWS.WorkMail.ListOrganizations" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "ListOrganizationsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lorsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lorsOrganizationSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OrganizationSummary]))) (S1 * (MetaSel (Just Symbol "_lorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lorsNextToken :: 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.

lorsOrganizationSummaries :: Lens' ListOrganizationsResponse [OrganizationSummary]

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

lorsResponseStatus :: Lens' ListOrganizationsResponse Int

• - | The response status code.