ListControls
Returns a list of controls from AWS Audit Manager.
Request Syntax
GET /controls?controlType=controlType
&maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- controlType
-
The type of control, such as a standard control or a custom control.
Valid Values:
Standard | Custom
Required: Yes
- maxResults
-
Represents the maximum number of results on a page or for an API request call.
Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
The pagination token that's used to fetch the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[A-Za-z0-9+\/=]*$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"controlMetadataList": [
{
"arn": "string",
"controlSources": "string",
"createdAt": number,
"id": "string",
"lastUpdatedAt": number,
"name": "string"
}
],
"nextToken": "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.
- controlMetadataList
-
A list of metadata that the
ListControls
API returns for each control.Type: Array of ControlMetadata objects
- nextToken
-
The pagination token that's used to fetch the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[A-Za-z0-9+\/=]*$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
HTTP Status Code: 403
- InternalServerException
-
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
- ValidationException
-
The request has invalid or missing parameters.
HTTP Status Code: 400
Examples
Retrieving a list of custom controls
This shows a sample response that the ListControls
operation might
return if you had three custom controls.
Sample Response
{
"controlMetadataList": [
{
"arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example11111",
"id": "a1b2c3d4-5678-90ab-cdef-example11111",
"name": "Example custom control",
"controlSources": "AWS API calls, AWS Config, Manual",
"createdAt": "2022-03-28T18:08:24.446000-07:00",
"lastUpdatedAt": "2022-03-28T18:08:24.446000-07:00"
},
{
"arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example22222",
"id": "a1b2c3d4-5678-90ab-cdef-example22222",
"name": "Another custom control",
"controlSources": "AWS API calls, AWS Config, Manual",
"createdAt": "2022-03-28T17:45:15.622000-07:00",
"lastUpdatedAt": "2022-03-28T18:06:56.171000-07:00"
},
{
"arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example33333",
"id": "a1b2c3d4-5678-90ab-cdef-example33333",
"name": "Custom control - CloudTrail Volume Events",
"controlSources": "AWS CloudTrail",
"createdAt": "2021-03-08T11:31:12.468000-08:00",
"lastUpdatedAt": "2022-01-10T14:13:37.979000-08:00"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: