| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.WorkMail.ListAliases
Description
Creates a paginated call to list the aliases associated with a given entity.
This operation returns paginated results.
Synopsis
- listAliases :: Text -> Text -> ListAliases
- data ListAliases
- laNextToken :: Lens' ListAliases (Maybe Text)
- laMaxResults :: Lens' ListAliases (Maybe Natural)
- laOrganizationId :: Lens' ListAliases Text
- laEntityId :: Lens' ListAliases Text
- listAliasesResponse :: Int -> ListAliasesResponse
- data ListAliasesResponse
- larsAliases :: Lens' ListAliasesResponse [Text]
- larsNextToken :: Lens' ListAliasesResponse (Maybe Text)
- larsResponseStatus :: Lens' ListAliasesResponse Int
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> 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 Source #
See: listAliases smart constructor.
Instances
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
Arguments
| :: Int | |
| -> 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 Source #
See: listAliasesResponse smart constructor.
Instances
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.