affected_accounts_for_organizations
Creates, updates, deletes, gets or lists an affected_accounts_for_organizations resource.
Overview
| Name | affected_accounts_for_organizations |
| Type | Resource |
| Id | aws.health.affected_accounts_for_organizations |
Fields
The following fields are returned by SELECT queries:
- describe_affected_accounts_for_organization
| Name | Datatype | Description |
|---|---|---|
affected_account | string | A JSON set of elements of the affected accounts. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_affected_accounts_for_organization | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_affected_accounts_for_organization
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.
SELECT
affected_account
FROM aws.health.affected_accounts_for_organizations
WHERE region = '{{ region }}' -- required
;