Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAutomationEvents

Lists automation events based on specified filters. You can retrieve events that were created within the past year.

Request Syntax


{
   "endTimeExclusive": number,
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "startTimeInclusive": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTimeExclusive

The end of the time range to query for events.

Type: Timestamp

Required: No

filters

The filters to apply to the list of automation events.

Type: Array of AutomationEventFilter objects

Required: No

maxResults

The maximum number of results to return in a single call.

Type: Integer

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

Required: No

nextToken

The token for the next page of results.

Type: String

Pattern: [A-Za-z0-9+/=]+

Required: No

startTimeInclusive

The start of the time range to query for events.

Type: Timestamp

Required: No

Response Syntax


{
   "automationEvents": [ 
      { 
         "accountId": "string",
         "completedTimestamp": number,
         "createdTimestamp": number,
         "estimatedMonthlySavings": { 
            "afterDiscountSavings": number,
            "beforeDiscountSavings": number,
            "currency": "string",
            "savingsEstimationMode": "string"
         },
         "eventDescription": "string",
         "eventId": "string",
         "eventStatus": "string",
         "eventStatusReason": "string",
         "eventType": "string",
         "recommendedActionId": "string",
         "region": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "resourceType": "string",
         "ruleId": "string"
      }
   ],
   "nextToken": "string"
}

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.

automationEvents

The list of automation events that match the specified criteria.

Type: Array of AutomationEvent objects

nextToken

The token to use to retrieve the next page of results.

Type: String

Pattern: [A-Za-z0-9+/=]+

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

OptInRequiredException

The account must be opted in to Compute Optimizer Automation before performing this action.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400