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

ListOperationEvents

Returns a list of operations events.

Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.

Request Syntax


POST /list-operation-events HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "OperationId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

Optionally specify filters to narrow the returned operation event items.

Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.

Type: Array of Filter objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Type: Integer

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

Required: No

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Pattern: .{16,2048}

Required: No

OperationId

The ID of the operation.

Type: String

Pattern: [{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "OperationEvents": [ 
      { 
         "Description": "string",
         "Resource": { 
            "ResourceArn": "string",
            "ResourceType": "string"
         },
         "Status": "string",
         "StatusMessage": "string",
         "Timestamp": 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.

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Pattern: .{16,2048}

OperationEvents

A returned list of operation events that meet the filter criteria.

Type: Array of OperationEvent objects

Errors

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

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400