Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StartDashboardRefresh

Starts a refresh of the specified dashboard.

Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the AWS CloudTrail User Guide.

Request Syntax


{
   "DashboardId": "string",
   "QueryParameterValues": { 
      "string" : "string" 
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DashboardId

The name or ARN of the dashboard.

Type: String

Pattern: ^[a-zA-Z0-9._/\-:]+$

Required: Yes

QueryParameterValues

The query parameter values for the dashboard

For custom dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

For managed dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , $Period$ , and $EventDataStoreId$ . The $EventDataStoreId$ query parameter is required.

Type: String to string map

Key Length Constraints: Minimum length of 3. Maximum length of 128.

Key Pattern: ^[a-zA-Z0-9._/\-:$]+$

Value Length Constraints: Minimum length of 1. Maximum length of 128.

Value Pattern: ^[a-zA-Z0-9._/\-:]+$

Required: No

Response Syntax


{
   "RefreshId": "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.

RefreshId

The refresh ID for the dashboard.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 20.

Pattern: \d+

Errors

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

EventDataStoreNotFoundException

The specified event data store was not found.

HTTP Status Code: 400

InactiveEventDataStoreException

The event data store is inactive.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the specified resource is not found.

HTTP Status Code: 400

ServiceQuotaExceededException

This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see Service quotas in the AWS General Reference.

HTTP Status Code: 400

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400

Examples

Example

The following example refreshes a managed dashboard. Because managed dashboards are configured by CloudTrail, the refresh request needs to include the ID of the event data store that the queries will run on.


{
  "DashboardId": "AWSCloudTrail-Overview",
  "QueryParameterValues": {
      "$StartTime$": "2024-11-13T08:00:00.00Z",
      "$EndTime$": "2024-11-13T12:00:00.00Z",
      "$Period$": "minute",
      "$EventDataStoreId$": "<eds-id>"
  }
}

Example

The following example refreshes a custom dashboard named AccountActivityDashboard.


{
  "DashboardId": "AccountActivityDashboard",
  "QueryParameterValues": {
      "$StartTime$": "2024-11-13T08:00:00.00Z",
      "$EndTime$": "2024-11-13T12:00:00.00Z",
      "$Period$": "minute"
  }
}