analyses

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

Overview

Name	analyses
Type	Resource
Id	aws.quicksight.analyses

Fields

The following fields are returned by SELECT queries:

search_analyses

Name	Datatype	Description
analysis_id	string	The ID of the analysis. This ID displays in the URL. (pattern: <code>[\w-]+</code>)
arn	string	The Amazon Resource Name (ARN) for the analysis.
created_time	string (date-time)	The time that the analysis was created.
last_updated_time	string (date-time)	The time that the analysis was last updated.
name	string	The name of the analysis. This name is displayed in the Quick Sight console.
status	string	The last known status for the analysis. (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)

list_analyses

Name	Datatype	Description
analysis_id	string	The ID of the analysis. This ID displays in the URL. (pattern: <code>[\w-]+</code>)
arn	string	The Amazon Resource Name (ARN) for the analysis.
created_time	string (date-time)	The time that the analysis was created.
last_updated_time	string (date-time)	The time that the analysis was last updated.
name	string	The name of the analysis. This name is displayed in the Quick Sight console.
status	string	The last known status for the analysis. (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_analyses	select	aws_account_id, region		Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
list_analyses	select	aws_account_id, region	next-token, max-results	Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.

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
aws_account_id	string	The ID of the Amazon Web Services account that contains the analyses.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return.
next-token	string	A pagination token that can be used in a subsequent request.

SELECT examples

search_analyses

Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

SELECT
analysis_id,
arn,
created_time,
last_updated_time,
name,
status
FROM aws.quicksight.analyses
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_analyses

Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.

SELECT
analysis_id,
arn,
created_time,
last_updated_time,
name,
status
FROM aws.quicksight.analyses
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;