Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141310385.1 KB

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

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

  • This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

post/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntities

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Headers

X-Amz-Target'AWSHealth_20160804.DescribeAffectedEntities' required

Request body

localestring

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

nextTokenstring

If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.

maxResultsinteger

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

Response

Success

nextTokenstring

If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.