PUT

/dashboards/{dashboardId}

http://iotsitewise.{region}.amazonaws.com/dashboards/{dashboardId}

Updates an IoT SiteWise Monitor dashboard.

Access Token Required: API Key

Path Parameters

dashboardIdstringrequired

The ID of the dashboard to update.

Body Params

clientTokenstring

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

dashboardNamestringrequired

A new friendly name for the dashboard.

dashboardDefinitionstringrequired

The new dashboard definition, as specified in a JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.

dashboardDescriptionstring

A new description for the dashboard.

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 PUT \
2     --url 'http://iotsitewise.{region}.amazonaws.com/dashboards/{dashboardId}' \
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}