Struct aws_sdk_quicksight::client::fluent_builders::CreateTemplate

pub struct CreateTemplate { /* private fields */ }

Fluent builder constructing a request to CreateTemplate.

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Implementations

impl CreateTemplate

pub async fn send(
    self
) -> Result<CreateTemplateOutput, SdkError<CreateTemplateError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

pub fn template_id(self, input: impl Into<String>) -> Self

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

pub fn set_template_id(self, input: Option<String>) -> Self

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

pub fn name(self, input: impl Into<String>) -> Self

A display name for the template.

pub fn set_name(self, input: Option<String>) -> Self

A display name for the template.

pub fn permissions(self, input: ResourcePermission) -> Self

Appends an item to Permissions.

To override the contents of this collection use set_permissions.

A list of resource permissions to be set on the template.

pub fn set_permissions(self, input: Option<Vec<ResourcePermission>>) -> Self

A list of resource permissions to be set on the template.

pub fn source_entity(self, input: TemplateSourceEntity) -> Self

The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

pub fn set_source_entity(self, input: Option<TemplateSourceEntity>) -> Self

The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

pub fn version_description(self, input: impl Into<String>) -> Self

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

pub fn set_version_description(self, input: Option<String>) -> Self

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

Trait Implementations

impl Clone for CreateTemplate

fn clone(&self) -> CreateTemplate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateTemplate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.