Struct aws_sdk_quicksight::types::AnalysisDefinition

#[non_exhaustive]
pub struct AnalysisDefinition {
    pub data_set_identifier_declarations: Option<Vec<DataSetIdentifierDeclaration>>,
    pub sheets: Option<Vec<SheetDefinition>>,
    pub calculated_fields: Option<Vec<CalculatedField>>,
    pub parameter_declarations: Option<Vec<ParameterDeclaration>>,
    pub filter_groups: Option<Vec<FilterGroup>>,
    pub column_configurations: Option<Vec<ColumnConfiguration>>,
    pub analysis_defaults: Option<AnalysisDefaults>,
}

The definition of an analysis.

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.

data_set_identifier_declarations: Option<Vec<DataSetIdentifierDeclaration>>

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

sheets: Option<Vec<SheetDefinition>>

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

calculated_fields: Option<Vec<CalculatedField>>

An array of calculated field definitions for the analysis.

parameter_declarations: Option<Vec<ParameterDeclaration>>

An array of parameter declarations for an analysis.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

filter_groups: Option<Vec<FilterGroup>>

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

column_configurations: Option<Vec<ColumnConfiguration>>

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

analysis_defaults: Option<AnalysisDefaults>

The configuration for default analysis settings.

Implementations

impl AnalysisDefinition

pub fn data_set_identifier_declarations( &self ) -> Option<&[DataSetIdentifierDeclaration]>

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

pub fn sheets(&self) -> Option<&[SheetDefinition]>

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

pub fn calculated_fields(&self) -> Option<&[CalculatedField]>

An array of calculated field definitions for the analysis.

pub fn parameter_declarations(&self) -> Option<&[ParameterDeclaration]>

An array of parameter declarations for an analysis.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

pub fn filter_groups(&self) -> Option<&[FilterGroup]>

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

pub fn column_configurations(&self) -> Option<&[ColumnConfiguration]>

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

pub fn analysis_defaults(&self) -> Option<&AnalysisDefaults>

The configuration for default analysis settings.

impl AnalysisDefinition

pub fn builder() -> AnalysisDefinitionBuilder

Creates a new builder-style object to manufacture AnalysisDefinition.

Trait Implementations

impl Clone for AnalysisDefinition

fn clone(&self) -> AnalysisDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnalysisDefinition

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

Formats the value using the given formatter.

impl PartialEq<AnalysisDefinition> for AnalysisDefinition

fn eq(&self, other: &AnalysisDefinition) -> 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 AnalysisDefinition