翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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 時 (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 です。最大長は 1,024 です。  
パターン: `.*\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>
フレームワークは、1 つ以上のコントロールで構成されます。各コントロールは、バックアッププラン、バックアップ選択、バックアップボールト、復旧ポイントなどのリソースを管理します。また、各リソースの AWS Config 録音をオンまたはオフに切り替えることもできます。ステータスは次のとおりです。  
+  `ACTIVE`フレームワークによって管理されるすべてのリソースで記録が有効になっている場合。
+  `PARTIALLY_ACTIVE`フレームワークによって管理されている少なくとも 1 つのリソースについて記録がオフになっている場合。
+  `INACTIVE`フレームワークによって管理されるすべてのリソースで記録がオフになっている場合。
+  `UNAVAILABLE` この時点で AWS Backup が記録ステータスを検証できない場合。
タイプ: 文字列

 ** [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework)