aws_sdk_quicksight/client/
delete_analysis.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteAnalysis`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account where you want to delete an analysis.</p><br>
7    ///   - [`analysis_id(impl Into<String>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::analysis_id) / [`set_analysis_id(Option<String>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::set_analysis_id):<br>required: **true**<br><p>The ID of the analysis that you're deleting.</p><br>
8    ///   - [`recovery_window_in_days(i64)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::recovery_window_in_days) / [`set_recovery_window_in_days(Option<i64>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::set_recovery_window_in_days):<br>required: **false**<br><p>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.</p><br>
9    ///   - [`force_delete_without_recovery(bool)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::force_delete_without_recovery) / [`set_force_delete_without_recovery(Option<bool>)`](crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::set_force_delete_without_recovery):<br>required: **false**<br><p>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.</p><br>
10    /// - On success, responds with [`DeleteAnalysisOutput`](crate::operation::delete_analysis::DeleteAnalysisOutput) with field(s):
11    ///   - [`status(i32)`](crate::operation::delete_analysis::DeleteAnalysisOutput::status): <p>The HTTP status of the request.</p>
12    ///   - [`arn(Option<String>)`](crate::operation::delete_analysis::DeleteAnalysisOutput::arn): <p>The Amazon Resource Name (ARN) of the deleted analysis.</p>
13    ///   - [`analysis_id(Option<String>)`](crate::operation::delete_analysis::DeleteAnalysisOutput::analysis_id): <p>The ID of the deleted analysis.</p>
14    ///   - [`deletion_time(Option<DateTime>)`](crate::operation::delete_analysis::DeleteAnalysisOutput::deletion_time): <p>The date and time that the analysis is scheduled to be deleted.</p>
15    ///   - [`request_id(Option<String>)`](crate::operation::delete_analysis::DeleteAnalysisOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
16    /// - On failure, responds with [`SdkError<DeleteAnalysisError>`](crate::operation::delete_analysis::DeleteAnalysisError)
17    pub fn delete_analysis(&self) -> crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder {
18        crate::operation::delete_analysis::builders::DeleteAnalysisFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_quicksight/client/delete_analysis.rs

aws_sdk_quicksight/client/
delete_analysis.rs
