Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDashboardDefinition

Provides a detailed description of the definition of a dashboard.

Note

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Request Syntax


GET /accounts/AwsAccountId/dashboards/DashboardId/definition?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AliasName

The alias name.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DashboardId

The ID for the dashboard.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

VersionNumber

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

Valid Range: Minimum value of 1.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "DashboardId": "string",
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "DataPointDrillUpDownOption": { 
         "AvailabilityStatus": "string"
      },
      "DataPointMenuLabelOption": { 
         "AvailabilityStatus": "string"
      },
      "DataPointTooltipOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportWithHiddenFieldsOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      },
      "SheetLayoutElementMaximizationOption": { 
         "AvailabilityStatus": "string"
      },
      "VisualAxisSortOption": { 
         "AvailabilityStatus": "string"
      },
      "VisualMenuOption": { 
         "AvailabilityStatus": "string"
      },
      "VisualPublishOptions": { 
         "ExportHiddenFieldsOption": { 
            "AvailabilityStatus": "string"
         }
      }
   },
   "Definition": { 
      "AnalysisDefaults": { 
         "DefaultNewSheetConfiguration": { ... }
      },
      "CalculatedFields": [ 
         { ... }
      ],
      "ColumnConfigurations": [ 
         { ... }
      ],
      "DataSetIdentifierDeclarations": [ 
         { ... }
      ],
      "FilterGroups": [ 
         { ... }
      ],
      "Options": { 
         "Timezone": "string",
         "WeekStart": "string"
      },
      "ParameterDeclarations": [ 
         { ... }
      ],
      "Sheets": [ 
         { ... }
      ]
   },
   "Errors": [ 
      { 
         "Message": "string",
         "Type": "string",
         "ViolatedEntities": [ 
            { 
               "Path": "string"
            }
         ]
      }
   ],
   "Name": "string",
   "RequestId": "string",
   "ResourceStatus": "string",
   "ThemeArn": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

DashboardId

The ID of the dashboard described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

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.

Type: DashboardPublishOptions object

Definition

The definition of a dashboard.

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

Type: DashboardVersionDefinition object

Errors

Errors associated with this dashboard version.

Type: Array of DashboardError objects

Array Members: Minimum number of 1 item.

Name

The display name of the dashboard.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

RequestId

The AWS request ID for this operation.

Type: String

ResourceStatus

Status associated with the dashboard version.

CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED

Type: String

ThemeArn

The ARN of the theme of the dashboard.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403