StartOnDemandAuditTask
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
Request Syntax
POST /audit/tasks HTTP/1.1
Content-type: application/json
{
"targetCheckNames": [ "string" ]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- targetCheckNames
-
Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use
DescribeAccountAuditConfigurationto see the list of all checks, including those that are enabled orUpdateAccountAuditConfigurationto select which checks are enabled.Type: Array of strings
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"taskId": "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.
- taskId
-
The ID of the on-demand audit you started.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z0-9\-]+
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit has been exceeded.
HTTP Status Code: 410
- 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:
