| Copyright | (c) 2013-2021 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 |
Amazonka.GameLift.ListAliases
Description
Retrieves all aliases 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.
Returned aliases are not listed in any particular order.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
This operation returns paginated results.
Synopsis
- data ListAliases = ListAliases' {}
- newListAliases :: ListAliases
- listAliases_routingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType)
- listAliases_nextToken :: Lens' ListAliases (Maybe Text)
- listAliases_name :: Lens' ListAliases (Maybe Text)
- listAliases_limit :: Lens' ListAliases (Maybe Natural)
- data ListAliasesResponse = ListAliasesResponse' {}
- newListAliasesResponse :: Int -> ListAliasesResponse
- listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [Alias])
- listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text)
- listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int
Creating a Request
data ListAliases Source #
Represents the input for a request operation.
See: newListAliases smart constructor.
Constructors
| ListAliases' | |
Fields
| |
Instances
newListAliases :: ListAliases Source #
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:routingStrategyType:ListAliases', listAliases_routingStrategyType - The routing type to filter results on. Use this parameter to retrieve
only aliases with a certain routing type. To retrieve all aliases, leave
this parameter empty.
Possible routing types include the following:
- 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.
$sel:nextToken:ListAliases', listAliases_nextToken - A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
$sel:name:ListAliases', listAliases_name - A descriptive label that is associated with an alias. Alias names do not
need to be unique.
$sel:limit:ListAliases', listAliases_limit - The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
Request Lenses
listAliases_routingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType) Source #
The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
- 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.
listAliases_nextToken :: Lens' ListAliases (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
listAliases_name :: Lens' ListAliases (Maybe Text) Source #
A descriptive label that is associated with an alias. Alias names do not need to be unique.
listAliases_limit :: Lens' ListAliases (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
Destructuring the Response
data ListAliasesResponse Source #
Represents the returned data in response to a request operation.
See: newListAliasesResponse smart constructor.
Constructors
| ListAliasesResponse' | |
Fields
| |
Instances
newListAliasesResponse Source #
Arguments
| :: Int | |
| -> 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 - A collection of alias resources that match the request parameters.
$sel:nextToken:ListAliases', listAliasesResponse_nextToken - A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.
Response Lenses
listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [Alias]) Source #
A collection of alias resources that match the request parameters.
listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #
The response's http status code.