Skip to content

/AWS1/CL_HLTDSCAFFECTEDACCTS01

DescribeAffectedAccountsForOrganizationResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

IT_AFFECTEDACCOUNTS TYPE /AWS1/CL_HLTAFFECTEDACCTSLST_W=>TT_AFFECTEDACCOUNTSLIST TT_AFFECTEDACCOUNTSLIST

A JSON set of elements of the affected accounts.

IV_EVENTSCOPECODE TYPE /AWS1/HLTEVENTSCOPECODE /AWS1/HLTEVENTSCOPECODE

This parameter specifies if the Health event is a public Amazon Web 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 Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services 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.

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.

Queryable Attributes

affectedAccounts

A JSON set of elements of the affected accounts.

Accessible with the following methods

Method Description
GET_AFFECTEDACCOUNTS() Getter for AFFECTEDACCOUNTS, with configurable default
ASK_AFFECTEDACCOUNTS() Getter for AFFECTEDACCOUNTS w/ exceptions if field has no va
HAS_AFFECTEDACCOUNTS() Determine if AFFECTEDACCOUNTS has a value

eventScopeCode

This parameter specifies if the Health event is a public Amazon Web 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 Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services 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.

Accessible with the following methods

Method Description
GET_EVENTSCOPECODE() Getter for EVENTSCOPECODE, with configurable default
ASK_EVENTSCOPECODE() Getter for EVENTSCOPECODE w/ exceptions if field has no valu
HAS_EVENTSCOPECODE() Determine if EVENTSCOPECODE has a value

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.

Accessible with the following methods

Method Description
GET_NEXTTOKEN() Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN() Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN() Determine if NEXTTOKEN has a value