v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141341,3811.0 MB

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

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

Path parameters

AwsAccountIdstring required

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

TemplateIdstring required

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

Request body

Namestring

A display name for the template.

VersionDescriptionstring

A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.

Response

Success

Arnstring

The ARN for the template.

VersionArnstring

The ARN for the template, including the version information of the first version.

TemplateIdstring

The ID of the template.

CreationStatus'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED'

The template creation status.

Statusinteger

The HTTP status of the request.

RequestIdstring

The Amazon Web Services request ID for this operation.