PUT

/assessments/{assessmentId}

http://auditmanager.{region}.amazonaws.com/assessments/{assessmentId}

Edits an Audit Manager assessment.

Access Token Required: API Key

Path Parameters

assessmentIdstringrequired

The unique identifier for the assessment.

Body Params

rolesarray

The list of roles for the assessment.

scopeobjectrequired

The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.

assessmentNamestring

The name of the assessment to be updated.

assessmentDescriptionstring

The description of the assessment.

assessmentReportsDestinationobject

The location where Audit Manager saves assessment reports for the given assessment.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://auditmanager.{region}.amazonaws.com/assessments/{assessmentId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}