amazonka-workmail-2.0: Amazon WorkMail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkMail.ListResources

Description

Returns summaries of the organization's resources.

This operation returns paginated results.

Synopsis

Creating a Request

data ListResources Source #

See: newListResources smart constructor.

Constructors

ListResources' 

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.

  • organizationId :: Text

    The identifier for the organization under which the resources exist.

Instances

Instances details
ToJSON ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

toJSON :: ListResources -> Value #

toEncoding :: ListResources -> Encoding #

toJSONList :: [ListResources] -> Value #

toEncodingList :: [ListResources] -> Encoding #

ToHeaders ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

toHeaders :: ListResources -> [Header] #

ToPath ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

toPath :: ListResources -> ByteString #

ToQuery ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

toQuery :: ListResources -> QueryString #

AWSPager ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

page :: ListResources -> AWSResponse ListResources -> Maybe ListResources #

AWSRequest ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Associated Types

type AWSResponse ListResources #

Methods

request :: (Service -> Service) -> ListResources -> Request ListResources #

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

Generic ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Associated Types

type Rep ListResources :: Type -> Type #

Methods

from :: ListResources -> Rep ListResources x #

to :: Rep ListResources x -> ListResources #

Read ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

readsPrec :: Int -> ReadS ListResources #

readList :: ReadS [ListResources] #

readPrec :: ReadPrec ListResources #

readListPrec :: ReadPrec [ListResources] #

Show ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

showsPrec :: Int -> ListResources -> ShowS #

show :: ListResources -> String #

showList :: [ListResources] -> ShowS #

NFData ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

rnf :: ListResources -> () #

Eq ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

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

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

Hashable ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

hashWithSalt :: Int -> ListResources -> Int #

hash :: ListResources -> Int #

type AWSResponse ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

type AWSResponse ListResources = ListResourcesResponse
type Rep ListResources Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

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

newListResources Source #

Arguments

:: Text

ListResources

-> ListResources 

Create a value of ListResources 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:ListResources', listResources_maxResults - The maximum number of results to return in a single call.

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

ListResources, listResources_organizationId - The identifier for the organization under which the resources exist.

Request Lenses

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

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

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

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

listResources_organizationId :: Lens' ListResources Text Source #

The identifier for the organization under which the resources exist.

Destructuring the Response

data ListResourcesResponse Source #

See: newListResourcesResponse smart constructor.

Constructors

ListResourcesResponse' 

Fields

  • nextToken :: 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.

  • resources :: Maybe [Resource]

    One page of the organization's resource representation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Associated Types

type Rep ListResourcesResponse :: Type -> Type #

Methods

from :: ListResourcesResponse -> Rep ListResourcesResponse x #

to :: Rep ListResourcesResponse x -> ListResourcesResponse #

Read ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

readsPrec :: Int -> ReadS ListResourcesResponse #

readList :: ReadS [ListResourcesResponse] #

readPrec :: ReadPrec ListResourcesResponse #

readListPrec :: ReadPrec [ListResourcesResponse] #

Show ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

showsPrec :: Int -> ListResourcesResponse -> ShowS #

show :: ListResourcesResponse -> String #

showList :: [ListResourcesResponse] -> ShowS #

NFData ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

rnf :: ListResourcesResponse -> () #

Eq ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

Methods

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

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

type Rep ListResourcesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListResources

type Rep ListResourcesResponse = D1 ('MetaData "ListResourcesResponse" "Amazonka.WorkMail.ListResources" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "ListResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListResourcesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListResourcesResponse'

-> ListResourcesResponse 

Create a value of ListResourcesResponse 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:

ListResources, listResourcesResponse_nextToken - 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.

$sel:resources:ListResourcesResponse', listResourcesResponse_resources - One page of the organization's resource representation.

$sel:httpStatus:ListResourcesResponse', listResourcesResponse_httpStatus - The response's http status code.

Response Lenses

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

listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource]) Source #

One page of the organization's resource representation.

listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #

The response's http status code.