/audit/scheduledaudits

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/audit/scheduledaudits'

Response Example

200 - Example 1

{
    "scheduledAudits": [],
    "nextToken": "string"
}

Request

Query Params

nextToken

string

optional

The token for the next set of results.

maxResults

integer

optional

The maximum number of results to return at one time. The default is 25.

Responses

🟢200Success

application/json

Body

scheduledAudits

array[object (ScheduledAuditMetadata) {5}]

optional

The list of scheduled audits.

scheduledAuditName

string

optional

The name of the scheduled audit.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

scheduledAuditArn

string

optional

The ARN of the scheduled audit.

frequency

enum<string>

optional

How often the scheduled audit occurs.

Allowed values:

DAILYWEEKLYBIWEEKLYMONTHLY

dayOfMonth

string

optional

The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

Match pattern:

^([1-9]|[12][0-9]|3[01])$|^LAST$

dayOfWeek

enum<string>

optional

The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

Allowed values:

SUNMONTUEWEDTHUFRISAT

nextToken

string

optional

A token that can be used to retrieve the next set of results, or null if there are no additional results.

<= 4096 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException

Modified at 2022-09-10 23:12:18

/role-aliases

/security-profiles