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

DeleteTemplateAlias

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

Request Syntax


DELETE /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AliasName

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

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

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

Required: Yes

AwsAccountId

The ID of the Amazon account that contains the item to delete.

Length Constraints: Fixed length of 12.

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

Required: Yes

TemplateId

The ID for the template that the specified alias is for.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "AliasName": "string",
   "Arn": "string",
   "RequestId": "string",
   "TemplateId": "string"
}

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.

AliasName

The name for the template alias.

Type: String

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

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

Arn

The Amazon Resource Name (ARN) of the template you want to delete.

Type: String

RequestId

The Amazon request ID for this operation.

Type: String

TemplateId

An ID for the template associated with the deletion.

Type: String

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

Pattern: [\w\-]+

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

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