DescribeEventsForOrganization - AWS Health

DescribeEventsForOrganization

Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.

For more information about the different types of AWS Health events, see Event.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

Note

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Request Syntax

{ "filter": { "awsAccountIds": [ "string" ], "endTime": { "from": number, "to": number }, "entityArns": [ "string" ], "entityValues": [ "string" ], "eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTime": { "from": number, "to": number }, "regions": [ "string" ], "services": [ "string" ], "startTime": { "from": number, "to": number } }, "locale": "string", "maxResults": number, "nextToken": "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.

filter

Values to narrow the results returned.

Type: OrganizationEventFilter object

Required: No

locale

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Type: String

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

Pattern: .{2,256}

Required: No

maxResults

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{ "events": [ { "arn": "string", "endTime": number, "eventScopeCode": "string", "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string" } ], "nextToken": "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.

events

The events that match the specified filter criteria.

Type: Array of OrganizationEvent objects

nextToken

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

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

InvalidPaginationToken

The specified pagination token (nextToken) is not valid.

HTTP Status Code: 400

UnsupportedLocale

The specified locale is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: