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.
Idawscc.quicksight.analyses

Fields

NameDatatypeDescription
statusstring
created_timestring<p>The time that the analysis was created.</p>
parametersobject<p>A list of Amazon QuickSight parameters and the list's override values.</p>
data_set_arnsarray<p>The ARNs of the datasets of the analysis.</p>
source_entityobject<p>The source entity of an analysis.</p>
theme_arnstring<p>The ARN of the theme of the analysis.</p>
definitionobject
last_updated_timestring<p>The time that the analysis was last updated.</p>
validation_strategyobject<p>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 &#95;&#95;CODE&#95;BLOCK&#95;0&#95;&#95;, validation is skipped for specific errors.</p>
folder_arnsarray
namestring<p>The descriptive name of the analysis.</p>
errorsarray<p>Errors associated with the analysis.</p>
analysis_idstring
aws_account_idstring
permissionsarray
arnstring<p>The Amazon Resource Name (ARN) of the analysis.</p>
tagsarray
sheetsarray<p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
regionstringAWS region.

For more information, see AWS::QuickSight::Analysis.

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 properties from an individual analysis.

SELECT
region,
status,
created_time,
parameters,
data_set_arns,
source_entity,
theme_arn,
definition,
last_updated_time,
validation_strategy,
folder_arns,
name,
errors,
analysis_id,
aws_account_id,
permissions,
arn,
tags,
sheets
FROM awscc.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 awscc.quicksight.analyses (
Name,
AnalysisId,
AwsAccountId,
region
)
SELECT
'{{ Name }}',
'{{ AnalysisId }}',
'{{ AwsAccountId }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM awscc.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,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource

Update

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

List

quicksight:ListAnalyses

Delete

quicksight:DescribeAnalysis,
quicksight:DeleteAnalysis