本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# DescribeFramework
<a name="API_DescribeFramework"></a>

返回指定 `FrameworkName` 的框架详细信息。

## 请求语法
<a name="API_DescribeFramework_RequestSyntax"></a>

```
GET /audit/frameworks/frameworkName HTTP/1.1
```

## URI 请求参数
<a name="API_DescribeFramework_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
框架的唯一名称。  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必需：是

## 请求体
<a name="API_DescribeFramework_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DescribeFramework_ResponseSyntax"></a>

```
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"
}
```

## 响应元素
<a name="API_DescribeFramework_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
框架的创建日期和时间，以 ISO 8601 表示。`CreationTime` 的值精确到毫秒。例如，2020-07-10T15:00:00.000-08:00 表示 2020 年 7 月 10 日下午 3:00，比 UTC 晚 8 个小时。  
类型：时间戳

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
框架的部署状态。状态包括：  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
类型：字符串

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
构成框架的控件。列表中的每个控件都有名称、输入参数和范围。  
类型：[FrameworkControl](API_FrameworkControl.md) 对象数组

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
框架的可选描述。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 1024。  
模式：`.*\S.*`

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
框架的唯一名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
框架由一个或多个控件组成。每个控件都控制一种资源，例如备份计划、备份选择、备份保管库或恢复点。您也可以为每种资源开启或关闭 AWS Config 记录。状态包括：  
+  `ACTIVE`，当框架管理的所有资源都开启记录功能时。
+  `PARTIALLY_ACTIVE`，当至少一个受框架管理的资源关闭记录时。
+  `INACTIVE`，当框架管理的所有资源都关闭记录时。
+  `UNAVAILABLE`wh AWS Backup en 此时无法验证录制状态。
类型：字符串

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
客户选择的字符串，可用于区分对 `DescribeFrameworkOutput` 的其他相同调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息，而不执行任何操作。  
类型：字符串

## 错误
<a name="API_DescribeFramework_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示参数的值有问题。例如，该值超出了范围。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** MissingParameterValueException **   
表示缺少必需的参数。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作所需的资源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ServiceUnavailableException **   
由于服务器发生临时故障而导致请求失败。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：500

## 另请参阅
<a name="API_DescribeFramework_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework)