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

DescribeOrganizationHealth

Returns the number of metrics, insights, and resource hours DevOps Guru analyzed in the last hour.

There are two types of insights:

Reactive: A reactive insight identifies anomalous behavior as it occurs. It contains anomalies with recommendations, related metrics, and events to help you understand and address the issues now.
Proactive: A proactive insight lets you know about anomalous behavior before it occurs. It contains anomalies with recommendations to help you address the issues before they are predicted to happen.

Request Syntax


POST /organization/health HTTP/1.1
Content-type: application/json

{
   "AccountIds": [ "string" ],
   "OrganizationalUnitIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountIds

The ID of the AWS account.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

OrganizationalUnitIds

The ID of the organizational unit.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Maximum length of 68.

Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MetricsAnalyzed": number,
   "OpenProactiveInsights": number,
   "OpenReactiveInsights": number,
   "ResourceHours": number
}

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.

MetricsAnalyzed

An integer that specifies the number of metrics that have been analyzed in your organization.

Type: Integer

OpenProactiveInsights

An integer that specifies the number of open proactive insights in your AWS account.

Type: Integer

OpenReactiveInsights

An integer that specifies the number of open reactive insights in your AWS account.

Type: Integer

ResourceHours

The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.

Type: Long

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

An internal failure in an Amazon service occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to a request throttling.

HTTP Status Code: 429

ValidationException

Contains information about data passed in to a field during a request that is not valid.

HTTP Status Code: 400