Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
Request Syntax
GET /audit/scheduledaudits/scheduledAuditName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- scheduledAuditName
-
The name of the scheduled audit whose information you want to get.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"dayOfMonth": "string",
"dayOfWeek": "string",
"frequency": "string",
"scheduledAuditArn": "string",
"scheduledAuditName": "string",
"targetCheckNames": [ "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.
- dayOfMonth
-
The day of the month on which the scheduled audit takes place. This is will be
1through31orLAST. If days29-31are specified, and the month does not have that many days, the audit takes place on theLASTday of the month.Type: String
Pattern:
^([1-9]|[12][0-9]|3[01])$|^LAST$ - dayOfWeek
-
The day of the week on which the scheduled audit takes place, either one of
SUN,MON,TUE,WED,THU,FRI, orSAT.Type: String
Valid Values:
SUN | MON | TUE | WED | THU | FRI | SAT - frequency
-
How often the scheduled audit takes place, either one of
DAILY,WEEKLY,BIWEEKLY, orMONTHLY. The start time of each audit is determined by the system.Type: String
Valid Values:
DAILY | WEEKLY | BIWEEKLY | MONTHLY - scheduledAuditArn
-
The ARN of the scheduled audit.
Type: String
- scheduledAuditName
-
The name of the scheduled audit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+ - targetCheckNames
-
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
DescribeAccountAuditConfigurationto see the list of all checks, including those that are enabled or useUpdateAccountAuditConfigurationto select which checks are enabled.)Type: Array of strings
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 AWS SDKs, see the following:
