1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::delete_analysis::_delete_analysis_output::DeleteAnalysisOutputBuilder;
pub use crate::operation::delete_analysis::_delete_analysis_input::DeleteAnalysisInputBuilder;
/// Fluent builder constructing a request to `DeleteAnalysis`.
///
/// <p>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.</p>
/// <p>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.</p>
/// <p>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.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteAnalysisFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::delete_analysis::builders::DeleteAnalysisInputBuilder,
}
impl DeleteAnalysisFluentBuilder {
/// Creates a new `DeleteAnalysis`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::delete_analysis::DeleteAnalysis,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::delete_analysis::DeleteAnalysisError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::delete_analysis::DeleteAnalysisOutput,
aws_smithy_http::result::SdkError<crate::operation::delete_analysis::DeleteAnalysisError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.aws_account_id(input.into());
self
}
/// <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
pub fn set_aws_account_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_aws_account_id(input);
self
}
/// <p>The ID of the analysis that you're deleting.</p>
pub fn analysis_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.analysis_id(input.into());
self
}
/// <p>The ID of the analysis that you're deleting.</p>
pub fn set_analysis_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_analysis_id(input);
self
}
/// <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>
pub fn recovery_window_in_days(mut self, input: i64) -> Self {
self.inner = self.inner.recovery_window_in_days(input);
self
}
/// <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>
pub fn set_recovery_window_in_days(mut self, input: std::option::Option<i64>) -> Self {
self.inner = self.inner.set_recovery_window_in_days(input);
self
}
/// <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>
pub fn force_delete_without_recovery(mut self, input: bool) -> Self {
self.inner = self.inner.force_delete_without_recovery(input);
self
}
/// <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>
pub fn set_force_delete_without_recovery(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_force_delete_without_recovery(input);
self
}
}