[ aws . quicksight ]

describe-template

Description

Describes a template’s metadata.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-template
--aws-account-id <value>
--template-id <value>
[--version-number <value>]
[--alias-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the template that you’re describing.

--template-id (string)

The ID for the template.

--version-number (long)

(Optional) The number for the version to describe. If a VersionNumber parameter value isn’t provided, the latest version of the template is described.

--alias-name (string)

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn’t apply to templates.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

Template -> (structure)

The template structure for the object you want to describe.

Arn -> (string)

The Amazon Resource Name (ARN) of the template.

Name -> (string)

The display name of the template.

Version -> (structure)

A structure describing the versions of the template.

CreatedTime -> (timestamp)

The time that this template version was created.

Errors -> (list)

Errors associated with this template version.

(structure)

List of errors that occurred when the template version creation failed.

Type -> (string)

Type of error.

Message -> (string)

Description of the error type.

VersionNumber -> (long)

The version number of the template version.

Status -> (string)

The HTTP status of the request.

DataSetConfigurations -> (list)

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

(structure)

Dataset configuration.

Placeholder -> (string)

Placeholder.

DataSetSchema -> (structure)

Dataset schema.

ColumnSchemaList -> (list)

A structure containing the list of column schemas.

(structure)

The column schema.

Name -> (string)

The name of the column schema.

DataType -> (string)

The data type of the column schema.

GeographicRole -> (string)

The geographic role of the column schema.

ColumnGroupSchemaList -> (list)

A structure containing the list of column group schemas.

(structure)

The column group schema.

Name -> (string)

The name of the column group schema.

ColumnGroupColumnSchemaList -> (list)

A structure containing the list of schemas for column group columns.

(structure)

A structure describing the name, data type, and geographic role of the columns.

Name -> (string)

The name of the column group’s column schema.

Description -> (string)

The description of the template.

SourceEntityArn -> (string)

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

ThemeArn -> (string)

The ARN of the theme associated with this version of the template.

Sheets -> (list)

A list of the associated sheets with the unique identifier and name of each sheet.

(structure)

A sheet , which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

SheetId -> (string)

The unique identifier associated with a sheet.

Name -> (string)

The name of a sheet. This name is displayed on the sheet’s tab in the QuickSight console.

TemplateId -> (string)

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

LastUpdatedTime -> (timestamp)

Time when this was last updated.

CreatedTime -> (timestamp)

Time when this was created.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.