describeAffectedAccountsForOrganization method

Future<DescribeAffectedAccountsForOrganizationResponse> describeAffectedAccountsForOrganization({
  1. required String eventArn,
  2. int? maxResults,
  3. String? nextToken,
})

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

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

May throw InvalidPaginationToken.

Parameter 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

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

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

Implementation

Future<DescribeAffectedAccountsForOrganizationResponse>
    describeAffectedAccountsForOrganization({
  required String eventArn,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    10,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSHealth_20160804.DescribeAffectedAccountsForOrganization'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'eventArn': eventArn,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeAffectedAccountsForOrganizationResponse.fromJson(
      jsonResponse.body);
}