aws_sdk_quicksight/operation/delete_analysis/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_analysis::_delete_analysis_output::DeleteAnalysisOutputBuilder;
3
4pub use crate::operation::delete_analysis::_delete_analysis_input::DeleteAnalysisInputBuilder;
5
6impl crate::operation::delete_analysis::builders::DeleteAnalysisInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::delete_analysis::DeleteAnalysisOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::delete_analysis::DeleteAnalysisError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.delete_analysis();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeleteAnalysis`.
24///
25/// <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>
26/// <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>
27/// <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>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DeleteAnalysisFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::delete_analysis::builders::DeleteAnalysisInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::delete_analysis::DeleteAnalysisOutput,
37        crate::operation::delete_analysis::DeleteAnalysisError,
38    > for DeleteAnalysisFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::delete_analysis::DeleteAnalysisOutput,
46            crate::operation::delete_analysis::DeleteAnalysisError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DeleteAnalysisFluentBuilder {
53    /// Creates a new `DeleteAnalysisFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the DeleteAnalysis as a reference.
62    pub fn as_input(&self) -> &crate::operation::delete_analysis::builders::DeleteAnalysisInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::delete_analysis::DeleteAnalysisOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::delete_analysis::DeleteAnalysisError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::delete_analysis::DeleteAnalysis::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::delete_analysis::DeleteAnalysis::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::delete_analysis::DeleteAnalysisOutput,
99        crate::operation::delete_analysis::DeleteAnalysisError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
114    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.aws_account_id(input.into());
116        self
117    }
118    /// <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
119    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_aws_account_id(input);
121        self
122    }
123    /// <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
124    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_aws_account_id()
126    }
127    /// <p>The ID of the analysis that you're deleting.</p>
128    pub fn analysis_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.analysis_id(input.into());
130        self
131    }
132    /// <p>The ID of the analysis that you're deleting.</p>
133    pub fn set_analysis_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_analysis_id(input);
135        self
136    }
137    /// <p>The ID of the analysis that you're deleting.</p>
138    pub fn get_analysis_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_analysis_id()
140    }
141    /// <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>
142    pub fn recovery_window_in_days(mut self, input: i64) -> Self {
143        self.inner = self.inner.recovery_window_in_days(input);
144        self
145    }
146    /// <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>
147    pub fn set_recovery_window_in_days(mut self, input: ::std::option::Option<i64>) -> Self {
148        self.inner = self.inner.set_recovery_window_in_days(input);
149        self
150    }
151    /// <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>
152    pub fn get_recovery_window_in_days(&self) -> &::std::option::Option<i64> {
153        self.inner.get_recovery_window_in_days()
154    }
155    /// <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>
156    pub fn force_delete_without_recovery(mut self, input: bool) -> Self {
157        self.inner = self.inner.force_delete_without_recovery(input);
158        self
159    }
160    /// <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>
161    pub fn set_force_delete_without_recovery(mut self, input: ::std::option::Option<bool>) -> Self {
162        self.inner = self.inner.set_force_delete_without_recovery(input);
163        self
164    }
165    /// <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>
166    pub fn get_force_delete_without_recovery(&self) -> &::std::option::Option<bool> {
167        self.inner.get_force_delete_without_recovery()
168    }
169}
aws_sdk_quicksight/operation/delete_analysis/builders.rs

aws_sdk_quicksight/operation/delete_analysis/
builders.rs
