Skip to content

AffectedEntity

Source code in docs_src/capo_health/types/affected_entity.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class AffectedEntity(TypedDict, closed=True):
    entity_arn: NotRequired["capo_health.types.entity_arn.entityArn"]
    """<p>The unique identifier for the entity. Format: <code>arn:aws:health:<i>entity-region</i>:<i>aws-account</i>:entity/<i>entity-id</i> </code>. Example: <code>arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K</code> </p>"""
    event_arn: NotRequired["capo_health.types.event_arn.eventArn"]
    """<p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"""
    entity_value: NotRequired["capo_health.types.entity_value.entityValue"]
    """<p>The ID of the affected entity.</p>"""
    entity_url: NotRequired["capo_health.types.entity_url.entityUrl"]
    """<p>The URL of the affected entity.</p>"""
    aws_account_id: NotRequired["capo_health.types.account_id.accountId"]
    """<p>The 12-digit Amazon Web Services account number that contains the affected entity.</p>"""
    last_updated_time: NotRequired["capo_health.types.timestamp.timestamp"]
    """<p>The most recent time that the entity was updated.</p>"""
    status_code: NotRequired["capo_health.types.entity_status_code.entityStatusCode"]
    """<p>The most recent status of the entity affected by the event. The possible values are <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, <code>UNKNOWN</code>, <code>PENDING</code>, and <code>RESOLVED</code>.</p>"""
    tags: NotRequired["capo_health.types.tag_set.tagSet"]
    """<p>A map of entity tags attached to the affected entity.</p> <note> <p>Currently, the <code>tags</code> property isn't supported.</p> </note>"""
    entity_metadata: NotRequired["capo_health.types.entity_metadata.entityMetadata"]
    """<p>Additional metadata about the affected entity.</p>"""

aws_account_id instance-attribute 

aws_account_id: NotRequired[accountId]

The 12-digit Amazon Web Services account number that contains the affected entity.

entity_arn instance-attribute 

entity_arn: NotRequired[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

entity_metadata instance-attribute 

entity_metadata: NotRequired[entityMetadata]

Additional metadata about the affected entity.

entity_url instance-attribute 

entity_url: NotRequired[entityUrl]

The URL of the affected entity.

entity_value instance-attribute 

entity_value: NotRequired[entityValue]

The ID of the affected entity.

event_arn instance-attribute 

event_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

last_updated_time instance-attribute 

last_updated_time: NotRequired[timestamp]

The most recent time that the entity was updated.

status_code instance-attribute 

status_code: NotRequired[entityStatusCode]

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, and RESOLVED.

tags instance-attribute 

tags: NotRequired[tagSet]

A map of entity tags attached to the affected entity.

Currently, the tags property isn't supported.