CloudWatchApplicationSignals / Client / list_entity_events

list_entity_events

CloudWatchApplicationSignals.Client.list_entity_events(**kwargs)

Returns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities. This operation helps track the history of changes that may have affected service performance.

See also: AWS API Documentation

Request Syntax

response = client.list_entity_events(
    Entity={
        'string': 'string'
    },
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Entity (dict) –

    [REQUIRED]

    The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.

    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" }

    • (string) –

      • (string) –

  • StartTime (datetime) –

    [REQUIRED]

    The start of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

  • EndTime (datetime) –

    [REQUIRED]

    The end of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

  • MaxResults (integer) – The maximum number of change events to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken (string) – Include this value, if it was returned by the previous operation, to get the next set of change events.

Return type:

dict

Returns:

Response Syntax

{
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'ChangeEvents': [
        {
            'Timestamp': datetime(2015, 1, 1),
            'AccountId': 'string',
            'Region': 'string',
            'Entity': {
                'string': 'string'
            },
            'ChangeEventType': 'DEPLOYMENT'|'CONFIGURATION',
            'EventId': 'string',
            'UserName': 'string',
            'EventName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • StartTime (datetime) –

      The start of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

    • EndTime (datetime) –

      The end of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

    • ChangeEvents (list) –

      An array of structures, where each structure contains information about one change event that occurred for the specified entity during the requested time period.

      • (dict) –

        A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.

        • 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.

        • AccountId (string) –

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

        • Region (string) –

          The Amazon Web Services region where this change event occurred.

        • Entity (dict) –

          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" }

          • (string) –

            • (string) –

        • ChangeEventType (string) –

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

        • EventId (string) –

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

        • UserName (string) –

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

        • EventName (string) –

          The name or description of this change event.

    • NextToken (string) –

      Include this value in your next use of this API to get the next set of change events.

Exceptions