# DescribeAffectedEntities
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 AWS 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.
**Note**
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 AWS Health events. For more information, see [Resource- and action-based conditions](https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) in the * AWS Health User Guide*.
## Request Syntax
```
{
"filter": {
"entityArns": [ "string" ],
"entityValues": [ "string" ],
"eventArns": [ "string" ],
"lastUpdatedTimes": [
{
"from": number,
"to": number
}
],
"statusCodes": [ "string" ],
"tags": [
{
"string" : "string"
}
]
},
"locale": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [filter](#API_DescribeAffectedEntities_RequestSyntax) **
Values to narrow the results returned. At least one event ARN is required.
Type: [EntityFilter](API_EntityFilter.md) object
Required: Yes
** [locale](#API_DescribeAffectedEntities_RequestSyntax) **
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](#API_DescribeAffectedEntities_RequestSyntax) **
The maximum number of items to return in one batch, between 1 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_DescribeAffectedEntities_RequestSyntax) **
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
```
{
"entities": [
{
"awsAccountId": "string",
"entityArn": "string",
"entityMetadata": {
"string" : "string"
},
"entityUrl": "string",
"entityValue": "string",
"eventArn": "string",
"lastUpdatedTime": number,
"statusCode": "string",
"tags": {
"string" : "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](#API_DescribeAffectedEntities_ResponseSyntax) **
The entities that match the filter criteria.
Type: Array of [AffectedEntity](API_AffectedEntity.md) objects
** [nextToken](#API_DescribeAffectedEntities_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/health-2016-08-04/DescribeAffectedEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/health-2016-08-04/DescribeAffectedEntities)