ListAuditTasks
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
Request Syntax
GET /audit/tasks?endTime=endTime&maxResults=maxResults&nextToken=nextToken&startTime=startTime&taskStatus=taskStatus&taskType=taskType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- endTime
-
The end of the time period.
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.
- startTime
-
The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
Required: Yes
- taskStatus
-
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
Valid Values:
IN_PROGRESS | COMPLETED | FAILED | CANCELED - taskType
-
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
Valid Values:
ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"tasks": [
{
"taskId": "string",
"taskStatus": "string",
"taskType": "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
-
A token that can be used to retrieve the next set of results, or
nullif there are no additional results.Type: String
- tasks
-
The audits that were performed during the specified time period.
Type: Array of AuditTaskMetadata 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:
