Skip to content

/AWS1/CL_HLTORGANIZATIONEVENT

Summary information about an event, returned by the DescribeEventsForOrganization operation.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/HLTEVENTARN /AWS1/HLTEVENTARN

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

iv_service TYPE /AWS1/HLTSERVICE /AWS1/HLTSERVICE

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

iv_eventtypecode TYPE /AWS1/HLTEVENTTYPECODE /AWS1/HLTEVENTTYPECODE

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

iv_eventtypecategory TYPE /AWS1/HLTEVENTTYPECATEGORY /AWS1/HLTEVENTTYPECATEGORY

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

iv_eventscopecode TYPE /AWS1/HLTEVENTSCOPECODE /AWS1/HLTEVENTSCOPECODE

This parameter specifies if the Health event is a public Amazon Web Services 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 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 eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

iv_region TYPE /AWS1/HLTREGION /AWS1/HLTREGION

The Amazon Web Services Region name of the event.

iv_starttime TYPE /AWS1/HLTTIMESTAMP /AWS1/HLTTIMESTAMP

The date and time that the event began.

iv_endtime TYPE /AWS1/HLTTIMESTAMP /AWS1/HLTTIMESTAMP

The date and time that the event ended.

iv_lastupdatedtime TYPE /AWS1/HLTTIMESTAMP /AWS1/HLTTIMESTAMP

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

iv_statuscode TYPE /AWS1/HLTEVENTSTATUSCODE /AWS1/HLTEVENTSTATUSCODE

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

iv_actionability TYPE /AWS1/HLTEVENTACTIONABILITY /AWS1/HLTEVENTACTIONABILITY

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.

it_personas TYPE /AWS1/CL_HLTEVENTPERSONALIST_W=>TT_EVENTPERSONALIST TT_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.

Queryable Attributes

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

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

service

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

Accessible with the following methods

Method Description
GET_SERVICE() Getter for SERVICE, with configurable default
ASK_SERVICE() Getter for SERVICE w/ exceptions if field has no value
HAS_SERVICE() Determine if SERVICE has a value

eventTypeCode

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

Accessible with the following methods

Method Description
GET_EVENTTYPECODE() Getter for EVENTTYPECODE, with configurable default
ASK_EVENTTYPECODE() Getter for EVENTTYPECODE w/ exceptions if field has no value
HAS_EVENTTYPECODE() Determine if EVENTTYPECODE has a value

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.

Accessible with the following methods

Method Description
GET_EVENTTYPECATEGORY() Getter for EVENTTYPECATEGORY, with configurable default
ASK_EVENTTYPECATEGORY() Getter for EVENTTYPECATEGORY w/ exceptions if field has no v
HAS_EVENTTYPECATEGORY() Determine if EVENTTYPECATEGORY has a value

eventScopeCode

This parameter specifies if the Health event is a public Amazon Web Services 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 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 eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

Accessible with the following methods

Method Description
GET_EVENTSCOPECODE() Getter for EVENTSCOPECODE, with configurable default
ASK_EVENTSCOPECODE() Getter for EVENTSCOPECODE w/ exceptions if field has no valu
HAS_EVENTSCOPECODE() Determine if EVENTSCOPECODE has a value

region

The Amazon Web Services Region name of the event.

Accessible with the following methods

Method Description
GET_REGION() Getter for REGION, with configurable default
ASK_REGION() Getter for REGION w/ exceptions if field has no value
HAS_REGION() Determine if REGION has a value

startTime

The date and time that the event began.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

The date and time that the event ended.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

lastUpdatedTime

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

Accessible with the following methods

Method Description
GET_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME, with configurable default
ASK_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME w/ exceptions if field has no val
HAS_LASTUPDATEDTIME() Determine if LASTUPDATEDTIME has a value

statusCode

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

Accessible with the following methods

Method Description
GET_STATUSCODE() Getter for STATUSCODE, with configurable default
ASK_STATUSCODE() Getter for STATUSCODE w/ exceptions if field has no value
HAS_STATUSCODE() Determine if STATUSCODE has a value

actionability

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.

Accessible with the following methods

Method Description
GET_ACTIONABILITY() Getter for ACTIONABILITY, with configurable default
ASK_ACTIONABILITY() Getter for ACTIONABILITY w/ exceptions if field has no value
HAS_ACTIONABILITY() Determine if ACTIONABILITY has a value

personas

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.

Accessible with the following methods

Method Description
GET_PERSONAS() Getter for PERSONAS, with configurable default
ASK_PERSONAS() Getter for PERSONAS w/ exceptions if field has no value
HAS_PERSONAS() Determine if PERSONAS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ORGANIZATIONEVENTLIST

TYPES TT_ORGANIZATIONEVENTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_HLTORGANIZATIONEVENT WITH DEFAULT KEY
.