UpdateAssessmentControl - AWS Audit Manager

UpdateAssessmentControl

Updates a control within an assessment in AWS Audit Manager.

Request Syntax

PUT /assessments/assessmentId/controlSets/controlSetId/controls/controlId HTTP/1.1 Content-type: application/json { "commentBody": "string", "controlStatus": "string" }

URI Request Parameters

The request uses the following URI parameters.

assessmentId

The identifier for the specified assessment.

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

controlId

The identifier for the specified 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

controlSetId

The identifier for the specified control set.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

commentBody

The comment body text for the specified control.

Type: String

Length Constraints: Maximum length of 500.

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

Required: No

controlStatus

The status of the specified control.

Type: String

Valid Values: UNDER_REVIEW | REVIEWED | INACTIVE

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "control": { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "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 returned by the UpdateAssessmentControl API.

Type: AssessmentControl object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS 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 specified in the request cannot be found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: