aws_sdk_quicksight/client/describe_template.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 [`DescribeTemplate`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`aws_account_id(impl Into<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the template that you're describing.</p><br>
7 /// - [`template_id(impl Into<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::template_id) / [`set_template_id(Option<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::set_template_id):<br>required: **true**<br><p>The ID for the template.</p><br>
8 /// - [`version_number(i64)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::version_number) / [`set_version_number(Option<i64>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::set_version_number):<br>required: **false**<br><p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the template is described.</p><br>
9 /// - [`alias_name(impl Into<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::alias_name) / [`set_alias_name(Option<String>)`](crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::set_alias_name):<br>required: **false**<br><p>The alias of the template 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 template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p><br>
10 /// - On success, responds with [`DescribeTemplateOutput`](crate::operation::describe_template::DescribeTemplateOutput) with field(s):
11 /// - [`template(Option<Template>)`](crate::operation::describe_template::DescribeTemplateOutput::template): <p>The template structure for the object you want to describe.</p>
12 /// - [`status(i32)`](crate::operation::describe_template::DescribeTemplateOutput::status): <p>The HTTP status of the request.</p>
13 /// - [`request_id(Option<String>)`](crate::operation::describe_template::DescribeTemplateOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
14 /// - On failure, responds with [`SdkError<DescribeTemplateError>`](crate::operation::describe_template::DescribeTemplateError)
15 pub fn describe_template(&self) -> crate::operation::describe_template::builders::DescribeTemplateFluentBuilder {
16 crate::operation::describe_template::builders::DescribeTemplateFluentBuilder::new(self.handle.clone())
17 }
18}