affected_entities

Creates, updates, deletes, gets or lists an affected_entities resource.

Overview

Name	affected_entities
Type	Resource
Id	aws.health.affected_entities

Fields

The following fields are returned by SELECT queries:

describe_affected_entities

Name	Datatype	Description
aws_account_id	string	The 12-digit Amazon Web Services account number that contains the affected entity. (pattern: <code>^\S+$</code>)
entity_arn	string	The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K (pattern: <code>.{0,1600}</code>)
entity_metadata	object	Additional metadata about the affected entity.
entity_url	string	The URL of the affected entity.
entity_value	string	The ID of the affected entity. (pattern: <code>.{0,1224}</code>)
event_arn	string	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 (pattern: <code>arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]:[^:]:event(?:/[\w-]+){3}</code>)
last_updated_time	string (date-time)	The most recent time that the entity was updated.
status_code	string	The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, and RESOLVED. (IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, RESOLVED)
tags	object	A map of entity tags attached to the affected entity. Currently, the tags property isn't supported.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_affected_entities	select	region		Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

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_entities

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

SELECT
aws_account_id,
entity_arn,
entity_metadata,
entity_url,
entity_value,
event_arn,
last_updated_time,
status_code,
tags
FROM aws.health.affected_entities
WHERE region = '{{ region }}' -- required
;