Event - AWS Health

Event

Summary information about an AWS Health event.

AWS Health events can be public or account-specific:

  • Public events might be service events that are not specific to an AWS account. For example, if there is an issue with an AWS Region, AWS Health provides information about the event, even if you don't use services or resources in that Region.

  • Account-specific events are specific to either your AWS account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event and the affected resources in the account.

You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.

Contents

arn

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: 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

availabilityZone

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

Type: String

Length Constraints: Minimum length of 6. Maximum length of 18.

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

Required: No

endTime

The date and time that the event ended.

Type: Timestamp

Required: No

eventScopeCode

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

  • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

  • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response.

  • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

Type: String

Valid Values: PUBLIC | ACCOUNT_SPECIFIC | NONE

Required: No

eventTypeCategory

The category of the event. Possible values are issue, scheduledChange, and accountNotification.

Type: String

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

Valid Values: issue | accountNotification | scheduledChange | investigation

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.

Pattern: [a-zA-Z0-9\_\-]{3,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

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

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.

Pattern: [^:/]{2,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: