PUT

/audit/frameworks/{frameworkName}

http://backup.{region}.amazonaws.com/audit/frameworks/{frameworkName}

Updates an existing framework identified by its <code>FrameworkName</code> with the input document in JSON format.

Access Token Required: API Key

Path Parameters

frameworkNamestringrequired

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Body Params

IdempotencyTokenstring

A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>UpdateFrameworkInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.

FrameworkControlsarray

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

FrameworkDescriptionstring

An optional description of the framework with a maximum 1,024 characters.

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://backup.{region}.amazonaws.com/audit/frameworks/{frameworkName}' \
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}