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

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

Overview

Note:

When making an API call, you may pass UpdateDashboardRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  name: "DashboardName", # required
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  version_description: "VersionDescription",
  dashboard_publish_options: {
    ad_hoc_filtering_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    export_to_csv_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    sheet_controls_option: {
      visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
    },
  },
  theme_arn: "Arn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID of the AWS account that contains the dashboard that you're updating.

Returns:

  • (String)


11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#dashboard_idString

The ID for the dashboard.

Returns:

  • (String)


11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#dashboard_publish_optionsTypes::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, 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.



11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#nameString

The display name of the dashboard.

Returns:

  • (String)


11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#parametersTypes::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:



11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#source_entityTypes::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 AWS Account and any QuickSight-supported AWS 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.



11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#theme_arnString

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 AWS account where you create the dashboard.

Returns:

  • (String)


11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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

#version_descriptionString

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

Returns:

  • (String)


11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11156

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