Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Mengembalikan rincian kerangka kerja untuk yang ditentukan`FrameworkName`.

## Minta Sintaks
<a name="API_DescribeFramework_RequestSyntax"></a>

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

## Parameter Permintaan URI
<a name="API_DescribeFramework_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
Nama unik dari sebuah kerangka kerja.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z][_a-zA-Z0-9]*`   
Wajib: Ya

## Isi Permintaan
<a name="API_DescribeFramework_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<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"
}
```

## Elemen Respons
<a name="API_DescribeFramework_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
Tanggal dan waktu kerangka kerja dibuat, dalam representasi ISO 8601. Nilai akurat `CreationTime` untuk milidetik. Misalnya, 2020-07-10T 15:00:00.000-08:00 mewakili tanggal 10 Juli 2020 pukul 15:00 8 jam di belakang UTC.  
Tipe: Timestamp

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
Status penyebaran kerangka kerja. Statusnya adalah:  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
Tipe: String

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi sumber daya. Format ARN tergantung pada jenis sumber daya.  
Tipe: String

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
Kontrol yang membentuk kerangka kerja. Setiap kontrol dalam daftar memiliki nama, parameter input, dan ruang lingkup.  
Tipe: Array objek [FrameworkControl](API_FrameworkControl.md)

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
Deskripsi opsional dari kerangka kerja.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.  
Pola: `.*\S.*` 

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
Nama unik dari sebuah kerangka kerja.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Pola: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
Framework terdiri dari satu atau lebih kontrol. Setiap kontrol mengatur sumber daya, seperti rencana cadangan, pilihan cadangan, brankas cadangan, atau titik pemulihan. Anda juga dapat mengaktifkan atau menonaktifkan AWS Config perekaman untuk setiap sumber daya. Statusnya adalah:  
+  `ACTIVE`saat perekaman dihidupkan untuk semua sumber daya yang diatur oleh kerangka kerja.
+  `PARTIALLY_ACTIVE`saat perekaman dimatikan untuk setidaknya satu sumber daya yang diatur oleh kerangka kerja.
+  `INACTIVE`saat perekaman dimatikan untuk semua sumber daya yang diatur oleh kerangka kerja.
+  `UNAVAILABLE`ketika AWS Backup tidak dapat memvalidasi status perekaman saat ini.
Tipe: String

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
String yang dipilih pelanggan yang dapat Anda gunakan untuk membedakan antara panggilan yang identik. `DescribeFrameworkOutput` Mencoba kembali permintaan yang berhasil dengan token idempotensi yang sama menghasilkan pesan sukses tanpa tindakan yang diambil.  
Tipe: String

## Kesalahan
<a name="API_DescribeFramework_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md).

 ** InvalidParameterValueException **   
Menunjukkan bahwa ada sesuatu yang salah dengan nilai parameter. Misalnya, nilainya di luar jangkauan.    
 ** Context **   
  
 ** Type **   

Kode Status HTTP: 400

 ** MissingParameterValueException **   
Menunjukkan bahwa parameter yang diperlukan tidak ada.    
 ** Context **   
  
 ** Type **   

Kode Status HTTP: 400

 ** ResourceNotFoundException **   
Sumber daya yang diperlukan untuk tindakan tidak ada.    
 ** Context **   
  
 ** Type **   

Kode Status HTTP: 400

 ** ServiceUnavailableException **   
Permintaan gagal karena kegagalan sementara server.    
 ** Context **   
  
 ** Type **   

Kode Status HTTP: 500

## Lihat Juga
<a name="API_DescribeFramework_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah 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 untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para 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 untuk 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)