Class: Aws::QuickSight::Types::DescribeDashboardDefinitionResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard_idString

The ID of the dashboard described.

Returns:

  • (String)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_publish_optionsTypes::DashboardPublishOptions

Options for publishing the dashboard:

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



8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#definitionTypes::DashboardVersionDefinition

The definition of a dashboard.

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



8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#errorsArray<Types::DashboardError>

Errors associated with this dashboard version.

Returns:



8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The display name of the dashboard.

Returns:

  • (String)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#request_idString

The Amazon Web Services request ID for this operation.

Returns:

  • (String)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#resource_statusString

Status associated with the dashboard version.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

Returns:

  • (String)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#statusInteger

The HTTP status of the request.

Returns:

  • (Integer)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arnString

The ARN of the theme of the dashboard.

Returns:

  • (String)


8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8177

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  SENSITIVE = []
  include Aws::Structure
end