CreateFramework
Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
Request Syntax
POST /audit/frameworks HTTP/1.1
Content-type: application/json
{
"FrameworkControls": [
{
"ControlInputParameters": [
{
"ParameterName": "string
",
"ParameterValue": "string
"
}
],
"ControlName": "string
",
"ControlScope": {
"ComplianceResourceIds": [ "string
" ],
"ComplianceResourceTypes": [ "string
" ],
"Tags": {
"string
" : "string
"
}
}
}
],
"FrameworkDescription": "string
",
"FrameworkName": "string
",
"FrameworkTags": {
"string
" : "string
"
},
"IdempotencyToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- FrameworkControls
-
The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
Type: Array of FrameworkControl objects
Required: Yes
- FrameworkDescription
-
An optional description of the framework with a maximum of 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*\S.*
Required: No
- FrameworkName
-
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z][_a-zA-Z0-9]*
Required: Yes
- FrameworkTags
-
The tags to assign to the framework.
Type: String to string map
Required: No
- IdempotencyToken
-
A customer-chosen string that you can use to distinguish between otherwise identical calls to
CreateFrameworkInput
. Retrying a successful request with the same idempotency token results in a success message with no action taken.Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"FrameworkArn": "string",
"FrameworkName": "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.
- FrameworkArn
-
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
- FrameworkName
-
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z][_a-zA-Z0-9]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
The required resource already exists.
HTTP Status Code: 400
- InvalidParameterValueException
-
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
HTTP Status Code: 400
- LimitExceededException
-
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
HTTP Status Code: 400
- MissingParameterValueException
-
Indicates that a required parameter is missing.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request failed due to a temporary failure of the server.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: