amazonka-workmail-1.6.1: Amazon WorkMail SDK.

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

Network.AWS.WorkMail.ListResources

Contents

Description

Returns summaries of the organization's resources.

This operation returns paginated results.

Synopsis

Creating a Request

listResources Source #

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

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

  • lrNextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • lrMaxResults - The maximum number of results to return in a single call.
  • lrOrganizationId - The identifier for the organization under which the resources exist.

data ListResources Source #

See: listResources smart constructor.

Instances
Eq ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Data ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Methods

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

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

toConstr :: ListResources -> Constr #

dataTypeOf :: ListResources -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResources) #

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

gmapT :: (forall b. Data b => b -> b) -> ListResources -> ListResources #

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

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

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

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

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

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

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

Read ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Show ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Generic ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Associated Types

type Rep ListResources :: Type -> Type #

Hashable ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

ToJSON ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

AWSPager ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

AWSRequest ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Associated Types

type Rs ListResources :: Type #

ToHeaders ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

ToPath ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

ToQuery ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

NFData ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Methods

rnf :: ListResources -> () #

type Rep ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

type Rep ListResources = D1 (MetaData "ListResources" "Network.AWS.WorkMail.ListResources" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" False) (C1 (MetaCons "ListResources'" PrefixI True) (S1 (MetaSel (Just "_lrNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lrMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_lrOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListResources Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Request Lenses

lrNextToken :: Lens' ListResources (Maybe Text) Source #

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

lrMaxResults :: Lens' ListResources (Maybe Natural) Source #

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

lrOrganizationId :: Lens' ListResources Text Source #

The identifier for the organization under which the resources exist.

Destructuring the Response

listResourcesResponse Source #

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

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

  • lrrsResources - One page of the organization's resource representation.
  • lrrsNextToken - The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
  • lrrsResponseStatus - -- | The response status code.

data ListResourcesResponse Source #

See: listResourcesResponse smart constructor.

Instances
Eq ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Data ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Methods

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

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

toConstr :: ListResourcesResponse -> Constr #

dataTypeOf :: ListResourcesResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResourcesResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> ListResourcesResponse -> ListResourcesResponse #

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

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

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

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

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

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

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

Read ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Show ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Generic ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Associated Types

type Rep ListResourcesResponse :: Type -> Type #

NFData ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

Methods

rnf :: ListResourcesResponse -> () #

type Rep ListResourcesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListResources

type Rep ListResourcesResponse = D1 (MetaData "ListResourcesResponse" "Network.AWS.WorkMail.ListResources" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" False) (C1 (MetaCons "ListResourcesResponse'" PrefixI True) (S1 (MetaSel (Just "_lrrsResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Resource])) :*: (S1 (MetaSel (Just "_lrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lrrsResources :: Lens' ListResourcesResponse [Resource] Source #

One page of the organization's resource representation.

lrrsNextToken :: Lens' ListResourcesResponse (Maybe Text) Source #

The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

lrrsResponseStatus :: Lens' ListResourcesResponse Int Source #

  • - | The response status code.