| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.QuickSight.DeleteAnalysis
Description
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.
Synopsis
- data DeleteAnalysis = DeleteAnalysis' {}
- newDeleteAnalysis :: Text -> Text -> DeleteAnalysis
- deleteAnalysis_recoveryWindowInDays :: Lens' DeleteAnalysis (Maybe Natural)
- deleteAnalysis_forceDeleteWithoutRecovery :: Lens' DeleteAnalysis (Maybe Bool)
- deleteAnalysis_awsAccountId :: Lens' DeleteAnalysis Text
- deleteAnalysis_analysisId :: Lens' DeleteAnalysis Text
- data DeleteAnalysisResponse = DeleteAnalysisResponse' {}
- newDeleteAnalysisResponse :: Int -> DeleteAnalysisResponse
- deleteAnalysisResponse_requestId :: Lens' DeleteAnalysisResponse (Maybe Text)
- deleteAnalysisResponse_analysisId :: Lens' DeleteAnalysisResponse (Maybe Text)
- deleteAnalysisResponse_arn :: Lens' DeleteAnalysisResponse (Maybe Text)
- deleteAnalysisResponse_deletionTime :: Lens' DeleteAnalysisResponse (Maybe UTCTime)
- deleteAnalysisResponse_status :: Lens' DeleteAnalysisResponse Int
Creating a Request
data DeleteAnalysis Source #
See: newDeleteAnalysis smart constructor.
Constructors
| DeleteAnalysis' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteAnalysis |
Create a value of DeleteAnalysis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recoveryWindowInDays:DeleteAnalysis', deleteAnalysis_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
ForceDeleteWithoutRecovery option in the same API call. The default
value is 30.
$sel:forceDeleteWithoutRecovery:DeleteAnalysis', deleteAnalysis_forceDeleteWithoutRecovery - 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.
$sel:awsAccountId:DeleteAnalysis', deleteAnalysis_awsAccountId - The ID of the Amazon Web Services account where you want to delete an
analysis.
$sel:analysisId:DeleteAnalysis', deleteAnalysis_analysisId - The ID of the analysis that you're deleting.
Request Lenses
deleteAnalysis_recoveryWindowInDays :: Lens' DeleteAnalysis (Maybe Natural) Source #
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.
deleteAnalysis_forceDeleteWithoutRecovery :: Lens' DeleteAnalysis (Maybe Bool) Source #
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.
deleteAnalysis_awsAccountId :: Lens' DeleteAnalysis Text Source #
The ID of the Amazon Web Services account where you want to delete an analysis.
deleteAnalysis_analysisId :: Lens' DeleteAnalysis Text Source #
The ID of the analysis that you're deleting.
Destructuring the Response
data DeleteAnalysisResponse Source #
See: newDeleteAnalysisResponse smart constructor.
Constructors
| DeleteAnalysisResponse' | |
Fields
| |
Instances
newDeleteAnalysisResponse Source #
Arguments
| :: Int | |
| -> DeleteAnalysisResponse |
Create a value of DeleteAnalysisResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestId:DeleteAnalysisResponse', deleteAnalysisResponse_requestId - The Amazon Web Services request ID for this operation.
$sel:analysisId:DeleteAnalysis', deleteAnalysisResponse_analysisId - The ID of the deleted analysis.
$sel:arn:DeleteAnalysisResponse', deleteAnalysisResponse_arn - The Amazon Resource Name (ARN) of the deleted analysis.
$sel:deletionTime:DeleteAnalysisResponse', deleteAnalysisResponse_deletionTime - The date and time that the analysis is scheduled to be deleted.
$sel:status:DeleteAnalysisResponse', deleteAnalysisResponse_status - The HTTP status of the request.
Response Lenses
deleteAnalysisResponse_requestId :: Lens' DeleteAnalysisResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
deleteAnalysisResponse_analysisId :: Lens' DeleteAnalysisResponse (Maybe Text) Source #
The ID of the deleted analysis.
deleteAnalysisResponse_arn :: Lens' DeleteAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deleted analysis.
deleteAnalysisResponse_deletionTime :: Lens' DeleteAnalysisResponse (Maybe UTCTime) Source #
The date and time that the analysis is scheduled to be deleted.
deleteAnalysisResponse_status :: Lens' DeleteAnalysisResponse Int Source #
The HTTP status of the request.