IoT / Client / start_on_demand_audit_task
start_on_demand_audit_task#
- IoT.Client.start_on_demand_audit_task(**kwargs)#
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
See also: AWS API Documentation
Request Syntax
response = client.start_on_demand_audit_task( targetCheckNames=[ 'string', ] )
- Parameters:
targetCheckNames (list) –
[REQUIRED]
Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use
DescribeAccountAuditConfiguration
to see the list of all checks, including those that are enabled orUpdateAccountAuditConfiguration
to select which checks are enabled.(string) –
An audit check name. Checks must be enabled for your account. (Use
DescribeAccountAuditConfiguration
to see the list of all checks, including those that are enabled or useUpdateAccountAuditConfiguration
to select which checks are enabled.)
- Return type:
dict
- Returns:
Response Syntax
{ 'taskId': 'string' }
Response Structure
(dict) –
taskId (string) –
The ID of the on-demand audit you started.
Exceptions
IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.InternalFailureException
IoT.Client.exceptions.LimitExceededException