AWS::QuickSight::Analysis - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::Analysis

Creates an analysis in Amazon QuickSight.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QuickSight::Analysis",
  "Properties" : {
      "AnalysisId" : String,
      "AwsAccountId" : String,
      "Definition" : AnalysisDefinition,
      "Errors" : [ AnalysisError, ... ],
      "FolderArns" : [ String, ... ],
      "Name" : String,
      "Parameters" : Parameters,
      "Permissions" : [ ResourcePermission, ... ],
      "Sheets" : [ Sheet, ... ],
      "SourceEntity" : AnalysisSourceEntity,
      "Status" : String,
      "Tags" : [ Tag, ... ],
      "ThemeArn" : String,
      "ValidationStrategy" : ValidationStrategy
    }
}

Properties

AnalysisId

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: Replacement

AwsAccountId

The ID of the AWS account where you are creating an analysis.

Required: Yes

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

Definition

Property description not available.

Required: No

Type: AnalysisDefinition

Update requires: No interruption

Errors

Errors associated with the analysis.

Required: No

Type: Array of AnalysisError

Minimum: 1

Update requires: No interruption

FolderArns

Property description not available.

Required: No

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

Name

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Parameters

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Required: No

Type: Parameters

Update requires: No interruption

Permissions

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Required: No

Type: Array of ResourcePermission

Minimum: 1

Maximum: 64

Update requires: No interruption

Sheets

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

Required: No

Type: Array of Sheet

Minimum: 0

Maximum: 20

Update requires: No interruption

SourceEntity

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Required: No

Type: AnalysisSourceEntity

Update requires: No interruption

Status

Status associated with the analysis.

Required: No

Type: String

Allowed values: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | PENDING_UPDATE | DELETED

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

ThemeArn

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

Required: No

Type: String

Update requires: No interruption

ValidationStrategy

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

Required: No

Type: ValidationStrategy

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the analysis.

CreatedTime

The time that the analysis was created.

DataSetArns

The ARNs of the datasets of the analysis.

LastUpdatedTime

The time that the analysis was last updated.