Class: Aws::QuickSight::Types::UpdateDashboardRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::UpdateDashboardRequest

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The ID of the Amazon Web Services account that contains the dashboard that you’re updating.

• #dashboard_id ⇒ String

  The ID for the dashboard.

• #dashboard_publish_options ⇒ Types::DashboardPublishOptions

  Options for publishing the dashboard when you create it:.

• #definition ⇒ Types::DashboardVersionDefinition

  The definition of a dashboard.

• #name ⇒ String

  The display name of the dashboard.

• #parameters ⇒ Types::Parameters

  A structure that contains the parameters of the dashboard.

• #source_entity ⇒ Types::DashboardSourceEntity

  The entity that you are using as a source when you update the dashboard.

• #theme_arn ⇒ String

  The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

• #validation_strategy ⇒ Types::ValidationStrategy

  The option to relax the validation needed to update a dashboard with definition objects.

• #version_description ⇒ String

  A description for the first version of the dashboard being created.

Instance Attribute Details

#aws_account_id ⇒ String

The ID of the Amazon Web Services account that contains the dashboard that you’re updating.

Returns:

• (String)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_id ⇒ String

The ID for the dashboard.

Returns:

• (String)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_publish_options ⇒ Types::DashboardPublishOptions

Options for publishing the dashboard when you create it:

• ‘AvailabilityStatus` for `AdHocFilteringOption` - This status can be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is `ENABLED` by default.

• ‘AvailabilityStatus` for `ExportToCSVOption` - This status can be either `ENABLED` or `DISABLED`. The visual option to export data to .CSV format isn’t enabled when this is set to ‘DISABLED`. This option is `ENABLED` by default.

• ‘VisibilityState` for `SheetControlsOption` - This visibility state can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED` by default.

Returns:

• (Types::DashboardPublishOptions)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::DashboardVersionDefinition

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Returns:

• (Types::DashboardVersionDefinition)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The display name of the dashboard.

Returns:

• (String)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Types::Parameters

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Returns:

• (Types::Parameters)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#source_entity ⇒ Types::DashboardSourceEntity

The entity that you are using as a source when you update the dashboard. In ‘SourceEntity`, you specify the type of object you’re using as source. You can only update a dashboard from a template, so you use a ‘SourceTemplate` entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the ` CreateTemplate ` API operation. For `SourceTemplate`, specify the Amazon Resource Name (ARN) of the source template. The `SourceTemplate` ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the ‘DataSetReferences` entity within `SourceTemplate` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Returns:

• (Types::DashboardSourceEntity)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arn ⇒ String

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Returns:

• (String)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#validation_strategy ⇒ Types::ValidationStrategy

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Returns:

• (Types::ValidationStrategy)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A description for the first version of the dashboard being created.

Returns:

• (String)

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

class UpdateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :source_entity,
  :parameters,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end