Template -

Template

A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an 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.

You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.

Contents

Note

In the following list, the required parameters are described first.

Arn

The Amazon Resource Name (ARN) of the template.

Type: String

Required: No

CreatedTime

Time when this was created.

Type: Timestamp

Required: No

LastUpdatedTime

Time when this was last updated.

Type: Timestamp

Required: No

Name

The display name of the template.

Type: String

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

Pattern: [\u0020-\u00FF]+

Required: No

TemplateId

The ID for the template. This is unique per AWS Region for each AWS account.

Type: String

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

Pattern: [\w\-]+

Required: No

Version

A structure describing the versions of the template.

Type: TemplateVersion object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: