기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

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

지정된 `FrameworkName`에 대한 프레임워크 세부 정보를 반환합니다.

## Request Syntax
<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]*`   
필수 여부: 예

## Request Body
<a name="API_DescribeFramework_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<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은 UTC보다 8시간 늦은 2020년 7월 10일 오후 3시를 나타냅니다.  
유형: 타임스탬프

 ** [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` 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
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS .NET V4용 SDK](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 Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS Java V2용 SDK](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 PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS Python용 SDK](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)