GET

/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition

<p>Provides a detailed description of the definition of a dashboard.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html"> <code>DescribeDashboard</code> </a> instead. </p> </note>

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The ID of the Amazon Web Services account that contains the dashboard that you're describing.

DashboardIdstringrequired

The ID for the dashboard.

Query Params

version-numberinteger

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

alias-namestring

The alias name.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}