Skip to content

Returns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities

Description

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.

Usage

cloudwatchapplicationsignals_list_entity_events(Entity, StartTime,
  EndTime, MaxResults, NextToken)

Arguments

  • Entity

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

  • StartTime

    [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

    [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

    The maximum number of change events to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken

    Include this value, if it was returned by the previous operation, to get the next set of change events.

Value

A list with the following syntax:

list(
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  ChangeEvents = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      AccountId = "string",
      Region = "string",
      Entity = list(
        "string"
      ),
      ChangeEventType = "DEPLOYMENT"|"CONFIGURATION",
      EventId = "string",
      UserName = "string",
      EventName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_entity_events(
  Entity = list(
    "string"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NextToken = "string"
)