aws_sdk_quicksight/client/
describe_theme.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 [`DescribeTheme`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p><br>
7    ///   - [`theme_id(impl Into<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::theme_id) / [`set_theme_id(Option<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::set_theme_id):<br>required: **true**<br><p>The ID for the theme.</p><br>
8    ///   - [`version_number(i64)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::version_number) / [`set_version_number(Option<i64>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::set_version_number):<br>required: **false**<br><p>The version number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the theme is described.</p><br>
9    ///   - [`alias_name(impl Into<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::alias_name) / [`set_alias_name(Option<String>)`](crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::set_alias_name):<br>required: **false**<br><p>The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p><br>
10    /// - On success, responds with [`DescribeThemeOutput`](crate::operation::describe_theme::DescribeThemeOutput) with field(s):
11    ///   - [`theme(Option<Theme>)`](crate::operation::describe_theme::DescribeThemeOutput::theme): <p>The information about the theme that you are describing.</p>
12    ///   - [`status(i32)`](crate::operation::describe_theme::DescribeThemeOutput::status): <p>The HTTP status of the request.</p>
13    ///   - [`request_id(Option<String>)`](crate::operation::describe_theme::DescribeThemeOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
14    /// - On failure, responds with [`SdkError<DescribeThemeError>`](crate::operation::describe_theme::DescribeThemeError)
15    pub fn describe_theme(&self) -> crate::operation::describe_theme::builders::DescribeThemeFluentBuilder {
16        crate::operation::describe_theme::builders::DescribeThemeFluentBuilder::new(self.handle.clone())
17    }
18}