aws_sdk_quicksight/client/
describe_analysis_definition.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 [`DescribeAnalysisDefinition`](crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder::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_definition::builders::DescribeAnalysisDefinitionFluentBuilder::analysis_id) / [`set_analysis_id(Option<String>)`](crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder::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 [`DescribeAnalysisDefinitionOutput`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput) with field(s):
9    ///   - [`analysis_id(Option<String>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::analysis_id): <p>The ID of the analysis described.</p>
10    ///   - [`name(Option<String>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::name): <p>The descriptive name of the analysis.</p>
11    ///   - [`errors(Option<Vec::<AnalysisError>>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::errors): <p>Errors associated with the analysis.</p>
12    ///   - [`resource_status(Option<ResourceStatus>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::resource_status): <p>Status associated with the analysis.</p> <ul>  <li>   <p><code>CREATION_IN_PROGRESS</code></p></li>  <li>   <p><code>CREATION_SUCCESSFUL</code></p></li>  <li>   <p><code>CREATION_FAILED</code></p></li>  <li>   <p><code>UPDATE_IN_PROGRESS</code></p></li>  <li>   <p><code>UPDATE_SUCCESSFUL</code></p></li>  <li>   <p><code>UPDATE_FAILED</code></p></li>  <li>   <p><code>DELETED</code></p></li> </ul>
13    ///   - [`theme_arn(Option<String>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::theme_arn): <p>The ARN of the theme of the analysis.</p>
14    ///   - [`definition(Option<AnalysisDefinition>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::definition): <p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
15    ///   - [`status(i32)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::status): <p>The HTTP status of the request.</p>
16    ///   - [`request_id(Option<String>)`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
17    /// - On failure, responds with [`SdkError<DescribeAnalysisDefinitionError>`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionError)
18    pub fn describe_analysis_definition(&self) -> crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder {
19        crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_quicksight/client/describe_analysis_definition.rs

aws_sdk_quicksight/client/
describe_analysis_definition.rs
