Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAffectedEntitiesForOrganization

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

At least one event Amazon Resource Name (ARN) and account ID are required.

Before you can call this operation, you must first enable Amazon Health to work with Amazon 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.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Amazon Health events. For more information, see Resource- and action-based conditions in the Amazon Health User Guide.

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

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"
}