Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

UpdateAlias

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.

Alias-related operations include:

Request Syntax

{
   "AliasId": "string",
   "Description": "string",
   "Name": "string",
   "RoutingStrategy": { 
      "FleetId": "string",
      "Message": "string",
      "Type": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

AliasId

Unique identifier for a fleet alias. Specify the alias you want to update.

Type: String

Pattern: ^alias-\S+

Required: Yes

Description

Human-readable description of an alias.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Required: No

RoutingStrategy

Object that specifies the fleet and routing type to use for the alias.

Type: RoutingStrategy object

Required: No

Response Syntax

{
   "Alias": { 
      "AliasArn": "string",
      "AliasId": "string",
      "CreationTime": number,
      "Description": "string",
      "LastUpdatedTime": number,
      "Name": "string",
      "RoutingStrategy": { 
         "FleetId": "string",
         "Message": "string",
         "Type": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Alias

Object that contains the updated alias configuration.

Type: Alias object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: