aws_sdk_quicksight/client/
restore_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 [`RestoreAnalysis`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the analysis.</p><br>
7    ///   - [`analysis_id(impl Into<String>)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::analysis_id) / [`set_analysis_id(Option<String>)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::set_analysis_id):<br>required: **true**<br><p>The ID of the analysis that you're restoring.</p><br>
8    ///   - [`restore_to_folders(bool)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::restore_to_folders) / [`set_restore_to_folders(Option<bool>)`](crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::set_restore_to_folders):<br>required: **false**<br><p>A boolean value that determines if the analysis will be restored to folders that it previously resided in. A <code>True</code> value restores analysis back to all folders that it previously resided in. A <code>False</code> value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to <code>True</code>.</p><br>
9    /// - On success, responds with [`RestoreAnalysisOutput`](crate::operation::restore_analysis::RestoreAnalysisOutput) with field(s):
10    ///   - [`status(i32)`](crate::operation::restore_analysis::RestoreAnalysisOutput::status): <p>The HTTP status of the request.</p>
11    ///   - [`arn(Option<String>)`](crate::operation::restore_analysis::RestoreAnalysisOutput::arn): <p>The Amazon Resource Name (ARN) of the analysis that you're restoring.</p>
12    ///   - [`analysis_id(Option<String>)`](crate::operation::restore_analysis::RestoreAnalysisOutput::analysis_id): <p>The ID of the analysis that you're restoring.</p>
13    ///   - [`request_id(Option<String>)`](crate::operation::restore_analysis::RestoreAnalysisOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
14    ///   - [`restoration_failed_folder_arns(Option<Vec::<String>>)`](crate::operation::restore_analysis::RestoreAnalysisOutput::restoration_failed_folder_arns): <p>A list of folder arns thatthe analysis failed to be restored to.</p>
15    /// - On failure, responds with [`SdkError<RestoreAnalysisError>`](crate::operation::restore_analysis::RestoreAnalysisError)
16    pub fn restore_analysis(&self) -> crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder {
17        crate::operation::restore_analysis::builders::RestoreAnalysisFluentBuilder::new(self.handle.clone())
18    }
19}