DESCRAFFECTEDACCOUNTSFORORG()`¶

About DescribeAffectedAccountsForOrganization¶

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.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Method Signature¶

METHODS /AWS1/IF_HLT~DESCRAFFECTEDACCOUNTSFORORG
  IMPORTING
    !IV_EVENTARN TYPE /AWS1/HLTEVENTARN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/HLTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/HLTMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hltdscaffectedaccts01
  RAISING
    /AWS1/CX_HLTINVPAGINATIONTOKEN
    /AWS1/CX_HLTCLIENTEXC
    /AWS1/CX_HLTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_eventarn` `TYPE /AWS1/HLTEVENTARN` `/AWS1/HLTEVENTARN`¶

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

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/HLTNEXTTOKEN` `/AWS1/HLTNEXTTOKEN`¶

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.

`iv_maxresults` `TYPE /AWS1/HLTMAXRESULTS` `/AWS1/HLTMAXRESULTS`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_hltdscaffectedaccts01` `/AWS1/CL_HLTDSCAFFECTEDACCTS01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->descraffectedaccountsfororg(
  iv_eventarn = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_affectedaccounts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_accountid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_eventscopecode = lo_result->get_eventscopecode( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_HLT=>DESCRAFFECTEDACCOUNTSFORORG()¶