QuickSight / Client / delete_analysis

delete_analysis#

QuickSight.Client.delete_analysis(**kwargs)#

Deletes an analysis from Amazon QuickSight. 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 QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight 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 QuickSight console. To access it in the console, restore it. Deleting an analysis doesn’t delete the dashboards that you publish from it.

See also: AWS API Documentation

Request Syntax

response = client.delete_analysis(
    AwsAccountId='string',
    AnalysisId='string',
    RecoveryWindowInDays=123,
    ForceDeleteWithoutRecovery=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account where you want to delete an analysis.

  • AnalysisId (string) –

    [REQUIRED]

    The ID of the analysis that you’re deleting.

  • RecoveryWindowInDays (integer) – A value that specifies the number of days that Amazon QuickSight 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.

  • ForceDeleteWithoutRecovery (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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'AnalysisId': 'string',
    'DeletionTime': datetime(2015, 1, 1),
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the deleted analysis.

    • AnalysisId (string) –

      The ID of the deleted analysis.

    • DeletionTime (datetime) –

      The date and time that the analysis is scheduled to be deleted.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException