| 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.UpdateAlias
Description
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
Synopsis
- data UpdateAlias = UpdateAlias' {}
- newUpdateAlias :: Text -> UpdateAlias
- updateAlias_routingStrategy :: Lens' UpdateAlias (Maybe RoutingStrategy)
- updateAlias_name :: Lens' UpdateAlias (Maybe Text)
- updateAlias_description :: Lens' UpdateAlias (Maybe Text)
- updateAlias_aliasId :: Lens' UpdateAlias Text
- data UpdateAliasResponse = UpdateAliasResponse' {
- alias :: Maybe Alias
- httpStatus :: Int
- newUpdateAliasResponse :: Int -> UpdateAliasResponse
- updateAliasResponse_alias :: Lens' UpdateAliasResponse (Maybe Alias)
- updateAliasResponse_httpStatus :: Lens' UpdateAliasResponse Int
Creating a Request
data UpdateAlias Source #
Represents the input for a request operation.
See: newUpdateAlias smart constructor.
Constructors
| UpdateAlias' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UpdateAlias |
Create a value of UpdateAlias 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:routingStrategy:UpdateAlias', updateAlias_routingStrategy - The routing configuration, including routing type and fleet target, for
the alias.
$sel:name:UpdateAlias', updateAlias_name - A descriptive label that is associated with an alias. Alias names do not
need to be unique.
$sel:description:UpdateAlias', updateAlias_description - A human-readable description of the alias.
$sel:aliasId:UpdateAlias', updateAlias_aliasId - A unique identifier for the alias that you want to update. You can use
either the alias ID or ARN value.
Request Lenses
updateAlias_routingStrategy :: Lens' UpdateAlias (Maybe RoutingStrategy) Source #
The routing configuration, including routing type and fleet target, for the alias.
updateAlias_name :: Lens' UpdateAlias (Maybe Text) Source #
A descriptive label that is associated with an alias. Alias names do not need to be unique.
updateAlias_description :: Lens' UpdateAlias (Maybe Text) Source #
A human-readable description of the alias.
updateAlias_aliasId :: Lens' UpdateAlias Text Source #
A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.
Destructuring the Response
data UpdateAliasResponse Source #
Represents the returned data in response to a request operation.
See: newUpdateAliasResponse smart constructor.
Constructors
| UpdateAliasResponse' | |
Fields
| |
Instances
newUpdateAliasResponse Source #
Arguments
| :: Int | |
| -> UpdateAliasResponse |
Create a value of UpdateAliasResponse 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:alias:UpdateAliasResponse', updateAliasResponse_alias - The updated alias resource.
$sel:httpStatus:UpdateAliasResponse', updateAliasResponse_httpStatus - The response's http status code.
Response Lenses
updateAliasResponse_alias :: Lens' UpdateAliasResponse (Maybe Alias) Source #
The updated alias resource.
updateAliasResponse_httpStatus :: Lens' UpdateAliasResponse Int Source #
The response's http status code.