Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAffectedAccountsForOrganization

Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.

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


{
   "eventArn": "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.

eventArn

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Type: String

Length Constraints: Maximum length of 1600.

Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}

Required: Yes

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


{
   "affectedAccounts": [ "string" ],
   "eventScopeCode": "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.

affectedAccounts

A JSON set of elements of the affected accounts.

Type: Array of strings

Length Constraints: Maximum length of 12.

Pattern: ^\S+$

eventScopeCode

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response.
If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

Type: String

Valid Values: PUBLIC | ACCOUNT_SPECIFIC | NONE

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