本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CreateFramework
建立具有一或多個控制項的架構。架構是可用於評估備份實際做法的控制項集合。透過使用預先建立的可自訂控制項來定義政策,您即可評估備份實際做法是否符合您的政策,以及哪些資源尚未合規。
請求語法
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 請求參數
請求不會使用任何URI參數。
請求主體
請求接受下列JSON格式的資料。
- FrameworkControls
-
構成架構的控制項。清單中的每個控制項都具有名稱、輸入參數和範圍。
類型:FrameworkControl 物件陣列
必要:是
- FrameworkDescription
-
架構的選用描述,最多包含 1,024 個字元。
類型:字串
長度限制:長度下限為 0。長度上限為 1024。
模式:
.*\S.*
必要:否
- FrameworkName
-
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元,以英文字母開頭,由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (_) 組成。
類型:字串
長度限制:長度下限為 1。長度上限為 256。
模式:
[a-zA-Z][_a-zA-Z0-9]*
必要:是
- FrameworkTags
-
要指派給架構的標籤。
類型:字串到字串映射
必要:否
- IdempotencyToken
-
客戶所選擇的字串,可用來區分在其他方面相同的
CreateFrameworkInput
呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息,但未執行任何動作。類型:字串
必要:否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"FrameworkArn": "string",
"FrameworkName": "string"
}
回應元素
如果動作成功,服務會傳回 HTTP 200 個回應。
服務會以 JSON 格式傳回下列資料。
- FrameworkArn
-
唯一識別資源的 Amazon Resource Name (ARN)。的格式ARN取決於資源類型。
類型:字串
- FrameworkName
-
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元,以英文字母開頭,由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (_) 組成。
類型:字串
長度限制:長度下限為 1。長度上限為 256。
模式:
[a-zA-Z][_a-zA-Z0-9]*
錯誤
如需所有動作常見的錯誤資訊,請參閱《常見錯誤》。
- AlreadyExistsException
-
所需資源已存在。
HTTP 狀態碼:400
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
HTTP 狀態碼:400
- LimitExceededException
-
請求已超過限制;例如,請求中允許的最大項目數量。
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: