Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateTemplateAlias

Creates a template alias for a template.

Request Syntax


POST /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1
Content-type: application/json

{
   "TemplateVersionNumber": number
}

URI Request Parameters

The request uses the following URI parameters.

AliasName

The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.

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

Pattern: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

Required: Yes

AwsAccountId

The ID of the AWS account that contains the template that you creating an alias for.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

TemplateId

An ID for the template.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

TemplateVersionNumber

The version number of the template.

Type: Long

Valid Range: Minimum value of 1.

Required: Yes

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "TemplateAlias": { 
      "AliasName": "string",
      "Arn": "string",
      "TemplateVersionNumber": number
   }
}

Response Elements

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

Status: The HTTP status of the request.

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

RequestId

The AWS request ID for this operation.

Type: String

TemplateAlias

Information about the template alias.

Type: TemplateAlias object

Errors

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403