OrganizationEvent
¶
Source code in docs_src/capo_health/types/organization_event.py
actionability
instance-attribute
¶
actionability: NotRequired[EventActionability]
The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.
arn
instance-attribute
¶
arn: NotRequired[eventArn]
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
end_time
instance-attribute
¶
end_time: NotRequired[timestamp]
The date and time that the event ended.
event_scope_code
instance-attribute
¶
event_scope_code: NotRequired[eventScopeCode]
This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
-
If the
eventScopeCodevalue isPUBLIC, then theaffectedAccountsvalue is always empty. -
If the
eventScopeCodevalue isACCOUNT_SPECIFIC, then theaffectedAccountsvalue lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response. -
If the
eventScopeCodevalue isNONE, then theeventArnthat you specified in the request is invalid or doesn't exist.
event_type_category
instance-attribute
¶
event_type_category: NotRequired[eventTypeCategory]
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
event_type_code
instance-attribute
¶
event_type_code: NotRequired[eventTypeCode]
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
last_updated_time
instance-attribute
¶
last_updated_time: NotRequired[timestamp]
The most recent date and time that the event was updated.
personas
instance-attribute
¶
personas: NotRequired[EventPersonaList]
A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
region
instance-attribute
¶
region: NotRequired[region]
The Amazon Web Services Region name of the event.
service
instance-attribute
¶
service: NotRequired[service]
The Amazon Web Services service that is affected by the event, such as EC2 and RDS.
start_time
instance-attribute
¶
start_time: NotRequired[timestamp]
The date and time that the event began.
status_code
instance-attribute
¶
status_code: NotRequired[eventStatusCode]
The most recent status of the event. Possible values are open, closed, and upcoming.