Struct aws_sdk_quicksight::operation::create_template::builders::CreateTemplateFluentBuilder

source · 
pub struct CreateTemplateFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to CreateTemplate.

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

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§

source§

impl CreateTemplateFluentBuilder

source

pub fn as_input(&self) -> &CreateTemplateInputBuilder

Access the CreateTemplate as a reference.

source

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

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.

source

pub fn customize( self ) -> CustomizableOperation<CreateTemplateOutput, CreateTemplateError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

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.

source

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.

source

pub fn get_aws_account_id(&self) -> &Option<String>

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.

source

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.

source

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.

source

pub fn get_template_id(&self) -> &Option<String>

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.

source

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

A display name for the template.

source

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

A display name for the template.

source

pub fn get_name(&self) -> &Option<String>

A display name for the template.

source

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.

source

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

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

source

pub fn get_permissions(&self) -> &Option<Vec<ResourcePermission>>

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

source

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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

pub fn get_source_entity(&self) -> &Option<TemplateSourceEntity>

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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

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.

source

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.

source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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

source

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.

source

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.

source

pub fn get_version_description(&self) -> &Option<String>

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.

source

pub fn definition(self, input: TemplateVersionDefinition) -> Self

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

pub fn set_definition(self, input: Option<TemplateVersionDefinition>) -> Self

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

pub fn get_definition(&self) -> &Option<TemplateVersionDefinition>

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

source

pub fn validation_strategy(self, input: ValidationStrategy) -> Self

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

source

pub fn set_validation_strategy(self, input: Option<ValidationStrategy>) -> Self

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

source

pub fn get_validation_strategy(&self) -> &Option<ValidationStrategy>

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

Trait Implementations§

source§

impl Clone for CreateTemplateFluentBuilder

source§

fn clone(&self) -> CreateTemplateFluentBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CreateTemplateFluentBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more