Skip to main content

analyses

Creates, updates, deletes or gets an analysis resource or lists analyses in a region

Overview

Nameanalyses
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Idaws.quicksight.analyses

Fields

NameDatatypeDescription
statusstring
created_timestring

The time that the analysis was created.

parametersobject

A list of Amazon QuickSight parameters and the list's override values.

data_set_arnsarray

The ARNs of the datasets of the analysis.

source_entityobject

The source entity of an analysis.

theme_arnstring

The ARN of the theme of the analysis.

definitionobject
last_updated_timestring

The time that the analysis was last updated.

validation_strategyobject

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.

namestring

The descriptive name of the analysis.

errorsarray

Errors associated with the analysis.

analysis_idstring
aws_account_idstring
permissionsarray
arnstring

The Amazon Resource Name (ARN) of the analysis.

tagsarray
sheetsarray

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

regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTAwsAccountId, AnalysisId, Name, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all analyses in a region.

SELECT
region,
status,
created_time,
parameters,
data_set_arns,
source_entity,
theme_arn,
definition,
last_updated_time,
validation_strategy,
name,
errors,
analysis_id,
aws_account_id,
permissions,
arn,
tags,
sheets
FROM aws.quicksight.analyses
WHERE region = 'us-east-1';

Gets all properties from an individual analysis.

SELECT
region,
status,
created_time,
parameters,
data_set_arns,
source_entity,
theme_arn,
definition,
last_updated_time,
validation_strategy,
name,
errors,
analysis_id,
aws_account_id,
permissions,
arn,
tags,
sheets
FROM aws.quicksight.analyses
WHERE region = 'us-east-1' AND data__Identifier = '<AnalysisId>|<AwsAccountId>';

INSERT example

Use the following StackQL query and manifest file to create a new analysis resource, using stack-deploy.

/*+ create */
INSERT INTO aws.quicksight.analyses (
Name,
AnalysisId,
AwsAccountId,
region
)
SELECT
'{{ Name }}',
'{{ AnalysisId }}',
'{{ AwsAccountId }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.analyses
WHERE data__Identifier = '<AnalysisId|AwsAccountId>'
AND region = 'us-east-1';

Permissions

To operate on the analyses resource, the following permissions are required:

Read

quicksight:DescribeAnalysis,
quicksight:DescribeAnalysisPermissions,
quicksight:ListTagsForResource

Create

quicksight:DescribeAnalysis,
quicksight:DescribeAnalysisPermissions,
quicksight:CreateAnalysis,
quicksight:DescribeTemplate,
quicksight:DescribeTheme,
quicksight:PassDataSet,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

Update

quicksight:DescribeAnalysis,
quicksight:DescribeAnalysisPermissions,
quicksight:UpdateAnalysis,
quicksight:UpdateAnalysisPermissions,
quicksight:DescribeTemplate,
quicksight:DescribeTheme,
quicksight:PassDataSet,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

List

quicksight:ListAnalyses

Delete

quicksight:DescribeAnalysis,
quicksight:DeleteAnalysis