Skip to contents

Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template

Source: R/quicksight_operations.R
quicksight_create_template.Rd

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

See https://www.paws-r-sdk.com/docs/quicksight_create_template/ for full documentation.

Usage

quicksight_create_template(
  AwsAccountId,
  TemplateId,
  Name = NULL,
  Permissions = NULL,
  SourceEntity = NULL,
  Tags = NULL,
  VersionDescription = NULL,
  Definition = NULL,
  ValidationStrategy = NULL
)

Arguments

AwsAccountId

[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 Quick Sight account.

TemplateId

[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.

Name

A display name for the template.

Permissions

A list of resource permissions to be set on the template.

SourceEntity

The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

VersionDescription

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

Definition

The definition of a template.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

ValidationStrategy

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.