DescribeFramework - AWS Backup
Minta SintaksParameter Permintaan URIIsi PermintaanSintaks ResponsElemen ResponsKesalahanLihat Juga

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

DescribeFramework

Mengembalikan rincian kerangka kerja untuk yang ditentukanFrameworkName.

Minta Sintaks

GET /audit/frameworks/frameworkName HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

frameworkName

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

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

CreationTime

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

Status penyebaran kerangka kerja. Statusnya adalah:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Jenis: String

FrameworkArn

Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi sumber daya. Format ARN tergantung pada jenis sumber daya.

Jenis: String

FrameworkControls

Kontrol yang membentuk kerangka kerja. Setiap kontrol dalam daftar memiliki nama, parameter input, dan ruang lingkup.

Tipe: Array objek FrameworkControl

FrameworkDescription

Deskripsi opsional dari kerangka kerja.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.

Pola: .*\S.*

FrameworkName

Nama unik dari sebuah kerangka kerja.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

Pola: [a-zA-Z][_a-zA-Z0-9]*

FrameworkStatus

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:

  • ACTIVEsaat perekaman dihidupkan untuk semua sumber daya yang diatur oleh kerangka kerja.

  • PARTIALLY_ACTIVEsaat perekaman dimatikan untuk setidaknya satu sumber daya yang diatur oleh kerangka kerja.

  • INACTIVEsaat perekaman dimatikan untuk semua sumber daya yang diatur oleh kerangka kerja.

  • UNAVAILABLEketika AWS Backup tidak dapat memvalidasi status perekaman saat ini.

Jenis: String

IdempotencyToken

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.

Jenis: String

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidParameterValueException

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

Kode Status HTTP: 400

MissingParameterValueException

Menunjukkan bahwa parameter yang diperlukan tidak ada.

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang diperlukan untuk tindakan tidak ada.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

Kode Status HTTP: 500

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: