/audit/scheduledaudits/{scheduledAuditName}

The AWS IoT Wireless multi-region endpoint

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

POST

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/audit/scheduledaudits/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "frequency": "DAILY",
    "dayOfMonth": "string",
    "dayOfWeek": "SUN",
    "targetCheckNames": [
        "string"
    ],
    "tags": [
        {
            "Key": "string",
            "Value": "string"
        }
    ]
}'

Response Example

200 - Example 1

{
    "scheduledAuditArn": "string"
}

Request

Path Params

scheduledAuditName

string

required

The name you want to give to the scheduled audit. (Max. 128 chars)

Body Params application/json

frequency

enum<string>

required

How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.

Allowed values:

DAILYWEEKLYBIWEEKLYMONTHLY

dayOfMonth

string

optional

The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't 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 takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

Allowed values:

SUNMONTUEWEDTHUFRISAT

targetCheckNames

array[string]

required

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Responses

🟢200Success

application/json

Body

scheduledAuditArn

string

optional

The ARN of the scheduled audit.

🟠480InvalidRequestException

🟠481ResourceAlreadyExistsException

🟠482ThrottlingException

🟠483InternalFailureException

🟠484LimitExceededException

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

/role-aliases/{roleAlias}

/audit/scheduledaudits/{scheduledAuditName}