EntityFilter - AWS Health
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

EntityFilter

The values to use to filter results from the DescribeAffectedEntities operation.

Contents

eventArns

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Maximum length of 1600.

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

Required: Yes

entityArns

A list of entity ARNs (unique identifiers).

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 99 items.

Length Constraints: Maximum length of 1600.

Pattern: .{0,1600}

Required: No

entityValues

A list of IDs for affected entities.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 99 items.

Length Constraints: Maximum length of 1224.

Pattern: .{0,1224}

Required: No

lastUpdatedTimes

A list of the most recent dates and times that the entity was updated.

Type: Array of DateTimeRange objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

statusCodes

A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Valid Values: IMPAIRED | UNIMPAIRED | UNKNOWN | PENDING | RESOLVED

Required: No

tags

A map of entity tags attached to the affected entity.

Note

Currently, the tags property isn't supported.

Type: Array of string to string maps

Array Members: Maximum number of 50 items.

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 AWS SDKs, see the following: