aws_sdk_quicksight/client/describe_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 [`DescribeAnalysis`](crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`aws_account_id(impl Into<String>)`](crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.</p><br>
7 /// - [`analysis_id(impl Into<String>)`](crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder::analysis_id) / [`set_analysis_id(Option<String>)`](crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder::set_analysis_id):<br>required: **true**<br><p>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</p><br>
8 /// - On success, responds with [`DescribeAnalysisOutput`](crate::operation::describe_analysis::DescribeAnalysisOutput) with field(s):
9 /// - [`analysis(Option<Analysis>)`](crate::operation::describe_analysis::DescribeAnalysisOutput::analysis): <p>A metadata structure that contains summary information for the analysis that you're describing.</p>
10 /// - [`status(i32)`](crate::operation::describe_analysis::DescribeAnalysisOutput::status): <p>The HTTP status of the request.</p>
11 /// - [`request_id(Option<String>)`](crate::operation::describe_analysis::DescribeAnalysisOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
12 /// - On failure, responds with [`SdkError<DescribeAnalysisError>`](crate::operation::describe_analysis::DescribeAnalysisError)
13 pub fn describe_analysis(&self) -> crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder {
14 crate::operation::describe_analysis::builders::DescribeAnalysisFluentBuilder::new(self.handle.clone())
15 }
16}