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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::AnalysisDefinition

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

The definition of an analysis.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_defaults ⇒ Types::AnalysisDefaults

  The configuration for default analysis settings.

• #calculated_fields ⇒ Array<Types::CalculatedField>

  An array of calculated field definitions for the analysis.

• #column_configurations ⇒ Array<Types::ColumnConfiguration>

  An array of analysis-level column configurations.

• #data_set_identifier_declarations ⇒ Array<Types::DataSetIdentifierDeclaration>

  An array of dataset identifier declarations.

• #filter_groups ⇒ Array<Types::FilterGroup>

  Filter definitions for an analysis.

• #options ⇒ Types::AssetOptions

  An array of option definitions for an analysis.

• #parameter_declarations ⇒ Array<Types::ParameterDeclaration>

  An array of parameter declarations for an analysis.

• #query_execution_options ⇒ Types::QueryExecutionOptions

  A structure that describes the query execution options.

• #sheets ⇒ Array<Types::SheetDefinition>

  An array of sheet definitions for an analysis.

• #static_files ⇒ Array<Types::StaticFile>

  The static files for the definition.

• #tooltip_sheets ⇒ Array<Types::TooltipSheetDefinition>

  An array of tooltip sheet definitions for an analysis.

• #topic_identifier_declarations ⇒ Array<Types::TopicIdentifierDeclaration>

  An array of topic identifier declarations.

Instance Attribute Details

#analysis_defaults ⇒ Types::AnalysisDefaults

The configuration for default analysis settings.

Returns:

• (Types::AnalysisDefaults)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#calculated_fields ⇒ Array<Types::CalculatedField>

An array of calculated field definitions for the analysis.

Returns:

• (Array<Types::CalculatedField>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#column_configurations ⇒ Array<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:

• (Array<Types::ColumnConfiguration>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#data_set_identifier_declarations ⇒ Array<Types::DataSetIdentifierDeclaration>

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

Returns:

• (Array<Types::DataSetIdentifierDeclaration>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#filter_groups ⇒ Array<Types::FilterGroup>

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

• (Array<Types::FilterGroup>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#options ⇒ Types::AssetOptions

An array of option definitions for an analysis.

Returns:

• (Types::AssetOptions)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#parameter_declarations ⇒ Array<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 Quick Sight in the Amazon Quick Suite User Guide.

Returns:

• (Array<Types::ParameterDeclaration>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#query_execution_options ⇒ Types::QueryExecutionOptions

A structure that describes the query execution options.

Returns:

• (Types::QueryExecutionOptions)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#sheets ⇒ Array<Types::SheetDefinition>

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

Returns:

• (Array<Types::SheetDefinition>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#static_files ⇒ Array<Types::StaticFile>

The static files for the definition.

Returns:

• (Array<Types::StaticFile>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#tooltip_sheets ⇒ Array<Types::TooltipSheetDefinition>

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

Returns:

• (Array<Types::TooltipSheetDefinition>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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

#topic_identifier_declarations ⇒ Array<Types::TopicIdentifierDeclaration>

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

Returns:

• (Array<Types::TopicIdentifierDeclaration>)

# File 'lib/aws-sdk-quicksight/types.rb', line 1021

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