

# DeleteAnalysis


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.

## Request Syntax


```
DELETE /accounts/AwsAccountId/analyses/AnalysisId?force-delete-without-recovery=ForceDeleteWithoutRecovery&recovery-window-in-days=RecoveryWindowInDays HTTP/1.1
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [AnalysisId](#API_DeleteAnalysis_RequestSyntax) **   <a name="QS-DeleteAnalysis-request-uri-AnalysisId"></a>
The ID of the analysis that you're deleting.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `[\w\-]+`   
Required: Yes

 ** [AwsAccountId](#API_DeleteAnalysis_RequestSyntax) **   <a name="QS-DeleteAnalysis-request-uri-AwsAccountId"></a>
The ID of the AWS account where you want to delete an analysis.  
Length Constraints: Fixed length of 12.  
Pattern: `^[0-9]{12}$`   
Required: Yes

 ** [ForceDeleteWithoutRecovery](#API_DeleteAnalysis_RequestSyntax) **   <a name="QS-DeleteAnalysis-request-uri-ForceDeleteWithoutRecovery"></a>
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. 

 ** [RecoveryWindowInDays](#API_DeleteAnalysis_RequestSyntax) **   <a name="QS-DeleteAnalysis-request-uri-RecoveryWindowInDays"></a>
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.  
Valid Range: Minimum value of 7. Maximum value of 30.

## Request Body


The request does not have a request body.

## Response Syntax


```
HTTP/1.1 Status
Content-type: application/json

{
   "AnalysisId": "string",
   "Arn": "string",
   "DeletionTime": number,
   "RequestId": "string"
}
```

## Response Elements


If the action is successful, the service sends back the following HTTP response.

 ** [Status](#API_DeleteAnalysis_ResponseSyntax) **   <a name="QS-DeleteAnalysis-response-Status"></a>
The HTTP status of the request.

The following data is returned in JSON format by the service.

 ** [AnalysisId](#API_DeleteAnalysis_ResponseSyntax) **   <a name="QS-DeleteAnalysis-response-AnalysisId"></a>
The ID of the deleted analysis.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `[\w\-]+` 

 ** [Arn](#API_DeleteAnalysis_ResponseSyntax) **   <a name="QS-DeleteAnalysis-response-Arn"></a>
The Amazon Resource Name (ARN) of the deleted analysis.  
Type: String

 ** [DeletionTime](#API_DeleteAnalysis_ResponseSyntax) **   <a name="QS-DeleteAnalysis-response-DeletionTime"></a>
The date and time that the analysis is scheduled to be deleted.  
Type: Timestamp

 ** [RequestId](#API_DeleteAnalysis_ResponseSyntax) **   <a name="QS-DeleteAnalysis-response-RequestId"></a>
The AWS request ID for this operation.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.    
 ** RequestId **   
The AWS request ID for this request.
HTTP Status Code: 409

 ** InternalFailureException **   
An internal failure occurred.    
 ** RequestId **   
The AWS request ID for this request.
HTTP Status Code: 500

 ** InvalidParameterValueException **   
One or more parameters has a value that isn't valid.    
 ** RequestId **   
The AWS request ID for this request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
One or more resources can't be found.    
 ** RequestId **   
The AWS request ID for this request.  
 ** ResourceType **   
The resource type for this request.
HTTP Status Code: 404

 ** ThrottlingException **   
Access is throttled.    
 ** RequestId **   
The AWS request ID for this request.
HTTP Status Code: 429

 ** UnsupportedUserEditionException **   
This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.    
 ** RequestId **   
The AWS request ID for this request.
HTTP Status Code: 403

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DeleteAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DeleteAnalysis) 