amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

All APIs by task

Synopsis

Creating a Request

data UpdateAlias Source #

See: newUpdateAlias smart constructor.

Constructors

UpdateAlias' 

Fields

  • description :: Maybe Text

    A human-readable description of the alias.

  • name :: Maybe Text

    A descriptive label that is associated with an alias. Alias names do not need to be unique.

  • routingStrategy :: Maybe RoutingStrategy

    The routing configuration, including routing type and fleet target, for the alias.

  • aliasId :: Text

    A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.

Instances

Instances details
ToJSON UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

ToHeaders UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Methods

toHeaders :: UpdateAlias -> [Header] #

ToPath UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

ToQuery UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

AWSRequest UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Associated Types

type AWSResponse UpdateAlias #

Generic UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Associated Types

type Rep UpdateAlias :: Type -> Type #

Read UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Show UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

NFData UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Methods

rnf :: UpdateAlias -> () #

Eq UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Hashable UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

type AWSResponse UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

type Rep UpdateAlias Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

type Rep UpdateAlias = D1 ('MetaData "UpdateAlias" "Amazonka.GameLift.UpdateAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateAlias'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "routingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingStrategy)) :*: S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateAlias Source #

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:

UpdateAlias, updateAlias_description - A human-readable description of the alias.

UpdateAlias, updateAlias_name - A descriptive label that is associated with an alias. Alias names do not need to be unique.

UpdateAlias, updateAlias_routingStrategy - The routing configuration, including routing type and fleet target, for the alias.

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_description :: Lens' UpdateAlias (Maybe Text) Source #

A human-readable description of 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_routingStrategy :: Lens' UpdateAlias (Maybe RoutingStrategy) Source #

The routing configuration, including routing type and fleet target, for 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 #

See: newUpdateAliasResponse smart constructor.

Constructors

UpdateAliasResponse' 

Fields

Instances

Instances details
Generic UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Associated Types

type Rep UpdateAliasResponse :: Type -> Type #

Read UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Show UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

NFData UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

Methods

rnf :: UpdateAliasResponse -> () #

Eq UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

type Rep UpdateAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateAlias

type Rep UpdateAliasResponse = D1 ('MetaData "UpdateAliasResponse" "Amazonka.GameLift.UpdateAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateAliasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alias)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAliasResponse Source #

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