CreateAssessmentFramework
Creates a custom framework in AWS Audit Manager.
Request Syntax
POST /assessmentFrameworks HTTP/1.1
Content-type: application/json
{
"complianceType": "string",
"controlSets": [
{
"controls": [
{
"id": "string"
}
],
"name": "string"
}
],
"description": "string",
"name": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- complianceType
-
The compliance type that the new custom framework supports, such as CIS or HIPAA.
Type: String
Length Constraints: Maximum length of 100.
Pattern:
^[\w\W\s\S]*$Required: No
- controlSets
-
The control sets that are associated with the framework.
Type: Array of CreateAssessmentFrameworkControlSet objects
Array Members: Minimum number of 1 item.
Required: Yes
- description
-
An optional description for the new custom framework.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[\w\W\s\S]*$Required: No
- name
-
The name of the new custom framework.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
^[^\\]*$Required: Yes
-
The tags that are associated with the framework.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
.{0,255}Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"framework": {
"arn": "string",
"complianceType": "string",
"controlSets": [
{
"controls": [
{
"actionPlanInstructions": "string",
"actionPlanTitle": "string",
"arn": "string",
"controlMappingSources": [
{
"sourceDescription": "string",
"sourceFrequency": "string",
"sourceId": "string",
"sourceKeyword": {
"keywordInputType": "string",
"keywordValue": "string"
},
"sourceName": "string",
"sourceSetUpOption": "string",
"sourceType": "string",
"troubleshootingText": "string"
}
],
"controlSources": "string",
"createdAt": number,
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"name": "string",
"state": "string",
"tags": {
"string" : "string"
},
"testingInformation": "string",
"type": "string"
}
],
"id": "string",
"name": "string"
}
],
"controlSources": "string",
"createdAt": number,
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"logo": "string",
"name": "string",
"tags": {
"string" : "string"
},
"type": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the 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 that's specified in the request can't be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or request a quota increase from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for AWS Audit Manager.
HTTP Status Code: 402
- 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:
