Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
Request Syntax
GET /audit/mitigationactions/tasks?auditTaskId=auditTaskId&endTime=endTime&findingId=findingId&maxResults=maxResults&nextToken=nextToken&startTime=startTime&taskStatus=taskStatus HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- auditTaskId
-
Specify this filter to limit results to tasks that were applied to results for a specific audit.
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z0-9\-]+ - endTime
-
Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
Required: Yes
- findingId
-
Specify this filter to limit results to tasks that were applied to a specific audit finding.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+ - 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.
- startTime
-
Specify this filter to limit results to tasks that began on or after a specific date and time.
Required: Yes
- taskStatus
-
Specify this filter to limit results to tasks that are in a specific state.
Valid Values:
IN_PROGRESS | COMPLETED | FAILED | CANCELED
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"tasks": [
{
"startTime": number,
"taskId": "string",
"taskStatus": "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.
- nextToken
-
The token for the next set of results.
Type: String
- tasks
-
The collection of audit mitigation tasks that matched the filter criteria.
Type: Array of AuditMitigationActionsTaskMetadata objects
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:
