GetControl
Gets information about a specified control.
Request Syntax
GET /controls/controlId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- controlId
-
The identifier for the control.
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"control": {
"actionPlanInstructions": "string",
"actionPlanTitle": "string",
"arn": "string",
"controlMappingSources": [
{
"sourceDescription": "string",
"sourceFrequency": "string",
"sourceId": "string",
"sourceKeyword": {
"keywordInputType": "string",
"keywordValue": "string"
},
"sourceName": "string",
"sourceSetUpOption": "string",
"sourceType": "string",
"troubleshootingText": "string"
}
],
"controlSources": "string",
"createdAt": number,
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"name": "string",
"state": "string",
"tags": {
"string" : "string"
},
"testingInformation": "string",
"type": "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.
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
- ResourceNotFoundException
-
The resource that's specified in the request can't be found.
HTTP Status Code: 404
- ValidationException
-
The request has invalid or missing parameters.
HTTP Status Code: 400
Examples
Getting information about a control
This example shows a sample response for the GetControl
API
operation. This example returns details about a specific custom control. In this
case, the control has three automated data sources. Each data source is a specific
CloudTrail event (ec2_ModifyInstanceAttribute
,
ec2_CreateImage
, and ec2_RunInstances
).
Sample Response
{
"control": {
"arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example11111",
"id": "a1b2c3d4-5678-90ab-cdef-example11111",
"type": "Custom",
"name": "1.0.1 - CloudTrail Instance Events_CUSTOM",
"description": "CloudTrail eventName for instances",
"testingInformation": "CloudTrail eventName:\n\n- CreateImage\n- RunInstances\n- ModifyInstanceAttribute ",
"actionPlanTitle": "The title of my action plan",
"actionPlanInstructions": "The details of my action plan instructions",
"controlSources": "AWS CloudTrail",
"controlMappingSources": [
{
"sourceId": "sourceid-5678-90ab-cdef-example11111",
"sourceName": "Data source 1",
"sourceSetUpOption": "System_Controls_Mapping",
"sourceType": "AWS_Cloudtrail",
"sourceKeyword": {
"keywordInputType": "SELECT_FROM_LIST",
"keywordValue": "ec2_ModifyInstanceAttribute"
}
},
{
"sourceId": "sourceid-5678-90ab-cdef-example22222",
"sourceName": "Data source 2",
"sourceSetUpOption": "System_Controls_Mapping",
"sourceType": "AWS_Cloudtrail",
"sourceKeyword": {
"keywordInputType": "SELECT_FROM_LIST",
"keywordValue": "ec2_CreateImage"
}
},
{
"sourceId": "sourceid-5678-90ab-cdef-example33333",
"sourceName": "Data source 3",
"sourceSetUpOption": "System_Controls_Mapping",
"sourceType": "AWS_Cloudtrail",
"sourceKeyword": {
"keywordInputType": "SELECT_FROM_LIST",
"keywordValue": "ec2_RunInstances"
}
}
],
"createdAt": "2023-03-13T12:00:58.943000-07:00",
"lastUpdatedAt": "2023-03-13T12:00:58.943000-07:00",
"createdBy": "john-doe",
"lastUpdatedBy": "jane-doe",
"state": "ACTIVE",
"tags": {
"Department": "Legal"
}
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: