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

Amazonka.WorkMail.ListAliases

Description

Creates a paginated call to list the aliases associated with a given entity.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAliases Source #

See: newListAliases smart constructor.

Constructors

ListAliases' 

Fields

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

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

  • organizationId :: Text

    The identifier for the organization under which the entity exists.

  • entityId :: Text

    The identifier for the entity for which to list the aliases.

Instances

Instances details
Eq ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

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

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

Read ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliases #

readList :: ReadS [ListAliases] #

readPrec :: ReadPrec ListAliases #

readListPrec :: ReadPrec [ListAliases] #

Show ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

showsPrec :: Int -> ListAliases -> ShowS #

show :: ListAliases -> String #

showList :: [ListAliases] -> ShowS #

Generic ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Associated Types

type Rep ListAliases :: Type -> Type #

Methods

from :: ListAliases -> Rep ListAliases x #

to :: Rep ListAliases x -> ListAliases #

NFData ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

rnf :: ListAliases -> () #

Hashable ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

hashWithSalt :: Int -> ListAliases -> Int #

hash :: ListAliases -> Int #

ToJSON ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

toJSON :: ListAliases -> Value #

toEncoding :: ListAliases -> Encoding #

toJSONList :: [ListAliases] -> Value #

toEncodingList :: [ListAliases] -> Encoding #

AWSPager ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

page :: ListAliases -> AWSResponse ListAliases -> Maybe ListAliases #

AWSRequest ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Associated Types

type AWSResponse ListAliases #

Methods

request :: ListAliases -> Request ListAliases #

response :: MonadResource m => Logger -> Service -> Proxy ListAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAliases))) #

ToHeaders ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

toHeaders :: ListAliases -> [Header] #

ToPath ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

toPath :: ListAliases -> ByteString #

ToQuery ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

toQuery :: ListAliases -> QueryString #

type Rep ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

type Rep ListAliases = D1 ('MetaData "ListAliases" "Amazonka.WorkMail.ListAliases" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListAliases Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

type AWSResponse ListAliases = ListAliasesResponse

newListAliases Source #

Arguments

:: Text

$sel:organizationId:ListAliases'

-> Text

$sel:entityId:ListAliases'

-> ListAliases 

Create a value of ListAliases 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:nextToken:ListAliases', listAliases_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

$sel:maxResults:ListAliases', listAliases_maxResults - The maximum number of results to return in a single call.

$sel:organizationId:ListAliases', listAliases_organizationId - The identifier for the organization under which the entity exists.

$sel:entityId:ListAliases', listAliases_entityId - The identifier for the entity for which to list the aliases.

Request Lenses

listAliases_nextToken :: Lens' ListAliases (Maybe Text) Source #

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

listAliases_maxResults :: Lens' ListAliases (Maybe Natural) Source #

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

listAliases_organizationId :: Lens' ListAliases Text Source #

The identifier for the organization under which the entity exists.

listAliases_entityId :: Lens' ListAliases Text Source #

The identifier for the entity for which to list the aliases.

Destructuring the Response

data ListAliasesResponse Source #

See: newListAliasesResponse smart constructor.

Constructors

ListAliasesResponse' 

Fields

  • aliases :: Maybe [Text]

    The entity's paginated aliases.

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

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

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

Read ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliasesResponse #

readList :: ReadS [ListAliasesResponse] #

readPrec :: ReadPrec ListAliasesResponse #

readListPrec :: ReadPrec [ListAliasesResponse] #

Show ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

showsPrec :: Int -> ListAliasesResponse -> ShowS #

show :: ListAliasesResponse -> String #

showList :: [ListAliasesResponse] -> ShowS #

Generic ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Associated Types

type Rep ListAliasesResponse :: Type -> Type #

Methods

from :: ListAliasesResponse -> Rep ListAliasesResponse x #

to :: Rep ListAliasesResponse x -> ListAliasesResponse #

NFData ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

Methods

rnf :: ListAliasesResponse -> () #

type Rep ListAliasesResponse Source # 
Instance details

Defined in Amazonka.WorkMail.ListAliases

type Rep ListAliasesResponse = D1 ('MetaData "ListAliasesResponse" "Amazonka.WorkMail.ListAliases" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAliasesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListAliasesResponse'

-> ListAliasesResponse 

Create a value of ListAliasesResponse 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:aliases:ListAliasesResponse', listAliasesResponse_aliases - The entity's paginated aliases.

$sel:nextToken:ListAliases', listAliasesResponse_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:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.

Response Lenses

listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [Text]) Source #

The entity's paginated aliases.

listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #

The response's http status code.