DescribeAffectedEntitiesForOrganization - AWS Health

DescribeAffectedEntitiesForOrganization

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

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

{ "locale": "string", "maxResults": number, "nextToken": "string", "organizationEntityFilters": [ { "awsAccountId": "string", "eventArn": "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.

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 10. 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

organizationEntityFilters

A JSON set of elements including the awsAccountId and the eventArn.

Type: Array of EventAccountFilter objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax

{ "entities": [ { "awsAccountId": "string", "entityArn": "string", "entityUrl": "string", "entityValue": "string", "eventArn": "string", "lastUpdatedTime": number, "statusCode": "string", "tags": { "string" : "string" } } ], "failedSet": [ { "awsAccountId": "string", "errorMessage": "string", "errorName": "string", "eventArn": "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.

entities

A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.

Type: Array of AffectedEntity objects

failedSet

A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.

Type: Array of OrganizationAffectedEntitiesErrorItem 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: