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.

Event

Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.

Contents

arn

The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331

Type: String

Length Constraints: Maximum length of 1600.

Pattern: arn:aws:health:[^:]*:[^:]*:event/[\w-]+

Required: No

availabilityZone

The AWS Availability Zone of the event. For example, us-east-1a.

Type: String

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

Required: No

endTime

The date and time that the event ended.

Type: Timestamp

Required: No

eventTypeCategory

The

Type: String

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

Valid Values: issue | accountNotification | scheduledChange

Required: No

eventTypeCode

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

Type: String

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

Required: No

lastUpdatedTime

The most recent date and time that the event was updated.

Type: Timestamp

Required: No

region

The AWS region name of the event.

Type: String

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

Required: No

service

The AWS service that is affected by the event. For example, EC2, RDS.

Type: String

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

Required: No

startTime

The date and time that the event began.

Type: Timestamp

Required: No

statusCode

The most recent status of the event. Possible values are open, closed, and upcoming.

Type: String

Valid Values: open | closed | upcoming

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: