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

DescribeOrganizationOverview

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

Request Syntax


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

{
   "AccountIds": [ "string" ],
   "FromTime": number,
   "OrganizationalUnitIds": [ "string" ],
   "ToTime": number
}

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

FromTime

The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.

Type: Timestamp

Required: Yes

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

ToTime

The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.

Type: Timestamp

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ProactiveInsights": number,
   "ReactiveInsights": 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.

ProactiveInsights

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

Type: Integer

ReactiveInsights

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

Type: Integer

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