analysis

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

Overview

Name	analysis
Type	Resource
Id	aws.quicksight.analysis

Fields

The following fields are returned by SELECT queries:

describe_analysis

Name	Datatype	Description
analysis	object	A metadata structure that contains summary information for the analysis that you're describing.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_analysis	select	aws_account_id, analysis_id, region		Provides a summary of the metadata for an analysis.
create_analysis	insert	aws_account_id, analysis_id, region, Name		Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
update_analysis	update	aws_account_id, analysis_id, region, Name		Updates an analysis in Amazon Quick Sight
delete_analysis	delete	aws_account_id, analysis_id, region	recovery-window-in-days, force-delete-without-recovery	Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
restore_analysis	exec	aws_account_id, analysis_id, region	restore-to-folders	Restores an analysis.

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 restoring.
aws_account_id	string	The ID of the Amazon Web Services account that contains the analysis.
region	string	AWS region (default: us-east-1)
force-delete-without-recovery	boolean	This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
recovery-window-in-days	integer (int64)	A value that specifies the number of days that Amazon Quick Sight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
restore-to-folders	boolean	A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

SELECT examples

describe_analysis

Provides a summary of the metadata for an analysis.

SELECT
analysis,
request_id,
status
FROM aws.quicksight.analysis
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND analysis_id = '{{ analysis_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_analysis

Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.

INSERT INTO aws.quicksight.analysis (
Name,
Parameters,
Permissions,
SourceEntity,
ThemeArn,
Tags,
Definition,
ValidationStrategy,
FolderArns,
aws_account_id,
analysis_id,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Parameters }}',
'{{ Permissions }}',
'{{ SourceEntity }}',
'{{ ThemeArn }}',
'{{ Tags }}',
'{{ Definition }}',
'{{ ValidationStrategy }}',
'{{ FolderArns }}',
'{{ aws_account_id }}',
'{{ analysis_id }}',
'{{ region }}'
RETURNING
analysis_id,
arn,
creation_status,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: analysis
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the analysis resource.
  - name: analysis_id
    value: "{{ analysis_id }}"
    description: Required parameter for the analysis resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the analysis resource.
  - name: Name
    value: "{{ Name }}"
  - name: Parameters
    description: |
      A list of Quick Sight parameters and the list's override values.
    value:
      StringParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      IntegerParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      DecimalParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
      DateTimeParameters:
        - Name: "{{ Name }}"
          Values: "{{ Values }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: SourceEntity
    description: |
      The source entity of an analysis.
    value:
      SourceTemplate:
        DataSetReferences:
          - DataSetPlaceholder: "{{ DataSetPlaceholder }}"
            DataSetArn: "{{ DataSetArn }}"
        TopicReferences:
          - TopicPlaceholder: "{{ TopicPlaceholder }}"
            TopicArn: "{{ TopicArn }}"
        Arn: "{{ Arn }}"
  - name: ThemeArn
    value: "{{ ThemeArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Definition
    description: |
      The definition of an analysis.
    value:
      DataSetIdentifierDeclarations:
        - Identifier: "{{ Identifier }}"
          DataSetArn: "{{ DataSetArn }}"
      TopicIdentifierDeclarations:
        - Identifier: "{{ Identifier }}"
          TopicArn: "{{ TopicArn }}"
      Sheets:
        - SheetId: "{{ SheetId }}"
          Title: "{{ Title }}"
          Description: "{{ Description }}"
          Name: "{{ Name }}"
          ParameterControls: "{{ ParameterControls }}"
          FilterControls: "{{ FilterControls }}"
          Visuals: "{{ Visuals }}"
          TextBoxes: "{{ TextBoxes }}"
          Images: "{{ Images }}"
          Layouts: "{{ Layouts }}"
          SheetControlLayouts: "{{ SheetControlLayouts }}"
          ContentType: "{{ ContentType }}"
          CustomActionDefaults:
            highlightOperation:
              Trigger: "{{ Trigger }}"
      TooltipSheets:
        - SheetId: "{{ SheetId }}"
          Name: "{{ Name }}"
          Visuals: "{{ Visuals }}"
          TextBoxes: "{{ TextBoxes }}"
          Images: "{{ Images }}"
          Layouts: "{{ Layouts }}"
      CalculatedFields:
        - DataSetIdentifier: "{{ DataSetIdentifier }}"
          TopicIdentifier: "{{ TopicIdentifier }}"
          Name: "{{ Name }}"
          Expression: "{{ Expression }}"
      ParameterDeclarations:
        - StringParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - "{{ StaticValues }}"
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: "{{ CustomValue }}"
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          DecimalParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - {{ StaticValues }}
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: {{ CustomValue }}
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          IntegerParameterDeclaration:
            ParameterValueType: "{{ ParameterValueType }}"
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - {{ StaticValues }}
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: {{ CustomValue }}
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
          DateTimeParameterDeclaration:
            Name: "{{ Name }}"
            DefaultValues:
              DynamicValue:
                UserNameColumn: "{{ UserNameColumn }}"
                GroupNameColumn: "{{ GroupNameColumn }}"
                DefaultValueColumn: "{{ DefaultValueColumn }}"
              StaticValues:
                - "{{ StaticValues }}"
              RollingDate:
                DataSetIdentifier: "{{ DataSetIdentifier }}"
                Expression: "{{ Expression }}"
            TimeGranularity: "{{ TimeGranularity }}"
            ValueWhenUnset:
              ValueWhenUnsetOption: "{{ ValueWhenUnsetOption }}"
              CustomValue: "{{ CustomValue }}"
            MappedDataSetParameters:
              - DataSetIdentifier: "{{ DataSetIdentifier }}"
                DataSetParameterName: "{{ DataSetParameterName }}"
      FilterGroups:
        - FilterGroupId: "{{ FilterGroupId }}"
          Filters: "{{ Filters }}"
          ScopeConfiguration:
            SelectedSheets:
              SheetVisualScopingConfigurations:
                - SheetId: "{{ SheetId }}"
                  Scope: "{{ Scope }}"
                  VisualIds: "{{ VisualIds }}"
            AllSheets: "{{ AllSheets }}"
          Status: "{{ Status }}"
          CrossDataset: "{{ CrossDataset }}"
      ColumnConfigurations:
        - Column:
            DataSetIdentifier: "{{ DataSetIdentifier }}"
            TopicIdentifier: "{{ TopicIdentifier }}"
            ColumnName: "{{ ColumnName }}"
          FormatConfiguration:
            StringFormatConfiguration:
              NullValueFormatConfiguration:
                NullString: "{{ NullString }}"
              NumericFormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
            NumberFormatConfiguration:
              FormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
            DateTimeFormatConfiguration:
              DateTimeFormat: "{{ DateTimeFormat }}"
              NullValueFormatConfiguration:
                NullString: "{{ NullString }}"
              NumericFormatConfiguration:
                NumberDisplayFormatConfiguration: "{{ NumberDisplayFormatConfiguration }}"
                CurrencyDisplayFormatConfiguration: "{{ CurrencyDisplayFormatConfiguration }}"
                PercentageDisplayFormatConfiguration: "{{ PercentageDisplayFormatConfiguration }}"
          Role: "{{ Role }}"
          ColorsConfiguration:
            CustomColors:
              - FieldValue: "{{ FieldValue }}"
                Color: "{{ Color }}"
                SpecialValue: "{{ SpecialValue }}"
          DecalSettingsConfiguration:
            CustomDecalSettings:
              - ElementValue: "{{ ElementValue }}"
                DecalVisibility: "{{ DecalVisibility }}"
                DecalColor: "{{ DecalColor }}"
                DecalPatternType: "{{ DecalPatternType }}"
                DecalStyleType: "{{ DecalStyleType }}"
      AnalysisDefaults:
        DefaultNewSheetConfiguration:
          InteractiveLayoutConfiguration:
            Grid:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
            FreeForm:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
          PaginatedLayoutConfiguration:
            SectionBased:
              CanvasSizeOptions: "{{ CanvasSizeOptions }}"
          SheetContentType: "{{ SheetContentType }}"
      Options:
        Timezone: "{{ Timezone }}"
        WeekStart: "{{ WeekStart }}"
        QBusinessInsightsStatus: "{{ QBusinessInsightsStatus }}"
        ExcludedDataSetArns:
          - "{{ ExcludedDataSetArns }}"
        CustomActionDefaults:
          highlightOperation:
            Trigger: "{{ Trigger }}"
        VisualMessages:
          NoDataMessage:
            Enabled: {{ Enabled }}
            Title: "{{ Title }}"
            TitleVisibility: "{{ TitleVisibility }}"
            Description: "{{ Description }}"
            DescriptionVisibility: "{{ DescriptionVisibility }}"
            LinkText: "{{ LinkText }}"
            LinkUrl: "{{ LinkUrl }}"
            LinkVisibility: "{{ LinkVisibility }}"
      QueryExecutionOptions:
        QueryExecutionMode: "{{ QueryExecutionMode }}"
      StaticFiles:
        - ImageStaticFile:
            StaticFileId: "{{ StaticFileId }}"
            Source:
              UrlOptions:
                Url: "{{ Url }}"
              S3Options:
                BucketName: "{{ BucketName }}"
                ObjectKey: "{{ ObjectKey }}"
                Region: "{{ Region }}"
          SpatialStaticFile:
            StaticFileId: "{{ StaticFileId }}"
            Source:
              UrlOptions:
                Url: "{{ Url }}"
              S3Options:
                BucketName: "{{ BucketName }}"
                ObjectKey: "{{ ObjectKey }}"
                Region: "{{ Region }}"
  - name: ValidationStrategy
    description: |
      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.
    value:
      Mode: "{{ Mode }}"
  - name: FolderArns
    value:
      - "{{ FolderArns }}"

UPDATE examples

update_analysis

Updates an analysis in Amazon Quick Sight

UPDATE aws.quicksight.analysis
SET 
Name = '{{ Name }}',
Parameters = '{{ Parameters }}',
SourceEntity = '{{ SourceEntity }}',
ThemeArn = '{{ ThemeArn }}',
Definition = '{{ Definition }}',
ValidationStrategy = '{{ ValidationStrategy }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND analysis_id = '{{ analysis_id }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
RETURNING
analysis_id,
arn,
request_id,
status,
update_status;

DELETE examples

delete_analysis

Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

DELETE FROM aws.quicksight.analysis
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND analysis_id = '{{ analysis_id }}' --required
AND region = '{{ region }}' --required
AND `recovery-window-in-days` = '{{ recovery-window-in-days }}'
AND `force-delete-without-recovery` = '{{ force-delete-without-recovery }}'
;

Lifecycle Methods

restore_analysis

Restores an analysis.

EXEC aws.quicksight.analysis.restore_analysis 
@aws_account_id='{{ aws_account_id }}' --required, 
@analysis_id='{{ analysis_id }}' --required, 
@region='{{ region }}' --required, 
@restore-to-folders={{ restore-to-folders }}
;