create_template

QuickSight.Client.create_template(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'VersionArn': 'string',
    'TemplateId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) --
  • Arn (string) --

    The ARN for the template.

  • VersionArn (string) --

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

  • TemplateId (string) --

    The ID of the template.

  • CreationStatus (string) --

    The template creation status.

  • Status (integer) --

    The HTTP status of the request.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.ResourceExistsException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.LimitExceededException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.ConflictException
• QuickSight.Client.exceptions.InternalFailureException