Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

Related actions

All APIs by task

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

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

Type: String

Pattern: ^alias-\S+|^arn:.*:alias\/alias-\S+

Required: Yes

Description

A human-readable description of the alias.

Type: String

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

Required: No

Name

A 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

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

The updated alias resource.

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

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

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

HTTP Status Code: 400