UpdateAssessmentControlSetStatus - AWS Audit Manager

UpdateAssessmentControlSetStatus

Updates the status of a control set in an AWS Audit Manager assessment.

Request Syntax

PUT /assessments/assessmentId/controlSets/controlSetId/status HTTP/1.1 Content-type: application/json { "comment": "string", "status": "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

controlSetId

The identifier for the specified control set.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Required: Yes

Request Body

The request accepts the following data in JSON format.

comment

The comment related to the status update.

Type: String

Length Constraints: Maximum length of 350.

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

Required: Yes

status

The status of the control set that is being updated.

Type: String

Valid Values: ACTIVE | UNDER_REVIEW | REVIEWED

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "controlSet": { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } }

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.

controlSet

The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.

Type: AssessmentControlSet 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: