/AWS1/CL_HLTAFFECTEDENTITY¶
Information about an entity that is affected by a Health event.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_entityarn TYPE /AWS1/HLTENTITYARN /AWS1/HLTENTITYARN¶
The unique identifier for the entity. Format:
arn:aws:health:entity-region:aws-account:entity/entity-id. Example:arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
iv_eventarn 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_IDformat.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_entityvalue TYPE /AWS1/HLTENTITYVALUE /AWS1/HLTENTITYVALUE¶
The ID of the affected entity.
iv_entityurl TYPE /AWS1/HLTENTITYURL /AWS1/HLTENTITYURL¶
The URL of the affected entity.
iv_awsaccountid TYPE /AWS1/HLTACCOUNTID /AWS1/HLTACCOUNTID¶
The 12-digit Amazon Web Services account number that contains the affected entity.
iv_lastupdatedtime TYPE /AWS1/HLTTIMESTAMP /AWS1/HLTTIMESTAMP¶
The most recent time that the entity was updated.
iv_statuscode TYPE /AWS1/HLTENTITYSTATUSCODE /AWS1/HLTENTITYSTATUSCODE¶
The most recent status of the entity affected by the event. The possible values are
IMPAIRED,UNIMPAIRED,UNKNOWN,PENDING, andRESOLVED.
it_tags TYPE /AWS1/CL_HLTTAGSET_W=>TT_TAGSET TT_TAGSET¶
A map of entity tags attached to the affected entity.
Currently, the
tagsproperty isn't supported.
it_entitymetadata TYPE /AWS1/CL_HLTENTITYMETADATA_W=>TT_ENTITYMETADATA TT_ENTITYMETADATA¶
Additional metadata about the affected entity.
Queryable Attributes¶
entityArn¶
The unique identifier for the entity. Format:
arn:aws:health:entity-region:aws-account:entity/entity-id. Example:arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTITYARN() |
Getter for ENTITYARN, with configurable default |
ASK_ENTITYARN() |
Getter for ENTITYARN w/ exceptions if field has no value |
HAS_ENTITYARN() |
Determine if ENTITYARN has a value |
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_IDformat.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_EVENTARN() |
Getter for EVENTARN, with configurable default |
ASK_EVENTARN() |
Getter for EVENTARN w/ exceptions if field has no value |
HAS_EVENTARN() |
Determine if EVENTARN has a value |
entityValue¶
The ID of the affected entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTITYVALUE() |
Getter for ENTITYVALUE, with configurable default |
ASK_ENTITYVALUE() |
Getter for ENTITYVALUE w/ exceptions if field has no value |
HAS_ENTITYVALUE() |
Determine if ENTITYVALUE has a value |
entityUrl¶
The URL of the affected entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTITYURL() |
Getter for ENTITYURL, with configurable default |
ASK_ENTITYURL() |
Getter for ENTITYURL w/ exceptions if field has no value |
HAS_ENTITYURL() |
Determine if ENTITYURL has a value |
awsAccountId¶
The 12-digit Amazon Web Services account number that contains the affected entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWSACCOUNTID() |
Getter for AWSACCOUNTID, with configurable default |
ASK_AWSACCOUNTID() |
Getter for AWSACCOUNTID w/ exceptions if field has no value |
HAS_AWSACCOUNTID() |
Determine if AWSACCOUNTID has a value |
lastUpdatedTime¶
The most recent time that the entity 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 entity affected by the event. The possible values are
IMPAIRED,UNIMPAIRED,UNKNOWN,PENDING, andRESOLVED.
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 |
tags¶
A map of entity tags attached to the affected entity.
Currently, the
tagsproperty isn't supported.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
entityMetadata¶
Additional metadata about the affected entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTITYMETADATA() |
Getter for ENTITYMETADATA, with configurable default |
ASK_ENTITYMETADATA() |
Getter for ENTITYMETADATA w/ exceptions if field has no valu |
HAS_ENTITYMETADATA() |
Determine if ENTITYMETADATA 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_ENTITYLIST¶
TYPES TT_ENTITYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_HLTAFFECTEDENTITY WITH DEFAULT KEY
.