

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

# Cluster Elastis Amazon DocumentDB
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

Tindakan berikut didukung oleh Amazon DocumentDB Elastic Clusters:
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# ApplyPendingMaintenanceAction
<a name="API_elastic_ApplyPendingMaintenanceAction"></a>

Jenis tindakan pemeliharaan tertunda yang akan diterapkan ke sumber daya.

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

```
POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}
```

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

Permintaan tidak menggunakan parameter URI apa pun.

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

Permintaan menerima data berikut dalam format JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
Tindakan pemeliharaan yang tertunda untuk diterapkan ke sumber daya.  
Tindakan yang valid adalah:  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Nilai yang menentukan jenis permintaan opt-in atau membatalkan permintaan opt-in. Permintaan opt-in dari jenis `IMMEDIATE` tidak dapat dibatalkan.  
Tipe: String  
Nilai yang Valid: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Wajib: Ya

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
Nama Sumber Daya Amazon DocumentDB Amazon (ARN) dari sumber daya tempat tindakan pemeliharaan tertunda berlaku.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Tanggal tertentu untuk menerapkan tindakan pemeliharaan yang tertunda. Diperlukan jika opt-in-type adalah `APPLY_ON`. Format: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Output dari tindakan pemeliharaan tertunda yang diterapkan.  
Tipe: Objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ApplyPendingMaintenanceAction_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/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

# CopyClusterSnapshot
<a name="API_elastic_CopyClusterSnapshot"></a>

Menyalin snapshot dari cluster elastis.

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

```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}
```

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

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi Amazon Resource Name (ARN) dari snapshot cluster elastis.  
Wajib: Ya

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

Permintaan menerima data berikut dalam format JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
Pengidentifikasi snapshot cluster elastis baru untuk dibuat dari snapshot cluster sumber. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `elastic-cluster-snapshot-5`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.  
Wajib: Ya

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Setel `true` untuk menyalin semua tag dari snapshot cluster sumber ke snapshot cluster elastis target. Defaultnya adalah `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
ID kunci AWS KMS untuk snapshot cluster elastis terenkripsi. ID kunci AWS KMS adalah Nama Sumber Daya Amazon (ARN) AWS , pengidentifikasi kunci KMS, atau alias kunci KMS AWS untuk kunci enkripsi KMS. AWS   
Jika Anda menyalin snapshot cluster elastis terenkripsi dari AWS akun Anda, Anda dapat menentukan nilai `KmsKeyId` untuk mengenkripsi salinan dengan kunci enkripsi AWS S KMS baru. Jika Anda tidak menentukan nilai untuk`KmsKeyId`, maka salinan snapshot cluster elastis dienkripsi dengan kunci `AWS` KMS yang sama dengan snapshot cluster elastis sumber.  
Jika Anda menyalin snapshot cluster elastis yang tidak terenkripsi dan menentukan nilai untuk `KmsKeyId` parameter, kesalahan akan dikembalikan.  
Tipe: String  
Wajib: Tidak

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
Tag yang akan ditetapkan ke snapshot cluster elastis.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CopyClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis tertentu.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CopyClusterSnapshot_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/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

# CreateCluster
<a name="API_elastic_CreateCluster"></a>

Membuat cluster elastis Amazon DocumentDB baru dan mengembalikan struktur klasternya.

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

```
POST /cluster HTTP/1.1
Content-type: application/json

{
   "adminUserName": "string",
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "clusterName": "string",
   "kmsKeyId": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

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

Permintaan tidak menggunakan parameter URI apa pun.

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

Permintaan menerima data berikut dalam format JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Nama administrator cluster elastis Amazon DocumentDB.  
 *Kendala*:  
+ Harus dari 1 hingga 63 huruf atau angka.
+ Karakter pertama harus berupa surat.
+ Tidak dapat berupa kata yang dicadangkan.
Tipe: String  
Diperlukan: Ya

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
Kata sandi untuk administrator cluster elastis Amazon DocumentDB. Kata sandi dapat berisi karakter ASCII yang dapat dicetak.  
 *Kendala*:  
+ Harus berisi 8 hingga 100 karakter.
+ Tidak dapat berisi garis miring (/), tanda kutip ganda (“), atau simbol “at” (@).
Tipe: String  
Diperlukan: Ya

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
Jenis otentikasi yang digunakan untuk menentukan di mana untuk mengambil password yang digunakan untuk mengakses cluster elastis. Jenis yang valid adalah `PLAIN_TEXT` atau`SECRET_ARN`.  
Tipe: String  
Nilai yang Valid: `PLAIN_TEXT | SECRET_ARN`   
Wajib: Ya

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
Nama cluster elastis baru. Parameter ini disimpan sebagai string huruf kecil.  
 *Kendala*:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
 *Contoh*: `my-cluster`   
Tipe: String  
Diperlukan: Ya

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
Jumlah v yang CPUs ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.  
Jenis: Integer  
Wajib: Ya

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.  
Jenis: Integer  
Wajib: Ya

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
Jumlah hari di mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
Token klien untuk cluster elastis.  
Tipe: String  
Wajib: Tidak

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis baru.  
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.  
Jika kunci enkripsi tidak ditentukan, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.  
Tipe: String  
Wajib: Tidak

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh. `backupRetentionPeriod`  
Tipe: String  
Wajib: Tidak

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Default*: jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.  
 *Hari yang berlaku*: Senin, Sel, Rabu, Kam, Jumat, Sabtu, Minggu  
 *Kendala: Jendela* minimum 30 menit.  
Tipe: String  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis baru.  
Tipe: Array string  
Wajib: Tidak

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
Tag yang akan ditetapkan ke cluster elastis baru.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis baru.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CreateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
Cluster elastis baru yang telah dibuat.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CreateCluster_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/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

# CreateClusterSnapshot
<a name="API_elastic_CreateClusterSnapshot"></a>

Membuat snapshot dari cluster elastis.

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

```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

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

Permintaan tidak menggunakan parameter URI apa pun.

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

Permintaan menerima data berikut dalam format JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis yang ingin Anda buat snapshot.  
Tipe: String  
Diperlukan: Ya

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
Nama snapshot cluster elastis baru.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.  
Wajib: Ya

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
Tag yang akan ditetapkan ke snapshot cluster elastis baru.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CreateClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis baru.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CreateClusterSnapshot_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/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

# DeleteCluster
<a name="API_elastic_DeleteCluster"></a>

Hapus cluster elastis.

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

```
DELETE /cluster/clusterArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis yang akan dihapus.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_DeleteCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis yang baru dihapus.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_DeleteCluster_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/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

# DeleteClusterSnapshot
<a name="API_elastic_DeleteClusterSnapshot"></a>

Hapus snapshot cluster elastis.

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

```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis yang akan dihapus.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_DeleteClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis yang baru dihapus.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_DeleteClusterSnapshot_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/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

# GetCluster
<a name="API_elastic_GetCluster"></a>

Mengembalikan informasi tentang cluster elastis tertentu.

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

```
GET /cluster/clusterArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetCluster_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/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

# GetClusterSnapshot
<a name="API_elastic_GetClusterSnapshot"></a>

Mengembalikan informasi tentang snapshot cluster elastis tertentu

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

```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis tertentu.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetClusterSnapshot_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/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

# GetPendingMaintenanceAction
<a name="API_elastic_GetPendingMaintenanceAction"></a>

Mengambil semua tindakan pemeliharaan yang tertunda.

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

```
GET /pending-action/resourceArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Mengambil tindakan pemeliharaan yang tertunda untuk Nama Sumber Daya Amazon (ARN) tertentu.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetPendingMaintenanceAction_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/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

# ListClusters
<a name="API_elastic_ListClusters"></a>

Mengembalikan informasi tentang klaster elastis Amazon DocumentDB yang disediakan.

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

```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Daftar cluster elastis Amazon DocumentDB.  
Tipe: Array objek [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.  
Tipe: String

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListClusters_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/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

Mengembalikan informasi tentang snapshot untuk cluster elastis tertentu.

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

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.  
Rentang Valid: Nilai minimum 20. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
Jenis snapshot klaster untuk dikembalikan. Anda dapat menentukan salah satu nilai berikut:  
+  `automated`- Kembalikan semua snapshot cluster yang Amazon DocumentDB telah secara otomatis dibuat untuk akun Anda. AWS 
+  `manual`- Kembalikan semua snapshot cluster yang telah Anda buat secara manual untuk AWS akun Anda.

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.  
Tipe: String

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Daftar snapshot untuk cluster elastis tertentu.  
Tipe: Array objek [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListClusterSnapshots_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/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

# ListPendingMaintenanceActions
<a name="API_elastic_ListPendingMaintenanceActions"></a>

Mengambil daftar semua tindakan pemeliharaan yang tertunda.

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

```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
Jumlah maksimum hasil untuk dimasukkan dalam respons. Jika lebih banyak catatan ada daripada nilai `maxResults` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `maxResults`.

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListPendingMaintenanceActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePendingMaintenanceActions": [ 
      { 
         "pendingMaintenanceActionDetails": [ 
            { 
               "action": "string",
               "autoAppliedAfterDate": "string",
               "currentApplyDate": "string",
               "description": "string",
               "forcedApplyDate": "string",
               "optInStatus": "string"
            }
         ],
         "resourceArn": "string"
      }
   ]
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Array objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditampilkan, tanggapan hanya akan menyertakan catatan di luar penanda, hingga nilai yang ditentukan oleh`maxResults`.  
Tipe: String

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListPendingMaintenanceActions_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/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

# ListTagsForResource
<a name="API_elastic_ListTagsForResource"></a>

Daftar semua tag pada sumber daya cluster elastis

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

```
GET /tags/resourceArn HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
Daftar tag untuk sumber daya cluster elastis yang ditentukan.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

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

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

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListTagsForResource_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/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

Mengembalikan cluster elastis dari snapshot.

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

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

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

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Wajib: Ya

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

Permintaan menerima data berikut dalam format JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Nama cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis Amazon DocumentDB baru.  
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.  
Jika kunci enkripsi tidak ditentukan di sini, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.  
Tipe: String  
Wajib: Tidak

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
Kapasitas setiap pecahan dalam cluster elastis baru yang dipulihkan.  
Tipe: Integer  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Tidak

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Daftar nama tag yang akan ditetapkan ke cluster elastis yang dipulihkan, dalam bentuk array pasangan kunci-nilai di mana kuncinya adalah nama tag dan nilainya adalah nilai kunci.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis dipulihkan.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_RestoreClusterFromSnapshot_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/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

# StartCluster
<a name="API_elastic_StartCluster"></a>

Memulai ulang cluster elastis berhenti yang ditentukan oleh`clusterARN`.

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

```
POST /cluster/clusterArn/start HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_StartCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_StartCluster_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/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

# StopCluster
<a name="API_elastic_StopCluster"></a>

Menghentikan cluster elastis yang berjalan yang ditentukan oleh`clusterArn`. Cluster elastis harus dalam keadaan *tersedia*. 

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

```
POST /cluster/clusterArn/stop HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_StopCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_StopCluster_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/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

# TagResource
<a name="API_elastic_TagResource"></a>

Menambahkan tag metadata ke sumber daya cluster elastis

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

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

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

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

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

Permintaan menerima data berikut dalam format JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
Tag yang ditetapkan ke sumber daya cluster elastis.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Ya

## Sintaksis Respons
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200 dengan isi HTTP kosong.

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

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

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_TagResource_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/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

# UntagResource
<a name="API_elastic_UntagResource"></a>

Menghapus tag metadata dari sumber daya cluster elastis

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

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

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

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
Kunci tag yang akan dihapus dari sumber daya cluster elastis.  
Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 50 item.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.  
Pola: `(?!aws:)[a-zA-Z+-=._:/]+`   
Wajib: Ya

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

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200 dengan isi HTTP kosong.

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

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

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_UntagResource_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/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

Memodifikasi cluster elastis. Ini termasuk memperbarui admin-username/password, memutakhirkan versi API, dan menyiapkan jendela cadangan dan jendela pemeliharaan

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

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

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

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

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

Permintaan menerima data berikut dalam format JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
Kata sandi yang terkait dengan administrator cluster elastis. Kata sandi ini dapat berisi karakter ASCII apa pun yang dapat dicetak kecuali garis miring (/), tanda kutip ganda ("), atau simbol "at" (@).  
 *Kendala*: Harus berisi dari 8 hingga 100 karakter.  
Tipe: String  
Wajib: Tidak

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
Jenis otentikasi yang digunakan untuk menentukan di mana untuk mengambil password yang digunakan untuk mengakses cluster elastis. Jenis yang valid adalah `PLAIN_TEXT` atau`SECRET_ARN`.  
Tipe: String  
Nilai yang Valid: `PLAIN_TEXT | SECRET_ARN`   
Wajib: Tidak

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
Jumlah hari di mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
Token klien untuk cluster elastis.  
Tipe: String  
Wajib: Tidak

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh. `backupRetentionPeriod`  
Tipe: String  
Wajib: Tidak

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Default*: jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.  
 *Hari yang berlaku*: Senin, Sel, Rabu, Kam, Jumat, Sabtu, Minggu  
 *Kendala: Jendela* minimum 30 menit.  
Tipe: String  
Wajib: Tidak

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
Jumlah v yang CPUs ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.  
Tipe: Integer  
Wajib: Tidak

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.  
Tipe: Integer  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis diperbarui.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

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

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

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_UpdateCluster_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/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) 