Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

update-template

Description

Updates a template from an existing Amazon QuickSight analysis or another template.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-template
--aws-account-id <value>
--template-id <value>
--source-entity <value>
[--version-description <value>]
[--name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the template that you're updating.

--template-id (string)

The ID for the template.

--source-entity (structure)

The entity that you are using as a source when you update 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 AWS Account and any QuickSight-supported AWS 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.

SourceAnalysis -> (structure)

The source analysis, if it is based on an analysis.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

DataSetReferences -> (list)

A structure containing information about the dataset references used as placeholders in the template.

(structure)

Dataset reference.

DataSetPlaceholder -> (string)

Dataset placeholder.

DataSetArn -> (string)

Dataset Amazon Resource Name (ARN).

SourceTemplate -> (structure)

The source template, if it is based on an template.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

JSON Syntax:

{
  "SourceAnalysis": {
    "Arn": "string",
    "DataSetReferences": [
      {
        "DataSetPlaceholder": "string",
        "DataSetArn": "string"
      }
      ...
    ]
  },
  "SourceTemplate": {
    "Arn": "string"
  }
}

--version-description (string)

A description of the current template version that is being updated. Every time you call UpdateTemplate , you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

--name (string)

The name for the template.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

TemplateId -> (string)

The ID for the template.

Arn -> (string)

The Amazon Resource Name (ARN) for the template.

VersionArn -> (string)

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

CreationStatus -> (string)

The creation status of the template.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.