AWS::QuickSight::Analysis - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::QuickSight::Analysis

Creates an analysis in Amazon QuickSight.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::Analysis",
  "Properties" : {
      "AnalysisId" : String,
      "AwsAccountId" : String,
      "Errors" : [ AnalysisError, ... ],
      "Name" : String,
      "Parameters" : Parameters,
      "Permissions" : [ ResourcePermission, ... ],
      "SourceEntity" : AnalysisSourceEntity,
      "Tags" : [ Tag, ... ],
      "ThemeArn" : String
    }
}

YAML

Type: AWS::QuickSight::Analysis
Properties: 
  AnalysisId: String
  AwsAccountId: String
  Errors: 
    - AnalysisError
  Name: String
  Parameters: 
    Parameters
  Permissions: 
    - ResourcePermission
  SourceEntity: 
    AnalysisSourceEntity
  Tags: 
    - Tag
  ThemeArn: String

Properties

AnalysisId

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

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Pattern: [\w\-]+

Update requires: Replacement

AwsAccountId

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

Required: Yes

Type: String

Minimum: 12

Maximum: 12

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

Update requires: Replacement

Errors

Property description not available.

Required: No

Type: List of AnalysisError

Update requires: No interruption

Name

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

Required: No

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 Amazon 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: List of ResourcePermission

Maximum: 64

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.

Required: Yes

Type: AnalysisSourceEntity

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: List of Tag

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 QuickSight console, make sure that you have access to it.

Required: No

Type: String

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the analysis.

CreatedTime

Property description not available.

DataSetArns

The ARNs of the datasets of the analysis.

LastUpdatedTime

The time that the analysis was last updated.