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

DescribeTemplateDefinition

Provides a detailed description of the definition of a template.

Note

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

Request Syntax


GET /accounts/AwsAccountId/templates/TemplateId/definition?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AliasName

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

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

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

AwsAccountId

The ID of the AWS account that contains the template. You must be using the AWS account that the template is in.

Length Constraints: Fixed length of 12.

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

Required: Yes

TemplateId

The ID of the template that you're describing.

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

Pattern: [\w\-]+

Required: Yes

VersionNumber

The version number of the template.

Valid Range: Minimum value of 1.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Definition": { 
      "AnalysisDefaults": { 
         "DefaultNewSheetConfiguration": { ... }
      },
      "CalculatedFields": [ 
         { ... }
      ],
      "ColumnConfigurations": [ 
         { ... }
      ],
      "DataSetConfigurations": [ 
         { ... }
      ],
      "FilterGroups": [ 
         { ... }
      ],
      "Options": { 
         "Timezone": "string",
         "WeekStart": "string"
      },
      "ParameterDeclarations": [ 
         { ... }
      ],
      "QueryExecutionOptions": { 
         "QueryExecutionMode": "string"
      },
      "Sheets": [ 
         { ... }
      ],
      "StaticFiles": [ 
         { ... }
      ]
   },
   "Errors": [ 
      { 
         "Message": "string",
         "Type": "string",
         "ViolatedEntities": [ 
            { 
               "Path": "string"
            }
         ]
      }
   ],
   "Name": "string",
   "RequestId": "string",
   "ResourceStatus": "string",
   "TemplateId": "string",
   "ThemeArn": "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.

Definition

The definition of the template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Type: TemplateVersionDefinition object

Errors

Errors associated with the template version.

Type: Array of TemplateError objects

Array Members: Minimum number of 1 item.

Name

The descriptive name of the template.

Type: String

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

RequestId

The AWS request ID for this operation.

Type: String

ResourceStatus

Status associated with the template.

CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED

Type: String

TemplateId

The ID of the template described.

Type: String

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

Pattern: [\w\-]+

ThemeArn

The ARN of the theme of the template.

Type: String

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

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