DeleteAnalysisCommand

Use a bare-bones client and the command you need to make an API call.

DeleteAnalysisCommandInput

[DeleteAnalysisCommandInput](@aws-sdk/client-quicksight!DeleteAnalysisCommandInput:Interface)

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 <code>DeletionTime</code> 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 <code>RestoreAnalysis</code> API operation to remove the <code>DeletionTime</code> 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.

AnalysisId

The ID of the analysis that you're deleting.

AwsAccountId

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

ForceDeleteWithoutRecovery

This option defaults to the value <code>NoForceDeleteWithoutRecovery</code>. To immediately delete the analysis, add the <code>ForceDeleteWithoutRecovery</code> option. You can't restore an analysis after it's deleted.

RecoveryWindowInDays

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 <code>ForceDeleteWithoutRecovery</code> option in the same API call. The default value is 30.

The input for [DeleteAnalysisCommand](@aws-sdk/client-quicksight!DeleteAnalysisCommand:Class).

$metadata

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

DeletionTime

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

RequestId

The Amazon Web Services request ID for this operation.

Status

DeleteAnalysisCommandOutput

The output of [DeleteAnalysisCommand](@aws-sdk/client-quicksight!DeleteAnalysisCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

Message

The Amazon Web Services request ID for this request.

name

ConflictException

Updating or deleting a resource can cause an inconsistent state.

InternalFailureException

InvalidParameterValueException

One or more parameters has a value that isn't valid.

ResourceType

The resource type for this request.

ResourceNotFoundException

One or more resources can't be found.

ThrottlingException

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

QuickSightServiceException

Base exception class for all service exceptions from QuickSight service.