OrganizationEvent
Summary information about an event, returned by the DescribeEventsForOrganization operation.
Contents
- arn
-
The unique identifier for the event. The event ARN has the
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
format.For example, an event ARN might look like the following:
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
- 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 isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
Type: String
Valid Values:
PUBLIC | ACCOUNT_SPECIFIC | NONE
Required: No
-
- eventTypeCategory
-
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time.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, such as EC2 and 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
, andupcoming
.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: