AWS Health
API Reference (API Version 2016-08-04)

EntityFilter

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

Contents

entityArns

A list of entity ARNs (unique identifiers).

Type: Array of strings

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

Length Constraints: Maximum length of 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 100 items.

Length Constraints: Maximum length of 256.

Required: No

eventArns

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331", "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"

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:health:[^:]*:[^:]*:event/[\w-]+

Required: Yes

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 3 items.

Valid Values: IMPAIRED | UNIMPAIRED | UNKNOWN

Required: No

tags

A map of entity tags attached to the affected entity.

Type: Array of string to string maps

Array Members: Maximum number of 50 items.

Key Length Constraints: Maximum length of 127.

Value Length Constraints: Maximum length of 255.

Required: No

See Also

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

On this page: