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 ]

describe-analysis

Description

Provides a summary of the metadata for an analysis.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-analysis
--aws-account-id <value>
--analysis-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.

--analysis-id (string)

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

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

Analysis -> (structure)

A metadata structure that contains summary information for the analysis that you're describing.

AnalysisId -> (string)

The ID of the analysis.

Arn -> (string)

The Amazon Resource Name (ARN) of the analysis.

Name -> (string)

The descriptive name of the analysis.

Status -> (string)

Status associated with the analysis.

Errors -> (list)

Errors associated with the analysis.

(structure)

A metadata error structure for an analysis.

Type -> (string)

The type of the analysis error.

Message -> (string)

The message associated with the analysis error.

DataSetArns -> (list)

The ARNs of the datasets of the analysis.

(string)

ThemeArn -> (string)

The ARN of the theme of the analysis.

CreatedTime -> (timestamp)

The time that the analysis was created.

LastUpdatedTime -> (timestamp)

The time that the analysis was last updated.

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.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.