---
title: "GET /accounts/{AwsAccountId}/dashboards/{DashboardId}"
method: GET
path: "/accounts/{AwsAccountId}/dashboards/{DashboardId}"
---

# GET /accounts/{AwsAccountId}/dashboards/{DashboardId}

`GET /accounts/{AwsAccountId}/dashboards/{DashboardId}`

Provides a summary for a dashboard.

## Path parameters

- `AwsAccountId` string, required
- `DashboardId` string, required

## Query parameters

- `version-number` integer
- `alias-name` string

## Response `200`

Success

- DescribeDashboardResponse
  - `Dashboard` object — Information about the dashboard.
    - `DashboardId` string — Dashboard ID.
    - `Arn` string — The Amazon Resource Name (ARN) of the resource.
    - `Name` string — A display name for the dashboard.
    - `Version` object — Version.
      - `CreatedTime` string, date-time — The time that this dashboard version was created.
      - `Errors` DashboardError[] — Errors associated with this dashboard version.
        - `Type` 'ACCESS_DENIED' | 'SOURCE_NOT_FOUND' | 'DATA_SET_NOT_FOUND' | 'INTERNAL_FAILURE' | 'PARAMETER_VALUE_INCOMPATIBLE' | 'PARAMETER_TYPE_INVALID' | 'PARAMETER_NOT_FOUND' | 'COLUMN_TYPE_MISMATCH' | 'COLUMN_GEOGRAPHIC_ROLE_MISMATCH' | 'COLUMN_REPLACEMENT_MISSING' — Type.
        - `Message` string — Message.
        - `ViolatedEntities` Entity[] — Lists the violated entities that caused the dashboard error.
          - `Path` string — The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
      - `VersionNumber` integer — Version number for this version of the dashboard.
      - `Status` 'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED' — The HTTP status of the request.
      - `Arn` string — The Amazon Resource Name (ARN) of the resource.
      - `SourceEntityArn` string — Source entity ARN.
      - `DataSetArns` Arn[] — The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
      - `Description` string — Description.
      - `ThemeArn` string — The ARN of the theme associated with a version of the dashboard.
      - `Sheets` Sheet[] — A list of the associated sheets with the unique identifier and name of each sheet.
        - `SheetId` string — The unique identifier associated with a sheet.
        - `Name` string — The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
    - `CreatedTime` string, date-time — The time that this dashboard was created.
    - `LastPublishedTime` string, date-time — The last time that this dashboard was published.
    - `LastUpdatedTime` string, date-time — The last time that this dashboard was updated.
  - `Status` integer — The HTTP status of this request.
  - `RequestId` string — The Amazon Web Services request ID for this operation.

## Other responses

- `480` — InvalidParameterValueException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ThrottlingException
- `484` — UnsupportedUserEditionException
- `485` — InternalFailureException

---

[API](https://skmtc.net/aws/apis/quicksight.md) · [All operations](https://skmtc.net/aws/apis/quicksight/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/quicksight/versions/2f2bbd7e70ca/schema)