AWS IoT
API Reference

ListScheduledAudits

Lists all of your scheduled audits.

Request Syntax

GET /audit/scheduledaudits?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "scheduledAudits": [ { "dayOfMonth": "string", "dayOfWeek": "string", "frequency": "string", "scheduledAuditArn": "string", "scheduledAuditName": "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 null if there are no additional results.

Type: String

scheduledAudits

The list of scheduled audits.

Type: Array of ScheduledAuditMetadata 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: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: