Struct aws_sdk_quicksight::operation::create_analysis::CreateAnalysisInput

#[non_exhaustive]
pub struct CreateAnalysisInput {
    pub aws_account_id: Option<String>,
    pub analysis_id: Option<String>,
    pub name: Option<String>,
    pub parameters: Option<Parameters>,
    pub permissions: Option<Vec<ResourcePermission>>,
    pub source_entity: Option<AnalysisSourceEntity>,
    pub theme_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub definition: Option<AnalysisDefinition>,
    pub validation_strategy: Option<ValidationStrategy>,
    pub folder_arns: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

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

analysis_id: Option<String>

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

name: Option<String>

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

parameters: 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.

permissions: 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.

source_entity: 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.

theme_arn: 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.

tags: Option<Vec<Tag>>

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

definition: 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.

validation_strategy: Option<ValidationStrategy>

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

folder_arns: Option<Vec<String>>

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

Implementations

impl CreateAnalysisInput

pub fn aws_account_id(&self) -> Option<&str>

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

pub fn analysis_id(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .permissions.is_none().

pub fn 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) -> Option<&str>

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) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn 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) -> 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) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .folder_arns.is_none().

impl CreateAnalysisInput

pub fn builder() -> CreateAnalysisInputBuilder

Creates a new builder-style object to manufacture CreateAnalysisInput.

Trait Implementations

impl Clone for CreateAnalysisInput

fn clone(&self) -> CreateAnalysisInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAnalysisInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAnalysisInput

fn eq(&self, other: &CreateAnalysisInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateAnalysisInput