Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Clusters Amazon DocumentDB Elastic
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

Les actions suivantes sont prises en charge par 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>

Type d'action de maintenance en attente à appliquer à la ressource.

## Syntaxe de la demande
<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"
}
```

## Paramètres de demande URI
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

La demande n’utilise pas de paramètres URI.

## Corps de la demande
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
L'action de maintenance en attente à appliquer à la ressource.  
Les actions valides sont :  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.  
Obligatoire : oui

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Valeur qui spécifie le type de demande de confirmation de l'acceptation ou annule cette dernière. Un type demande de confirmation de l'acceptation de type `IMMEDIATE` ne peut pas être annulée.  
Type : Chaîne  
Valeurs valides : `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Obligatoire : oui

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
Nom de ressource Amazon DocumentDB (ARN) Amazon DocumentDB de la ressource à laquelle s'applique l'action de maintenance en attente.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.  
Obligatoire : oui

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Une date précise pour appliquer l'action de maintenance en attente. Obligatoire si opt-in-type a pour valeur `APPLY_ON`. Format : `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.  
Obligatoire : non

## Syntaxe de la réponse
<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"
   }
}
```

## Eléments de réponse
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Résultat de l'action de maintenance en attente appliquée.  
Type : objet [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

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

Copie un instantané d'un cluster élastique.

## Syntaxe de la demande
<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"
}
```

## Paramètres de demande URI
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
L'identifiant Amazon Resource Name (ARN) de l'instantané du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
Identifiant du nouvel instantané de cluster élastique à créer à partir de l'instantané de cluster source. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `elastic-cluster-snapshot-5`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Obligatoire : oui

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Définissez sur `true` pour copier toutes les balises de l'instantané du cluster source vers l'instantané du cluster élastique cible. La valeur par défaut est `false`.  
Type : booléen  
Obligatoire : non

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
ID de clé AWS KMS pour un instantané de cluster élastique chiffré. L'ID de clé AWS KMS est le nom de ressource Amazon (ARN), l'identifiant de clé AWS KMS ou l'alias de clé AWS KMS pour la clé de chiffrement AWS KMS.  
Si vous copiez un instantané chiffré du cluster Elastic depuis votre AWS compte, vous pouvez spécifier une valeur `KmsKeyId` pour chiffrer la copie avec une nouvelle clé de chiffrement AWS S KMS. Si vous ne spécifiez aucune valeur pour`KmsKeyId`, la copie de l'instantané du cluster élastique est chiffrée avec la même clé `AWS` KMS que l'instantané du cluster élastique source.  
Si vous copiez un instantané d'un cluster élastique non chiffré et que vous spécifiez une valeur pour le `KmsKeyId` paramètre, une erreur est renvoyée.  
Type : chaîne  
Obligatoire : non

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
Les balises à attribuer à l'instantané du cluster élastique.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : non

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Renvoie des informations sur un instantané de cluster élastique spécifique.  
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ServiceQuotaExceededException **   
Le quota de service pour l'action a été dépassé.  
Code d'état HTTP : 402

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

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

Crée un nouveau cluster élastique Amazon DocumentDB et renvoie sa structure de cluster.

## Syntaxe de la demande
<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" ]
}
```

## Paramètres de demande URI
<a name="API_elastic_CreateCluster_RequestParameters"></a>

La demande n’utilise pas de paramètres URI.

## Corps de la demande
<a name="API_elastic_CreateCluster_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Nom de l'administrateur des clusters élastiques Amazon DocumentDB.  
 *Contraintes* :  
+ Doit comporter entre 1 et 63 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas être un mot réservé.
Type : Chaîne  
Obligatoire : oui

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
Le mot de passe de l'administrateur des clusters élastiques Amazon DocumentDB. Le mot de passe peut contenir n'importe quel caractère ASCII imprimable.  
 *Contraintes* :  
+ Doit contenir de 8 à 100 caractères.
+ Ne peut pas contenir de barre oblique (/), de guillemet double («) ou le symbole « at » (@).
Type : Chaîne  
Obligatoire : oui

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont `PLAIN_TEXT` ou`SECRET_ARN`.  
Type : Chaîne  
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`   
Obligatoire : oui

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
Nom du nouveau cluster élastique. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.  
 *Contraintes* :  
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
 *Exemple* : `my-cluster`   
Type : Chaîne  
Obligatoire : oui

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
Le nombre de v CPUs attribué à chaque partition de cluster élastique. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.  
Type : Integer  
Obligatoire : oui

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.  
Type : Integer  
Obligatoire : oui

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : Integer  
Obligatoire : non

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
Le jeton client pour le cluster élastique.  
Type : chaîne  
Obligatoire : non

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster élastique.  
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le même compte Amazon qui possède cette clé de chiffrement KMS, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN comme clé de chiffrement KMS.  
Si aucune clé de chiffrement n'est spécifiée, Amazon DocumentDB utilise la clé de chiffrement par défaut créée par KMS pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.  
Type : chaîne  
Obligatoire : non

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
La plage horaire quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par le`backupRetentionPeriod`.  
Type : chaîne  
Obligatoire : non

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
 *Format* : `ddd:hh24:mi-ddd:hh24:mi`   
 *Par défaut* : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.  
 *Jours valides* : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche  
 *Contraintes* : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. Une `shardInstanceCount` valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.  
Type : Integer  
Obligatoire : non

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
Le sous-réseau Amazon EC2 IDs pour le nouveau cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
Les balises à attribuer au nouveau cluster élastique.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : non

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité VPC EC2 à associer au nouveau cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_CreateCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
Le nouveau cluster élastique qui a été créé.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ServiceQuotaExceededException **   
Le quota de service pour l'action a été dépassé.  
Code d'état HTTP : 402

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_CreateCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

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

Crée un instantané d'un cluster élastique.

## Syntaxe de la demande
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

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

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

## Paramètres de demande URI
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

La demande n’utilise pas de paramètres URI.

## Corps de la demande
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
Identifiant ARN du cluster élastique dont vous souhaitez créer un instantané.  
Type : Chaîne  
Obligatoire : oui

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
Nom du nouvel instantané du cluster élastique.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Obligatoire : oui

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
Les balises à attribuer au nouvel instantané du cluster élastique.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : non

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Renvoie des informations sur le nouvel instantané du cluster élastique.  
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ServiceQuotaExceededException **   
Le quota de service pour l'action a été dépassé.  
Code d'état HTTP : 402

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

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

Supprimez un cluster élastique.

## Syntaxe de la demande
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
Identifiant ARN du cluster élastique à supprimer.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_DeleteCluster_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Renvoie des informations sur le cluster élastique récemment supprimé.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

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

Supprimez un instantané d'Elastic Cluster.

## Syntaxe de la demande
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique à supprimer.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Renvoie des informations sur le cliché du cluster élastique récemment supprimé.  
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

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

Renvoie des informations sur un cluster élastique spécifique.

## Syntaxe de la demande
<a name="API_elastic_GetCluster_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_GetCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_GetCluster_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_GetCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Renvoie des informations sur un cluster élastique spécifique.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_GetCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

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

Renvoie des informations sur un instantané de cluster élastique spécifique

## Syntaxe de la demande
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Renvoie des informations sur un instantané de cluster élastique spécifique.  
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource qui n'a pas pu être localisée.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

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

Récupère toutes les actions de maintenance en attente.

## Syntaxe de la demande
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Récupère les actions de maintenance en attente pour un Amazon Resource Name (ARN) spécifique.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 256.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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"
   }
}
```

## Eléments de réponse
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Fournit des informations sur une action de maintenance en attente pour une ressource.  
Type : objet [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

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

Renvoie des informations sur les clusters élastiques Amazon DocumentDB provisionnés.

## Syntaxe de la demande
<a name="API_elastic_ListClusters_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_ListClusters_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
Le nombre maximal de résultats de capture instantanée du cluster élastique à recevoir dans la réponse.  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.  
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.

## Corps de la requête
<a name="API_elastic_ListClusters_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

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

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

## Eléments de réponse
<a name="API_elastic_ListClusters_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Liste des clusters élastiques Amazon DocumentDB.  
Type : tableau d’objets [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.  
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.  
Type : Chaîne

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_ListClusters_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

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

Renvoie des informations sur les instantanés d'un cluster élastique spécifié.

## Syntaxe de la demande
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
Le nombre maximal de résultats de capture instantanée du cluster élastique à recevoir dans la réponse.  
Plage valide : valeur minimale de 20. Valeur maximale fixée à 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.  
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
Type de snapshots de cluster à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :  
+  `automated`- Renvoie tous les instantanés de cluster qu'Amazon DocumentDB a automatiquement créés pour AWS votre compte.
+  `manual`- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre AWS compte.

## Corps de la requête
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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"
      }
   ]
}
```

## Eléments de réponse
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.  
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.  
Type : Chaîne

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Liste des instantanés pour un cluster élastique spécifié.  
Type : tableau d’objets [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

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

Récupère la liste de toutes les actions de maintenance en attente.

## Syntaxe de la demande
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
Le nombre maximum de résultats à inclure dans la réponse. S'il existe plus d'enregistrements que la `maxResults` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `maxResults`.

## Corps de la requête
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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"
      }
   ]
}
```

## Eléments de réponse
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Fournit des informations sur une action de maintenance en attente pour une ressource.  
Type : tableau d’objets [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est affiché, les réponses incluront uniquement les enregistrements situés au-delà du marqueur, jusqu'à la valeur spécifiée par`maxResults`.  
Type : Chaîne

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

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

Répertorie toutes les balises d'une ressource de cluster élastique

## Syntaxe de la demande
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
Identifiant ARN de la ressource Elastic Cluster.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

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

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

## Eléments de réponse
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
La liste des balises pour la ressource de cluster élastique spécifiée.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

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

Restaure un cluster élastique à partir d'un instantané.

## Syntaxe de la demande
<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" ]
}
```

## Paramètres de demande URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Nom du cluster élastique.  
Type : Chaîne  
Obligatoire : oui

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster de clusters élastiques Amazon DocumentDB.  
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le même compte Amazon qui possède cette clé de chiffrement KMS, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN comme clé de chiffrement KMS.  
Si aucune clé de chiffrement n'est spécifiée ici, Amazon DocumentDB utilise la clé de chiffrement par défaut créée par KMS pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.  
Type : chaîne  
Obligatoire : non

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
Capacité de chaque partition du nouveau cluster élastique restauré.  
Type : Integer  
Obligatoire : non

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. Une `shardInstanceCount` valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.  
Type : Integer  
Obligatoire : non

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Une liste des noms de balises à attribuer au cluster élastique restauré, sous la forme d'un tableau de paires clé-valeur dans lequel la clé est le nom de balise et la valeur est la valeur clé.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : non

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Renvoie des informations sur le cluster élastique restauré.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ServiceQuotaExceededException **   
Le quota de service pour l'action a été dépassé.  
Code d'état HTTP : 402

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

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

Redémarre le cluster élastique arrêté spécifié par`clusterARN`.

## Syntaxe de la demande
<a name="API_elastic_StartCluster_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_StartCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_StartCluster_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_StartCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Renvoie des informations sur un cluster élastique spécifique.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_StartCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

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

Arrête le cluster élastique en cours d'exécution spécifié par`clusterArn`. Le cluster élastique doit être dans l'état *disponible*. 

## Syntaxe de la demande
<a name="API_elastic_StopCluster_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_StopCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_StopCluster_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_StopCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Renvoie des informations sur un cluster élastique spécifique.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource qui n'a pas pu être localisée.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_StopCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

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

Ajoute des balises de métadonnées à une ressource de cluster élastique

## Syntaxe de la demande
<a name="API_elastic_TagResource_RequestSyntax"></a>

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

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

## Paramètres de demande URI
<a name="API_elastic_TagResource_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
Identifiant ARN de la ressource Elastic Cluster.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_TagResource_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
Les balises attribuées à la ressource Elastic Cluster.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : oui

## Syntaxe de la réponse
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Eléments de réponse
<a name="API_elastic_TagResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** InternalServerException **   
Une erreur interne s'est produite au niveau du serveur.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_TagResource_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

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

Supprime les balises de métadonnées d'une ressource de cluster élastique

## Syntaxe de la demande
<a name="API_elastic_UntagResource_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_elastic_UntagResource_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
Identifiant ARN de la ressource Elastic Cluster.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.  
Obligatoire : oui

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
Les clés de balise à supprimer de la ressource Elastic Cluster.  
Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 128.  
Modèle : `(?!aws:)[a-zA-Z+-=._:/]+`   
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_UntagResource_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Eléments de réponse
<a name="API_elastic_UntagResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_UntagResource_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

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

Modifie un cluster élastique. Cela inclut la mise à jour du nom d'utilisateur/mot de passe administrateur, la mise à niveau de la version de l'API et la configuration d'une fenêtre de sauvegarde et d'une fenêtre de maintenance

## Syntaxe de la demande
<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" ]
}
```

## Paramètres de demande URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_UpdateCluster_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
Le mot de passe associé à l'administrateur du cluster Elastic. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).  
 *Contraintes* : Doit contenir de 8 à 100 caractères.  
Type : chaîne  
Obligatoire : non

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont `PLAIN_TEXT` ou`SECRET_ARN`.  
Type : Chaîne  
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`   
Obligatoire : non

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : Integer  
Obligatoire : non

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
Le jeton client pour le cluster élastique.  
Type : chaîne  
Obligatoire : non

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
La plage horaire quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par le`backupRetentionPeriod`.  
Type : chaîne  
Obligatoire : non

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
 *Format* : `ddd:hh24:mi-ddd:hh24:mi`   
 *Par défaut* : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.  
 *Jours valides* : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche  
 *Contraintes* : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
Le nombre de v CPUs attribué à chaque partition de cluster élastique. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.  
Type : Integer  
Obligatoire : non

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.  
Type : Integer  
Obligatoire : non

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. Une `shardInstanceCount` valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.  
Type : Integer  
Obligatoire : non

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

## Syntaxe de la réponse
<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" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Renvoie des informations sur le cluster élastique mis à jour.  
Type : objet [Cluster](API_elastic_Cluster.md)

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)