Skip to content

Entity

Used by
Source code in docs_src/capo_cloudwatch_logs/types/entity.py 
12
13
14
15
16
17
18
19
20
class Entity(TypedDict, closed=True):
    key_attributes: NotRequired[
        "capo_cloudwatch_logs.types.entity_key_attributes.EntityKeyAttributes"
    ]
    """<p>The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same <code>keyAttributes</code> are considered to be the same entity.</p> <p>There are five allowed attributes (key names): <code>Type</code>, <code>ResourceType</code>, <code>Identifier</code> <code>Name</code>, and <code>Environment</code>.</p> <p>For details about how to use the key attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How to add related information to telemetry</a> in the <i>CloudWatch User Guide</i>.</p>"""
    attributes: NotRequired[
        "capo_cloudwatch_logs.types.entity_attributes.EntityAttributes"
    ]
    """<p>Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.</p> <p>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How to add related information to telemetry</a> in the <i>CloudWatch User Guide</i>.</p>"""

attributes instance-attribute 

attributes: NotRequired[EntityAttributes]

Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.

For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.

key_attributes instance-attribute 

key_attributes: NotRequired[EntityKeyAttributes]

The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same keyAttributes are considered to be the same entity.

There are five allowed attributes (key names): Type, ResourceType, Identifier Name, and Environment.

For details about how to use the key attributes, see How to add related information to telemetry in the CloudWatch User Guide.