Skip to content

ChangeEvent

Source code in docs_src/capo_application_signals/types/change_event.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ChangeEvent(TypedDict, closed=True):
    timestamp: "datetime.datetime"
    """<p>The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>"""
    account_id: "capo_application_signals.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account ID where this change event occurred.</p>"""
    region: "str"
    """<p>The Amazon Web Services region where this change event occurred.</p>"""
    entity: "capo_application_signals.types.attributes.Attributes"
    """<p>The entity (service or resource) that was affected by this change event, including its key attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> <li> <p> <code>AwsAccountId</code> specifies the account where this object is in.</p> </li> </ul> <p>Below is an example of a service.</p> <p> <code>{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }</code> </p> <p>Below is an example of a resource.</p> <p> <code>{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }</code> </p>"""
    change_event_type: (
        "capo_application_signals.types.change_event_type.ChangeEventType"
    )
    """<p>The type of change event that occurred, such as <code>DEPLOYMENT</code>.</p>"""
    event_id: "str"
    """<p>A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be <code>Unknown</code>.</p>"""
    user_name: NotRequired["str"]
    """<p>The name of the user who initiated this change event, if available.</p>"""
    event_name: NotRequired["str"]
    """<p>The name or description of this change event.</p>"""

account_id instance-attribute 

account_id: AwsAccountId

The Amazon Web Services account ID where this change event occurred.

change_event_type instance-attribute 

change_event_type: ChangeEventType

The type of change event that occurred, such as DEPLOYMENT.

entity instance-attribute 

entity: Attributes

The entity (service or resource) that was affected by this change event, including its key attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

  • AwsAccountId specifies the account where this object is in.

Below is an example of a service.

{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

Below is an example of a resource.

{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

event_id instance-attribute 

event_id: str

A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be Unknown.

event_name instance-attribute 

event_name: NotRequired[str]

The name or description of this change event.

region instance-attribute 

region: str

The Amazon Web Services region where this change event occurred.

timestamp instance-attribute 

timestamp: datetime

The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

user_name instance-attribute 

user_name: NotRequired[str]

The name of the user who initiated this change event, if available.