CreateScheduledAudit
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
Request Syntax
POST /audit/scheduledaudits/scheduledAuditName
HTTP/1.1
Content-type: application/json
{
"dayOfMonth": "string
",
"dayOfWeek": "string
",
"frequency": "string
",
"tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"targetCheckNames": [ "string
" ]
}
URI Request Parameters
The request uses the following URI parameters.
- scheduledAuditName
-
The name you want to give to the scheduled audit. (Max. 128 chars)
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
- dayOfMonth
-
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 theLAST
day of the month.Type: String
Pattern:
^([1-9]|[12][0-9]|3[01])$|^LAST$
Required: No
- dayOfWeek
-
The day of the week on which the scheduled audit takes place, either
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if thefrequency
parameter is set toWEEKLY
orBIWEEKLY
.Type: String
Valid Values:
SUN | MON | TUE | WED | THU | FRI | SAT
Required: No
- frequency
-
How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
orMONTHLY
. The start time of each audit is determined by the system.Type: String
Valid Values:
DAILY | WEEKLY | BIWEEKLY | MONTHLY
Required: Yes
-
Metadata that can be used to manage the scheduled audit.
Type: Array of Tag objects
Required: No
- targetCheckNames
-
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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)Type: Array of strings
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"scheduledAuditArn": "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.
- scheduledAuditArn
-
The ARN of the scheduled audit.
Type: String
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
- ResourceAlreadyExistsException
-
The resource already exists.
HTTP Status Code: 409
- 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: