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

DescribeDashboard

Retrieves information about a dashboard.

Request Syntax


GET /dashboards/dashboardId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

dashboardId

The ID of the dashboard.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dashboardArn": "string",
   "dashboardCreationDate": number,
   "dashboardDefinition": "string",
   "dashboardDescription": "string",
   "dashboardId": "string",
   "dashboardLastUpdateDate": number,
   "dashboardName": "string",
   "projectId": "string"
}

Response Elements

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

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

dashboardArn

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

dashboardCreationDate

The date the dashboard was created, in Unix epoch time.

Type: Timestamp

dashboardDefinition

The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 204800.

Pattern: .+

dashboardDescription

The dashboard's description.

Type: String

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

Pattern: [^\u0000-\u001F\u007F]+

dashboardId

The ID of the dashboard.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

dashboardLastUpdateDate

The date the dashboard was last updated, in Unix epoch time.

Type: Timestamp

dashboardName

The name of the dashboard.

Type: String

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

Pattern: [^\u0000-\u001F\u007F]+

projectId

The ID of the project that the dashboard is in.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Errors

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

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429