Class: Aws::QuickSight::Types::TemplateVersionDefinition

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TemplateVersionDefinition

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

The detailed definition of a template.

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

• #column_configurations ⇒ Array<Types::ColumnConfiguration>

  An array of template-level column configurations.

• #data_set_configurations ⇒ Array<Types::DataSetConfiguration>

  An array of dataset configurations.

• #filter_groups ⇒ Array<Types::FilterGroup>

  Filter definitions for a template.

• #options ⇒ Types::AssetOptions

  An array of option definitions for a template.

• #parameter_declarations ⇒ Array<Types::ParameterDeclaration>

  An array of parameter declarations for a template.

• #query_execution_options ⇒ Types::QueryExecutionOptions

  A structure that describes the query execution options.

• #sheets ⇒ Array<Types::SheetDefinition>

  An array of sheet definitions for a template.

• #static_files ⇒ Array<Types::StaticFile>

  The static files for the definition.

• #tooltip_sheets ⇒ Array<Types::TooltipSheetDefinition>

  An array of tooltip sheet definitions for a template.

• #topic_configurations ⇒ Array<Types::TopicConfiguration>

  An array of topic configurations.

Instance Attribute Details

#analysis_defaults ⇒ Types::AnalysisDefaults

The configuration for default analysis settings.

Returns:

• (Types::AnalysisDefaults)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 template.

Returns:

• (Array<Types::CalculatedField>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Returns:

• (Array<Types::ColumnConfiguration>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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_configurations ⇒ Array<Types::DataSetConfiguration>

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Returns:

• (Array<Types::DataSetConfiguration>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 a template.

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

Returns:

• (Array<Types::FilterGroup>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 a template.

Returns:

• (Types::AssetOptions)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 a template.

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 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 46676

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 46676

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 a template.

Returns:

• (Array<Types::SheetDefinition>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 46676

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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 a template.

Returns:

• (Array<Types::TooltipSheetDefinition>)

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

class TemplateVersionDefinition < Struct.new(
  :data_set_configurations,
  :topic_configurations,
  :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_configurations ⇒ Array<Types::TopicConfiguration>

An array of topic configurations. These configurations define the required columns for each topic used within a template.

Returns:

• (Array<Types::TopicConfiguration>)

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

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