Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateControl

Updates a custom control in AWS Audit Manager.

Request Syntax


PUT /controls/controlId HTTP/1.1
Content-type: application/json

{
   "actionPlanInstructions": "string",
   "actionPlanTitle": "string",
   "controlMappingSources": [ 
      { 
         "sourceDescription": "string",
         "sourceFrequency": "string",
         "sourceId": "string",
         "sourceKeyword": { 
            "keywordInputType": "string",
            "keywordValue": "string"
         },
         "sourceName": "string",
         "sourceSetUpOption": "string",
         "sourceType": "string",
         "troubleshootingText": "string"
      }
   ],
   "description": "string",
   "name": "string",
   "testingInformation": "string"
}

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 accepts the following data in JSON format.

actionPlanInstructions

The recommended actions to carry out if the control isn't fulfilled.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: ^[\w\W\s\S]*$

Required: No

actionPlanTitle

The title of the action plan for remediating the control.

Type: String

Length Constraints: Maximum length of 300.

Pattern: ^[\w\W\s\S]*$

Required: No

controlMappingSources

The data mapping sources for the control.

Type: Array of ControlMappingSource objects

Array Members: Minimum number of 1 item.

Required: Yes

description

The optional description of the control.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: ^[\w\W\s\S]*$

Required: No

name

The name of the updated control.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: ^[^\\]*$

Required: Yes

testingInformation

The steps that you should follow to determine if the control is met.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: ^[\w\W\s\S]*$

Required: No

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",
      "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.

control

The name of the updated control set that the UpdateControl API returned.

Type: Control object

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