Struct aws_sdk_quicksight::operation::create_analysis::builders::CreateAnalysisFluentBuilder

pub struct CreateAnalysisFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAnalysis.

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

Implementations

impl CreateAnalysisFluentBuilder

pub fn as_input(&self) -> &CreateAnalysisInputBuilder

Access the CreateAnalysis as a reference.

pub async fn send( self ) -> Result<CreateAnalysisOutput, SdkError<CreateAnalysisError, 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.

pub fn customize( self ) -> CustomizableOperation<CreateAnalysisOutput, CreateAnalysisError, Self>

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

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

The ID of the Amazon Web Services account where you are creating an analysis.

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

The ID of the Amazon Web Services account where you are creating an analysis.

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

The ID of the Amazon Web Services account where you are creating an analysis.

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

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

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

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

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

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

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

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

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

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

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

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

pub fn parameters(self, input: Parameters) -> Self

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

pub fn set_parameters(self, input: Option<Parameters>) -> Self

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

pub fn get_parameters(&self) -> &Option<Parameters>

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

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

Appends an item to Permissions.

To override the contents of this collection use set_permissions.

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

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

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

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

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

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

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

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

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

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

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

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

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

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

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

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

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

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

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

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

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 analysis.

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 analysis.

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 analysis.

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

The definition of an analysis.

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.

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

The definition of an analysis.

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.

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

The definition of an analysis.

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.

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

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

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

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

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

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

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

Appends an item to FolderArns.

To override the contents of this collection use set_folder_arns.

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

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

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

pub fn get_folder_arns(&self) -> &Option<Vec<String>>

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Trait Implementations

impl Clone for CreateAnalysisFluentBuilder

fn clone(&self) -> CreateAnalysisFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAnalysisFluentBuilder

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

Formats the value using the given formatter.