Struct aws_sdk_quicksight::client::fluent_builders::DeleteAnalysis

pub struct DeleteAnalysis<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to DeleteAnalysis.

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.

Implementations

impl<C, M, R> DeleteAnalysis<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DeleteAnalysisOutput, SdkError<DeleteAnalysisError>> where
    R::Policy: SmithyRetryPolicy<DeleteAnalysisInputOperationOutputAlias, DeleteAnalysisOutput, DeleteAnalysisError, DeleteAnalysisInputOperationRetryAlias>, 

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, which can be set when configuring the client.

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The ID of the Amazon Web Services account where you want to delete an analysis.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The ID of the Amazon Web Services account where you want to delete an analysis.

pub fn analysis_id(self, input: impl Into<String>) -> Self

The ID of the analysis that you're deleting.

pub fn set_analysis_id(self, input: Option<String>) -> Self

The ID of the analysis that you're deleting.

pub fn recovery_window_in_days(self, input: i64) -> Self

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.

pub fn set_recovery_window_in_days(self, input: Option<i64>) -> Self

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.

pub fn force_delete_without_recovery(self, input: bool) -> Self

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.

pub fn set_force_delete_without_recovery(self, input: Option<bool>) -> Self

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DeleteAnalysis<C, M, R>

fn clone(&self) -> DeleteAnalysis<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DeleteAnalysis<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.