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.

# Actions
<a name="API_Operations"></a>

Les actions suivantes sont prises en charge par Amazon DocumentDB (with MongoDB compatibility) :
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

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) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Operations_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

Les actions suivantes sont prises en charge par Amazon DocumentDB (with MongoDB compatibility) :
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

Ajoute un identifiant source à un abonnement à la notification d'événements existant.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SourceIdentifier **   
Identifiant de la source d'événement à ajouter :  
+ Si le type de source est une instance, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est un groupe de sécurité, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est un groupe de paramètres, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est un instantané, un `DBSnapshotIdentifier` doit être fourni.
Type : Chaîne  
Obligatoire : oui

 ** SubscriptionName **   
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB auquel vous souhaitez ajouter un identifiant de source.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EventSubscription **   
Informations détaillées sur un événement auquel vous vous êtes inscrit.  
Type : objet [EventSubscription](API_EventSubscription.md)

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

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

 ** SourceNotFound **   
La source demandée est introuvable.   
Code d’état HTTP :404

 ** SubscriptionNotFound **   
Le nom de l'abonnement n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_AddSourceIdentifierToSubscription_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-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Ajoute des balises de métadonnées à une ressource Amazon DocumentDB. Vous pouvez utiliser ces balises avec les rapports de répartition des coûts pour suivre les coûts associés aux ressources Amazon DocumentDB ou dans une `Condition` déclaration d'une politique Gestion des identités et des accès AWS (IAM) pour Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** ResourceName **   
La ressource Amazon DocumentDB à laquelle les balises sont ajoutées. Cette valeur est un nom de ressource Amazon.  
Type : Chaîne  
Obligatoire : oui

 **Étiquettes.Tag.N**   
Les balises à attribuer à la ressource Amazon DocumentDB.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : oui

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`ne fait pas référence à un instantané existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_AddTagsToResource_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-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) 

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

Applique une action de maintenance en attente à une ressource (par exemple, à une instance Amazon DocumentDB).

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** ApplyAction **   
Action de maintenance en attente à appliquer à cette ressource.  
Valeurs valides : `system-update`, `db-upgrade`   
Type : Chaîne  
Obligatoire : oui

 ** OptInType **   
Valeur qui spécifie le type de demande d'opt-in ou qui annule une demande d'opt-in. Un type demande de confirmation de l'acceptation de type `immediate` ne peut pas être annulée.  
Valeurs valides :  
+  `immediate` - Appliquer immédiatement l'action de maintenance.
+  `next-maintenance` - Appliquer l'action de maintenance pendant le créneau de maintenance suivant pour la ressource. 
+  `undo-opt-in` - Annuler toute demande de confirmation de l'acceptation `next-maintenance` existante.
Type : Chaîne  
Obligatoire : oui

 ** ResourceIdentifier **   
ARN (Amazon Resource Name) de la ressource à laquelle s'applique l'action de maintenance en attente.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** ResourcePendingMaintenanceActions **   
Représente la sortie de[ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).   
Type : objet [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

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

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

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

 ** ResourceNotFoundFault **   
L'ID de ressource spécifiée est introuvable.  
Code d’état HTTP :404

## Voir aussi
<a name="API_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-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

Copie le groupe de paramètres de cluster spécifié.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SourceDBClusterParameterGroupIdentifier **   
Identifiant ou Amazon Resource Name (ARN) du groupe de paramètres du cluster source.  
Contraintes:  
+ Vous devez spécifier un groupe de paramètres de cluster valide.
+ Si le groupe de paramètres du cluster source est Région AWS identique à celui de la copie, spécifiez un identifiant de groupe de paramètres valide, par exemple`my-db-cluster-param-group`, ou un ARN valide.
+ Si le groupe de paramètres source est différent de Région AWS celui de la copie, spécifiez un ARN de groupe de paramètres de cluster valide ; par exemple,`arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
Type : Chaîne  
Obligatoire : oui

 ** TargetDBClusterParameterGroupDescription **   
Description du groupe de paramètres de cluster copié.  
Type : Chaîne  
Obligatoire : oui

 ** TargetDBClusterParameterGroupIdentifier **   
Identifiant du groupe de paramètres de cluster copié.  
Contraintes:  
+ Ne peut pas être null ou vide.
+ Doit contenir entre 1 et 255 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-param-group1`   
Type : Chaîne  
Obligatoire : oui

 **Étiquettes.Tag.N**   
Les balises qui doivent être attribuées au groupe de paramètres.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterParameterGroup **   
Informations détaillées sur un groupe de paramètres de cluster.   
Type : objet [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

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

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

 ** DBParameterGroupAlreadyExists **   
Un groupe de paramètres portant le même nom existe déjà.  
Code d’état HTTP : 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** DBParameterGroupQuotaExceeded **   
Cette demande vous obligerait à dépasser le nombre autorisé de groupes de paramètres.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CopyDBClusterParameterGroup_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-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

Copie un instantané d'un cluster.

Pour copier un instantané de cluster à partir d'un instantané de cluster manuel partagé, `SourceDBClusterSnapshotIdentifier` il doit s'agir du nom de ressource Amazon (ARN) de l'instantané de cluster partagé. Vous ne pouvez copier qu’un instantané de cluster de bases de données partagé, chiffré ou non, dans la même Région AWS.

Pour annuler l'opération de copie une fois qu'elle est en cours, supprimez le cliché du cluster cible identifié `TargetDBClusterSnapshotIdentifier` alors que cet instantané de cluster est en état de *copie*.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SourceDBClusterSnapshotIdentifier **   
L'identifiant de l'instantané du cluster à copier. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Vous devez spécifier un instantané de cluster valide dans l'état *disponible*.
+ Si le cliché du cluster source est Région AWS identique à la copie, spécifiez un identifiant de capture d'écran valide.
+ Si le snapshot du cluster source se trouve dans un autre compte Région AWS ou appartient à un autre AWS compte, spécifiez l'ARN du snapshot.
Exemple : `my-cluster-snapshot1`   
Type : Chaîne  
Obligatoire : oui

 ** TargetDBClusterSnapshotIdentifier **   
L'identifiant du nouvel instantané du cluster à créer à partir de l'instantané du 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 : `my-cluster-snapshot2`   
Type : Chaîne  
Obligatoire : oui

 ** CopyTags **   
Définissez sur `true` pour copier toutes les balises de l'instantané du cluster source vers le cliché du cluster cible, et sinon`false`. La valeur par défaut est `false`.  
Type : booléen  
Obligatoire : non

 ** KmsKeyId **   
ID de AWS KMS clé pour un instantané de cluster chiffré. L'ID de AWS KMS clé est le Amazon Resource Name (ARN), AWS KMS l'identifiant de AWS KMS clé ou l'alias de clé de AWS KMS chiffrement.   
Si vous copiez un instantané de cluster chiffré depuis votre Compte AWS, vous pouvez spécifier une valeur `KmsKeyId` pour chiffrer la copie avec une nouvelle clé de AWS KMS chiffrement. Si vous ne spécifiez aucune valeur pour`KmsKeyId`, la copie du cliché de cluster est chiffrée avec la même AWS KMS clé que l'instantané de cluster source.  
Si vous copiez un instantané de cluster chiffré partagé depuis un autre Compte AWS, vous devez spécifier une valeur pour`KmsKeyId`.  
Pour copier un instantané de cluster chiffré vers un autre Région AWS, définissez `KmsKeyId` l'ID de AWS KMS clé que vous souhaitez utiliser pour chiffrer la copie de l'instantané de cluster dans la région de destination. AWS KMS les clés de chiffrement sont spécifiques à l' Région AWS endroit dans lequel elles ont été créées, et vous ne pouvez pas utiliser les clés de chiffrement les unes Région AWS des autres Région AWS.  
Si vous copiez un instantané de cluster non chiffré et que vous spécifiez une valeur pour le `KmsKeyId` paramètre, une erreur est renvoyée.  
Type : chaîne  
Obligatoire : non

 ** PreSignedUrl **   
L'URL qui contient une demande signée Signature Version 4 pour l'action d'`CopyDBClusterSnapshot`API dans Région AWS laquelle figure l'instantané du cluster source à copier. Vous devez utiliser le `PreSignedUrl` paramètre lorsque vous copiez un instantané de cluster à partir d'un autre Région AWS.  
Si vous utilisez un outil AWS SDK ou le AWS CLI, vous pouvez le spécifier `SourceRegion` (ou `--source-region` pour le AWS CLI) au lieu de le spécifier `PreSignedUrl` manuellement. La spécification `SourceRegion` génère automatiquement une URL pré-signée qui est une demande valide pour l'opération pouvant être exécutée dans la source. Région AWS  
L'URL présignée doit être une demande valide pour l'action d'`CopyDBClusterSnapshot`API qui peut être exécutée dans la source Région AWS contenant l'instantané du cluster à copier. La demande d'URL pré-signée doit contenir les valeurs de paramètres suivantes :  
+  `SourceRegion`- L'ID de la région qui contient le cliché à copier.
+  `SourceDBClusterSnapshotIdentifier`- L'identifiant de l'instantané du cluster chiffré à copier. Cet identifiant doit être au format Amazon Resource Name (ARN) pour la Région AWS source. Par exemple, si vous copiez un instantané de cluster chiffré à partir de l' Région AWS us-east-1, cela ressemble à ce qui `SourceDBClusterSnapshotIdentifier` suit : `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`
+  `TargetDBClusterSnapshotIdentifier`- L'identifiant du nouvel instantané du cluster à créer. Ce paramètre n'est pas sensible à la casse.
Type : chaîne  
Obligatoire : non

 **Étiquettes.Tag.N**   
Les balises à attribuer à l'instantané du cluster.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterSnapshot **   
Informations détaillées sur un instantané de cluster.   
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

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

 ** DBClusterSnapshotAlreadyExistsFault **   
Vous disposez déjà d'un instantané du cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** KMSKeyNotAccessibleFault **   
Une erreur s'est produite lors de l'accès à une AWS KMS clé.  
Code d’état HTTP : 400

 ** SnapshotQuotaExceeded **   
La demande vous obligerait à dépasser le nombre autorisé de clichés.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CopyDBClusterSnapshot_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-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) 

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

Crée un nouveau cluster Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
L'identifiant du cluster. 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

 ** Engine **   
Nom du moteur de base de données à utiliser pour ce cluster.  
Valeurs valides : `docdb`   
Type : Chaîne  
Obligatoire : oui

 **AvailabilityZones. AvailabilityZone**N.   
Liste des zones de disponibilité Amazon EC2 dans lesquelles les instances du cluster peuvent être créées.  
Type : tableau de chaînes  
Obligatoire : non

 ** BackupRetentionPeriod **   
Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.  
Par défaut : 1  
Contraintes:  
+ Doit être une valeur comprise entre 1 et 35.
Type : Integer  
Obligatoire : non

 ** DBClusterParameterGroupName **   
Nom du groupe de paramètres de cluster à associer à ce cluster.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroupName **   
Groupe de sous-réseaux à associer à ce cluster.  
Contraintes : doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.  
Exemple : `mySubnetgroup`   
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.  
Type : booléen  
Obligatoire : non

 **EnableCloudwatchLogsExports.membre.n**   
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs. Vous pouvez activer les journaux d'audit ou les journaux de profileur. Pour plus d'informations, consultez [Audit des événements Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) et [profilage des opérations Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).   
Type : tableau de chaînes  
Obligatoire : non

 ** EngineVersion **   
Numéro de version du moteur de base de données à utiliser. La version `--engine-version` utilise par défaut la dernière version majeure du moteur. Pour les charges de travail de production, nous vous recommandons de déclarer explicitement ce paramètre avec la version majeur du moteur prévue.  
Type : chaîne  
Obligatoire : non

 ** GlobalClusterIdentifier **   
Identifiant de cluster du nouveau cluster global.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : non

 ** KmsKeyId **   
Identifiant de AWS KMS clé pour un cluster chiffré.  
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous créez un cluster à l'aide du même cluster Compte AWS qui possède la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.  
Si aucune clé de chiffrement n'est spécifiée dans `KmsKeyId` :   
+ Si le paramètre `StorageEncrypted` est `true`, Amazon DocumentDB utilise votre clé de chiffrement par défaut. 
 AWS KMS crée la clé de chiffrement par défaut pour votre Compte AWS. Vous disposez Compte AWS d'une clé de chiffrement par défaut différente pour chacune d'entre elles Régions AWS.  
Type : chaîne  
Obligatoire : non

 ** ManageMasterUserPassword **   
Spécifie s'il faut gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager.  
Contrainte : vous ne pouvez pas gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager s'il `MasterUserPassword` est spécifié.  
Type : booléen  
Obligatoire : non

 ** MasterUsername **   
Nom de l'utilisateur principal du cluster.  
Contraintes:  
+ Doit comporter entre 1 et 63 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne doit pas être un mot réservé pour le moteur de base de données choisi. 
Type : chaîne  
Obligatoire : non

 ** MasterUserPassword **   
Mot de passe de l'utilisateur principal de la base de données. 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 comporter entre 8 et 100 caractères.  
Type : chaîne  
Obligatoire : non

 ** MasterUserSecretKmsKeyId **   
L'identifiant de clé KMS d'Amazon Web Services permettant de chiffrer un secret généré et géré automatiquement dans Amazon Web Services Secrets Manager. Ce paramètre n'est valide que si le mot de passe de l'utilisateur principal est géré par Amazon DocumentDB dans Amazon Web Services Secrets Manager pour le cluster de base de données.  
L'identifiant de clé KMS d'Amazon Web Services est l'ARN de la clé, l'identifiant de clé, l'alias ARN ou le nom d'alias de la clé KMS. Pour utiliser une clé KMS dans un autre compte Amazon Web Services, spécifiez l'ARN de la clé ou l'alias ARN.  
Si vous ne le spécifiez pas`MasterUserSecretKmsKeyId`, la clé `aws/secretsmanager` KMS est utilisée pour chiffrer le secret. Si le secret se trouve dans un autre compte Amazon Web Services, vous ne pouvez pas utiliser la clé `aws/secretsmanager` KMS pour le chiffrer et vous devez utiliser une clé KMS gérée par le client.  
Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.  
Type : chaîne  
Obligatoire : non

 ** NetworkType **   
Type de réseau du cluster.  
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).  
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.  
Valeurs valides : `IPV4` \$1 `DUAL`   
Type : chaîne  
Obligatoire : non

 ** Port **   
Numéro de port sur lequel les instances du cluster acceptent les connexions.  
Type : Integer  
Obligatoire : non

 ** PreferredBackupWindow **   
Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre `BackupRetentionPeriod`.   
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS  
Contraintes:  
+ Doit être au format `hh24:mi-hh24:mi`.
+ Doit être exprimée en heure UTC (Universal Coordinated Time).
+ Ne doit pas être en conflit avec la fenêtre de maintenance préférée. 
+ Doit être de 30 minutes minimum.
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
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`   
La valeur par défaut est 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 : Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Contraintes : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** PreSignedUrl **   
Cette option n'est pas prise en charge actuellement.   
Type : chaîne  
Obligatoire : non

 ** ServerlessV2ScalingConfiguration **   
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.  
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatoire : non

 ** StorageEncrypted **   
Indique si le cluster est chiffré.  
Type : booléen  
Obligatoire : non

 ** StorageType **   
Type de stockage à associer au cluster de base de données.  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Lorsque vous créez un cluster Amazon DocumentDB avec le type de stockage défini sur`iopt1`, le type de stockage est renvoyé dans la réponse. Le type de stockage n'est pas renvoyé lorsque vous le définissez sur`standard`.
Type : chaîne  
Obligatoire : non

 **Étiquettes.Tag.N**   
Balises à attribuer au cluster.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Liste des groupes de sécurité VPC EC2 à associer à ce cluster.   
Type : tableau de chaînes  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterAlreadyExistsFault **   
Vous avez déjà un cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName`ne fait pas référence à un groupe de paramètres de cluster existant.   
Code d’état HTTP :404

 ** DBClusterQuotaExceededFault **   
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.  
Code d’état HTTP : 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.  
Code d’état HTTP : 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InsufficientStorageClusterCapacity **   
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.   
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

 ** InvalidDBSubnetGroupStateFault **   
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.  
Code d’état HTTP : 400

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** KMSKeyNotAccessibleFault **   
Une erreur s'est produite lors de l'accès à une AWS KMS clé.  
Code d’état HTTP : 400

 ** NetworkTypeNotSupported **   
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDBCluster_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-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) 

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

Crée un nouveau groupe de paramètres de cluster.

Les paramètres d'un groupe de paramètres de cluster s'appliquent à toutes les instances d'un cluster.

Un groupe de paramètres de cluster est initialement créé avec les paramètres par défaut pour le moteur de base de données utilisé par les instances du cluster. Dans Amazon DocumentDB, vous ne pouvez pas modifier directement le groupe de paramètres du `default.docdb3.6` cluster. Si votre cluster Amazon DocumentDB utilise le groupe de paramètres de cluster par défaut et que vous souhaitez y modifier une valeur, vous devez d'abord [créer un nouveau groupe de paramètres](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) ou [copier un groupe de paramètres existant](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), le modifier, puis appliquer le groupe de paramètres modifié à votre cluster. Pour que le nouveau groupe de paramètres de cluster et les paramètres associés prennent effet, vous devez ensuite redémarrer les instances du cluster sans basculement. Pour plus d'informations, consultez [Modifier les groupes de paramètres du cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html). 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nom du groupe de paramètres de cluster.  
Contraintes:  
+ Ne doit pas correspondre au nom d'un élément `DBClusterParameterGroup` existant.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne  
Obligatoire : oui

 ** DBParameterGroupFamily **   
Nom de la famille du groupe de paramètres de cluster.  
Type : Chaîne  
Obligatoire : oui

 ** Description **   
Description du groupe de paramètres de cluster.  
Type : Chaîne  
Obligatoire : oui

 **Étiquettes.Tag.N**   
Balises à attribuer au groupe de paramètres de cluster.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterParameterGroup **   
Informations détaillées sur un groupe de paramètres de cluster.   
Type : objet [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

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

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

 ** DBParameterGroupAlreadyExists **   
Un groupe de paramètres portant le même nom existe déjà.  
Code d’état HTTP : 400

 ** DBParameterGroupQuotaExceeded **   
Cette demande vous obligerait à dépasser le nombre autorisé de groupes de paramètres.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDBClusterParameterGroup_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-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

Crée un instantané d'un cluster. 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster pour lequel créer un instantané. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Exemple : `my-cluster`   
Type : Chaîne  
Obligatoire : oui

 ** DBClusterSnapshotIdentifier **   
Identifiant du snapshot du cluster. 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-snapshot1`   
Type : Chaîne  
Obligatoire : oui

 **Étiquettes.Tag.N**   
Les balises à attribuer à l'instantané du cluster.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterSnapshot **   
Informations détaillées sur un instantané de cluster.   
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBClusterSnapshotAlreadyExistsFault **   
Vous disposez déjà d'un instantané du cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** SnapshotQuotaExceeded **   
La demande vous obligerait à dépasser le nombre autorisé de clichés.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDBClusterSnapshot_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-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) 

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

Crée une nouvelle instance.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster auquel l'instance appartiendra.  
Type : Chaîne  
Obligatoire : oui

 ** DBInstanceClass **   
Capacité de calcul et de mémoire de l'instance ; par exemple, `db.r5.large`.   
Type : Chaîne  
Obligatoire : oui

 ** DBInstanceIdentifier **   
Identifiant de l’instance. 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 : `mydbinstance`   
Type : Chaîne  
Obligatoire : oui

 ** Engine **   
Nom du moteur de base de données à utiliser pour cette instance.  
Valeur valide : `docdb`   
Type : Chaîne  
Obligatoire : oui

 ** AutoMinorVersionUpgrade **   
Ce paramètre ne s'applique pas à Amazon DocumentDB. Amazon DocumentDB n'effectue pas de mises à niveau mineures de version, quelle que soit la valeur définie.  
Valeur par défaut : `false`   
Type : booléen  
Obligatoire : non

 ** AvailabilityZone **   
Zone de disponibilité Amazon EC2 dans laquelle l'instance est créée.   
Par défaut : une zone de disponibilité choisie au hasard par le système dans le terminal. Région AWS  
Exemple : `us-east-1d`   
Type : chaîne  
Obligatoire : non

 ** CACertificateIdentifier **   
L'identifiant de certificat CA à utiliser pour le certificat de serveur de l'instance de base de données.  
*Pour plus d'informations, consultez la section [Mise à jour de vos certificats TLS Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) et [chiffrement des données en transit dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) guide du développeur Amazon DocumentDB.*  
Type : chaîne  
Obligatoire : non

 ** CopyTagsToSnapshot **   
Une valeur qui indique si vous voulez copier toutes les balises à partir de l'instance de base de données pour les instantanés de l'instance de base de données. Par défaut, les balises ne sont pas copiées.  
Type : booléen  
Obligatoire : non

 ** EnablePerformanceInsights **   
Une valeur qui indique s'il convient d'activer Performance Insights pour l'instance de base de données. Pour plus d'informations, voir [Utilisation d'Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Type : booléen  
Obligatoire : non

 ** PerformanceInsightsKMSKeyId **   
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights.  
L'identifiant de AWS KMS clé est l'ARN de la clé, l'ID de clé, l'alias ARN ou le nom d'alias de la clé KMS.  
Si vous ne spécifiez aucune valeur pour PerformanceInsights KMSKey Id, Amazon DocumentDB utilise votre clé KMS par défaut. Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.  
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
Intervalle de temps hebdomadaire, au format UTC (temps universel), pendant lequel a lieu la maintenance du système.  
 Format : `ddd:hh24:mi-ddd:hh24:mi`   
La valeur par défaut est 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 : Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Contraintes : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** PromotionTier **   
Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.  
Valeur par défaut : 1  
Valeurs valides : 0 à 15  
Type : Integer  
Obligatoire : non

 **Étiquettes.Tag.N**   
Balises à attribuer à l'instance. Vous pouvez attribuer jusqu'à 10 balises à une instance.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateDBInstance_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBInstance **   
Informations détaillées sur une instance.   
Type : objet [DBInstance](API_DBInstance.md)

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

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

 ** AuthorizationNotFound **   
L'adresse IP CIDR ou le groupe de sécurité Amazon EC2 spécifié n'est pas autorisé pour le groupe de sécurité spécifié.  
Amazon DocumentDB peut également ne pas être autorisé à effectuer les actions nécessaires en votre nom à l'aide d'IAM.  
Code d’état HTTP :404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBInstanceAlreadyExists **   
Vous avez déjà une instance avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName`ne fait pas référence à un groupe de sécurité existant.   
Code d’état HTTP :404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.  
Code d’état HTTP : 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** InstanceQuotaExceeded **   
La demande vous obligerait à dépasser le nombre d'instances autorisé.  
Code d’état HTTP : 400

 ** InsufficientDBInstanceCapacity **   
La classe d'instance spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** KMSKeyNotAccessibleFault **   
Une erreur s'est produite lors de l'accès à une AWS KMS clé.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

 ** StorageTypeNotSupported **   
Le stockage du paramètre spécifié ne `StorageType` peut pas être associé à l'instance de base de données.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDBInstance_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-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) 

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

Crée un nouveau groupe de sous-réseaux. Les groupes de sous-réseaux doivent contenir au moins un sous-réseau dans au moins deux zones de disponibilité du. Région AWS

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBSubnetGroupDescription **   
Description du groupe de sous-réseaux.  
Type : Chaîne  
Obligatoire : oui

 ** DBSubnetGroupName **   
Nom du groupe de sous-réseaux. Cette valeur est stockée sous la forme d’une chaîne en minuscules.  
Contraintes : doit comporter au maximum 255 lettres, chiffres, points, traits de soulignement, espaces ou tirets. Impossible de conserver le nom par défaut.  
Exemple : `mySubnetgroup`   
Type : Chaîne  
Obligatoire : oui

 **SubnetIds. SubnetIdentifier**N.   
Le sous-réseau Amazon EC2 IDs pour le groupe de sous-réseaux.  
Type : tableau de chaînes  
Obligatoire : oui

 **Étiquettes.Tag.N**   
Balises à attribuer au groupe de sous-réseaux.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBSubnetGroup **   
Informations détaillées sur un groupe de sous-réseaux.   
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)

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

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

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName`est déjà utilisé par un groupe de sous-réseaux existant.   
Code d’état HTTP : 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.  
Code d’état HTTP : 400

 ** DBSubnetGroupQuotaExceeded **   
La demande vous obligerait à dépasser le nombre autorisé de groupes de sous-réseaux.  
Code d’état HTTP : 400

 ** DBSubnetQuotaExceededFault **   
La demande vous obligerait à dépasser le nombre autorisé de sous-réseaux dans un groupe de sous-réseaux.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDBSubnetGroup_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-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) 

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Crée un abonnement aux notifications d'événements Amazon DocumentDB. Cette action nécessite un nom de ressource Amazon (ARN) de rubrique créé à l'aide de la console Amazon DocumentDB, de la console Amazon SNS ou de l'API Amazon SNS. Pour obtenir un ARN avec Amazon SNS, vous devez créer une rubrique dans Amazon SNS et vous y abonner. L'ARN est affiché dans la console Amazon SNS.

Vous pouvez spécifier le type de source (`SourceType`) dont vous souhaitez être informé. Vous pouvez également fournir une liste des sources Amazon DocumentDB (`SourceIds`) qui déclenchent les événements, ainsi qu'une liste de catégories d'événements (`EventCategories`) pour les événements dont vous souhaitez être informé. Par exemple, vous pouvez spécifier`SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` et`EventCategories = Availability, Backup`.

Si vous spécifiez à la fois le `SourceType` et `SourceIds` (tel que `SourceType = db-instance` et`SourceIdentifier = myDBInstance1`), vous êtes informé de tous les `db-instance` événements relatifs à la source spécifiée. Si vous spécifiez a `SourceType` mais pas a`SourceIdentifier`, vous êtes informé des événements associés à ce type de source pour toutes vos sources Amazon DocumentDB. Si vous ne spécifiez `SourceType` ni le`SourceIdentifier`, vous êtes informé des événements générés par toutes les sources Amazon DocumentDB appartenant à votre compte client.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SnsTopicArn **   
Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. Amazon SNS crée l'ARN lorsque vous créez une rubrique et que vous vous y abonnez.  
Type : Chaîne  
Obligatoire : oui

 ** SubscriptionName **   
Nom de l'abonnement.  
Contraintes : Le nom doit comporter moins de 255 caractères.  
Type : Chaîne  
Obligatoire : oui

 ** Enabled **   
 Valeur booléenne ; définie sur `true` pour activer l'abonnement, définie pour `false` créer l'abonnement mais pas pour l'activer.   
Type : booléen  
Obligatoire : non

 **EventCategories. EventCategory**N.   
 Liste des catégories d'événements `SourceType` auxquels vous souhaitez vous abonner.   
Type : tableau de chaînes  
Obligatoire : non

 **SourceIds. SourceId**N.   
Liste des identifiants des sources d'événements pour lesquels des événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse. Un identifiant doit commencer par une lettre et contenir uniquement des lettres ASCII, des chiffres et des tirets. Il ne doit pas se terminer par un tiret ou contenir deux tirets consécutifs.  
Contraintes:  
+ S'`SourceIds`ils sont fournis, ils `SourceType` doivent également être fournis.
+ Si le type de source est une instance, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est un groupe de sécurité, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est un groupe de paramètres, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est un instantané, un `DBSnapshotIdentifier` doit être fourni.
Type : tableau de chaînes  
Obligatoire : non

 ** SourceType **   
Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance, vous devez définir ce paramètre sur`db-instance`. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.  
Valeurs valides: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`   
Type : chaîne  
Obligatoire : non

 **Étiquettes.Tag.N**   
Les tags à attribuer à l'abonnement à l'événement.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateEventSubscription_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EventSubscription **   
Informations détaillées sur un événement auquel vous vous êtes inscrit.  
Type : objet [EventSubscription](API_EventSubscription.md)

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

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

 ** EventSubscriptionQuotaExceeded **   
Vous avez atteint le nombre maximum d'abonnements aux événements.   
Code d’état HTTP : 400

 ** SNSInvalidTopic **   
Amazon SNS a répondu qu'il y avait un problème avec le sujet spécifié.   
Code d’état HTTP : 400

 ** SNSNoAuthorization **   
Vous n'êtes pas autorisé à publier sur la rubrique SNS Amazon Resource Name (ARN).   
Code d’état HTTP : 400

 ** SNSTopicArnNotFound **   
La rubrique SNS Amazon Resource Name (ARN) n'existe pas.   
Code d’état HTTP :404

 ** SourceNotFound **   
La source demandée n'a pas pu être trouvée.   
Code d’état HTTP :404

 ** SubscriptionAlreadyExist **   
Le nom d'abonnement fourni existe déjà.   
Code d’état HTTP : 400

 ** SubscriptionCategoryNotFound **   
La catégorie fournie n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_CreateEventSubscription_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-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

Crée un cluster global Amazon DocumentDB qui peut s'étendre sur plusieurs. Régions AWS Le cluster global contient un cluster principal doté d'une capacité de lecture-écriture et jusqu'à 10 clusters secondaires en lecture seule. Les clusters mondiaux utilisent une réplication rapide basée sur le stockage entre les régions avec des latences inférieures à une seconde, en utilisant une infrastructure dédiée sans impact sur les performances de votre charge de travail.



Vous pouvez créer un cluster global initialement vide, puis y ajouter un cluster principal et un cluster secondaire. Vous pouvez également spécifier un cluster existant lors de l'opération de création, et ce cluster devient le principal du cluster global. 

**Note**  
Cette action s'applique uniquement aux clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identifiant de cluster du nouveau cluster global.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

 ** DatabaseName **   
Nom de votre base de données comprenant au maximum 64 caractères alphanumériques. Si vous ne fournissez pas de nom, Amazon DocumentDB ne créera pas de base de données dans le cluster global que vous créez.  
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Le paramètre de protection contre la suppression pour le nouveau cluster global. Le cluster global ne peut pas être supprimé lorsque la protection contre la suppression est activée.   
Type : booléen  
Obligatoire : non

 ** Engine **   
Nom du moteur de base de données à utiliser pour ce cluster.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Version du moteur du cluster global.  
Type : chaîne  
Obligatoire : non

 ** SourceDBClusterIdentifier **   
Le nom de ressource Amazon (ARN) à utiliser comme cluster principal du cluster mondial. Ce paramètre est facultatif.  
Type : chaîne  
Obligatoire : non

 ** StorageEncrypted **   
Le paramètre de chiffrement du stockage pour le nouveau cluster global.   
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_CreateGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** GlobalClusterAlreadyExistsFault **   
`GlobalClusterIdentifier` existe déjà. Choisissez un nouvel identifiant de cluster global (nom unique) pour créer un nouveau cluster global.   
Code d’état HTTP : 400

 ** GlobalClusterQuotaExceededFault **   
Le nombre de clusters globaux pour ce compte est déjà au maximum autorisé.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateGlobalCluster_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-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) 

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

Supprime un cluster précédemment provisionné. Lorsque vous supprimez un cluster, toutes les sauvegardes automatiques de ce cluster sont supprimées et ne peuvent pas être restaurées. Les instantanés manuels du cluster de base de données du cluster spécifié ne sont pas supprimés.



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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster à supprimer. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à un existant`DBClusterIdentifier`.
Type : Chaîne  
Obligatoire : oui

 ** FinalDBSnapshotIdentifier **   
 L'identifiant de capture d'écran de cluster du nouveau cliché de cluster créé lorsque `SkipFinalSnapshot` ce paramètre est défini sur`false`.   
 Le fait de spécifier ce paramètre et de le `SkipFinalShapshot` définir également sur `true` entraîne une erreur. 
Contraintes:  
+ Il doit comporter de 1 à 255 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.
Type : chaîne  
Obligatoire : non

 ** SkipFinalSnapshot **   
 Détermine si un instantané final du cluster est créé avant la suppression du cluster. Si cette `true` option est spécifiée, aucun instantané de cluster n'est créé. Si cela `false` est spécifié, un instantané de cluster est créé avant que le cluster de base de données ne soit supprimé.   
Dans `SkipFinalSnapshot` l'`false`affirmative, vous devez spécifier un `FinalDBSnapshotIdentifier` paramètre.
Valeur par défaut : `false`   
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_DeleteDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBClusterSnapshotAlreadyExistsFault **   
Vous avez déjà un instantané du cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** SnapshotQuotaExceeded **   
La demande vous obligerait à dépasser le nombre autorisé de clichés.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteDBCluster_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-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) 

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

Supprime un groupe de paramètres de cluster spécifié. Le groupe de paramètres de cluster à supprimer ne peut être associé à aucun cluster.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nom du groupe de paramètres de cluster.  
Contraintes:  
+ Doit être le nom d'un groupe de paramètres de cluster existant.
+ Vous ne pouvez pas supprimer un groupe de paramètres de cluster par défaut.
+ Ne peut être associé à aucun cluster.
Type : Chaîne  
Obligatoire : oui

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** InvalidDBParameterGroupState **   
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteDBClusterParameterGroup_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-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

Supprime un instantané de cluster. Si l'instantané est en cours de copie, l'opération est arrêtée.

**Note**  
L'instantané du cluster doit être dans l'`available`état pour être supprimé.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
Identifiant du snapshot du cluster à supprimer.  
Contraintes : Doit être le nom d'un instantané de cluster existant dans l'`available`état.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterSnapshot **   
Informations détaillées sur un instantané de cluster.   
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteDBClusterSnapshot_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-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

Supprime une instance précédemment provisionnée.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBInstanceIdentifier **   
L'identifiant de l'instance à supprimer. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre au nom d'une instance existante.
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteDBInstance_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBInstance **   
Informations détaillées sur une instance.   
Type : objet [DBInstance](API_DBInstance.md)

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier`est déjà utilisé par un instantané existant.   
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

 ** SnapshotQuotaExceeded **   
La demande vous obligerait à dépasser le nombre autorisé de clichés.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteDBInstance_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-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) 

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

Supprime un groupe de sous-réseaux.

**Note**  
Le groupe de sous-réseaux de base de données spécifié ne doit pas être associé à des instances de base de données.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBSubnetGroupName **   
Nom du groupe de sous-réseaux de base de données à supprimer.  
Vous ne pouvez pas supprimer le groupe de sous-réseaux par défaut.
Contraintes:  
Doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.  
Exemple : `mySubnetgroup`   
Type : Chaîne  
Obligatoire : oui

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

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

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** InvalidDBSubnetGroupStateFault **   
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.  
Code d’état HTTP : 400

 ** InvalidDBSubnetStateFault **   
 Le sous-réseau n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteDBSubnetGroup_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-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) 

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

Supprime un abonnement aux notifications d'événements Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SubscriptionName **   
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB que vous souhaitez supprimer.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteEventSubscription_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EventSubscription **   
Informations détaillées sur un événement auquel vous vous êtes inscrit.  
Type : objet [EventSubscription](API_EventSubscription.md)

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

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

 ** InvalidEventSubscriptionState **   
Quelqu'un d'autre est peut-être en train de modifier un abonnement. Patientez quelques secondes, puis réessayez.  
Code d’état HTTP : 400

 ** SubscriptionNotFound **   
Le nom de l'abonnement n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DeleteEventSubscription_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-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) 

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

Supprime un cluster global. Les clusters principal et secondaire doivent déjà être détachés ou supprimés avant de tenter de supprimer un cluster global.

**Note**  
Cette action s'applique uniquement aux clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identifiant du cluster global en cours de suppression.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_DeleteGlobalCluster_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-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) 

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

Renvoie une liste des certificats d'autorité de certification (CA) fournis par Amazon DocumentDB à cet effet. Compte AWS

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** CertificateIdentifier **   
L'identifiant de certificat fourni par l'utilisateur. Si ce paramètre est spécifié, seules les informations relatives au certificat spécifié sont renvoyées. Si ce paramètre est omis, une liste de `MaxRecords` certificats maximum est renvoyée. Ce paramètre n'est pas sensible à la casse.  
Constaintes  
+ Doit correspondre à un existant`CertificateIdentifier`.
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
Jeton de pagination facultatif fourni par une demande `DescribeCertificates` 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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur `MaxRecords` spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats restants.  
Par défaut : 100  
Contraintes:  
+ Minimum : 20
+ Maximum : 100
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeCertificates_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **Certificats.Certificat.N**   
Une liste de certificats pour cela Compte AWS.  
Type : tableau d’objets [Certificate](API_Certificate.md)

 ** Marker **   
Un jeton de pagination facultatif fourni si le nombre d'enregistrements récupérés est supérieur à`MaxRecords`. Si ce paramètre est spécifié, le marqueur indique l'enregistrement suivant de la liste. Inclure la valeur de `Marker` dans le prochain appel aux `DescribeCertificates` résultats dans la page de certificats suivante.  
Type : Chaîne

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

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

 ** CertificateNotFound **   
 `CertificateIdentifier`ne fait pas référence à un certificat existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeCertificates_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-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) 

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

Renvoie une liste des descriptions de `DBClusterParameterGroup`. Si un `DBClusterParameterGroupName` paramètre est spécifié, la liste contient uniquement la description du groupe de paramètres de cluster spécifié. 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nom d'un groupe de paramètres de cluster spécifique pour lequel les détails doivent être renvoyés.  
Contraintes:  
+ S'il est fourni, il doit correspondre au nom d'un existant`DBClusterParameterGroup`.
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBClusterParameterGroups. DBClusterParameterGroup**N.   
Liste des groupes de paramètres du cluster.  
Type : tableau d’objets [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBClusterParameterGroups_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-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

Renvoie la liste détaillée des paramètres d'un groupe de paramètres de cluster particulier.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nom d'un groupe de paramètres de cluster spécifique pour lequel les détails des paramètres doivent être renvoyés.  
Contraintes:  
+ S'il est fourni, il doit correspondre au nom d'un existant`DBClusterParameterGroup`.
Type : Chaîne  
Obligatoire : oui

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** Source **   
 Valeur indiquée pour renvoyer uniquement les paramètres d'une source spécifique. Les sources du paramètre peuvent être `engine`, `service` ou `customer`.   
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

 **Paramètres.Paramètre.N**   
Fournit la liste des paramètres du groupe de paramètres de cluster.  
Type : tableau d’objets [Parameter](API_Parameter.md)

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBClusterParameters_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-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) 

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

Renvoie des informations sur les clusters Amazon DocumentDB provisionnés. Cette opération d'API prend en charge la pagination. Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS et Amazon Neptune. Utilisez le paramètre `filterName=engine,Values=docdb` filter pour renvoyer uniquement les clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
L'identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement du cluster spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ S'il est fourni, il doit correspondre à un existant`DBClusterIdentifier`.
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Filtre qui spécifie un ou plusieurs clusters à décrire.  
Filtres pris en charge :  
+  `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement des informations sur les clusters identifiés par ceux-ci ARNs.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBClusters_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBClusters. DBCluster**N.   
Une liste de clusters.  
Type : tableau d’objets [DBCluster](API_DBCluster.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBClusters_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-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) 

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

Renvoie une liste des noms et des valeurs des attributs d'un instantané de cluster de cluster pour un instantané de cluster de base de données manuel.

Lorsque vous partagez des instantanés avec d'autres Comptes AWS personnes, `DescribeDBClusterSnapshotAttributes` renvoie l'`restore`attribut et une liste IDs de ceux Comptes AWS qui sont autorisés à copier ou à restaurer le cliché manuel du cluster. S'il `all` est inclus dans la liste des valeurs de l'`restore`attribut, l'instantané manuel du cluster est public et peut être copié ou restauré par tous Comptes AWS.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
Identifiant du cliché du cluster dont les attributs doivent être décrits.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterSnapshotAttributesResult **   
Informations détaillées sur les attributs associés à un instantané de cluster.  
Type : objet [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBClusterSnapshotAttributes_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-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

Renvoie des informations sur les instantanés du cluster. Cette opération d'API prend en charge la pagination.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
ID du cluster pour lequel récupérer la liste des instantanés du cluster. Ce paramètre ne peut pas être utilisé avec le `DBClusterSnapshotIdentifier` paramètre. Ce paramètre n'est pas sensible à la casse.   
Contraintes:  
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBCluster`.
Type : chaîne  
Obligatoire : non

 ** DBClusterSnapshotIdentifier **   
Identifiant de capture d'écran spécifique du cluster à décrire. Ce paramètre ne peut pas être utilisé avec le `DBClusterIdentifier` paramètre. Cette valeur est stockée sous la forme d’une chaîne en minuscules.   
Contraintes:  
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBClusterSnapshot`.
+ Si cet identifiant est destinée à un instantané automatisé, le paramètre `SnapshotType` doit également être spécifié.
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** IncludePublic **   
Définissez sur `true` pour inclure les instantanés de cluster manuels qui sont publics et peuvent être copiés ou restaurés par n'importe qui Compte AWS, ou autrement`false`. La valeur par défaut est `false`.  
Type : booléen  
Obligatoire : non

 ** IncludeShared **   
Définissez sur `true` pour inclure les instantanés de cluster manuels partagés provenant d'autres Comptes AWS entités autorisées à copier ou à restaurer, etc. Compte AWS `false` La valeur par défaut est `false`.  
Type : booléen  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** SnapshotType **   
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 vous. Compte AWS
+  `manual`- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre Compte AWS.
+  `shared`- Renvoie tous les instantanés de cluster manuels qui ont été partagés avec votre Compte AWS.
+  `public`- Renvoie tous les instantanés du cluster marqués comme publics.
Si vous ne spécifiez aucune `SnapshotType` valeur, les instantanés de cluster automatisés et manuels sont renvoyés. Vous pouvez inclure des instantanés de cluster partagés avec ces résultats en définissant le `IncludeShared` paramètre sur. `true` Vous pouvez inclure des instantanés de clusters publics avec ces résultats en définissant le `IncludePublic` paramètre sur. `true`  
Les paramètres `IncludeShared` et `IncludePublic` ne s'appliquent pas pour les valeurs `SnapshotType` de `manual` ou `automated`. Le paramètre `IncludePublic` ne s'applique pas lorsque `SnapshotType` est défini sur `shared`. Le paramètre `IncludeShared` ne s'applique pas lorsque `SnapshotType` est défini sur `public`.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBClusterInstantanés. DBClusterSnapshot.N**   
Fournit une liste des instantanés du cluster.  
Type : tableau d’objets [DBClusterSnapshot](API_DBClusterSnapshot.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBClusterSnapshots_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-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

Renvoie la liste des moteurs disponibles.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBParameterGroupFamily **   
Nom d'une famille de groupes de paramètres spécifique pour laquelle les informations doivent être renvoyées.  
Contraintes:  
+ S'il est fourni, il doit correspondre à un existant`DBParameterGroupFamily`.
Type : chaîne  
Obligatoire : non

 ** DefaultOnly **   
Indique que seule la version par défaut du moteur spécifié ou de l'association moteur et version majeure est renvoyée.  
Type : booléen  
Obligatoire : non

 ** Engine **   
Moteur de base de données à renvoyer.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Version du moteur de base de données à renvoyer.  
Exemple : `3.6.0`   
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** ListSupportedCharacterSets **   
Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `CharacterSetName` pour `CreateDBInstance`, la réponse inclut une liste des jeux de caractères pris en charge pour chaque version de moteur.   
Type : booléen  
Obligatoire : non

 ** ListSupportedTimezones **   
Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `TimeZone` pour `CreateDBInstance`, la réponse inclut une liste des fuseaux horaires pris en charge pour chaque version de moteur.   
Type : booléen  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBEngineDes versions. DBEngineVersion.N**   
Informations détaillées sur une ou plusieurs versions du moteur.  
Type : tableau d’objets [DBEngineVersion](API_DBEngineVersion.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

## Voir aussi
<a name="API_DescribeDBEngineVersions_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-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) 

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

Renvoie des informations sur les instances Amazon DocumentDB provisionnées. Cette API prend en charge la pagination.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBInstanceIdentifier **   
L'identifiant d'instance fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement de l'instance spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBInstance`.
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Filtre qui spécifie une ou plusieurs instances à décrire.  
Filtres pris en charge :  
+  `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement les informations relatives aux instances associées aux clusters identifiés par celles-ci ARNs.
+  `db-instance-id`- Accepte les identifiants d'instance et les instances ARNs. La liste des résultats inclut uniquement les informations relatives aux instances identifiées par ces derniers ARNs.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBInstances_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBInstances. DBInstance**N.   
Informations détaillées sur une ou plusieurs instances.   
Type : tableau d’objets [DBInstance](API_DBInstance.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBInstances_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-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

Renvoie une liste des descriptions de `DBSubnetGroup`. Si a `DBSubnetGroupName` est spécifié, la liste contiendra uniquement les descriptions du spécifié`DBSubnetGroup`.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBSubnetGroupName **   
Nom du groupe de sous-réseaux pour lequel les informations doivent être renvoyées.  
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **DBSubnetGroupes. DBSubnetGroupe.N**   
Informations détaillées sur un ou plusieurs groupes de sous-réseaux.  
Type : tableau d’objets [DBSubnetGroup](API_DBSubnetGroup.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeDBSubnetGroups_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-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) 

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

Renvoie les informations sur les paramètres de moteur et de système par défaut du moteur de base de données du cluster.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBParameterGroupFamily **   
Nom de la famille de groupes de paramètres du cluster pour laquelle les informations sur les paramètres du moteur doivent être renvoyées.  
Type : Chaîne  
Obligatoire : oui

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EngineDefaults **   
Contient le résultat d'une invocation réussie de l'`DescribeEngineDefaultClusterParameters`opération.   
Type : objet [EngineDefaults](API_EngineDefaults.md)

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

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

## Voir aussi
<a name="API_DescribeEngineDefaultClusterParameters_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-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

Affiche une liste des catégories de tous les types de sources de l'événement ou, si la valeur est spécifiée, d'un type de source donné. 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** SourceType **   
Type de source qui génère les événements.  
Valeurs valides : `db-instance`, `db-parameter-group`, `db-security-group`   
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeEventCategories_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 **EventCategoriesMapList. EventCategoriesMap**N.   
Liste des cartes des catégories d'événements.  
Type : tableau d’objets [EventCategoriesMap](API_EventCategoriesMap.md)

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

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

## Voir aussi
<a name="API_DescribeEventCategories_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-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Renvoie les événements relatifs aux instances, aux groupes de sécurité, aux instantanés et aux groupes de paramètres de base de données des 14 derniers jours. Vous pouvez obtenir des événements spécifiques à une instance de base de données, à un groupe de sécurité, à un instantané ou à un groupe de paramètres en fournissant le nom en tant que paramètre. Par défaut, les événements de l'heure passée sont renvoyés.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** Duration **   
Nombre de minutes pour lesquelles récupérer les événements.  
Par défaut : 60  
Type : Integer  
Obligatoire : non

 ** EndTime **   
 Fin de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601.   
Exemple : 2009-07-08T18:00Z  
Type : Timestamp  
Obligatoire : non

 **EventCategories. EventCategory**N.   
Liste des catégories d'événements qui déclenchent des notifications pour un abonnement aux notifications d'événements.  
Type : tableau de chaînes  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** SourceIdentifier **   
Identifiant de la source de l'événement pour laquelle les événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse.  
Contraintes:  
+ S'il `SourceIdentifier` est fourni, `SourceType` il doit également être fourni.
+ Si le type de source est`DBInstance`, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est`DBSecurityGroup`, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est`DBParameterGroup`, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est`DBSnapshot`, un `DBSnapshotIdentifier` doit être fourni.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Type : chaîne  
Obligatoire : non

 ** SourceType **   
Source de l'événement pour laquelle récupérer les événements. Si aucune valeur n'est spécifiée, tous les événements sont renvoyés.  
Type : Chaîne  
Valeurs valides : `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obligatoire : non

 ** StartTime **   
 Début de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601.   
Exemple : 2009-07-08T18:00Z  
Type : Timestamp  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeEvents_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **Événements.Événement.N**   
Informations détaillées sur un ou plusieurs événements.   
Type : tableau d’objets [Event](API_Event.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

## Voir aussi
<a name="API_DescribeEvents_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-2014-10-31/DescribeEvents) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) 

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

Répertorie toutes les descriptions d'abonnements d'un compte client. La description d'un abonnement inclut `SubscriptionName``SNSTopicARN`,`CustomerID`, `SourceType``SourceID`,`CreationTime`, et`Status`.

Si vous spécifiez un`SubscriptionName`, répertorie la description de cet abonnement.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** SubscriptionName **   
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB que vous souhaitez décrire.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **EventSubscriptionsList. EventSubscription**N.   
Liste des abonnements aux événements.  
Type : tableau d’objets [EventSubscription](API_EventSubscription.md)

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

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

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

 ** SubscriptionNotFound **   
Le nom de l'abonnement n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeEventSubscriptions_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-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) 

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

Renvoie des informations sur les clusters globaux Amazon DocumentDB. Cette API prend en charge la pagination.

**Note**  
Cette action s'applique uniquement aux clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 **Filtres.Filter.N**   
Filtre qui spécifie un ou plusieurs clusters de bases de données globaux à décrire.  
Filtres pris en charge : `db-cluster-id` accepte les identifiants de cluster et les noms de ressources Amazon de clusters (ARNs). La liste des résultats inclura uniquement des informations sur les clusters identifiés par ceux-ci ARNs.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** GlobalClusterIdentifier **   
L'identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement du cluster spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : non

 ** Marker **   
Jeton de pagination facultatif fourni par une demande `DescribeGlobalClusters` 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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse afin que vous puissiez récupérer les résultats restants.   
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 **GlobalClusters. GlobalClusterMember**N.   
  
Type : tableau d’objets [GlobalCluster](API_GlobalCluster.md)

 ** Marker **   
  
Type : Chaîne

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribeGlobalClusters_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-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) 

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

Renvoie une liste d'options d'instance pouvant être commandées pour le moteur spécifié.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** Engine **   
Nom du moteur pour lequel les options d'instance doivent être récupérées.  
Type : Chaîne  
Obligatoire : oui

 ** DBInstanceClass **   
La valeur du filtre de classe d'instance. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la classe d'instance spécifiée.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Valeur de filtre de la version de moteur. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la version du moteur spécifiée.  
Type : chaîne  
Obligatoire : non

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** LicenseModel **   
Valeur de filtre du modèle de licence. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant au modèle de licence spécifié.  
Type : chaîne  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** Vpc **   
La valeur du filtre de cloud privé virtuel (VPC). Spécifiez ce paramètre pour afficher uniquement les offres VPC ou non VPC disponibles.  
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

 **Options DBInstance commandes.Option commandable.N DBInstance**   
Les options disponibles pour une instance commandable particulière.  
Type : tableau d’objets [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)

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

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

## Voir aussi
<a name="API_DescribeOrderableDBInstanceOptions_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-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

Renvoie une liste de ressources (par exemple, des instances) pour lesquelles au moins une action de maintenance est en attente.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 **Filtres.Filter.N**   
Filtre qui spécifie une ou plusieurs ressources pour lesquelles renvoyer des actions de maintenance en attente.  
Filtres pris en charge :  
+  `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement les actions de maintenance en attente pour les clusters identifiés par ceux-ci ARNs.
+  `db-instance-id`- Accepte les identifiants d'instance et les instances ARNs. La liste des résultats inclut uniquement les actions de maintenance en attente pour les instances de base de données identifiées par celles-ci ARNs.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** Marker **   
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 `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** MaxRecords **   
 Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` 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.  
Par défaut : 100  
Contraintes : Minimum 20, maximum 100.  
Type : Integer  
Obligatoire : non

 ** ResourceIdentifier **   
ARN d'une ressource pour laquelle renvoyer des actions de maintenance en attente.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

Les éléments suivants sont renvoyés par le service.

 ** Marker **   
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 `MaxRecords`.  
Type : Chaîne

 **PendingMaintenanceActions. ResourcePendingMaintenanceActions**N.   
Les actions de maintenance à appliquer.  
Type : tableau d’objets [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

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

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

 ** ResourceNotFoundFault **   
L'ID de ressource spécifiée est introuvable.  
Code d’état HTTP :404

## Voir aussi
<a name="API_DescribePendingMaintenanceActions_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-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

Force le basculement d'un cluster.

En cas de basculement d'un cluster, l'une des répliques Amazon DocumentDB (instances en lecture seule) du cluster devient l'instance principale (le rédacteur du cluster).

En cas de défaillance de l'instance principale, Amazon DocumentDB bascule automatiquement vers une réplique Amazon DocumentDB, le cas échéant. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant de cluster pour lequel forcer un basculement. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : chaîne  
Obligatoire : non

 ** TargetDBInstanceIdentifier **   
Nom de l'instance à promouvoir en instance principale.  
Vous devez spécifier l'identifiant d'instance pour une réplique Amazon DocumentDB dans le cluster. Par exemple, `mydbcluster-replica1`.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_FailoverDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_FailoverDBCluster_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-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) 

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

Fait du cluster de base de données secondaire spécifié le cluster de base de données principal du cluster global en cas de basculement d'un cluster global.

Utilisez cette opération pour répondre à un événement imprévu, tel qu'une catastrophe régionale dans la région principale. Un échec peut entraîner la perte de données de transaction d'écriture qui n'ont pas été répliquées sur le secondaire choisi avant que le basculement ne se produise. Cependant, le processus de restauration qui fait d'une instance de base de données du cluster de base de données secondaire choisi l'instance de base de données principale du rédacteur garantit que les données sont dans un état de cohérence transactionnelle.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identifiant du cluster global Amazon DocumentDB pour appliquer cette opération. L'identifiant est la clé unique attribuée par l'utilisateur lors de la création du cluster. En d'autres termes, il s'agit du nom du cluster mondial.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un cluster global existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

 ** TargetDbClusterIdentifier **   
Identifiant du cluster Amazon DocumentDB secondaire que vous souhaitez promouvoir au rang de cluster principal pour le cluster global. Utilisez l'Amazon Resource Name (ARN) comme identifiant afin qu'Amazon DocumentDB puisse localiser le cluster dans sa AWS région.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un cluster secondaire existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

 ** AllowDataLoss **   
Spécifie s'il faut autoriser la perte de données pour cette opération de cluster globale. Autoriser la perte de données déclenche une opération de basculement globale.  
Si vous ne le spécifiez pas`AllowDataLoss`, le fonctionnement du cluster global est par défaut un basculement.  
Contraintes:  
+ Ne peut pas être spécifié en même temps que le `Switchover` paramètre.
Type : booléen  
Obligatoire : non

 ** Switchover **   
Spécifie s'il convient de basculer entre ce cluster de bases de données global.  
Contraintes:  
+ Ne peut pas être spécifié en même temps que le `AllowDataLoss` paramètre.
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_FailoverGlobalCluster_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-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) 

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

Répertorie toutes les balises d'une ressource Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** ResourceName **   
La ressource Amazon DocumentDB avec les balises à répertorier. Cette valeur est un Amazon Resource Name (ARN).  
Type : Chaîne  
Obligatoire : oui

 **Filtres.Filter.N**   
Ce paramètre n'est actuellement pas pris en charge.  
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

## Éléments de réponse
<a name="API_ListTagsForResource_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 **TagList.Tag N**   
Liste d'un ou de plusieurs tags.  
Type : tableau d’objets [Tag](API_Tag.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`ne fait pas référence à un instantané existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_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-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) 

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

Modifie un paramètre pour un cluster Amazon DocumentDB. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande. 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster en cours de modification. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : Chaîne  
Obligatoire : oui

 ** AllowMajorVersionUpgrade **   
Une valeur qui indique que les mises à niveau de version majeures sont autorisées.  
Contraintes:  
+ Vous devez autoriser les mises à niveau des versions majeures lorsque vous spécifiez une valeur pour le `EngineVersion` paramètre qui est une version majeure différente de la version actuelle du cluster.
+ Certains paramètres étant spécifiques à la version, leur modification nécessite l'exécution d'un nouvel appel d'`ModifyDBCluster`API une fois le MVU en place terminé.
L'exécution d'un MVU a un impact direct sur les paramètres suivants :  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
Type : booléen  
Obligatoire : non

 ** ApplyImmediately **   
Valeur qui indique si les modifications apportées à cette demande et aux modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le `PreferredMaintenanceWindow` paramètre du cluster. Si ce paramètre est défini sur`false`, les modifications apportées au cluster sont appliquées lors de la fenêtre de maintenance suivante.  
Le `ApplyImmediately` paramètre affecte uniquement les `MasterUserPassword` valeurs `NewDBClusterIdentifier` et. Si vous définissez la valeur de ce paramètre sur`false`, les modifications apportées aux `MasterUserPassword` valeurs `NewDBClusterIdentifier` et sont appliquées lors de la fenêtre de maintenance suivante. Toutes les autres modifications sont appliquées immédiatement, quelle que soit la valeur du paramètre `ApplyImmediately`.  
Valeur par défaut : `false`   
Type : booléen  
Obligatoire : non

 ** BackupRetentionPeriod **   
Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.  
Par défaut : 1  
Contraintes:  
+ Doit être une valeur comprise entre 1 et 35.
Type : Integer  
Obligatoire : non

 ** CloudwatchLogsExportConfiguration **   
Le paramètre de configuration des types de journaux à activer pour l'exportation vers Amazon CloudWatch Logs pour une instance ou un cluster spécifique. Les `DisableLogTypes` tableaux `EnableLogTypes` et déterminent quels journaux sont exportés (ou non exportés) vers CloudWatch Logs.  
Type : objet [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)  
Obligatoire : non

 ** DBClusterParameterGroupName **   
Le nom du groupe de paramètres de cluster à utiliser pour le cluster.  
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.  
Type : booléen  
Obligatoire : non

 ** EngineVersion **   
Numéro de version du moteur de base de données vers lequel vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification sera appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` est activé.  
Pour répertorier toutes les versions de moteur disponibles pour Amazon DocumentDB, utilisez la commande suivante :  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
Type : chaîne  
Obligatoire : non

 ** ManageMasterUserPassword **   
Spécifie s'il faut gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager. Si le cluster ne gère pas le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager, vous pouvez activer cette gestion. Dans ce cas, vous ne pouvez pas le spécifier`MasterUserPassword`. Si le cluster gère déjà le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager et que vous spécifiez que le mot de passe de l'utilisateur principal n'est pas géré avec Amazon Web Services Secrets Manager, vous devez le spécifier`MasterUserPassword`. Dans ce cas, Amazon DocumentDB supprime le secret et utilise le nouveau mot de passe de l'utilisateur principal spécifié par. `MasterUserPassword`  
Type : booléen  
Obligatoire : non

 ** MasterUserPassword **   
Mot de passe de l'utilisateur principal de la base de données. 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 comporter entre 8 et 100 caractères.  
Type : chaîne  
Obligatoire : non

 ** MasterUserSecretKmsKeyId **   
L'identifiant de clé KMS d'Amazon Web Services permettant de chiffrer un secret généré et géré automatiquement dans Amazon Web Services Secrets Manager.  
Ce paramètre n'est valide que si les deux conditions suivantes sont remplies :  
+ Le cluster ne gère pas le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si le cluster gère déjà le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager, vous ne pouvez pas modifier la clé KMS utilisée pour chiffrer le secret.
+ Vous êtes en train `ManageMasterUserPassword` d'activer la gestion du mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si vous l'activez `ManageMasterUserPassword` et que vous ne le spécifiez pas`MasterUserSecretKmsKeyId`, la clé `aws/secretsmanager` KMS est utilisée pour chiffrer le secret. Si le secret se trouve dans un autre compte Amazon Web Services, vous ne pouvez pas utiliser la clé `aws/secretsmanager` KMS pour le chiffrer et vous devez utiliser une clé KMS gérée par le client.
L'identifiant de clé KMS d'Amazon Web Services est l'ARN de la clé, l'identifiant de clé, l'alias ARN ou le nom d'alias de la clé KMS. Pour utiliser une clé KMS dans un autre compte Amazon Web Services, spécifiez l'ARN de la clé ou l'alias ARN.  
Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.  
Type : chaîne  
Obligatoire : non

 ** NetworkType **   
Type de réseau du cluster.  
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).  
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.  
Valeurs valides : `IPV4` \$1 `DUAL`   
Type : chaîne  
Obligatoire : non

 ** NewDBClusterIdentifier **   
Le nouvel identificateur de cluster pour le cluster lors du changement de nom d'un cluster. Cette valeur est stockée sous la forme d’une chaîne en 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-cluster2`   
Type : chaîne  
Obligatoire : non

 ** Port **   
Numéro de port au niveau duquel le cluster accepte des connexions.  
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.   
Par défaut : le même port que le cluster d'origine.  
Type : Integer  
Obligatoire : non

 ** PreferredBackupWindow **   
Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre `BackupRetentionPeriod`.   
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS  
Contraintes:  
+ Doit être au format `hh24:mi-hh24:mi`.
+ Doit être exprimée en heure UTC (Universal Coordinated Time).
+ Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
+ Doit être de 30 minutes minimum.
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
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`   
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles Région AWS, survenant un jour aléatoire de la semaine.   
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Contraintes : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** RotateMasterUserPassword **   
Spécifie s'il faut remplacer le secret géré par Amazon Web Services Secrets Manager par le mot de passe de l'utilisateur principal.  
Ce paramètre n'est valide que si le mot de passe de l'utilisateur principal est géré par Amazon DocumentDB dans Amazon Web Services Secrets Manager pour le cluster. La valeur secrète contient le mot de passe mis à jour.  
Contrainte : vous devez appliquer la modification immédiatement lors de la rotation du mot de passe de l'utilisateur principal.  
Type : booléen  
Obligatoire : non

 ** ServerlessV2ScalingConfiguration **   
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.  
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatoire : non

 ** StorageType **   
Type de stockage à associer au cluster de base de données.  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Type : chaîne  
Obligatoire : non

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le cluster appartiendra.  
Type : tableau de chaînes  
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterAlreadyExistsFault **   
Vous avez déjà un cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName`ne fait pas référence à un groupe de paramètres de cluster existant.   
Code d’état HTTP :404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

 ** InvalidDBSecurityGroupState **   
L'état du groupe de sécurité n'autorise pas la suppression.  
Code d’état HTTP : 400

 ** InvalidDBSubnetGroupStateFault **   
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** NetworkTypeNotSupported **   
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyDBCluster_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-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) 

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

 Modifie les paramètres d'un groupe de paramètres de cluster. Pour modifier plusieurs paramètres, soumettez une liste des éléments suivants : `ParameterName`, `ParameterValue` et `ApplyMethod`. 20 paramètres maximum peuvent être modifiés dans une même demande. 

**Note**  
Les modifications apportées aux paramètres dynamiques sont appliquées immédiatement. Les modifications apportées aux paramètres statiques nécessitent un redémarrage ou une fenêtre de maintenance avant que la modification ne soit prise en compte.

**Important**  
Après avoir créé un groupe de paramètres de cluster, vous devez patienter au moins 5 minutes avant de créer votre premier cluster devant utiliser ce groupe de paramètres de cluster comme groupe de paramètres par défaut. Cela permet à Amazon DocumentDB de terminer complètement l'action de création avant que le groupe de paramètres ne soit utilisé par défaut pour un nouveau cluster. Cette étape est particulièrement importante pour les paramètres qui sont essentiels lors de la création de la base de données par défaut d'un cluster, tels que le jeu de caractères de la base de données par défaut définie par le paramètre `character_set_database`.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nom du groupe de paramètres de cluster à modifier.  
Type : Chaîne  
Obligatoire : oui

 **Paramètres.Paramètre.N**   
Liste des paramètres du groupe de paramètres du cluster à modifier.  
Type : tableau d’objets [Parameter](API_Parameter.md)  
Obligatoire : oui

## Éléments de réponse
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterParameterGroupName **   
Nom d'un groupe de paramètres de cluster.  
Contraintes:  
+ Doit contenir de 1 à 255 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** InvalidDBParameterGroupState **   
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyDBClusterParameterGroup_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-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

Ajoute un attribut et des valeurs ou supprime un attribut et des valeurs d'un instantané de cluster manuel.

Pour partager un instantané de cluster manuel avec d'autres personnes Comptes AWS`AttributeName`, spécifiez `restore` comme et utilisez le `ValuesToAdd` paramètre pour ajouter une liste IDs des Comptes AWS personnes autorisées à restaurer l'instantané de cluster manuel. Utilisez cette valeur `all` pour rendre public le cliché manuel du cluster, ce qui signifie qu'il peut être copié ou restauré par tous Comptes AWS. N'ajoutez aucune `all` valeur aux instantanés de cluster manuels contenant des informations privées que vous ne souhaitez pas voir accessibles à tous Comptes AWS. Si un instantané de cluster manuel est chiffré, il peut être partagé, mais uniquement en spécifiant une liste de personnes autorisées Compte AWS IDs pour le `ValuesToAdd` paramètre. Dans ce cas, vous ne pouvez pas utiliser `all` comme une valeur pour ce paramètre.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** AttributeName **   
Nom de l'attribut de capture d'écran du cluster à modifier.  
Pour gérer l'autorisation permettant Comptes AWS à d'autres utilisateurs de copier ou de restaurer un instantané de cluster manuel, définissez cette valeur sur`restore`.  
Type : Chaîne  
Obligatoire : oui

 ** DBClusterSnapshotIdentifier **   
Identifiant du cliché du cluster dont les attributs doivent être modifiés.  
Type : Chaîne  
Obligatoire : oui

 **ValuesToAdd. AttributeValue**N.   
Liste des attributs de capture d'écran du cluster à ajouter à l'attribut spécifié par`AttributeName`.  
Pour autoriser d'autres Comptes AWS utilisateurs à copier ou restaurer un instantané de cluster manuel, configurez cette liste pour en inclure un ou plusieurs Compte AWS IDs. Pour que l'instantané manuel du cluster puisse être restauré par n'importe qui Compte AWS, définissez-le sur`all`. N'ajoutez aucune `all` valeur aux instantanés de cluster manuels contenant des informations privées que vous ne souhaitez pas rendre accessibles à tous Comptes AWS.  
Type : tableau de chaînes  
Obligatoire : non

 **ValuesToRemove. AttributeValue**N.   
Liste des attributs de capture d'écran du cluster à supprimer de l'attribut spécifié par`AttributeName`.  
Pour supprimer l'autorisation permettant Comptes AWS à d'autres utilisateurs de copier ou de restaurer un instantané de cluster manuel, configurez cette liste pour inclure un ou plusieurs Compte AWS identifiants. Pour supprimer l'autorisation permettant Compte AWS à quiconque de copier ou de restaurer l'instantané du cluster, définissez-le sur`all`. Si vous le spécifiez`all`, un Compte AWS utilisateur dont l'ID de compte est explicitement ajouté à l'`restore`attribut peut toujours copier ou restaurer un instantané de cluster manuel.  
Type : tableau de chaînes  
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterSnapshotAttributesResult **   
Informations détaillées sur les attributs associés à un instantané de cluster.  
Type : objet [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** SharedSnapshotQuotaExceeded **   
Vous avez dépassé le nombre maximal de comptes avec lesquels vous pouvez partager un instantané de base de données manuel.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyDBClusterSnapshotAttribute_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-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

Modifie les paramètres d'une instance. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBInstanceIdentifier **   
Identifiant de l’instance. Cette valeur est stockée sous la forme d’une chaîne en minuscules.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBInstance` existant.
Type : Chaîne  
Obligatoire : oui

 ** ApplyImmediately **   
Spécifie si les modifications de cette demande et les modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le `PreferredMaintenanceWindow` paramètre de l'instance.   
 Si ce paramètre est défini sur`false`, les modifications apportées à l'instance sont appliquées lors de la fenêtre de maintenance suivante. Certaines modifications de paramètres peuvent provoquer une panne et sont appliquées lors du prochain redémarrage.  
Valeur par défaut : `false`   
Type : booléen  
Obligatoire : non

 ** AutoMinorVersionUpgrade **   
Ce paramètre ne s'applique pas à Amazon DocumentDB. Amazon DocumentDB n'effectue pas de mises à niveau mineures de version, quelle que soit la valeur définie.  
Type : booléen  
Obligatoire : non

 ** CACertificateIdentifier **   
Indique le certificat qui doit être associé à l'instance.  
Type : chaîne  
Obligatoire : non

 ** CertificateRotationRestart **   
Spécifie si l'instance de base de données est redémarrée lorsque vous faites pivoter votre SSL/TLS certificat.  
Par défaut, l'instance de base de données est redémarrée lorsque vous faites pivoter votre SSL/TLS certificat. Le certificat n'est pas mis à jour tant que l'instance de base de données n'est pas redémarrée.  
Définissez ce paramètre uniquement si vous ne l'utilisez *pas* pour vous connecter SSL/TLS à l'instance de base de données.
*Si vous utilisez SSL/TLS pour vous connecter à l'instance de base de données, consultez la section [Mise à jour de vos certificats TLS Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) et [chiffrement des données en transit dans](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) le guide du développeur Amazon DocumentDB.*  
Type : booléen  
Obligatoire : non

 ** CopyTagsToSnapshot **   
Une valeur qui indique s'il faut copier toutes les balises de l'instance de base de données vers des instantanés de l'instance de base de données. Par défaut, les balises ne sont pas copiées.  
Type : booléen  
Obligatoire : non

 ** DBInstanceClass **   
La nouvelle capacité de calcul et de mémoire de l'instance ; par exemple,`db.r5.large`. Les classes d'instance ne sont pas toutes disponibles Régions AWS.   
Si vous modifiez la classe d'instance, une panne se produit lors de la modification. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` a été spécifié `true` pour cette demande.   
Par défaut : Utilise le paramètre existant.  
Type : chaîne  
Obligatoire : non

 ** EnablePerformanceInsights **   
Une valeur qui indique s'il convient d'activer Performance Insights pour l'instance de base de données. Pour plus d'informations, voir [Utilisation d'Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Type : booléen  
Obligatoire : non

 ** NewDBInstanceIdentifier **   
 Le nouvel identifiant d'instance pour l'instance lorsque vous renommez une instance. Lorsque vous modifiez l'identifiant de l'instance, un redémarrage de l'instance a lieu immédiatement si vous le définissez `Apply Immediately` sur`true`. Cela se produit lors de la fenêtre de maintenance suivante si vous définissez `Apply Immediately` sur`false`. Cette valeur est stockée sous la forme d’une chaîne en 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 : `mydbinstance`   
Type : chaîne  
Obligatoire : non

 ** PerformanceInsightsKMSKeyId **   
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights.  
L'identifiant de AWS KMS clé est l'ARN de la clé, l'ID de clé, l'alias ARN ou le nom d'alias de la clé KMS.  
Si vous ne spécifiez aucune valeur pour PerformanceInsights KMSKey Id, Amazon DocumentDB utilise votre clé KMS par défaut. Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.  
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
Intervalle de temps hebdomadaire (au format UTC) pendant lequel se produit la maintenance du système qui peut entraîner une interruption. La modification de ce paramètre n'entraîne pas de panne, sauf dans le cas suivant, et la modification est appliquée de manière asynchrone dès que possible. Si des actions en attente entraînent un redémarrage et que la fenêtre de maintenance est modifiée pour inclure l'heure actuelle, la modification de ce paramètre entraîne le redémarrage de l'instance. Si vous déplacez cette fenêtre vers l'heure actuelle, il doit s'écouler au moins 30 minutes entre l'heure actuelle et la fin de la fenêtre pour garantir que les modifications en attente sont appliquées.  
Par défaut : Utilise le paramètre existant.  
Format : `ddd:hh24:mi-ddd:hh24:mi`   
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Contraintes : Doit durer au moins 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** PromotionTier **   
Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.  
Valeur par défaut : 1  
Valeurs valides : 0 à 15  
Type : Integer  
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyDBInstance_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBInstance **   
Informations détaillées sur une instance.   
Type : objet [DBInstance](API_DBInstance.md)

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

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

 ** AuthorizationNotFound **   
L'adresse IP CIDR ou le groupe de sécurité Amazon EC2 spécifié n'est pas autorisé pour le groupe de sécurité spécifié.  
Amazon DocumentDB peut également ne pas être autorisé à effectuer les actions nécessaires en votre nom à l'aide d'IAM.  
Code d’état HTTP :404

 ** CertificateNotFound **   
 `CertificateIdentifier`ne fait pas référence à un certificat existant.   
Code d’état HTTP :404

 ** DBInstanceAlreadyExists **   
Vous avez déjà une instance avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName`ne fait pas référence à un groupe de sécurité existant.   
Code d’état HTTP :404

 ** DBUpgradeDependencyFailure **   
La mise à niveau a échoué car une ressource dont dépend ne peut pas être modifiée.  
Code d’état HTTP : 400

 ** InsufficientDBInstanceCapacity **   
La classe d'instance spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas *disponible*.   
Code d’état HTTP : 400

 ** InvalidDBSecurityGroupState **   
L'état du groupe de sécurité n'autorise pas la suppression.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

 ** StorageTypeNotSupported **   
Le stockage du paramètre spécifié ne `StorageType` peut pas être associé à l'instance de base de données.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyDBInstance_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-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) 

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

Modifie un groupe de sous-réseaux existant. Les groupes de sous-réseaux doivent contenir au moins un sous-réseau dans au moins deux zones de disponibilité du. Région AWS

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBSubnetGroupName **   
Nom du groupe de sous-réseaux. Cette valeur est stockée sous la forme d’une chaîne en minuscules. Vous ne pouvez pas modifier le groupe de sous-réseaux par défaut.   
Contraintes : doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.  
Exemple : `mySubnetgroup`   
Type : Chaîne  
Obligatoire : oui

 **SubnetIds. SubnetIdentifier**N.   
Le sous-réseau Amazon EC2 IDs pour le groupe de sous-réseaux.  
Type : tableau de chaînes  
Obligatoire : oui

 ** DBSubnetGroupDescription **   
Description du groupe de sous-réseaux.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBSubnetGroup **   
Informations détaillées sur un groupe de sous-réseaux.   
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)

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

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

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.  
Code d’état HTTP : 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** DBSubnetQuotaExceededFault **   
La demande vous obligerait à dépasser le nombre autorisé de sous-réseaux dans un groupe de sous-réseaux.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** SubnetAlreadyInUse **   
Le sous-réseau est déjà utilisé dans la zone de disponibilité.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyDBSubnetGroup_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-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

Modifie un abonnement existant aux notifications d'événements Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SubscriptionName **   
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : Chaîne  
Obligatoire : oui

 ** Enabled **   
 Valeur booléenne ; définie sur pour `true` activer l'abonnement.   
Type : booléen  
Obligatoire : non

 **EventCategories. EventCategory**N.   
 Liste des catégories d'événements `SourceType` auxquels vous souhaitez vous abonner.  
Type : tableau de chaînes  
Obligatoire : non

 ** SnsTopicArn **   
Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. L'ARN est créé par Amazon SNS lorsque vous créez une rubrique et vous y abonnez.  
Type : chaîne  
Obligatoire : non

 ** SourceType **   
Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance, définissez ce paramètre sur`db-instance`. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.  
Valeurs valides : `db-instance`, `db-parameter-group`, `db-security-group`   
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyEventSubscription_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EventSubscription **   
Informations détaillées sur un événement auquel vous vous êtes inscrit.  
Type : objet [EventSubscription](API_EventSubscription.md)

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

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

 ** EventSubscriptionQuotaExceeded **   
Vous avez atteint le nombre maximum d'abonnements aux événements.   
Code d’état HTTP : 400

 ** SNSInvalidTopic **   
Amazon SNS a répondu qu'il y avait un problème avec le sujet spécifié.   
Code d’état HTTP : 400

 ** SNSNoAuthorization **   
Vous n'êtes pas autorisé à publier sur la rubrique SNS Amazon Resource Name (ARN).   
Code d’état HTTP : 400

 ** SNSTopicArnNotFound **   
La rubrique SNS Amazon Resource Name (ARN) n'existe pas.   
Code d’état HTTP :404

 ** SubscriptionCategoryNotFound **   
La catégorie fournie n'existe pas.   
Code d’état HTTP :404

 ** SubscriptionNotFound **   
Le nom de l'abonnement n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_ModifyEventSubscription_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-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Modifiez un paramètre pour un cluster global Amazon DocumentDB. Vous pouvez modifier un ou plusieurs paramètres de configuration (par exemple : protection contre la suppression) ou l'identifiant global du cluster en spécifiant ces paramètres et les nouvelles valeurs dans la demande.

**Note**  
Cette action s'applique uniquement aux clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identifiant du cluster global en cours de modification. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un cluster global existant.
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

 ** DeletionProtection **   
Indique si la protection contre les suppressions est activée sur le cluster global. Le cluster global ne peut pas être supprimé lorsque la protection contre la suppression est activée.   
Type : booléen  
Obligatoire : non

 ** NewGlobalClusterIdentifier **   
Le nouvel identifiant d'un cluster global lorsque vous modifiez un cluster global. Cette valeur est stockée sous la forme d’une chaîne en minuscules.  
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union

  Le premier caractère doit être une lettre

  Il ne peut pas se terminer par un trait d'union ou contenir deux traits d'union consécutifs.
Exemple : `my-cluster2`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : non

## Éléments de réponse
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ModifyGlobalCluster_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-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

Il se peut que vous deviez redémarrer votre instance, généralement pour des raisons de maintenance. Par exemple, si vous apportez certaines modifications ou si vous modifiez le groupe de paramètres de cluster associé à l'instance, vous devez redémarrer l'instance pour que les modifications prennent effet. 

Le redémarrage d'une instance entraîne celui du service du moteur de base de données. *Le redémarrage d'une instance entraîne une interruption momentanée, au cours de laquelle le statut de l'instance est défini sur le redémarrage.* 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBInstanceIdentifier **   
Identifiant de l’instance. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBInstance` existant.
Type : Chaîne  
Obligatoire : oui

 ** ForceFailover **   
 Lorsque `true` le redémarrage est effectué par le biais d'un basculement multi-AZ.   
Contrainte : vous ne pouvez pas spécifier `true` si l'instance n'est pas configurée pour le mode multi-AZ.  
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_RebootDBInstance_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBInstance **   
Informations détaillées sur une instance.   
Type : objet [DBInstance](API_DBInstance.md)

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_RebootDBInstance_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-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Détache un cluster secondaire Amazon DocumentDB d'un cluster global. Le cluster devient un cluster autonome doté d'une fonction de lecture-écriture au lieu d'être en lecture seule et de recevoir des données d'un serveur principal d'une autre région. 

**Note**  
Cette action s'applique uniquement aux clusters Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DbClusterIdentifier **   
Le nom de ressource Amazon (ARN) identifiant le cluster qui a été détaché du cluster global Amazon DocumentDB.   
Type : Chaîne  
Obligatoire : oui

 ** GlobalClusterIdentifier **   
Identifiant de cluster à détacher du cluster global Amazon DocumentDB.   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

## Éléments de réponse
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_RemoveFromGlobalCluster_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-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

Supprime un identifiant de source d'un abonnement existant aux notifications d'événements Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** SourceIdentifier **   
 L'identifiant source à supprimer de l'abonnement, tel que l'identifiant d'instance d'une instance ou le nom d'un groupe de sécurité.   
Type : Chaîne  
Obligatoire : oui

 ** SubscriptionName **   
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB dont vous souhaitez supprimer un identifiant de source.  
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** EventSubscription **   
Informations détaillées sur un événement auquel vous vous êtes inscrit.  
Type : objet [EventSubscription](API_EventSubscription.md)

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

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

 ** SourceNotFound **   
La source demandée n'a pas pu être trouvée.   
Code d’état HTTP :404

 ** SubscriptionNotFound **   
Le nom de l'abonnement n'existe pas.   
Code d’état HTTP :404

## Voir aussi
<a name="API_RemoveSourceIdentifierFromSubscription_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-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Supprime les balises de métadonnées d'une ressource Amazon DocumentDB.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** ResourceName **   
La ressource Amazon DocumentDB dont les balises sont supprimées. Cette valeur est un Amazon Resource Name (ARN).  
Type : Chaîne  
Obligatoire : oui

 **TagKeys.membre.n**   
Clé de balise (nom) de la balise à supprimer.  
Type : tableau de chaînes  
Obligatoire : oui

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`ne fait pas référence à une instance existante.   
Code d’état HTTP :404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`ne fait pas référence à un instantané existant.   
Code d’état HTTP :404

## Voir aussi
<a name="API_RemoveTagsFromResource_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-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 Modifie les paramètres d'un groupe de paramètres de cluster à la valeur par défaut. Pour réinitialiser des paramètres spécifiques, soumettez une liste des éléments suivants : `ParameterName` et`ApplyMethod`. Pour réinitialiser l'ensemble du groupe de paramètres du cluster, spécifiez les `ResetAllParameters` paramètres `DBClusterParameterGroupName` et. 

 Lorsque vous réinitialisez l'ensemble du groupe, les paramètres dynamiques sont immédiatement mis à jour et les paramètres statiques sont définis pour `pending-reboot` prendre effet au prochain redémarrage de l'instance de base de données.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Le nom du groupe de paramètres du cluster à réinitialiser.  
Type : Chaîne  
Obligatoire : oui

 **Paramètres.Paramètre.N**   
Liste des noms de paramètres du groupe de paramètres du cluster à rétablir aux valeurs par défaut. Vous ne pouvez pas utiliser ce paramètre si le paramètre `ResetAllParameters` est défini sur `true`.  
Type : tableau d’objets [Parameter](API_Parameter.md)  
Obligatoire : non

 ** ResetAllParameters **   
Une valeur définie `true` pour rétablir les valeurs par défaut de tous les paramètres du groupe de paramètres du cluster, et dans le `false` cas contraire. Vous ne pouvez pas utiliser ce paramètre si une liste des noms des paramètres spécifiés existe pour le paramètre `Parameters`.  
Type : booléen  
Obligatoire : non

## Éléments de réponse
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBClusterParameterGroupName **   
Nom d'un groupe de paramètres de cluster.  
Contraintes:  
+ Doit contenir de 1 à 255 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.   
Code d’état HTTP :404

 ** InvalidDBParameterGroupState **   
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ResetDBClusterParameterGroup_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-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

Crée un nouveau cluster à partir d'un instantané ou d'un instantané de cluster.

Si un instantané est spécifié, le cluster cible est créé à partir de l'instantané de base de données source avec une configuration et un groupe de sécurité par défaut.

Si un instantané de cluster est spécifié, le cluster cible est créé à partir du point de restauration du cluster source avec la même configuration que le cluster de base de données source d'origine, sauf que le nouveau cluster est créé avec le groupe de sécurité par défaut.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Nom du cluster à créer à partir du cliché ou de l'instantané du cluster. 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 : `my-snapshot-id`   
Type : Chaîne  
Obligatoire : oui

 ** Engine **   
Le moteur de base de données à utiliser pour le nouveau cluster.  
Par défaut : identique à la source.  
Contrainte : Doit être compatible avec le moteur de la source.  
Type : Chaîne  
Obligatoire : oui

 ** SnapshotIdentifier **   
Identifiant de l'instantané ou de l'instantané de cluster à partir duquel effectuer la restauration.  
Vous pouvez utiliser le nom ou l'Amazon Resource Name (ARN) pour spécifier un instantané de cluster. Cependant, vous pouvez uniquement utiliser l'ARN pour spécifier un instantané.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un instantané existant.
Type : Chaîne  
Obligatoire : oui

 **AvailabilityZones. AvailabilityZone**N.   
Fournit la liste des zones de disponibilité Amazon EC2 dans lesquelles les instances du cluster de base de données restauré peuvent être créées.  
Type : tableau de chaînes  
Obligatoire : non

 ** DBClusterParameterGroupName **   
Nom du groupe de paramètres de cluster DB à associer à ce cluster DB.  
 *Type* : chaîne.       *Nécessaire :* Non  
Si cet argument est omis, le groupe de paramètres du cluster de base de données par défaut est utilisé. S'il est fourni, il doit correspondre au nom d'un groupe de paramètres de cluster de base de données par défaut existant. La chaîne doit être composée de 1 à 255 lettres, chiffres ou tirets. Son premier caractère doit être une lettre et il ne peut pas se terminer par un tiret ni contenir deux tirets consécutifs.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroupName **   
Nom du groupe de sous-réseaux à utiliser pour le nouveau cluster.  
Contraintes : si indiqué, il doit correspondre au nom d'un existant`DBSubnetGroup`.  
Exemple : `mySubnetgroup`   
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.  
Type : booléen  
Obligatoire : non

 **EnableCloudwatchLogsExports.membre.n**   
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** EngineVersion **   
Version du moteur de base de données à utiliser pour le nouveau cluster.  
Type : chaîne  
Obligatoire : non

 ** KmsKeyId **   
Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un instantané de base de données ou d'un instantané de cluster.  
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous restaurez un cluster Compte AWS possédant la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.  
Si vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :  
+ Si le cliché ou le cliché de cluster `SnapshotIdentifier` intégré est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé qui a été utilisée pour chiffrer le cliché ou le cliché de cluster.
+ Si le snapshot ou le snapshot du cluster n'`SnapshotIdentifier`est pas chiffré, le cluster de base de données restauré n'est pas chiffré.
Type : chaîne  
Obligatoire : non

 ** NetworkType **   
Type de réseau du cluster.  
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).  
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.  
Valeurs valides : `IPV4` \$1 `DUAL`   
Type : chaîne  
Obligatoire : non

 ** Port **   
Numéro de port sur lequel le nouveau cluster accepte les connexions.  
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.  
Par défaut : le même port que le cluster d'origine.  
Type : Integer  
Obligatoire : non

 ** ServerlessV2ScalingConfiguration **   
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.  
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatoire : non

 ** StorageType **   
Type de stockage à associer au cluster de base de données.  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Type : chaîne  
Obligatoire : non

 **Étiquettes.Tag.N**   
Les balises à attribuer au cluster restauré.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le nouveau cluster appartiendra.  
Type : tableau de chaînes  
Obligatoire : non

## Éléments de réponse
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterAlreadyExistsFault **   
Vous avez déjà un cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBClusterQuotaExceededFault **   
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.  
Code d’état HTTP : 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`ne fait pas référence à un instantané existant.   
Code d’état HTTP :404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** InsufficientDBClusterCapacityFault **   
Le cluster ne dispose pas d'une capacité suffisante pour l'opération en cours.  
Code d’état HTTP : 403

 ** InsufficientStorageClusterCapacity **   
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.   
Code d’état HTTP : 400

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** InvalidDBSnapshotState **   
L'état de l'instantané ne permet pas de le supprimer.  
Code d’état HTTP : 400

 ** InvalidRestoreFault **   
Vous ne pouvez pas effectuer de restauration à partir d'une sauvegarde de cloud privé virtuel (VPC) vers une instance de base de données non VPC.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** KMSKeyNotAccessibleFault **   
Une erreur s'est produite lors de l'accès à une AWS KMS clé.  
Code d’état HTTP : 400

 ** NetworkTypeNotSupported **   
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_RestoreDBClusterFromSnapshot_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-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

Restaure un cluster à un moment arbitraire. Les utilisateurs peuvent restaurer à tout moment avant `LatestRestorableTime` pendant `BackupRetentionPeriod` jours. Le cluster cible est créé à partir du cluster source avec la même configuration que le cluster d'origine, sauf que le nouveau cluster est créé avec le groupe de sécurité par défaut. 

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Il faut créer le nom du nouveau cluster.  
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.
Type : Chaîne  
Obligatoire : oui

 ** SourceDBClusterIdentifier **   
L'identifiant du cluster source à partir duquel effectuer la restauration.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : Chaîne  
Obligatoire : oui

 ** DBSubnetGroupName **   
Le nom du groupe de sous-réseaux à utiliser pour le nouveau cluster.  
Contraintes : si indiqué, il doit correspondre au nom d'un existant`DBSubnetGroup`.  
Exemple : `mySubnetgroup`   
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.  
Type : booléen  
Obligatoire : non

 **EnableCloudwatchLogsExports.membre.n**   
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** KmsKeyId **   
Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un cluster chiffré.  
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous restaurez un cluster Compte AWS possédant la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.  
Vous pouvez effectuer une restauration sur un nouveau cluster et chiffrer le nouveau cluster avec une AWS KMS clé différente de celle utilisée pour chiffrer le cluster source. AWS KMS Le nouveau cluster de base de données est chiffré avec la AWS KMS clé identifiée par le `KmsKeyId` paramètre.  
Si vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :  
+ Si le cluster est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé utilisée pour chiffrer le cluster source.
+ Si le cluster n'est pas chiffré, le cluster restauré n'est pas chiffré.
S'il s'`DBClusterIdentifier`agit d'un cluster non chiffré, la demande de restauration est rejetée.  
Type : chaîne  
Obligatoire : non

 ** NetworkType **   
Type de réseau du cluster.  
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).  
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.  
Valeurs valides : `IPV4` \$1 `DUAL`   
Type : chaîne  
Obligatoire : non

 ** Port **   
Numéro de port sur lequel le nouveau cluster accepte les connexions.  
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.   
Par défaut : port par défaut du moteur.  
Type : Integer  
Obligatoire : non

 ** RestoreToTime **   
La date et l'heure auxquelles restaurer le cluster.  
Valeurs valides : une heure au format UTC (temps universel)  
Contraintes:  
+ Doit être antérieure à la dernière date de restauration de l'instance.
+ Cela doit être indiqué si le paramètre `UseLatestRestorableTime` n'est pas fourni.
+ Cela ne peut pas être spécifié lorsque le paramètre `UseLatestRestorableTime` est `true`.
+ Cela ne peut pas être spécifié lorsque le paramètre `RestoreType` est `copy-on-write`.
Exemple : `2015-03-07T23:45:00Z`   
Type : Timestamp  
Obligatoire : non

 ** RestoreType **   
Type de restauration à exécuter. Vous pouvez spécifier l’une des valeurs suivantes :  
+  `full-copy` - Le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.
+  `copy-on-write` - Le nouveau cluster de base de données est restauré sous la forme d'un clone du cluster de base de données source.
Contraintes : vous ne pouvez pas spécifier `copy-on-write` si la version du moteur du cluster de base de données source est antérieure à la version 1.11.  
Si vous ne spécifiez pas de valeur pour `RestoreType`, le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.  
Type : chaîne  
Obligatoire : non

 ** ServerlessV2ScalingConfiguration **   
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.  
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatoire : non

 ** StorageType **   
Type de stockage à associer au cluster de base de données.  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Type : chaîne  
Obligatoire : non

 **Étiquettes.Tag.N**   
Les balises à attribuer au cluster restauré.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

 ** UseLatestRestorableTime **   
Une valeur définie sur `true` pour restaurer le cluster à la dernière heure de sauvegarde restaurable, et sur `false` dans le cas contraire.   
Valeur par défaut : `false`   
Contraintes : ne peut pas être spécifiée si le paramètre `RestoreToTime` est fourni.  
Type : booléen  
Obligatoire : non

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Liste des groupes de sécurité VPC auxquels appartient le nouveau cluster.  
Type : tableau de chaînes  
Obligatoire : non

## Éléments de réponse
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterAlreadyExistsFault **   
Vous avez déjà un cluster avec l'identifiant indiqué.  
Code d’état HTTP : 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** DBClusterQuotaExceededFault **   
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.  
Code d’état HTTP : 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.   
Code d’état HTTP :404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.   
Code d’état HTTP :404

 ** InsufficientDBClusterCapacityFault **   
Le cluster ne dispose pas d'une capacité suffisante pour l'opération en cours.  
Code d’état HTTP : 403

 ** InsufficientStorageClusterCapacity **   
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.   
Code d’état HTTP : 400

 ** InvalidDBClusterSnapshotStateFault **   
La valeur fournie n'est pas un état de capture d'écran de cluster valide.  
Code d’état HTTP : 400

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBSnapshotState **   
L'état de l'instantané ne permet pas de le supprimer.  
Code d’état HTTP : 400

 ** InvalidRestoreFault **   
Vous ne pouvez pas effectuer de restauration à partir d'une sauvegarde de cloud privé virtuel (VPC) vers une instance de base de données non VPC.  
Code d’état HTTP : 400

 ** InvalidSubnet **   
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.  
Code d’état HTTP : 400

 ** InvalidVPCNetworkStateFault **   
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.  
Code d’état HTTP : 400

 ** KMSKeyNotAccessibleFault **   
Une erreur s'est produite lors de l'accès à une AWS KMS clé.  
Code d’état HTTP : 400

 ** NetworkTypeNotSupported **   
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.  
Code d’état HTTP : 400

 ** StorageQuotaExceeded **   
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_RestoreDBClusterToPointInTime_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-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

Redémarre le cluster arrêté spécifié par`DBClusterIdentifier`. Pour plus d'informations, consultez [Arrêter et démarrer un cluster Amazon DocumentDB.](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster à redémarrer. Exemple : `docdb-2019-05-28-15-24-52`   
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_StartDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_StartDBCluster_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-2014-10-31/StartDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

Arrête le cluster en cours d'exécution spécifié par`DBClusterIdentifier`. Le cluster doit être dans l'état *disponible*. Pour plus d'informations, consultez [Arrêter et démarrer un cluster Amazon DocumentDB.](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant du cluster à arrêter. Exemple : `docdb-2019-05-28-15-24-52`   
Type : Chaîne  
Obligatoire : oui

## Éléments de réponse
<a name="API_StopDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_StopDBCluster_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-2014-10-31/StopDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

Bascule le cluster Amazon DocumentDB secondaire spécifié en nouveau cluster Amazon DocumentDB principal dans le cluster de base de données global.

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

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identifiant du cluster de bases de données global Amazon DocumentDB à basculer. L'identifiant est la clé unique attribuée par l'utilisateur lors de la création du cluster. En d'autres termes, il s'agit du nom du cluster mondial. Ce paramètre ne fait pas la distinction majuscules/minuscules.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un cluster global existant (base de données globale Amazon DocumentDB).
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

 ** TargetDbClusterIdentifier **   
Identifiant du cluster Amazon DocumentDB secondaire à promouvoir en tant que nouveau cluster principal pour le cluster de bases de données global. Utilisez l'Amazon Resource Name (ARN) comme identifiant afin qu'Amazon DocumentDB puisse localiser le cluster dans sa AWS région.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un cluster secondaire existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : oui

## Éléments de réponse
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** GlobalCluster **   
Type de données représentant un cluster global Amazon DocumentDB.  
Type : objet [GlobalCluster](API_GlobalCluster.md)

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.  
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidGlobalClusterStateFault **   
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_SwitchoverGlobalCluster_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-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) 

# 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)