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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

EventFilter

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

Contents

availabilityZones

A list of AWS availability zones.

Type: Array of strings

Pattern: [a-z]{2}\-[0-9a-z\-]{4,16}

Required: No

endTimes

A list of dates and times that the event ended.

Type: Array of DateTimeRange objects

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

Required: No

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 entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

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: No

eventStatusCodes

A list of event status codes.

Type: Array of strings

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

Valid Values: open | closed | upcoming

Required: No

eventTypeCategories

A list of event type category codes (issue, scheduledChange, or accountNotification).

Type: Array of strings

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

Length Constraints: Minimum length of 3. Maximum length of 255.

Valid Values: issue | accountNotification | scheduledChange

Required: No

eventTypeCodes

A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"

Type: Array of strings

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

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

lastUpdatedTimes

A list of dates and times that the event was last updated.

Type: Array of DateTimeRange objects

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

Required: No

regions

A list of AWS regions.

Type: Array of strings

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

Pattern: [^:/]{2,25}

Required: No

services

The AWS services associated with the event. For example, EC2, RDS.

Type: Array of strings

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

Length Constraints: Minimum length of 2. Maximum length of 30.

Required: No

startTimes

A list of dates and times that the event began.

Type: Array of DateTimeRange objects

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

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: