本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeFramework
傳回指定 FrameworkName 的架構詳細資訊。
請求語法
GET /audit/frameworks/frameworkName HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- frameworkName
-
架構的唯一名稱。
長度限制：長度下限為 1。長度上限為 256。
模式：
[a-zA-Z][_a-zA-Z0-9]*必要：是
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"DeploymentStatus": "string",
"FrameworkArn": "string",
"FrameworkControls": [
{
"ControlInputParameters": [
{
"ParameterName": "string",
"ParameterValue": "string"
}
],
"ControlName": "string",
"ControlScope": {
"ComplianceResourceIds": [ "string" ],
"ComplianceResourceTypes": [ "string" ],
"Tags": {
"string" : "string"
}
}
}
],
"FrameworkDescription": "string",
"FrameworkName": "string",
"FrameworkStatus": "string",
"IdempotencyToken": "string"
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- CreationTime
-
架構建立時的日期和時間，採用 ISO 8601 表示法。
CreationTime的值精確到毫秒。舉例來說，2020-07-10T15:00:00.000-08:00 代表 2020 年 7 月 10 日下午 3 點，比國際標準時間晚 8 小時。類型：Timestamp
- DeploymentStatus
-
架構的部署狀態。狀態如下：
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED類型：字串
- FrameworkArn
-
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。
類型：字串
- FrameworkControls
-
組成架構的控制項。清單中的每個控制項都具有名稱、輸入參數和範圍。
類型：FrameworkControl 物件陣列
- FrameworkDescription
-
架構的選擇性說明。
類型：字串
長度限制：長度下限為 0。長度上限為 1024。
模式：
.*\S.* - FrameworkName
-
架構的唯一名稱。
類型：字串
長度限制：長度下限為 1。長度上限為 256。
模式：
[a-zA-Z][_a-zA-Z0-9]* - FrameworkStatus
-
架構包含一或多個控制項。每個控制項皆控管一項資源，例如備份計畫、備份選擇、備份保存庫或復原點。您也可以開啟或關閉每個資源的 AWS Config 記錄功能。狀態如下：
-
當架構控管的所有資源皆開啟記錄時為
ACTIVE。 -
當架構控管的資源中至少一項關閉記錄時為
PARTIALLY_ACTIVE。 -
當架構控管的所有資源皆關閉記錄時為
INACTIVE。 -
UNAVAILABLE此 AWS Backup 時無法驗證錄製狀態。
類型：字串
-
- IdempotencyToken
-
客戶所選擇的字串，可用來區分在其他方面相同的
DescribeFrameworkOutput呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。類型：字串
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如，值超出範圍。
HTTP 狀態碼：400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼：400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼：400
- ServiceUnavailableException
-
由於伺服器發生臨時故障，請求失敗。
HTTP 狀態碼：500
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
