AffectedEntity - Amazon Health
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AffectedEntity

Information about an entity that is affected by a Health event.

Contents

awsAccountId

The 12-digit Amazon Web Services account number that contains the affected entity.

Type: String

Length Constraints: Maximum length of 12.

Pattern: ^\S+$

Required: No

entityArn

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

Type: String

Length Constraints: Maximum length of 1600.

Pattern: .{0,1600}

Required: No

entityUrl

The URL of the affected entity.

Type: String

Required: No

entityValue

The ID of the affected entity.

Type: String

Length Constraints: Maximum length of 1224.

Pattern: .{0,1224}

Required: No

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

Type: String

Length Constraints: Maximum length of 1600.

Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}

Required: No

lastUpdatedTime

The most recent time that the entity was updated.

Type: Timestamp

Required: No

statusCode

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

Type: String

Valid Values: IMPAIRED | UNIMPAIRED | UNKNOWN

Required: No

tags

A map of entity tags attached to the affected entity.

Note

Currently, the tags property isn't supported.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Maximum length of 127.

Key Pattern: .{0,127}

Value Length Constraints: Maximum length of 255.

Value Pattern: .{0,255}

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: