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

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

listAliases Source #

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

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

  • laNextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.
  • laMaxResults - The maximum number of results to return in a single call.
  • laOrganizationId - The identifier for the organization under which the entity exists.
  • laEntityId - The identifier for the entity for which to list the aliases.

data ListAliases Source #

See: listAliases smart constructor.

Instances
Eq ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Data ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Methods

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

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

toConstr :: ListAliases -> Constr #

dataTypeOf :: ListAliases -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Show ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Generic ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Associated Types

type Rep ListAliases :: Type -> Type #

Hashable ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

ToJSON ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

AWSPager ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

AWSRequest ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Associated Types

type Rs ListAliases :: Type #

ToHeaders ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Methods

toHeaders :: ListAliases -> [Header] #

ToPath ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

ToQuery ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

NFData ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Methods

rnf :: ListAliases -> () #

type Rep ListAliases Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

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

Defined in Network.AWS.WorkMail.ListAliases

Request Lenses

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

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

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

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

laOrganizationId :: Lens' ListAliases Text Source #

The identifier for the organization under which the entity exists.

laEntityId :: Lens' ListAliases Text Source #

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

Destructuring the Response

listAliasesResponse Source #

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

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

  • larsAliases - The entity's paginated aliases.
  • larsNextToken - The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
  • larsResponseStatus - -- | The response status code.

data ListAliasesResponse Source #

See: listAliasesResponse smart constructor.

Instances
Eq ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Data ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Methods

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

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

toConstr :: ListAliasesResponse -> Constr #

dataTypeOf :: ListAliasesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Show ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Generic ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Associated Types

type Rep ListAliasesResponse :: Type -> Type #

NFData ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

Methods

rnf :: ListAliasesResponse -> () #

type Rep ListAliasesResponse Source # 
Instance details

Defined in Network.AWS.WorkMail.ListAliases

type Rep ListAliasesResponse = D1 (MetaData "ListAliasesResponse" "Network.AWS.WorkMail.ListAliases" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" False) (C1 (MetaCons "ListAliasesResponse'" PrefixI True) (S1 (MetaSel (Just "_larsAliases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_larsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_larsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

larsAliases :: Lens' ListAliasesResponse [Text] Source #

The entity's paginated aliases.

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

larsResponseStatus :: Lens' ListAliasesResponse Int Source #

  • - | The response status code.