Network.AWS.WorkMail.ListAliases

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

This operation returns paginated results.

Creating a Request

listAliases

Arguments

:: Text

laOrganizationId

-> Text

laEntityId

-> ListAliases

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

See: listAliases smart constructor.

Instances

Eq ListAliases

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS ListAliases

readList :: ReadS [ListAliases]

readPrec :: ReadPrec ListAliases

readListPrec :: ReadPrec [ListAliases]

Show ListAliases

Methods

showsPrec :: Int -> ListAliases -> ShowS

show :: ListAliases -> String

showList :: [ListAliases] -> ShowS

Generic ListAliases

Associated Types

type Rep ListAliases :: * -> *

Methods

from :: ListAliases -> Rep ListAliases x

to :: Rep ListAliases x -> ListAliases

Hashable ListAliases

Methods

hashWithSalt :: Int -> ListAliases -> Int

hash :: ListAliases -> Int

ToJSON ListAliases

Methods

toJSON :: ListAliases -> Value

toEncoding :: ListAliases -> Encoding

toJSONList :: [ListAliases] -> Value

toEncodingList :: [ListAliases] -> Encoding

NFData ListAliases

Methods

rnf :: ListAliases -> ()

AWSPager ListAliases

Methods

page :: ListAliases -> Rs ListAliases -> Maybe ListAliases

AWSRequest ListAliases

Associated Types

type Rs ListAliases :: *

Methods

request :: ListAliases -> Request ListAliases

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

ToHeaders ListAliases

Methods

toHeaders :: ListAliases -> [Header]

ToPath ListAliases

Methods

toPath :: ListAliases -> ByteString

ToQuery ListAliases

Methods

toQuery :: ListAliases -> QueryString

type Rep ListAliases

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

type Rs ListAliases

type Rs ListAliases = ListAliasesResponse

Request Lenses

laNextToken :: Lens' ListAliases (Maybe Text)

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

laMaxResults :: Lens' ListAliases (Maybe Natural)

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

laOrganizationId :: Lens' ListAliases Text

The identifier for the organization under which the entity exists.

laEntityId :: Lens' ListAliases Text

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

Destructuring the Response

listAliasesResponse

Arguments

:: Int

larsResponseStatus

-> ListAliasesResponse

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

See: listAliasesResponse smart constructor.

Instances

Eq ListAliasesResponse

Methods

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

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

Data ListAliasesResponse

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

Methods

readsPrec :: Int -> ReadS ListAliasesResponse

readList :: ReadS [ListAliasesResponse]

readPrec :: ReadPrec ListAliasesResponse

readListPrec :: ReadPrec [ListAliasesResponse]

Show ListAliasesResponse

Methods

showsPrec :: Int -> ListAliasesResponse -> ShowS

show :: ListAliasesResponse -> String

showList :: [ListAliasesResponse] -> ShowS

Generic ListAliasesResponse

Associated Types

type Rep ListAliasesResponse :: * -> *

Methods

from :: ListAliasesResponse -> Rep ListAliasesResponse x

to :: Rep ListAliasesResponse x -> ListAliasesResponse

NFData ListAliasesResponse

Methods

rnf :: ListAliasesResponse -> ()

type Rep ListAliasesResponse

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

Response Lenses

larsAliases :: Lens' ListAliasesResponse [Text]

The entity's paginated aliases.

larsNextToken :: Lens' ListAliasesResponse (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.

larsResponseStatus :: Lens' ListAliasesResponse Int

• - | The response status code.