UpdateAssessment - AWS Audit Manager

UpdateAssessment

Edits an AWS Audit Manager assessment.

Request Syntax

PUT /assessments/assessmentId HTTP/1.1 Content-type: application/json { "assessmentDescription": "string", "assessmentName": "string", "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "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

Request Body

The request accepts the following data in JSON format.

assessmentDescription

The description of the specified assessment.

Type: String

Length Constraints: Maximum length of 1000.

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

Required: No

assessmentName

The name of the specified assessment to be updated.

Type: String

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

Pattern: ^[^\\]*$

Required: No

assessmentReportsDestination

The assessment report storage destination for the specified assessment that is being updated.

Type: AssessmentReportsDestination object

Required: No

roles

The list of roles for the specified assessment.

Type: Array of Role objects

Required: No

scope

The scope of the specified assessment.

Type: Scope object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "assessment": { "arn": "string", "awsAccount": { "emailAddress": "string", "id": "string", "name": "string" }, "framework": { "arn": "string", "controlSets": [ { "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 } ], "id": "string", "metadata": { "complianceType": "string", "description": "string", "logo": "string", "name": "string" } }, "metadata": { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "complianceType": "string", "creationTime": number, "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", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "status": "string" }, "tags": { "string" : "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.

assessment

The response object (name of the updated assessment) for the UpdateAssessmentRequest API.

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