UpdateScheduledAudit
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
Request Syntax
PATCH /audit/scheduledaudits/scheduledAuditName
HTTP/1.1
Content-type: application/json
{
"dayOfMonth": "string
",
"dayOfWeek": "string
",
"frequency": "string
",
"targetCheckNames": [ "string
" ]
}
URI Request Parameters
The request uses the following URI parameters.
- scheduledAuditName
-
The name of 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
through31
orLAST
. This field is required if thefrequency
parameter is set toMONTHLY
. 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.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. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the "frequency" 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: 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: No
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
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- 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 Amazon SDKs, see the following: