ListControlOperations
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
Request Syntax
POST /list-control-operations HTTP/1.1
Content-type: application/json
{
"filter": {
"controlIdentifiers": [ "string" ],
"controlOperationTypes": [ "string" ],
"enabledControlIdentifiers": [ "string" ],
"statuses": [ "string" ],
"targetIdentifiers": [ "string" ]
},
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filter
-
An input filter for the
ListControlOperationsAPI that lets you select the types of control operations to view.Type: ControlOperationFilter object
Required: No
- maxResults
-
The maximum number of results to be shown.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
A pagination token.
Type: String
Pattern:
\S+Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"controlOperations": [
{
"controlIdentifier": "string",
"enabledControlIdentifier": "string",
"endTime": "string",
"operationIdentifier": "string",
"operationType": "string",
"startTime": "string",
"status": "string",
"statusMessage": "string",
"targetIdentifier": "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.
- controlOperations
-
Returns a list of output from control operations.
Type: Array of ControlOperationSummary objects
- nextToken
-
A pagination token.
Type: String
Pattern:
\S+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during processing of a request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input does not satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
