/AWS1/CL_QST=>CREATETEMPLATE()

About CreateTemplate

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.

Method Signature

IMPORTING

Required arguments:

IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

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.

IV_TEMPLATEID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

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.

Optional arguments:

IV_NAME TYPE /AWS1/QSTTEMPLATENAME /AWS1/QSTTEMPLATENAME

A display name for the template.

IT_PERMISSIONS TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST TT_RESOURCEPERMISSIONLIST

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

IO_SOURCEENTITY TYPE REF TO /AWS1/CL_QSTTMPLSOURCEENTITY /AWS1/CL_QSTTMPLSOURCEENTITY

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 Amazon QuickSight-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.

IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST TT_TAGLIST

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

IV_VERSIONDESCRIPTION TYPE /AWS1/QSTVERSIONDESCRIPTION /AWS1/QSTVERSIONDESCRIPTION

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

IO_DEFINITION TYPE REF TO /AWS1/CL_QSTTMPLVERSIONDEFN /AWS1/CL_QSTTMPLVERSIONDEFN

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.

IO_VALIDATIONSTRATEGY TYPE REF TO /AWS1/CL_QSTVALIDATIONSTRATEGY /AWS1/CL_QSTVALIDATIONSTRATEGY

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QSTCREATETMPLRESPONSE /AWS1/CL_QSTCREATETMPLRESPONSE