Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a collection of alias records for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Aliases are not listed in any particular order.
- listAliases :: ListAliases
- data ListAliases
- laRoutingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType)
- laNextToken :: Lens' ListAliases (Maybe Text)
- laName :: Lens' ListAliases (Maybe Text)
- laLimit :: Lens' ListAliases (Maybe Natural)
- listAliasesResponse :: Int -> ListAliasesResponse
- data ListAliasesResponse
- larsAliases :: Lens' ListAliasesResponse [Alias]
- larsNextToken :: Lens' ListAliasesResponse (Maybe Text)
- larsResponseStatus :: Lens' ListAliasesResponse Int
Creating a Request
listAliases :: 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:
data ListAliases Source #
Represents the input for a request action.
See: listAliases
smart constructor.
Request Lenses
laRoutingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType) Source #
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
- SIMPLE: The alias resolves to one specific fleet. Use this type when routing to active fleets.
- TERMINAL: The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
laNextToken :: Lens' ListAliases (Maybe Text) Source #
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
laName :: Lens' ListAliases (Maybe Text) Source #
Descriptive label associated with this alias. Alias names do not need to be unique.
laLimit :: Lens' ListAliases (Maybe Natural) Source #
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
Destructuring the Response
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:
data ListAliasesResponse Source #
Represents the returned data in response to a request action.
See: listAliasesResponse
smart constructor.
Response Lenses
larsAliases :: Lens' ListAliasesResponse [Alias] Source #
Collection of alias records that match the list request.
larsNextToken :: Lens' ListAliasesResponse (Maybe Text) Source #
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
larsResponseStatus :: Lens' ListAliasesResponse Int Source #
The response status code.