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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::DescribeDashboardDefinitionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dashboard_id ⇒ String

  The ID of the dashboard described.

• #dashboard_publish_options ⇒ Types::DashboardPublishOptions

  Options for publishing the dashboard:.

• #definition ⇒ Types::DashboardVersionDefinition

  The definition of a dashboard.

• #errors ⇒ Array<Types::DashboardError>

  Errors associated with this dashboard version.

• #name ⇒ String

  The display name of the dashboard.

• #request_id ⇒ String

  The Amazon Web Services request ID for this operation.

• #resource_status ⇒ String

  Status associated with the dashboard version.

• #status ⇒ Integer

  The HTTP status of the request.

• #theme_arn ⇒ String

  The ARN of the theme of the dashboard.

Instance Attribute Details

#dashboard_id ⇒ String

The ID of the dashboard described.

Returns:

• (String)

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

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_options ⇒ Types::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.

Returns:

• (Types::DashboardPublishOptions)

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

class DescribeDashboardDefinitionResponse < Struct.new(
  :dashboard_id,
  :errors,
  :name,
  :resource_status,
  :theme_arn,
  :definition,
  :status,
  :request_id,
  :dashboard_publish_options)
  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 12776

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

#errors ⇒ Array<Types::DashboardError>

Errors associated with this dashboard version.

Returns:

• (Array<Types::DashboardError>)

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

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

#name ⇒ String

The display name of the dashboard.

Returns:

• (String)

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

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_id ⇒ String

The Amazon Web Services request ID for this operation.

Returns:

• (String)

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

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_status ⇒ String

Status associated with the dashboard version.

• ‘CREATION_IN_PROGRESS`

• ‘CREATION_SUCCESSFUL`

• ‘CREATION_FAILED`

• ‘UPDATE_IN_PROGRESS`

• ‘UPDATE_SUCCESSFUL`

• ‘UPDATE_FAILED`

• ‘DELETED`

Returns:

• (String)

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

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

#status ⇒ Integer

The HTTP status of the request.

Returns:

• (Integer)

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

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_arn ⇒ String

The ARN of the theme of the dashboard.

Returns:

• (String)

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

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