PUT

/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}

Updates the template alias of a template.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The ID of the Amazon Web Services account that contains the template alias that you're updating.

TemplateIdstringrequired

The ID for the template.

AliasNamestringrequired

The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.

Body Params

TemplateVersionNumberintegerrequired

The version number of the template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}