ListAuditMitigationActionsExecutions
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
Request Syntax
GET /audit/mitigationactions/executions?actionStatus=actionStatus&findingId=findingId&maxResults=maxResults&nextToken=nextToken&taskId=taskId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- actionStatus
-
Specify this filter to limit results to those with a specific status.
Valid Values:
IN_PROGRESS | COMPLETED | FAILED | CANCELED | SKIPPED | PENDING - findingId
-
Specify this filter to limit results to those that were applied to a specific audit finding.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- maxResults
-
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- nextToken
-
The token for the next set of results.
- taskId
-
Specify this filter to limit results to actions for a specific audit mitigation actions task.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionsExecutions": [
{
"actionId": "string",
"actionName": "string",
"endTime": number,
"errorCode": "string",
"findingId": "string",
"message": "string",
"startTime": number,
"status": "string",
"taskId": "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.
- actionsExecutions
-
A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
Type: Array of AuditMitigationActionExecutionMetadata objects
- nextToken
-
The token for the next set of results.
Type: String
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
