GET

/accounts/{AwsAccountId}/templates/{TemplateId}

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

Describes a template's metadata.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

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

TemplateIdstringrequired

The ID for the template.

Query Params

version-numberinteger

(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the template is described.

alias-namestring

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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.

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 GET \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/templates/{TemplateId}' \
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}