Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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

The request accepts the following data in JSON format.

filter

Values to narrow the results returned. At least one event ARN is required.

Type: EntityFilter object

Required: Yes

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

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

The entities that match the filter criteria.

Type: Array of AffectedEntity objects

nextToken

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