Class: Aws::QuickSight::Types::AnalysisDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-quicksight/types.rb

Overview

The definition of an analysis.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_defaultsTypes::AnalysisDefaults

The configuration for default analysis settings.



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#calculated_fieldsArray<Types::CalculatedField>

An array of calculated field definitions for the analysis.

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#column_configurationsArray<Types::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.

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#data_set_identifier_declarationsArray<Types::DataSetIdentifierDeclaration>

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



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#filter_groupsArray<Types::FilterGroup>

Filter definitions for an analysis.

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

[1]: docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#optionsTypes::AssetOptions

An array of option definitions for an analysis.

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_declarationsArray<Types::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*.

[1]: docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#query_execution_optionsTypes::QueryExecutionOptions

A structure that describes the query execution options.



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end

#sheetsArray<Types::SheetDefinition>

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

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/aws-sdk-quicksight/types.rb', line 502

class AnalysisDefinition < Struct.new(
  :data_set_identifier_declarations,
  :sheets,
  :calculated_fields,
  :parameter_declarations,
  :filter_groups,
  :column_configurations,
  :analysis_defaults,
  :options,
  :query_execution_options)
  SENSITIVE = []
  include Aws::Structure
end