analysis_definitions

Creates, updates, deletes, gets or lists an analysis_definitions resource.

Overview

Name	analysis_definitions
Type	Resource
Id	aws.quicksight.analysis_definitions

Fields

The following fields are returned by SELECT queries:

describe_analysis_definition

Name	Datatype	Description
analysis_id	string	The ID of the analysis described. (pattern: <code>[\w-]+</code>)
definition	object	The definition of an analysis.
errors	array	Errors associated with the analysis.
name	string	The descriptive name of the analysis.
request_id	string	The Amazon Web Services request ID for this operation.
resource_status	string	Status associated with the analysis. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)
status	integer	The HTTP status of the request.
theme_arn	string	The ARN of the theme of the analysis.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_analysis_definition	select	aws_account_id, analysis_id, region		Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
analysis_id	string	The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
aws_account_id	string	The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_analysis_definition

Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

SELECT
analysis_id,
definition,
errors,
name,
request_id,
resource_status,
status,
theme_arn
FROM aws.quicksight.analysis_definitions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND analysis_id = '{{ analysis_id }}' -- required
AND region = '{{ region }}' -- required
;