Network.AWS.WorkMail.ListResources

Returns summaries of the organization's resources.

This operation returns paginated results.

Creating a Request

listResources

Arguments

:: Text

lrOrganizationId

-> ListResources

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

See: listResources smart constructor.

Instances

Eq ListResources

Methods

(==) :: ListResources -> ListResources -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS ListResources

readList :: ReadS [ListResources]

readPrec :: ReadPrec ListResources

readListPrec :: ReadPrec [ListResources]

Show ListResources

Methods

showsPrec :: Int -> ListResources -> ShowS

show :: ListResources -> String

showList :: [ListResources] -> ShowS

Generic ListResources

Associated Types

type Rep ListResources :: * -> *

Methods

from :: ListResources -> Rep ListResources x

to :: Rep ListResources x -> ListResources

Hashable ListResources

Methods

hashWithSalt :: Int -> ListResources -> Int

hash :: ListResources -> Int

ToJSON ListResources

Methods

toJSON :: ListResources -> Value

toEncoding :: ListResources -> Encoding

toJSONList :: [ListResources] -> Value

toEncodingList :: [ListResources] -> Encoding

NFData ListResources

Methods

rnf :: ListResources -> ()

AWSPager ListResources

Methods

page :: ListResources -> Rs ListResources -> Maybe ListResources

AWSRequest ListResources

Associated Types

type Rs ListResources :: *

Methods

request :: ListResources -> Request ListResources

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

ToHeaders ListResources

Methods

toHeaders :: ListResources -> [Header]

ToPath ListResources

Methods

toPath :: ListResources -> ByteString

ToQuery ListResources

Methods

toQuery :: ListResources -> QueryString

type Rep ListResources

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

type Rs ListResources

type Rs ListResources = ListResourcesResponse

Request Lenses

lrNextToken :: Lens' ListResources (Maybe Text)

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

lrMaxResults :: Lens' ListResources (Maybe Natural)

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

lrOrganizationId :: Lens' ListResources Text

The identifier for the organization under which the resources exist.

Destructuring the Response

listResourcesResponse

Arguments

:: Int

lrrsResponseStatus

-> ListResourcesResponse

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

See: listResourcesResponse smart constructor.

Instances

Eq ListResourcesResponse

Methods

(==) :: ListResourcesResponse -> ListResourcesResponse -> Bool

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

Data ListResourcesResponse

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

Methods

readsPrec :: Int -> ReadS ListResourcesResponse

readList :: ReadS [ListResourcesResponse]

readPrec :: ReadPrec ListResourcesResponse

readListPrec :: ReadPrec [ListResourcesResponse]

Show ListResourcesResponse

Methods

showsPrec :: Int -> ListResourcesResponse -> ShowS

show :: ListResourcesResponse -> String

showList :: [ListResourcesResponse] -> ShowS

Generic ListResourcesResponse

Associated Types

type Rep ListResourcesResponse :: * -> *

Methods

from :: ListResourcesResponse -> Rep ListResourcesResponse x

to :: Rep ListResourcesResponse x -> ListResourcesResponse

NFData ListResourcesResponse

Methods

rnf :: ListResourcesResponse -> ()

type Rep ListResourcesResponse

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

Response Lenses

lrrsResources :: Lens' ListResourcesResponse [Resource]

One page of the organization's resource representation.

lrrsNextToken :: Lens' ListResourcesResponse (Maybe Text)

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

• - | The response status code.