Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141341,3811.0 MB

Provides a detailed description of the definition of a dashboard.

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.

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

Path parameters

AwsAccountIdstring required

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

DashboardIdstring required

The ID for the dashboard.

Query parameters

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.

Response

Success

DashboardIdstring

The ID of the dashboard described.

Namestring

The display name of the dashboard.

ResourceStatus'CREATION_IN_PROGRESS' | 'CREATION_SUCCESSFUL' | 'CREATION_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCESSFUL' | 'UPDATE_FAILED' | 'DELETED'
<p>Status associated with the dashboard version.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>
ThemeArnstring

The ARN of the theme of the dashboard.

Statusinteger

The HTTP status of the request.

RequestIdstring

The Amazon Web Services request ID for this operation.