Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEntityEvents

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.

Request Syntax


POST /events?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "Entity": { 
      "string" : "string" 
   },
   "StartTime": number
}

URI Request Parameters

The request uses the following URI parameters.

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 250.

NextToken

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

Request Body

The request accepts the following data in JSON format.

EndTime

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

Type: Timestamp

Required: Yes

Entity

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

Type: String to string map

Map Entries: Maximum number of 4 items.

Key Pattern: [a-zA-Z]{1,50}

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [ -~]*[!-~]+[ -~]*

Required: Yes

StartTime

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

Type: Timestamp

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ChangeEvents": [ 
      { 
         "AccountId": "string",
         "ChangeEventType": "string",
         "Entity": { 
            "string" : "string" 
         },
         "EventId": "string",
         "EventName": "string",
         "Region": "string",
         "Timestamp": number,
         "UserName": "string"
      }
   ],
   "EndTime": number,
   "NextToken": "string",
   "StartTime": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeEvents

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

Type: Array of ChangeEvent objects

Array Members: Minimum number of 0 items. Maximum number of 250 items.

EndTime

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

Type: Timestamp

NextToken

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

Type: String

StartTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400