Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Referencia de la API para la administración de recursos, instancias y clústeres de Amazon DocumentDB
<a name="api-reference"></a>

En esta sección se describen las operaciones de administración de recursos, instancias y clústeres de Amazon DocumentDB (con compatibilidad con MongoDB) que se puede obtener acceso por medio de HTTP, la AWS Command Line Interface (AWS CLI) o el SDK de AWS. Puede utilizar estas API para crear, eliminar y modificar clústeres e instancias.

 

**importante**  
Estas API solo se usan para la administración de clústeres, instancias y recursos relacionados. Para obtener información sobre cómo conectarse con un clúster de Amazon DocumentDB en ejecución, consulte [Guía de introducción](get-started-guide.md).

**Topics**
+ [Acciones](API_Operations.md)
+ [Data Types](API_Types.md)
+ [Errores comunes](CommonErrors.md)
+ [Parámetros comunes](CommonParameters.md)

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

 admiten las siguientes acciones 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) 

Los clústeres elásticos de Amazon DocumentDB admiten las siguientes acciones:
+  [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>

 admiten las siguientes acciones 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>

Agrega un identificador de origen a una suscripción de notificación de eventos existente.

## Parámetros de la solicitud
<a name="API_AddSourceIdentifierToSubscription_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SourceIdentifier **   
El identificador del origen de eventos que se va a añadir:  
+ Si el tipo de origen es una instancia, debe proporcionarse un `DBInstanceIdentifier`.
+ Si el tipo de origen es un grupo de seguridad, debe proporcionarse un `DBSecurityGroupName`.
+ Si el tipo de origen es un grupo de parámetros, debe proporcionarse un `DBParameterGroupName`.
+ Si el tipo de origen es una instantánea de base de datos, debe proporcionarse un `DBSnapshotIdentifier`.
Tipo: cadena  
Obligatorio: sí

 ** SubscriptionName **   
El nombre de la suscripción a notificaciones de eventos de Amazon DocumentDB al que desea añadir un identificador de origen.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EventSubscription **   
Información detallada sobre un evento al que se ha suscrito.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** SourceNotFound **   
No se ha encontrado el origen solicitado.   
Código de estado HTTP: 404

 ** SubscriptionNotFound **   
El nombre de la suscripción no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_AddSourceIdentifierToSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 

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

Añade etiquetas de metadatos a un recurso de Amazon DocumentDB. Puede utilizar estas etiquetas con los informes de asignación de costes para realizar un seguimiento de los costes asociados a los recursos de Amazon DocumentDB o en una `Condition` declaración de una política AWS Identity and Access Management (IAM) de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_AddTagsToResource_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** ResourceName **   
El recurso de Amazon DocumentDB al que se añaden las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN).  
Tipo: cadena  
Obligatorio: sí

 **Tags.Tag.N**   
Las etiquetas que se van a asignar al recurso de Amazon DocumentDB.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: sí

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` no hace referencia a una instantánea existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_AddTagsToResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) 

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

Aplica una acción de mantenimiento pendiente a un recurso (por ejemplo, a una instancia de Amazon DocumentDB).

## Parámetros de la solicitud
<a name="API_ApplyPendingMaintenanceAction_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** ApplyAction **   
La acción de mantenimiento pendiente que se aplica a este recurso.  
Valores válidos: `system-update`, `db-upgrade`   
Tipo: cadena  
Obligatorio: sí

 ** OptInType **   
Un valor que especifica el tipo de solicitud de alta o deshace una solicitud de alta. Una solicitud de alta de tipo `immediate` no se puede deshacer.  
Valores válidos:  
+  `immediate`: aplicar inmediatamente la acción de mantenimiento.
+  `next-maintenance`: aplicar la acción de mantenimiento durante la siguiente ventana de mantenimiento del recurso. 
+  `undo-opt-in`: cancelar todas las solicitudes de alta `next-maintenance` existentes.
Tipo: cadena  
Obligatorio: sí

 ** ResourceIdentifier **   
El Nombre de recurso de Amazon (ARN) del recurso al que se aplica la acción de mantenimiento pendiente.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** ResourcePendingMaintenanceActions **   
Representa la salida de [ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).   
Tipo: objeto [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

 ** ResourceNotFoundFault **   
No se ha encontrado el ID del recurso especificado.  
Código de estado HTTP: 404

## Véase también
<a name="API_ApplyPendingMaintenanceAction_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 

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

Copia el grupo de parámetros de clúster especificado.

## Parámetros de la solicitud
<a name="API_CopyDBClusterParameterGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SourceDBClusterParameterGroupIdentifier **   
El identificador o Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster de origen.  
Restricciones:  
+ Debe especificar un grupo de parámetros de clúster válido.
+ Si el grupo de parámetros del clúster de origen está en el Región de AWS mismo lugar que la copia, especifique un identificador de grupo de parámetros válido, por ejemplo`my-db-cluster-param-group`, o un ARN válido.
+ Si el grupo de parámetros de origen está en un Región de AWS lugar diferente al de la copia, especifique un ARN de grupo de parámetros de clúster válido; por ejemplo,. `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`
Tipo: cadena  
Obligatorio: sí

 ** TargetDBClusterParameterGroupDescription **   
Descripción del grupo de parámetros de clúster copiado.  
Tipo: cadena  
Obligatorio: sí

 ** TargetDBClusterParameterGroupIdentifier **   
El identificador para el grupo de parámetros de clúster copiado.  
Restricciones:  
+ No puede ser nulo ni estar vacío o en blanco.
+ Deben contener de 1 a 255 caracteres (letras, números o guiones). 
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos. 
Ejemplo: `my-cluster-param-group1`   
Tipo: cadena  
Obligatorio: sí

 **Tags.Tag.N**   
Las etiquetas que deben asignarse al grupo de parámetros.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterParameterGroup **   
Información detallada sobre un grupo de parámetros de clúster.   
Tipo: objeto [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Existe un grupo de parámetros con el mismo nombre.  
Código de estado HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** DBParameterGroupQuotaExceeded **   
Esta solicitud provocaría que superara el número permitido de grupos de parámetros.  
Código de estado HTTP: 400

## Véase también
<a name="API_CopyDBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 

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

Copia una instantánea de un clúster.

Para copiar una instantánea del clúster de una instantánea manual del clúster compartida, `SourceDBClusterSnapshotIdentifier` debe ser el Nombre de recurso de Amazon (ARN) de la instantánea del clúster compartida. Solo puede copiar una instantánea de clúster de base de datos compartidos, cifrada o no, en la misma Región de AWS.

Para cancelar la operación de copia después de que esté en curso, elimine la instantánea de clúster de destino identificada por `TargetDBClusterSnapshotIdentifier` mientras esa instantánea de clúster está en estado de *copia*.

## Parámetros de la solicitud
<a name="API_CopyDBClusterSnapshot_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SourceDBClusterSnapshotIdentifier **   
El identificador de la instantánea del clúster que se va a copiar. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Se debe especificar una instantánea del clúster válida cuyo estado sea *disponible*.
+ Si la instantánea del clúster de origen está en la Región de AWS misma que la copia, especifique un identificador de instantánea válido.
+ Si la instantánea del clúster de origen está en una AWS cuenta diferente Región de AWS o es propiedad de otra, especifique el ARN de la instantánea.
Ejemplo: `my-cluster-snapshot1`   
Tipo: cadena  
Obligatorio: sí

 ** TargetDBClusterSnapshotIdentifier **   
El identificador de la nueva instantánea del clúster que se va a crear a partir de la instantánea del clúster de origen. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones). 
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos. 
Ejemplo: `my-cluster-snapshot2`   
Tipo: cadena  
Obligatorio: sí

 ** CopyTags **   
Establezca a `true` para copiar todas las etiquetas de la instantánea del clúster de origen a la instantánea del clúster de destino, y en caso contrario `false`. El valor predeterminado es `false`.  
Tipo: Booleano  
Obligatorio: no

 ** KmsKeyId **   
El identificador AWS KMS clave de una instantánea de clúster cifrada. El ID de AWS KMS clave es el nombre de recurso de Amazon (ARN), el identificador de AWS KMS clave o el alias de AWS KMS clave de la clave de AWS KMS cifrado.   
Si copia una instantánea de clúster cifrada de la suya Cuenta de AWS, puede especificar un valor `KmsKeyId` para cifrar la copia con una nueva clave de AWS KMS cifrado. Si no especificas un valor para`KmsKeyId`, la copia de la instantánea del clúster se cifra con la misma AWS KMS clave que la instantánea del clúster de origen.  
Si copia una instantánea de clúster cifrada que se comparte desde otra Cuenta de AWS, debe especificar un valor para`KmsKeyId`.  
Para copiar una instantánea de clúster cifrada a otra Región de AWS, `KmsKeyId` defina el ID de AWS KMS clave que desee utilizar para cifrar la copia de la instantánea de clúster en la región de destino. AWS KMS Las claves de cifrado son específicas del Región de AWS lugar en el que se crearon y no se pueden usar claves de cifrado de una Región de AWS en otra Región de AWS.  
Si intenta copiar un snapshot de clúster de base de datos sin cifrar y especificar un valor para el parámetro `KmsKeyId`, se devuelve un error.  
Tipo: cadena  
Requerido: no

 ** PreSignedUrl **   
La URL que contiene una solicitud firmada de la versión 4 de Signature para la acción de la `CopyDBClusterSnapshot` API en la Región de AWS que se incluye la instantánea del clúster de origen que se va a copiar. Debe usar el parámetro `PreSignedUrl` al copiar una instantánea de un clúster de otra Región de AWS.  
Si utilizas una herramienta AWS del SDK o la AWS CLI, puedes especificarla `SourceRegion` (o `--source-region` para ella AWS CLI) en lugar de hacerlo `PreSignedUrl` manualmente. Especificando `SourceRegion` autogenerar una URL prefirmada que es una solicitud válida para la operación que se puede ejecutar en la fuente Región de AWS.  
La URL prefirmada debe ser una solicitud válida para que la acción de la `CopyDBClusterSnapshot` API se pueda ejecutar en la fuente Región de AWS que contiene la instantánea del clúster que se va a copiar. La solicitud de la URL prefirmada debe contener los siguientes valores de parámetros:  
+  `SourceRegion`: el identificador de la región que contiene la instantánea que se va a copiar.
+  `SourceDBClusterSnapshotIdentifier`: identificador de la instantánea del clúster cifrada que se va a copiar. Este identificador debe estar en el formato de Nombre de recurso de Amazon (ARN) para la Región de AWS de origen. Por ejemplo, si copia una instantánea de clúster cifrada de la región us-east-1 Región de AWS, el `SourceDBClusterSnapshotIdentifier` tendrá un aspecto similar al del siguiente ejemplo: `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+  `TargetDBClusterSnapshotIdentifier`: identificador de la instantánea del clúster que se va a copiar. Este parámetro no distingue entre mayúsculas y minúsculas.
Tipo: cadena  
Requerido: no

 **Tags.Tag.N**   
Las etiquetas que se van a asignar a la instantánea del clúster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterSnapshot **   
Información detallada sobre una instantánea de un clúster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterSnapshotAlreadyExistsFault **   
El usuario ya tiene una instantánea del clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Se ha producido un error al acceder a una AWS KMS clave.  
Código de estado HTTP: 400

 ** SnapshotQuotaExceeded **   
La solicitud provocaría que superara el número de instantáneas permitido.  
Código de estado HTTP: 400

## Véase también
<a name="API_CopyDBClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) 

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

Crea un nuevo clúster de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_CreateDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster. Este parámetro se almacena como una cadena en minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones). 
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos. 
Ejemplo: `my-cluster`   
Tipo: cadena  
Obligatorio: sí

 ** Engine **   
El nombre del motor de base de datos que se debe utilizar para este clúster.  
Valores válidos: `docdb`   
Tipo: cadena  
Obligatorio: sí

 **AvailabilityZones. AvailabilityZone**N.   
Una lista de zonas de disponibilidad de Amazon EC2 en las que se pueden crear instancias en el clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** BackupRetentionPeriod **   
El número de días durante los que se retienen las copias de seguridad automatizadas. Debe especificar un valor mínimo de 1.  
Valor predeterminado: 1  
Restricciones:  
+ Debe ser un valor entre 1 y 35.
Tipo: entero  
Obligatorio: no

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros del clúster para asociar a este clúster.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroupName **   
Un grupo de subred con el que asociar este clúster.  
Limitaciones: debe coincidir con el nombre de un `DBSubnetGroup` existente. No debe ser predeterminado.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.  
Tipo: Booleano  
Obligatorio: no

 **EnableCloudwatchLogsExports.Miembro.**   
Una lista de los tipos de registro que deben estar habilitados para la exportación a Amazon CloudWatch Logs. Puede habilitar los registros de auditoría o los registros del generador de perfiles. Para obtener más información, consulte [Auditoría de eventos de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) y [Creación de perfiles de operaciones de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).   
Tipo: matriz de cadenas  
Obligatorio: no

 ** EngineVersion **   
El número de versión del motor de base de datos que se debe usar. `--engine-version` será el valor predeterminado de la última versión principal del motor. Para las cargas de trabajo de producción, se recomienda declarar explícitamente este parámetro con la versión del motor principal prevista.  
Tipo: cadena  
Requerido: no

 ** GlobalClusterIdentifier **   
Identificador de clúster del nuevo clúster global.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: no

 ** KmsKeyId **   
El identificador AWS KMS clave de un clúster cifrado.  
El identificador de AWS KMS clave es el nombre de recurso de Amazon (ARN) de la clave de AWS KMS cifrado. Si va a crear un clúster con el mismo Cuenta de AWS propietario de la clave de AWS KMS cifrado que se utiliza para cifrar el nuevo clúster, puede utilizar el alias de la AWS KMS clave en lugar del ARN para AWS KMS la clave de cifrado.  
Si no se especifica una clave de cifrado en `KmsKeyId`:   
+ Si el parámetro `StorageEncrypted` es `true`, Amazon DocumentDB utiliza la clave de cifrado predeterminada. 
 AWS KMS crea la clave de cifrado predeterminada para su. Cuenta de AWS Cuenta de AWS Tiene una clave de cifrado predeterminada diferente para cada uno Regiones de AWS.  
Tipo: cadena  
Requerido: no

 ** ManageMasterUserPassword **   
Especifica si se debe administrar la contraseña del usuario maestro con Secrets Manager de Amazon Web Services.  
Restricción: No puede administrar la contraseña del usuario maestro con Secrets Manager de Amazon Web Services si la `MasterUserPassword` está especificada.  
Tipo: Booleano  
Obligatorio: no

 ** MasterUsername **   
Nombre del usuario maestro del clúster.  
Restricciones:  
+ Debe tener de 1 a 63 letras o números.
+ El primer carácter debe ser una letra.
+ No puede ser una palabra reservada para el motor de base de datos elegido. 
Tipo: cadena  
Requerido: no

 ** MasterUserPassword **   
La contraseña del usuario de la base de datos maestra. Esta contraseña puede contener cualquier carácter ASCII imprimible, excepto barra inclinada (/), comillas dobles (") o el símbolo de “arroba” (@).  
Limitaciones: debe contener de 8 a 100 caracteres.  
Tipo: cadena  
Requerido: no

 ** MasterUserSecretKmsKeyId **   
El identificador de clave de KMS de Amazon Web Services para cifrar un secreto que se genera y administra automáticamente en Secrets Manager de Amazon Web Services. Esta configuración solo es válida si Amazon DocumentDB administra la contraseña del usuario maestro en Secrets Manager de Amazon Web Services para el clúster de base de datos.  
El identificador de la clave de KMS de Amazon Web Services es el ARN de la clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave de KMS. Para utilizar una clave de KMS en una cuenta de Amazon Web Services diferente, debe especificar el ARN de la clave o el ARN del alias.  
Si no especifica el `MasterUserSecretKmsKeyId`, se utiliza la clave de KMS de `aws/secretsmanager` para cifrar el secreto. Si el secreto está en una cuenta de Amazon Web Services diferente, entonces no puede usar la clave de KMS de `aws/secretsmanager` para cifrar el secreto y se debe usar una clave de KMS administrada por el cliente.  
Existe una clave KMS predeterminada para su cuenta de Amazon Web Services. La cuenta de Amazon Web Services tiene una clave de KMS predeterminada diferente para cada región de Amazon Web Services.  
Tipo: cadena  
Requerido: no

 ** NetworkType **   
El tipo de red del clúster.  
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. A `DBSubnetGroup` solo admite el IPv4 protocolo o los IPv6 protocolos IPv4 y (`DUAL`).  
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: cadena  
Requerido: no

 ** Port **   
El número de puerto en el que las instancias en el clúster aceptan conexiones.  
Tipo: entero  
Obligatorio: no

 ** PreferredBackupWindow **   
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas con el parámetro `BackupRetentionPeriod`.   
El valor predeterminado es un intervalo de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS.   
Restricciones:  
+ Tiene que tener el formato `hh24:mi-hh24:mi`.
+ Debe indicarse en Tiempo universal coordinado (UTC).
+ No debe entrar en conflicto con la ventana de mantenimiento preferida. 
+ Debe durar al menos 30 minutos.
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
Formato: `ddd:hh24:mi-ddd:hh24:mi`   
El valor predeterminado es un intervalo de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno de ellos Región de AWS, que se produce en un día aleatorio de la semana.  
Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
Restricciones: plazo mínimo de 30 minutos.  
Tipo: cadena  
Requerido: no

 ** PreSignedUrl **   
No se admite actualmente.   
Tipo: cadena  
Requerido: no

 ** ServerlessV2ScalingConfiguration **   
Contiene la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatorio: no

 ** StorageEncrypted **   
Especifica si el clúster está cifrado.  
Tipo: Booleano  
Obligatorio: no

 ** StorageType **   
El tipo de almacenamiento que se va a asociar al clúster de base de datos.  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Si crea un clúster de Amazon DocumentDB con el tipo de almacenamiento establecido en `iopt1`, el tipo de almacenamiento aparece en la respuesta. El tipo de almacenamiento no se devuelve cuando se establece en `standard`.
Tipo: cadena  
Requerido: no

 **Tags.Tag.N**   
Las etiquetas que se van a asignar al clúster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster.   
Tipo: matriz de cadenas  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
El usuario ya tiene un clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` no hace referencia a un grupo de parámetros de clúster existente.   
Código de estado HTTP: 404

 ** DBClusterQuotaExceededFault **   
No se puede crear el clúster porque ha alcanzado la cuota de clústeres máxima permitida.  
Código de estado HTTP: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Las subredes del grupo de subredes deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.  
Código de estado HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InsufficientStorageClusterCapacity **   
No hay bastante almacenamiento disponible para la acción en curso. Es posible que pueda resolver este error mediante la actualización de su grupo de subredes para utilizar diferentes zonas de disponibilidad que tienen más almacenamiento disponible.   
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
El grupo de subredes no se puede eliminar porque está en uso.  
Código de estado HTTP: 400

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Se ha producido un error al acceder a una AWS KMS clave.  
Código de estado HTTP: 400

 ** NetworkTypeNotSupported **   
El tipo de red no es compatible con `DBSubnetGroup` ni con la versión del motor de base de datos.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

## Véase también
<a name="API_CreateDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) 

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

Crear un nuevo grupo de parámetros de clúster.

Los parámetros de un grupo de parámetros de clúster se aplican a todas las instancias de un clúster.

Un grupo de parámetros de clúster se crea inicialmente con los parámetros predeterminados para el motor de base de datos utilizado por las instancias del clúster. En Amazon DocumentDB, no puede realizar modificaciones directamente en el grupo de parámetros de clúster `default.docdb3.6`. Si el clúster de Amazon DocumentDB utiliza el grupo de parámetros de clúster predeterminado y desea modificar un valor en él, primero debe [crear un nuevo grupo de parámetros](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) o [copiar un grupo de parámetros existente](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), modificarlo y, a continuación, aplicar el grupo de parámetros modificado a su clúster. Para que el nuevo grupo de parámetros de clúster y la configuración asociada surta efecto, debe reiniciar las instancias del clúster sin conmutación por error. Para obtener más información, consulte [Modificación de grupos de parámetros de clúster de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html). 

## Parámetros de la solicitud
<a name="API_CreateDBClusterParameterGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster.  
Restricciones:  
+ No debe coincidir con el nombre de un `DBClusterParameterGroup` existente.
Este valor se almacena como una cadena en minúsculas.
Tipo: cadena  
Obligatorio: sí

 ** DBParameterGroupFamily **   
El nombre de la familia del grupo de parámetros de clúster.  
Tipo: cadena  
Obligatorio: sí

 ** Description **   
Descripción del grupo de parámetros de clúster.  
Tipo: cadena  
Obligatorio: sí

 **Tags.Tag.N**   
Las etiquetas que se van a asignar al grupo de parámetros de clúster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterParameterGroup **   
Información detallada sobre un grupo de parámetros de clúster.   
Tipo: objeto [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Existe un grupo de parámetros con el mismo nombre.  
Código de estado HTTP: 400

 ** DBParameterGroupQuotaExceeded **   
Esta solicitud provocaría que superara el número permitido de grupos de parámetros.  
Código de estado HTTP: 400

## Véase también
<a name="API_CreateDBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 

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

Crea una instantánea de un clúster. 

## Parámetros de la solicitud
<a name="API_CreateDBClusterSnapshot_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster para el que se va a crear una instantánea. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBCluster` existente.
Ejemplo: `my-cluster`   
Tipo: cadena  
Obligatorio: sí

 ** DBClusterSnapshotIdentifier **   
El identificador de la instantánea del clúster. Este parámetro se almacena como una cadena en minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos. 
Ejemplo: `my-cluster-snapshot1`   
Tipo: cadena  
Obligatorio: sí

 **Tags.Tag.N**   
Las etiquetas que se van a asignar a la instantánea del clúster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterSnapshot **   
Información detallada sobre una instantánea de un clúster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
El usuario ya tiene una instantánea del clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** SnapshotQuotaExceeded **   
La solicitud provocaría que superara el número de instantáneas permitido.  
Código de estado HTTP: 400

## Véase también
<a name="API_CreateDBClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) 

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

Crea una nueva instancia.

## Parámetros de la solicitud
<a name="API_CreateDBInstance_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster al que pertenecerá la instancia.  
Tipo: cadena  
Obligatorio: sí

 ** DBInstanceClass **   
La capacidad de memoria e informática de la instancia (por ejemplo, `db.r5.large`).   
Tipo: cadena  
Obligatorio: sí

 ** DBInstanceIdentifier **   
El identificador de instancias. Este parámetro se almacena como una cadena en minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Ejemplo: `mydbinstance`   
Tipo: cadena  
Obligatorio: sí

 ** Engine **   
Nombre del motor de base de datos que se va a usar para esta instancia.  
Valor válido: `docdb`   
Tipo: cadena  
Obligatorio: sí

 ** AutoMinorVersionUpgrade **   
Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.  
Valor predeterminado: `false`   
Tipo: Booleano  
Obligatorio: no

 ** AvailabilityZone **   
La zona de disponibilidad de Amazon EC2 en la que se crea la instancia.   
Predeterminada: una zona de disponibilidad aleatoria elegida por el sistema en el punto final. Región de AWS  
Ejemplo: `us-east-1d`   
Tipo: cadena  
Requerido: no

 ** CACertificateIdentifier **   
El identificador del certificado CA que se utilizará para el certificado de servidor de la instancia de DB.  
Para obtener más información, consulte [Cómo actualizar los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [Cómo cifrar datos en tránsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) en la *Guía para desarrolladores de Amazon DocumentDB*.  
Tipo: cadena  
Requerido: no

 ** CopyTagsToSnapshot **   
Es un valor que indica si se deben copiar las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.  
Tipo: Booleano  
Obligatorio: no

 ** EnablePerformanceInsights **   
Un valor que indica si se habilita Información sobre rendimiento para la instancia de base de datos. Para obtener más información, consulte [Uso de Información sobre rendimiento de Amazon](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipo: Booleano  
Obligatorio: no

 ** PerformanceInsightsKMSKeyId **   
El identificador AWS KMS clave para el cifrado de los datos de Performance Insights.  
El identificador de AWS KMS clave es el ARN de clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave KMS.  
Si no especifica un valor para el PerformanceInsights KMSKey identificador, Amazon DocumentDB utilizará la clave de KMS predeterminada. Existe una clave KMS predeterminada para su cuenta de Amazon Web Services. La cuenta de Amazon Web Services tiene una clave de KMS predeterminada diferente para cada región de Amazon Web Services.  
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
 Formato: `ddd:hh24:mi-ddd:hh24:mi`   
El valor predeterminado es un período de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS, que se produce en un día aleatorio de la semana.   
Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
Restricciones: plazo mínimo de 30 minutos.  
Tipo: cadena  
Requerido: no

 ** PromotionTier **   
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.  
Valor predeterminado: 1  
Valores válidos: 0-15  
Tipo: entero  
Obligatorio: no

 **Tags.Tag.N**   
Las etiquetas que se van a asignar a la instancia. Puede asignar hasta 10 etiquetas a una instancia.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateDBInstance_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBInstance **   
Información detallada sobre una instancia.   
Tipo: objeto [DBInstance](API_DBInstance.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AuthorizationNotFound **   
La IP CIDR o el grupo de seguridad de Amazon EC2 especificados no están autorizados para el grupo de seguridad especificado.  
Es posible que Amazon DocumentDB tampoco esté autorizado para realizar las acciones necesarias en su nombre mediante IAM.  
Código de estado HTTP: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBInstanceAlreadyExists **   
Ya tiene una instancia con el identificador dado.  
Código de estado HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` no hace referencia a un grupo de seguridad existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Las subredes del grupo de subredes deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.  
Código de estado HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** InstanceQuotaExceeded **   
La solicitud provocaría que se superara el número de instancias permitido.  
Código de estado HTTP: 400

 ** InsufficientDBInstanceCapacity **   
La clase de instancia especificada no está disponible en la zona de disponibilidad especificada.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Se ha producido un error al acceder a una AWS KMS clave.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

 ** StorageTypeNotSupported **   
El almacenamiento del `StorageType` especificado no puede asociarse a la instancia de base de datos.   
Código de estado HTTP: 400

## Véase también
<a name="API_CreateDBInstance_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) 

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

Crea un nuevo grupo de subredes. Los grupos de subredes deben contener al menos una subred en al menos dos zonas de disponibilidad de la Región de AWS.

## Parámetros de la solicitud
<a name="API_CreateDBSubnetGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBSubnetGroupDescription **   
La descripción del grupo de subredes.  
Tipo: cadena  
Obligatorio: sí

 ** DBSubnetGroupName **   
El nombre del grupo de subredes. Este valor se almacena como una cadena en minúsculas.  
Restricciones: debe contener un máximo de 255 letras, números, puntos, guiones bajos, espacios o guiones. No debe ser predeterminado.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Obligatorio: sí

 **SubnetIds. SubnetIdentifier**N.   
La subred Amazon EC2 IDs para el grupo de subredes.  
Tipo: matriz de cadenas  
Obligatorio: sí

 **Tags.Tag.N**   
La etiqueta que se va a asignar al grupo de subredes.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBSubnetGroup **   
Información detallada sobre un grupo de subredes.   
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBSubnetGroupAlreadyExists **   
 Un grupo de subredes existente ya está utilizando `DBSubnetGroupName`.   
Código de estado HTTP: 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Las subredes del grupo de subredes deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.  
Código de estado HTTP: 400

 ** DBSubnetGroupQuotaExceeded **   
La solicitud provocaría que se superara el número de grupos de subredes permitidos.  
Código de estado HTTP: 400

 ** DBSubnetQuotaExceededFault **   
La solicitud le haría exceder el número permitido de subredes en un grupo de subredes.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

## Véase también
<a name="API_CreateDBSubnetGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) 

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

Crea una suscripción de notificación de eventos de Amazon DocumentDB. Esta acción requiere un nombre de recurso de Amazon (ARN) de tema creado por la consola de Amazon DocumentDB, la consola de Amazon SNS o la API de Amazon SNS. Para obtener un ARN con Amazon SNS, debe crear un tema en Amazon SNS y suscribirse al tema. El ARN se muestra en la consola de Amazon SNS.

Puede especificar el tipo de origen (`SourceType`) sobre el que desea recibir notificaciones. También puede proporcionar una lista de las fuentes de Amazon DocumentDB (`SourceIds`) que desencadenan los eventos y puede proporcionar una lista de categorías de eventos (`EventCategories`) para los eventos de los que desee recibir notificaciones. Por ejemplo, puede especificar `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` y `EventCategories = Availability, Backup`.

Si especifica ambos valores `SourceType` y `SourceIds`, como, por ejemplo, `SourceType = db-instance` y `SourceIdentifier = myDBInstance1`, recibirá todos los eventos `db-instance` del origen especificado. Si especifica un `SourceType`, pero no especifica `SourceIdentifier`, recibirá notificaciones de los eventos de ese tipo de origen para todos sus orígenes de Amazon DocumentDB. Si no especifica ni `SourceType` ni `SourceIdentifier`, recibirá notificaciones de los eventos generados desde todos los orígenes de Amazon DocumentDB que pertenezcan a su cuenta de cliente.

## Parámetros de la solicitud
<a name="API_CreateEventSubscription_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SnsTopicArn **   
El Nombre de recurso de Amazon (ARN) del tema SNS creado para la notificación de eventos. El ARN es creado por Amazon SNS al crear un tema y suscribirse a él.  
Tipo: cadena  
Obligatorio: sí

 ** SubscriptionName **   
El nombre de la suscripción.  
Restricciones: el nombre debe tener menos de 255 caracteres.  
Tipo: cadena  
Obligatorio: sí

 ** Enabled **   
 Establezca un valor booleano en `true` para activar la suscripción y en `false` para crear la suscripción, pero sin activarla.   
Tipo: Booleano  
Obligatorio: no

 **EventCategories. EventCategory**N.   
 Una lista de las categorías de eventos para un `SourceType` a los que desea suscribirse.   
Tipo: matriz de cadenas  
Obligatorio: no

 **SourceIds. SourceId**N.   
La lista de identificadores de los orígenes de eventos para los que se devuelven eventos. Si no se especifica, se incluyen todos los orígenes en la respuesta. Un identificador debe comenzar por una letra y solo deben contener letras ASCII, números y guiones; y no pueden terminar con un guion o contener dos guiones consecutivos.  
Restricciones:  
+ Si se proporciona `SourceIds`, también se debe proporcionar `SourceType`.
+ Si el tipo de origen es una instancia, debe proporcionarse un `DBInstanceIdentifier`.
+ Si el tipo de origen es un grupo de seguridad, debe proporcionarse un `DBSecurityGroupName`.
+ Si el tipo de origen es un grupo de parámetros, debe proporcionarse un `DBParameterGroupName`.
+ Si el tipo de origen es una instantánea de base de datos, debe proporcionarse un `DBSnapshotIdentifier`.
Tipo: matriz de cadenas  
Obligatorio: no

 ** SourceType **   
El tipo de origen que está generando los eventos. Por ejemplo, si desea recibir una notificación de eventos generados por una instancia, defina este parámetro como `db-instance`. Si no se especifica este valor, se devuelven todos los eventos.  
Valores válidos: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`   
Tipo: cadena  
Requerido: no

 **Tags.Tag.N**   
Las etiquetas que se asignarán a la suscripción de eventos.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateEventSubscription_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EventSubscription **   
Información detallada sobre un evento al que se ha suscrito.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
Ha alcanzado el número máximo de suscripciones a eventos.   
Código de estado HTTP: 400

 ** SNSInvalidTopic **   
Amazon SNS ha respondido que hay un problema con el tema especificado.   
Código de estado HTTP: 400

 ** SNSNoAuthorization **   
No tiene permiso para publicar en el tema SNS Nombre de recurso de Amazon (ARN).   
Código de estado HTTP: 400

 ** SNSTopicArnNotFound **   
El nombre de recurso de Amazon (ARN) del tema de SNS no existe.   
Código de estado HTTP: 404

 ** SourceNotFound **   
No se ha encontrado el origen solicitado.   
Código de estado HTTP: 404

 ** SubscriptionAlreadyExist **   
El nombre de suscripción proporcionado ya existe.   
Código de estado HTTP: 400

 ** SubscriptionCategoryNotFound **   
La categoría proporcionada no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_CreateEventSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 

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

Crea un clúster global de Amazon DocumentDB que puede abarcar varios múltiplos Regiones de AWS. El clúster global contiene un clúster principal con capacidad de lectura y escritura, y hasta 10 clústeres secundarios de solo lectura. Los clústeres globales utilizan una replicación rápida basada en el almacenamiento en todas las regiones con latencias inferiores a un segundo, mediante una infraestructura especializada que no afecta el rendimiento de la carga de trabajo.



Puede crear un clúster que inicialmente esté vacío y, a posteriormente agregarle un clúster principal y un clúster secundario. O bien, puede especificar un clúster existente durante la operación de creación y este clúster pasará a ser el principal del clúster global. 

**nota**  
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_CreateGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Identificador de clúster del nuevo clúster global.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

 ** DatabaseName **   
El nombre para la base de datos de hasta 64 caracteres alfanuméricos. Si no proporciona un nombre, Amazon DocumentDB no creará una base de datos en el clúster global que está creando.  
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
La configuración de protección contra eliminación para el nuevo clúster global. El clúster global no se puede eliminar cuando está habilitada la protección contra eliminación.   
Tipo: Booleano  
Obligatorio: no

 ** Engine **   
El nombre del motor de base de datos que se debe utilizar para este clúster.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
La versión del motor del clúster global.  
Tipo: cadena  
Requerido: no

 ** SourceDBClusterIdentifier **   
El i Nombre de recurso de Amazon (ARN) que se utilizará como clúster principal de la base de datos global. Este parámetro es opcional.  
Tipo: cadena  
Requerido: no

 ** StorageEncrypted **   
Configuración de cifrado de almacenamiento para el nuevo clúster global.   
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_CreateGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** GlobalClusterAlreadyExistsFault **   
El `GlobalClusterIdentifier` ya existe. Elija un nuevo identificador de clúster global (nombre único) para crear un nuevo clúster global.   
Código de estado HTTP: 400

 ** GlobalClusterQuotaExceededFault **   
El número de clústeres globales de esta cuenta ya es el máximo permitido.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

## Véase también
<a name="API_CreateGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) 

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

Elimina un clúster de aprovisionado anteriormente. Al eliminar un clúster, se eliminan todas las copias de seguridad automatizadas para ese clúster y no se pueden recuperar. Las instantáneas manuales del clúster de base de datos del clúster especificado no se eliminan.



## Parámetros de la solicitud
<a name="API_DeleteDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster del clúster que se va a eliminar. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con un `DBClusterIdentifier` existente.
Tipo: cadena  
Obligatorio: sí

 ** FinalDBSnapshotIdentifier **   
 El identificador de instantánea de clúster de la nueva instantánea del clúster creada al configurar `SkipFinalSnapshot` como `false`.   
 Se especifica este parámetro y también el parámetro `SkipFinalShapshot` en `true` genera un error. 
Restricciones:  
+ Debe tener de 1 a 255 letras, números o guiones.
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Tipo: cadena  
Requerido: no

 ** SkipFinalSnapshot **   
 Determina si se crea una instantánea de clúster final antes de que se elimine el clúster. Si se especifica `true`, no se crea ninguna instantánea del clúster. Si se especifica `false`, se crea una instantánea de clúster antes de que se elimine el clúster de base de datos.   
Debe especificar un parámetro `FinalDBSnapshotIdentifier` si `SkipFinalSnapshot` es `false`.
Valor predeterminado: `false`   
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_DeleteDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
El usuario ya tiene una instantánea del clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** SnapshotQuotaExceeded **   
La solicitud provocaría que superara el número de instantáneas permitido.  
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) 

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

Elimina un determinado grupo de parámetros de clúster especificados. El grupo de parámetros de clúster que se va a eliminar no puede asociarse a ningún clúster.

## Parámetros de la solicitud
<a name="API_DeleteDBClusterParameterGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster.  
Restricciones:  
+ Debe ser el nombre de un grupo de parámetros de clúster existente.
+ No puede eliminar un grupo de parámetros de clúster predeterminado.
+ No se puede asociar con ningún clúster.
Tipo: cadena  
Obligatorio: sí

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** InvalidDBParameterGroupState **   
El grupo de parámetros está en uso o se encuentra en un estado que no es válido. Si intenta eliminar el grupo de parámetros, no puede eliminarlo cuando el grupo de parámetros se encuentra en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteDBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 

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

Elimina una instantánea de clúster. Si se está copiando la instantánea, se termina la operación de copiado.

**nota**  
La instantánea del clúster debe encontrarse en el estado `available` para su eliminación.

## Parámetros de la solicitud
<a name="API_DeleteDBClusterSnapshot_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
El identificador de la instantánea del clúster que se va a eliminar.  
Restricciones: debe ser el nombre de una instantánea del clúster existente en el estado `available`.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterSnapshot **   
Información detallada sobre una instantánea de un clúster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteDBClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 

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

Elimina una instancia previamente aprovisionada.

## Parámetros de la solicitud
<a name="API_DeleteDBInstance_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBInstanceIdentifier **   
El identificador de instancias para la instancia que se va a eliminar. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el nombre de una instancia existente.
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_DeleteDBInstance_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBInstance **   
Información detallada sobre una instancia.   
Tipo: objeto [DBInstance](API_DBInstance.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBSnapshotAlreadyExists **   
 Una instantánea existente ya está utilizando `DBSnapshotIdentifier`.   
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

 ** SnapshotQuotaExceeded **   
La solicitud provocaría que superara el número de instantáneas permitido.  
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteDBInstance_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) 

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

Elimina un grupo de subredes.

**nota**  
El grupo de subred de base de datos especificado no debe estar asociado a cualquier instancia de base de datos.

## Parámetros de la solicitud
<a name="API_DeleteDBSubnetGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBSubnetGroupName **   
El nombre del grupo de subred de base de datos que se va a eliminar.  
El grupo de subred predeterminado no se puede eliminar.
Restricciones:  
Debe coincidir con el nombre de un `DBSubnetGroup` existente. No debe ser predeterminado.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Obligatorio: sí

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** InvalidDBSubnetGroupStateFault **   
El grupo de subredes no se puede eliminar porque está en uso.  
Código de estado HTTP: 400

 ** InvalidDBSubnetStateFault **   
 La subred de base de datos no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteDBSubnetGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) 

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

Elimina una suscripción de notificación de eventos de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_DeleteEventSubscription_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SubscriptionName **   
El nombre de la suscripción a notificaciones de eventos de Amazon DocumentDB que desea eliminar.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_DeleteEventSubscription_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EventSubscription **   
Información detallada sobre un evento al que se ha suscrito.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** InvalidEventSubscriptionState **   
Es posible que otra persona esté modificando una suscripción. Espere unos segundos e inténtelo de nuevo.  
Código de estado HTTP: 400

 ** SubscriptionNotFound **   
El nombre de la suscripción no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_DeleteEventSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) 

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

Elimina un clúster global. Los clústeres principal y secundario ya deben estar separados o eliminados antes de intentar eliminar un clúster global.

**nota**  
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_DeleteGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** GlobalClusterIdentifier **   
El identificador del clúster. del clúster global que se va a eliminar.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

## Elementos de respuesta
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_DeleteGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) 

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

Devuelve una lista de los certificados de la autoridad de certificación (CA) proporcionados por Amazon DocumentDB para esta Cuenta de AWS.

## Parámetros de la solicitud
<a name="API_DescribeCertificates_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** CertificateIdentifier **   
El identificador del certificado proporcionado por el usuario. Si se especifica este parámetro, se devuelve información solo del certificado especificado. Si se omite este parámetro, se devuelve una lista de hasta `MaxRecords` certificados. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones  
+ Debe coincidir con un `CertificateIdentifier` existente.
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud `DescribeCertificates` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.  
Predeterminado: 100  
Restricciones:  
+ Mínimo: 20
+ Máximo: 100
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeCertificates_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **Certificates.Certificate.N**   
Una lista de certificados para esta Cuenta de AWS.  
Tipo: matriz de objetos [Certificate](API_Certificate.md)

 ** Marker **   
Se proporciona un token de paginación opcional si el número de registros recuperados es superior a `MaxRecords`. Si se especifica este parámetro, el marcador especifica el siguiente registro de la lista. Si se incluye el valor de `Marker` en la siguiente llamada a `DescribeCertificates`, aparecerá la siguiente página de certificados.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` no hace referencia a un certificado existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeCertificates_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) 

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

Devuelve una lista de descripciones de `DBClusterParameterGroup`. Si se especifica un parámetro `DBClusterParameterGroupName`, la lista contendrá únicamente la descripción del grupo de parámetros de clúster especificado. 

## Parámetros de la solicitud
<a name="API_DescribeDBClusterParameterGroups_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre de un grupo de parámetros de clúster específico para el que devolver detalles.  
Restricciones:  
+ Si se suministra, debe coincidir con el nombre de un `DBClusterParameterGroup` existente.
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBClusterParameterGroups. DBClusterParameterGroup**N.   
Una lista de grupos de parámetros de clúster.  
Tipo: matriz de objetos [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBClusterParameterGroups_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 

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

Devuelve la lista detallada de parámetros para un grupo de parámetros de clúster en particular.

## Parámetros de la solicitud
<a name="API_DescribeDBClusterParameters_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre de un grupo de parámetros de clúster específico para el que devolver detalles de parámetros.  
Restricciones:  
+ Si se suministra, debe coincidir con el nombre de un `DBClusterParameterGroup` existente.
Tipo: cadena  
Obligatorio: sí

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** Source **   
 Un valor que indica devolver solo parámetros de un origen específico. Los orígenes de parámetros pueden ser `engine`, `service` o `customer`.   
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

 **Parameters.Parameter.N**   
Proporciona una lista de parámetros para el grupo de parámetros de clúster.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBClusterParameters_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) 

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

Devuelve información acerca de los clústeres de Amazon DocumentDB. La operación API admite la paginación. Para ciertas características de administración, como la administración del ciclo de vida de clúster y de instancia, Amazon DocumentDB aprovecha la tecnología operativa que se comparte con Amazon RDS and Amazon Neptune. Utilice el parámetro de filtro `filterName=engine,Values=docdb` para devolver únicamente los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_DescribeDBClusters_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador de clúster proporcionado por el usuario. Si se especifica este parámetro, se devuelve información solo del clúster específico. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Si se suministra, debe coincidir con un `DBClusterIdentifier` existente.
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Un filtro que especifica uno o varios clústeres por describir.  
Filtros compatibles:  
+  `db-cluster-id`- Acepta identificadores de clústeres y nombres de recursos de Amazon para clústeres (ARNs). La lista de resultados solo incluye información sobre los clústeres identificados por ellos ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeDBClusters_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBClusters. DBCluster**N.   
Una lista de clústeres.  
Tipo: matriz de objetos [DBCluster](API_DBCluster.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBClusters_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) 

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

Devuelve una lista de nombres y valores de atributos de instantáneas de clúster y valores para una instantánea del clúster de base de datos.

Al compartir instantáneas con otras personas Cuentas de AWS, `DescribeDBClusterSnapshotAttributes` devuelve el `restore` atributo y una lista de IDs las personas Cuentas de AWS autorizadas a copiar o restaurar la instantánea manual del clúster. Si `all` se incluye en la lista de valores para el atributo `restore`, la instantánea del clúster manual es pública y las Cuentas de AWS pueden copiarla o restaurarla.

## Parámetros de la solicitud
<a name="API_DescribeDBClusterSnapshotAttributes_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
El identificador para la instantánea del clúster para el que describir los atributos.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterSnapshotAttributesResult **   
Información detallada sobre los atributos asociados a una instantánea de clúster.  
Tipo: objeto [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBClusterSnapshotAttributes_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 

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

Devuelve información acerca de instantáneas del clúster. La operación API admite la paginación.

## Parámetros de la solicitud
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El ID del clúster para recuperar la lista de instantáneas del clúster. Este parámetro no puede utilizarse con el parámetro `DBClusterSnapshotIdentifier`. Este parámetro no distingue entre mayúsculas y minúsculas.   
Restricciones:  
+ De ser proporcionado, debe coincidir con el identificador de un `DBCluster` existente.
Tipo: cadena  
Requerido: no

 ** DBClusterSnapshotIdentifier **   
Un identificador de instantánea de clúster específica para describir. Este parámetro no puede utilizarse con el parámetro `DBClusterIdentifier`. Este valor se almacena como una cadena en minúsculas.   
Restricciones:  
+ De ser proporcionado, debe coincidir con el identificador de un `DBClusterSnapshot` existente.
+ Si este identificador es para una instantánea automatizada, también se debe especificar el parámetro `SnapshotType`.
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** IncludePublic **   
Configúrelo `true` para incluir instantáneas de clústeres manuales que sean públicas y que cualquiera pueda copiar o restaurar Cuenta de AWS, o de cualquier otra manera. `false` El valor predeterminado es `false`.  
Tipo: Booleano  
Obligatorio: no

 ** IncludeShared **   
Configúrelo `true` para incluir instantáneas de clústeres manuales compartidas de otros clústeres para las Cuentas de AWS que se le Cuenta de AWS haya dado permiso para copiar o restaurar, o de cualquier otro modo. `false` El valor predeterminado es `false`.  
Tipo: Booleano  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** SnapshotType **   
El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:  
+  `automated`: se devuelven todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su Cuenta de AWS.
+  `manual`: se devuelven todas las instantáneas del clúster que haya creado manualmente para su Cuenta de AWS.
+  `shared`: se devuelven todas las instantáneas manuales del clúster que se han compartido a su Cuenta de AWS.
+  `public`: se devuelven todas las instantáneas del clúster que se han marcado como públicas.
Si no se especifica ningún valor para `SnapshotType`, se devuelve las instantáneas del clúster automatizadas y manuales. Puede incluir instantáneas del clúster compartidas con estos resultados estableciendo el parámetro `IncludeShared` en `true`. Puede incluir instantáneas del clúster de base de datos públicas con estos resultados estableciendo el parámetro `IncludePublic` en `true`.  
Los parámetros `IncludeShared` y `IncludePublic` no se aplican para los valores de `SnapshotType` de `manual` o `automated`. El parámetro `IncludePublic` no se aplica cuando se establece `SnapshotType` en `shared`. El parámetro `IncludeShared` no se aplica cuando se establece `SnapshotType` en `public`.  
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBClusterInstantáneas. DBClusterInstantánea.**   
Proporciona una lista de instantáneas del clúster.  
Tipo: matriz de objetos [DBClusterSnapshot](API_DBClusterSnapshot.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 

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

Devuelve una lista con los motores disponibles.

## Parámetros de la solicitud
<a name="API_DescribeDBEngineVersions_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBParameterGroupFamily **   
El nombre de una familia de grupos de parámetros específicos para los que devolver detalles.  
Restricciones:  
+ Si se suministra, debe coincidir con un `DBParameterGroupFamily` existente.
Tipo: cadena  
Requerido: no

 ** DefaultOnly **   
Indica que solo se devuelve la versión predeterminada del motor especificado o motor y combinación de la versión principal.  
Tipo: Booleano  
Obligatorio: no

 ** Engine **   
El motor de base de datos que se debe devolver.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
La versión del motor de base de datos que se debe devolver.  
Ejemplo: `3.6.0`   
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** ListSupportedCharacterSets **   
Si se especifica este parámetro y el motor solicitado es compatible con el parámetro `CharacterSetName` para `CreateDBInstance`, la respuesta incluye una lista de conjuntos de caracteres admitidos para cada versión del motor.   
Tipo: Booleano  
Obligatorio: no

 ** ListSupportedTimezones **   
Si se especifica este parámetro y el motor solicitado es compatible con el parámetro `TimeZone` para `CreateDBInstance`, la respuesta incluye una lista de zonas horarias admitidas para cada versión del motor.   
Tipo: Booleano  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBEngineVersiones. DBEngineVersión.N**   
Información detallada sobre una o más versiones de un motor.  
Tipo: matriz de objetos [DBEngineVersion](API_DBEngineVersion.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

## Véase también
<a name="API_DescribeDBEngineVersions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) 

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

Devuelve información acerca de las instancias de Amazon DocumentDB aprovisionadas. Esta API admite la paginación.

## Parámetros de la solicitud
<a name="API_DescribeDBInstances_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBInstanceIdentifier **   
El identificador de instancia proporcionado por el usuario. Si se especifica este parámetro, solo se devuelve información de la instancia específica. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ De ser proporcionado, debe coincidir con el identificador de un `DBInstance` existente.
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Un filtro que especifica una o varias instancias para describir.  
Filtros compatibles:  
+  `db-cluster-id`- Acepta identificadores de clústeres y nombres de recursos de Amazon para clústeres (ARNs). La lista de resultados incluye solo la información sobre las instancias asociadas a los clústeres que estos ARNs identifican.
+  `db-instance-id`- Acepta los identificadores de instancia y la instancia ARNs. La lista de resultados incluye solo la información sobre las instancias identificadas por estos ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeDBInstances_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBInstances. DBInstance**N.   
Información detallada sobre una o varias instancias.   
Tipo: matriz de objetos [DBInstance](API_DBInstance.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBInstances_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 

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

Devuelve una lista de descripciones de `DBSubnetGroup`. Si se especifica un `DBSubnetGroupName`, la lista contendrá únicamente la descripción del grupo de parámetros de `DBSubnetGroup` especificado.

## Parámetros de la solicitud
<a name="API_DescribeDBSubnetGroups_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBSubnetGroupName **   
El nombre del grupo de subred del que desea consultar los detalles.  
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **DBSubnetGrupos. DBSubnetGrupo N.**   
Información detallada sobre uno o más grupos de subredes.  
Tipo: matriz de objetos [DBSubnetGroup](API_DBSubnetGroup.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeDBSubnetGroups_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) 

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

Devuelve la información de los parámetros del sistema y del motor predeterminados para el motor de base de datos del clúster.

## Parámetros de la solicitud
<a name="API_DescribeEngineDefaultClusterParameters_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBParameterGroupFamily **   
El nombre de la familia del grupo de parámetros de clúster para la que devolver información de los parámetros del motor.  
Tipo: cadena  
Obligatorio: sí

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EngineDefaults **   
Contiene el resultado de una invocación correcta de la operación `DescribeEngineDefaultClusterParameters`.   
Tipo: objeto [EngineDefaults](API_EngineDefaults.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

## Véase también
<a name="API_DescribeEngineDefaultClusterParameters_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 

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

Muestra una lista de categorías de todos los tipos de origen de eventos o, si se especifica, para un tipo de origen especificado. 

## Parámetros de la solicitud
<a name="API_DescribeEventCategories_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** SourceType **   
El tipo de origen que está generando los eventos.  
Valores válidos: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_DescribeEventCategories_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 **EventCategoriesMapList. EventCategoriesMap**N.   
Una lista de mapas de categorías de eventos.  
Tipo: matriz de objetos [EventCategoriesMap](API_EventCategoriesMap.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

## Véase también
<a name="API_DescribeEventCategories_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) 

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

Devuelve eventos relacionados con las instancias, grupos de seguridad, instantáneas y grupos de parámetros de base de datos para los últimos 14 días. Los eventos específicos de una instancia de base de datos concreta, grupo de seguridad, instantánea o grupo de parámetros se pueden obtener proporcionando el nombre como parámetro. De forma predeterminada, se devuelven los eventos de la última hora.

## Parámetros de la solicitud
<a name="API_DescribeEvents_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** Duration **   
El número de minutos para los que recuperar eventos.  
Predeterminado: 60  
Tipo: entero  
Obligatorio: no

 ** EndTime **   
 El final del intervalo de tiempo para el que recuperar eventos, especificado en formato ISO 8601.   
Ejemplo: 2009-07-08T18:00Z  
Tipo: marca temporal  
Obligatorio: no

 **EventCategories. EventCategory**N.   
Una lista de categorías de eventos que desencadena notificaciones para la suscripción a notificaciones de eventos.  
Tipo: matriz de cadenas  
Obligatorio: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** SourceIdentifier **   
El identificador del origen de eventos para el que se devuelven eventos. Si no se especifica, se incluyen todos los orígenes en la respuesta.  
Restricciones:  
+ Si se proporciona `SourceIdentifier`, también se debe proporcionar `SourceType`.
+ Si el tipo de origen es `DBInstance`, debe proporcionarse un `DBInstanceIdentifier`.
+ Si el tipo de origen es `DBSecurityGroup`, debe proporcionarse un `DBSecurityGroupName`.
+ Si el tipo de origen es `DBParameterGroup`, debe proporcionarse un `DBParameterGroupName`.
+ Si el tipo de origen es `DBSnapshot`, debe proporcionarse un `DBSnapshotIdentifier`.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Tipo: cadena  
Requerido: no

 ** SourceType **   
El origen del evento para el que recuperar eventos. Si no se especifica ningún valor, se devuelven todos los eventos.  
Tipo: cadena  
Valores válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obligatorio: no

 ** StartTime **   
 El principio del intervalo de tiempo para el que recuperar eventos, especificado en formato ISO 8601.   
Ejemplo: 2009-07-08T18:00Z  
Tipo: marca temporal  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeEvents_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **Events.Event.N**   
Información detallada sobre uno o varios eventos.   
Tipo: matriz de objetos [Event](API_Event.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

## Véase también
<a name="API_DescribeEvents_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) 

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

Muestra todas las descripciones de la suscripción para una cuenta de cliente. La descripción de una suscripción incluye `SubscriptionName`, `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime` y `Status`.

Si especifica un `SubscriptionName`, muestra la descripción de dicha suscripción.

## Parámetros de la solicitud
<a name="API_DescribeEventSubscriptions_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** SubscriptionName **   
El nombre de la suscripción a notificaciones de eventos de Amazon DocumentDB que desea describir.  
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **EventSubscriptionsList. EventSubscription**N.   
Lista de suscripciones a eventos.  
Tipo: matriz de objetos [EventSubscription](API_EventSubscription.md)

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** SubscriptionNotFound **   
El nombre de la suscripción no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeEventSubscriptions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) 

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

Devuelve información sobre los clústeres globales de Amazon DocumentDB. Esta API admite la paginación.

**nota**  
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_DescribeGlobalClusters_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 **Filters.Filter.N**   
Un filtro que especifica uno o varios clústeres de bases de datos globales a describir.  
Filtros compatibles: `db-cluster-id` acepta identificadores de clústeres y nombres de recursos de Amazon para clústeres (ARNs). La lista de resultados solo incluirá información sobre los clústeres identificados por ellos ARNs.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** GlobalClusterIdentifier **   
El identificador de clúster de base de datos suministrado por el usuario. Si se especifica este parámetro, se devuelve información solo del clúster específico. Este parámetro no distingue entre mayúsculas y minúsculas.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud `DescribeGlobalClusters` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que usted pueda recuperar el resto de los resultados.   
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 **GlobalClusters. GlobalClusterMember**N.   
  
Tipo: matriz de objetos [GlobalCluster](API_GlobalCluster.md)

 ** Marker **   
  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

## Véase también
<a name="API_DescribeGlobalClusters_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) 

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

Devuelve una lista de opciones de instancia ordenable para el motor especificado.

## Parámetros de la solicitud
<a name="API_DescribeOrderableDBInstanceOptions_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** Engine **   
Nombre del motor para recuperar opciones de la instancia.  
Tipo: cadena  
Obligatorio: sí

 ** DBInstanceClass **   
El valor del filtro de la clase de instancia. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la clase de instancia especificada.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Valor del filtro de la versión del motor. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la versión del motor especificado.  
Tipo: cadena  
Requerido: no

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** LicenseModel **   
El valor del filtro del modelo de licencia. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con el modelo de licencia especificado.  
Tipo: cadena  
Requerido: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** Vpc **   
Valor del filtro de la nube privada virtual (VPC). Especifique este parámetro para mostrar solo la disponibilidad de ofertas VPC o no VPC.  
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

 **Opciones que se pueden pedir. DBInstance Opción DBInstance que se puede pedir. N**   
Las opciones que están disponibles para una instancia concreta que se puede pedir.  
Tipo: matriz de objetos [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

## Véase también
<a name="API_DescribeOrderableDBInstanceOptions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos, consulte lo siguiente: AWS SDKs
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 

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

Devuelve una lista de recursos (por ejemplo, instancias) que tienen al menos una acción de mantenimiento pendiente.

## Parámetros de la solicitud
<a name="API_DescribePendingMaintenanceActions_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 **Filters.Filter.N**   
Un filtro que especifica uno o más recursos para devolver acciones de mantenimiento pendientes.  
Filtros compatibles:  
+  `db-cluster-id`- Acepta identificadores de clústeres y nombres de recursos de Amazon para clústeres (ARNs). La lista de resultados incluye solo las acciones de mantenimiento pendientes para los clústeres identificados por ellas ARNs.
+  `db-instance-id`- Acepta los identificadores de instancia y la instancia ARNs. La lista de resultados incluye solo las acciones de mantenimiento pendientes para las instancias de base de datos identificadas por ellas ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** MaxRecords **   
 El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Predeterminado: 100  
Restricciones: mínimo 20, máximo 100.  
Tipo: entero  
Obligatorio: no

 ** ResourceIdentifier **   
El ARN de un recuerdo para el que devolver acciones de mantenimiento pendientes.  
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

El servicio devuelve los siguientes elementos.

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena

 **PendingMaintenanceActions. ResourcePendingMaintenanceActions**N.   
Las acciones de mantenimiento que se van a aplicar.  
Tipo: matriz de objetos [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** ResourceNotFoundFault **   
No se ha encontrado el ID del recurso especificado.  
Código de estado HTTP: 404

## Véase también
<a name="API_DescribePendingMaintenanceActions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 

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

Fuerza una conmutación por error para un clúster.

Una conmutación por error de un clúster promueve una de las réplicas de Amazon DocumentDB (instancias de solo lectura) del clúster a instancia principal (la instancia de escritura del clúster).

Si se produce un error en la instancia principal, Amazon DocumentDB conmuta automáticamente a una réplica de Amazon DocumentDB, si existe. Puede forzar una conmutación por error cuando desee simular un error en una instancia principal para realizar pruebas.

## Parámetros de la solicitud
<a name="API_FailoverDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
Un identificador del clúster para forzar una conmutación por error. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBCluster` existente.
Tipo: cadena  
Requerido: no

 ** TargetDBInstanceIdentifier **   
El nombre de la instancia que se va a promover a instancia principal.  
Debe especificar el identificador de instancias para una réplica de Amazon DocumentDB en el clúster. Por ejemplo, `mydbcluster-replica1`.  
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_FailoverDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_FailoverDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) 

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

Hace que el clúster de base de datos secundario especificado sea el clúster de base de datos principal del clúster global cuando se produce una conmutación por error en un clúster global.

Utilice esta operación para responder a un suceso no planificado, como un desastre regional en la región principal. La conmutación por error puede provocar la pérdida de datos de transacciones de escritura que no se replicaron en el clúster secundario elegido antes de que se produjera el evento de conmutación por error. Sin embargo, el proceso de recuperación que promueve una instancia de base de datos del clúster de base de datos secundario elegido a instancia de base de datos principal de escritura garantiza que el estado de los datos sea coherente desde el punto de vista de las transacciones.

## Parámetros de la solicitud
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** GlobalClusterIdentifier **   
El identificador del clúster global de Amazon DocumentDB para aplicar esta operación. El identificador es la clave única asignada por el usuario cuando se creó el clúster. Dicho de otro modo, es el nombre del clúster global.  
Restricciones:  
+ Debe coincidir con el identificador de un clúster existente.
+ Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

 ** TargetDbClusterIdentifier **   
El identificador del clúster secundario de Amazon DocumentDB que desea promover para que sea el principal del clúster global. Utilice el nombre de recurso de Amazon (ARN) como identificador para que Amazon DocumentDB pueda localizar el clúster en su región. AWS   
Restricciones:  
+ Debe coincidir con el identificador de un clúster secundario existente.
+ Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

 ** AllowDataLoss **   
Especifica si se debe permitir la pérdida de datos para esta operación de clúster global. Al permitir la pérdida de datos, se desencadena una operación de conmutación por error global.  
Si no especifica `AllowDataLoss`, la operación del clúster global se establece de forma predeterminada en una transición.  
Restricciones:  
+ No se puede especificar junto con el parámetro `Switchover`.
Tipo: Booleano  
Obligatorio: no

 ** Switchover **   
Especifica si se debe hacer la transición de este clúster de base de datos global.  
Restricciones:  
+ No se puede especificar junto con el parámetro `AllowDataLoss`.
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) 

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

Enumera todas las etiquetas de un recurso de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_ListTagsForResource_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** ResourceName **   
El recurso de Amazon DocumentDB con las etiquetas que se desea listar. Este valor es un Nombre de recurso de Amazon (ARN).  
Tipo: cadena  
Obligatorio: sí

 **Filters.Filter.N**   
Este parámetro es incompatible en estos momentos.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obligatorio: no

## Elementos de respuesta
<a name="API_ListTagsForResource_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 **TagList.Etiqueta.N**   
Una lista de una o varias etiquetas.  
Tipo: matriz de objetos [Tag](API_Tag.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` no hace referencia a una instantánea existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_ListTagsForResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) 

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

Modifica un ajuste para un clúster de Amazon DocumentDB. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud. 

## Parámetros de la solicitud
<a name="API_ModifyDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster que se está modificando. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBCluster` existente.
Tipo: cadena  
Obligatorio: sí

 ** AllowMajorVersionUpgrade **   
Es un valor que indica si se permiten actualizaciones de las versiones principales.  
Restricciones:  
+ Debe permitir las actualizaciones de la versión principal cuando especifique un valor para el parámetro `EngineVersion` que sea una versión principal diferente a la versión actual del clúster.
+ Dado que algunos parámetros son específicos de la versión, para cambiarlos es necesario ejecutar una nueva llamada a la API `ModifyDBCluster` una vez que se complete la MVU local.
La ejecución de una MVU afecta directamente los siguientes parámetros:  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
Tipo: Booleano  
Obligatorio: no

 ** ApplyImmediately **   
Un valor que especifica si los cambios de esta solicitud y todos los cambios pendientes se asignan de manera asincrónica en cuanto sea posible, independientemente del valor de `PreferredMaintenanceWindow` del clúster. Si este parámetro es `false`, los cambios realizados en el clúster se aplican durante la siguiente ventana de mantenimiento.  
El parámetro `ApplyImmediately` solo afecta a los valores `NewDBClusterIdentifier` y `MasterUserPassword`. Si ajusta el valor de este parámetro a `false`, los cambios en los valores `NewDBClusterIdentifier` y `MasterUserPassword` se aplicarán durante la siguiente ventana de mantenimiento. Todas los demás cambios se aplican de inmediato, con independencia del valor del parámetro `ApplyImmediately`.  
Valor predeterminado: `false`   
Tipo: Booleano  
Obligatorio: no

 ** BackupRetentionPeriod **   
El número de días durante los que se retienen las copias de seguridad automatizadas. Debe especificar un valor mínimo de 1.  
Valor predeterminado: 1  
Restricciones:  
+ Debe ser un valor entre 1 y 35.
Tipo: entero  
Obligatorio: no

 ** CloudwatchLogsExportConfiguration **   
El ajuste de configuración de los tipos de registro que se van a habilitar para la exportación a Amazon CloudWatch Logs para una instancia o un clúster específicos. Las `DisableLogTypes` matrices `EnableLogTypes` y determinan qué registros se exportan (o no se exportan) a CloudWatch Logs.  
Tipo: objeto [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)  
Obligatorio: no

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster que se va a usar para el clúster.  
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.  
Tipo: Booleano  
Obligatorio: no

 ** EngineVersion **   
El número de versión del motor de base de datos al que desea realizar la actualización. El cambio de este parámetro produce una interrupción. El cambio se aplica durante la siguiente ventana de mantenimiento a menos que `ApplyImmediately` esté activado.  
Para listar todas las versiones de motor disponibles para Amazon DocumentDB utilice el siguiente comando:  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
Tipo: cadena  
Requerido: no

 ** ManageMasterUserPassword **   
Especifica si se debe administrar la contraseña del usuario maestro con Secrets Manager de Amazon Web Services. Si el clúster no administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services, puede activar esta administración. En este caso, no puede especificar `MasterUserPassword`. Si el clúster ya administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services y usted especifica que la contraseña del usuario maestro no se administre con Secrets Manager de Amazon Web Services, debe especificar `MasterUserPassword`. En este caso, Amazon DocumentDB elimina el secreto y utiliza la nueva contraseña para el usuario maestro especificado por `MasterUserPassword`.  
Tipo: Booleano  
Obligatorio: no

 ** MasterUserPassword **   
La contraseña del usuario de la base de datos maestra. Esta contraseña puede contener cualquier carácter ASCII imprimible, excepto barra inclinada (/), comillas dobles (") o el símbolo de “arroba” (@).  
Limitaciones: debe contener de 8 a 100 caracteres.  
Tipo: cadena  
Requerido: no

 ** MasterUserSecretKmsKeyId **   
El identificador de clave de KMS de Amazon Web Services para cifrar un secreto que se genera y administra automáticamente en Secrets Manager de Amazon Web Services.  
Esta configuración es válida solamente si se cumplen las siguientes dos condiciones:  
+ Si el clúster no administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services. Si el clúster ya administra la contraseña de usuario maestro en Secrets Manager de Amazon Web Services, no podrá cambiar la clave de KMS que se usa para cifrar el secreto.
+ Está habilitando `ManageMasterUserPassword` para que administre la contraseña de usuario maestro en Secrets Manager de Amazon Web Services. Si activa `ManageMasterUserPassword` y no especifica el `MasterUserSecretKmsKeyId`, se utilizará la clave de KMS de `aws/secretsmanager` para cifrar el secreto. Si el secreto está en una cuenta de Amazon Web Services diferente, entonces no puede usar la clave de KMS de `aws/secretsmanager` para cifrar el secreto y se debe usar una clave de KMS administrada por el cliente.
El identificador de la clave de KMS de Amazon Web Services es el ARN de la clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave de KMS. Para utilizar una clave de KMS en una cuenta de Amazon Web Services diferente, debe especificar el ARN de la clave o el ARN del alias.  
Existe una clave KMS predeterminada para su cuenta de Amazon Web Services. La cuenta de Amazon Web Services tiene una clave de KMS predeterminada diferente para cada región de Amazon Web Services.  
Tipo: cadena  
Requerido: no

 ** NetworkType **   
El tipo de red del clúster.  
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. A `DBSubnetGroup` solo admite el IPv4 protocolo o los IPv6 protocolos IPv4 y (`DUAL`).  
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: cadena  
Requerido: no

 ** NewDBClusterIdentifier **   
El nuevo identificador del clúster cuando se cambia el nombre de un clúster. Este valor se almacena como una cadena en minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Ejemplo: `my-cluster2`   
Tipo: cadena  
Requerido: no

 ** Port **   
El número de puerto en el que el clúster acepta las conexiones.  
Restricciones: el valor debe estar entre `1150` y `65535`.   
Valor predeterminado: el mismo puerto que el clúster original.  
Tipo: entero  
Obligatorio: no

 ** PreferredBackupWindow **   
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas con el parámetro `BackupRetentionPeriod`.   
El valor predeterminado es un intervalo de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS.   
Restricciones:  
+ Tiene que tener el formato `hh24:mi-hh24:mi`.
+ Debe indicarse en Tiempo universal coordinado (UTC).
+ No debe entrar en conflicto con la ventana de mantenimiento preferida.
+ Debe durar al menos 30 minutos.
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
Formato: `ddd:hh24:mi-ddd:hh24:mi`   
El valor predeterminado es un intervalo de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno de ellos Región de AWS, que se produce en un día aleatorio de la semana.   
Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
Restricciones: plazo mínimo de 30 minutos.  
Tipo: cadena  
Requerido: no

 ** RotateMasterUserPassword **   
Especifica si se debe rotar el secreto administrado por Secrets Manager de Amazon Web Services para la contraseña del usuario maestro.  
Esta configuración solo es válida si Amazon DocumentDB administra la contraseña del usuario maestro en Secrets Manager de Amazon Web Services para el clúster. El valor del secreto contiene la contraseña actualizada.  
Restricción: debe aplicar el cambio inmediatamente al rotar la contraseña del usuario maestro.  
Tipo: Booleano  
Obligatorio: no

 ** ServerlessV2ScalingConfiguration **   
Contiene la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatorio: no

 ** StorageType **   
El tipo de almacenamiento que se va a asociar al clúster de base de datos.  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Tipo: cadena  
Requerido: no

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Una lista de grupos de seguridad de la nube privada virtual (VPC) a la que pertenecerá el clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

## Elementos de respuesta
<a name="API_ModifyDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
El usuario ya tiene un clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` no hace referencia a un grupo de parámetros de clúster existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

 ** InvalidDBSecurityGroupState **   
El estado del grupo de seguridad no permite la eliminación.  
Código de estado HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
El grupo de subredes no se puede eliminar porque está en uso.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** NetworkTypeNotSupported **   
El tipo de red no es compatible con `DBSubnetGroup` ni con la versión del motor de base de datos.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) 

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

 Modifica los parámetros de un grupo de parámetros de clúster. Para modificar más de un parámetro, envíe una lista de los siguientes: `ParameterName`, `ParameterValue` y `ApplyMethod`. Se pueden modificar un máximo de 20 parámetros en una única solicitud. 

**nota**  
Los cambios realizados en los parámetros dinámicos se aplican inmediatamente. Los cambios en los parámetros estáticos requieren un período de reinicio o mantenimiento antes de que el cambio pueda surtir efecto.

**importante**  
Después de crear un grupo de parámetros de clúster, debe esperar al menos 5 minutos antes de crear el primer clúster que utilice ese grupo de parámetros de clúster como grupo de parámetros predeterminado. Esto permite a Amazon DocumentDB finalizar por completo la acción de creación antes de que el grupo de parámetros de clúster se use de forma predeterminada para un clúster nuevo. Este paso es especialmente importante para los parámetros que son críticos al crear la base de datos predeterminada de un clúster, como el conjunto de caracteres de la base de datos predeterminada definido por el parámetro `character_set_database`.

## Parámetros de la solicitud
<a name="API_ModifyDBClusterParameterGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster que se va a modificar.  
Tipo: cadena  
Obligatorio: sí

 **Parameters.Parameter.N**   
Un lista de parámetros en el grupo de parámetros de clúster que se va a modificar.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obligatorio: sí

## Elementos de respuesta
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster.  
Restricciones:  
+ Debe tener de 1 a 255 letras o números.
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Este valor se almacena como una cadena en minúsculas.
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** InvalidDBParameterGroupState **   
El grupo de parámetros está en uso o se encuentra en un estado que no es válido. Si intenta eliminar el grupo de parámetros, no puede eliminarlo cuando el grupo de parámetros se encuentra en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyDBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 

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

Añade un atributo y valores a una instantánea manual del clúster de base de datos o los elimina.

Para compartir una instantánea de clúster manual con otras Cuentas de AWS personas, especifique `restore` como parámetro y utilice el `ValuesToAdd` parámetro para añadir una lista IDs de las personas Cuentas de AWS que están autorizadas a restaurar la instantánea de clúster manual. `AttributeName` Utilice el valor `all` para convertir la instantánea manual del clúster en pública, lo que significa que todas las Cuentas de AWS la pueden copiar o restaurar. No añada el valor `all` a ninguna instantánea manual del clúster que contenga información privada que no quiera que esté disponible para todas las Cuentas de AWS. Si una instantánea de clúster manual está cifrada, se puede compartir, pero solo especificando una lista de personas autorizadas Cuenta de AWS IDs para el `ValuesToAdd` parámetro. No se puede utilizar `all` como valor para ese parámetro en este caso.

## Parámetros de la solicitud
<a name="API_ModifyDBClusterSnapshotAttribute_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** AttributeName **   
El nombre del atributo de la instantánea del clúster que se va a modificar.  
Para gestionar la autorización para Cuentas de AWS que otros copien o restauren una instantánea de clúster manual, defina este valor en`restore`.  
Tipo: cadena  
Obligatorio: sí

 ** DBClusterSnapshotIdentifier **   
El identificador para la instantánea del clúster para el que se modifican los atributos.  
Tipo: cadena  
Obligatorio: sí

 **ValuesToAdd. AttributeValue**N.   
Una lista de atributos de la instantánea del clúster que desea añadir al atributo especificado por `AttributeName`.  
Para autorizar a otras Cuentas de AWS personas a copiar o restaurar una instantánea de clúster manual, configure esta lista para que incluya una o varias Cuenta de AWS IDs. Para que cualquier persona pueda restaurar la instantánea manual del clúster Cuenta de AWS, configúrela en. `all` No añada el valor `all` a ninguna instantánea manual del clúster que contenga información privada que no quiera que esté disponible para todas las Cuentas de AWS.  
Tipo: matriz de cadenas  
Obligatorio: no

 **ValuesToRemove. AttributeValue**N.   
Una lista de atributos de la instantánea del clúster que desea eliminar del atributo especificado por `AttributeName`.  
Para eliminar la autorización para Cuentas de AWS que otros copien o restauren una instantánea de clúster manual, configure esta lista para que incluya uno o más Cuenta de AWS identificadores. Para eliminar la autorización para Cuenta de AWS que alguien copie o restaure la instantánea del clúster, configúrela `all` en. Si lo especificas`all`, una Cuenta de AWS persona cuyo ID de cuenta se añada explícitamente al `restore` atributo aún puede copiar o restaurar una instantánea del clúster manual.  
Tipo: matriz de cadenas  
Obligatorio: no

## Elementos de respuesta
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterSnapshotAttributesResult **   
Información detallada sobre los atributos asociados a una instantánea de clúster.  
Tipo: objeto [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** SharedSnapshotQuotaExceeded **   
Ha superado el número máximo de cuentas con las que puede compartir una instantánea manual de base de datos.   
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyDBClusterSnapshotAttribute_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 

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

Modifica la configuración de una instancia. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud.

## Parámetros de la solicitud
<a name="API_ModifyDBInstance_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBInstanceIdentifier **   
El identificador de instancias. Este valor se almacena como una cadena en minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBInstance` existente.
Tipo: cadena  
Obligatorio: sí

 ** ApplyImmediately **   
Especifica si las modificaciones de esta solicitud y todas las modificaciones pendientes se aplican de manera asíncrona en cuanto es posible, independientemente de la configuración de `PreferredMaintenanceWindow` de esta instancia.   
 Si este parámetro se establece en `false`, los cambios realizados en la instancia se aplican durante la siguiente ventana de mantenimiento. Algunos cambios de los parámetros pueden causar una interrupción y se aplican en el siguiente reinicio por error.  
Valor predeterminado: `false`   
Tipo: Booleano  
Obligatorio: no

 ** AutoMinorVersionUpgrade **   
Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.  
Tipo: Booleano  
Obligatorio: no

 ** CACertificateIdentifier **   
Indica el certificado que debe asociarse a la instancia.  
Tipo: cadena  
Requerido: no

 ** CertificateRotationRestart **   
Especifica si la instancia de base de datos se reinicia al rotar SSL/TLS el certificado.  
De forma predeterminada, la instancia de base de datos se reinicia al rotar el certificado. SSL/TLS El certificado no se actualiza hasta que se reinicia la instancia de base de datos.  
Establezca este parámetro solo si *no* va SSL/TLS a conectarse a la instancia de base de datos.
*Si utiliza la instancia de base de datos SSL/TLS para conectarse a la instancia de base de datos, [consulte Actualización de los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [cifrado de datos en tránsito en](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) la Guía para desarrolladores de Amazon DocumentDB.*  
Tipo: Booleano  
Obligatorio: no

 ** CopyTagsToSnapshot **   
Es un valor que indica si se deben copiar todas las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.  
Tipo: Booleano  
Obligatorio: no

 ** DBInstanceClass **   
La nueva capacidad de memoria e informática de la instancia (por ejemplo, `db.r5.large`). No todas las clases de instancia están disponibles en todas las Regiones de AWS.   
Si modifica la clase de la instancia se produce una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que `ApplyImmediately` se especifique como `true` para esta solicitud.   
Valor predeterminado: utiliza la configuración existente.  
Tipo: cadena  
Requerido: no

 ** EnablePerformanceInsights **   
Un valor que indica si se habilita Información sobre rendimiento para la instancia de base de datos. Para obtener más información, consulte [Uso de Información sobre rendimiento de Amazon](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipo: Booleano  
Obligatorio: no

 ** NewDBInstanceIdentifier **   
 El nuevo identificador de instancia para la instancia cuando se cambia el nombre de una instancia. Al cambiar el identificador de la instancia, la instancia se reiniciará inmediatamente si `Apply Immediately` se configura en `true`. Se produce durante el siguiente periodo de mantenimiento si `Apply Immediately` se configura en `false`. Este valor se almacena como una cadena en minúsculas.   
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Ejemplo: `mydbinstance`   
Tipo: cadena  
Requerido: no

 ** PerformanceInsightsKMSKeyId **   
El identificador AWS KMS clave para el cifrado de los datos de Performance Insights.  
El identificador de AWS KMS clave es el ARN de clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave KMS.  
Si no especifica un valor para el PerformanceInsights KMSKey identificador, Amazon DocumentDB utilizará la clave de KMS predeterminada. Existe una clave KMS predeterminada para su cuenta de Amazon Web Services. La cuenta de Amazon Web Services tiene una clave de KMS predeterminada diferente para cada región de Amazon Web Services.  
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
El intervalo de tiempo semanal (en UTC) durante el cual puede llevarse a cabo el mantenimiento del sistema, que puede producir una interrupción. El cambio de este parámetro no produce una interrupción, salvo en la siguiente situación, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Si hay acciones pendientes que provocan un reinicio, y el periodo de mantenimiento se cambia para incluir la hora actual, cambiar este parámetro provoca un reinicio de la instancia. Si traslada esta ventana a la hora actual, debe haber al menos 30 minutos entre la hora actual y el final de la ventana para garantizar que se apliquen los cambios pendientes.  
Valor predeterminado: utiliza la configuración existente.  
Formato: `ddd:hh24:mi-ddd:hh24:mi`   
Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
Restricciones: debe durar al menos 30 minutos.  
Tipo: cadena  
Requerido: no

 ** PromotionTier **   
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.  
Valor predeterminado: 1  
Valores válidos: 0-15  
Tipo: entero  
Obligatorio: no

## Elementos de respuesta
<a name="API_ModifyDBInstance_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBInstance **   
Información detallada sobre una instancia.   
Tipo: objeto [DBInstance](API_DBInstance.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AuthorizationNotFound **   
La IP CIDR o el grupo de seguridad de Amazon EC2 especificados no están autorizados para el grupo de seguridad especificado.  
Es posible que Amazon DocumentDB tampoco esté autorizado para realizar las acciones necesarias en su nombre mediante IAM.  
Código de estado HTTP: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` no hace referencia a un certificado existente.   
Código de estado HTTP: 404

 ** DBInstanceAlreadyExists **   
Ya tiene una instancia con el identificador dado.  
Código de estado HTTP: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` no hace referencia a un grupo de seguridad existente.   
Código de estado HTTP: 404

 ** DBUpgradeDependencyFailure **   
La actualización falló porque un recurso del que depende no puede ser modificado.  
Código de estado HTTP: 400

 ** InsufficientDBInstanceCapacity **   
La clase de instancia especificada no está disponible en la zona de disponibilidad especificada.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

 ** InvalidDBSecurityGroupState **   
El estado del grupo de seguridad no permite la eliminación.  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

 ** StorageTypeNotSupported **   
El almacenamiento del `StorageType` especificado no puede asociarse a la instancia de base de datos.   
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyDBInstance_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) 

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

Modifica un grupo de subredes existente. Los grupos de subredes deben contener al menos una subred en al menos dos Zonas de Disponibilidad en la Región de AWS.

## Parámetros de la solicitud
<a name="API_ModifyDBSubnetGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBSubnetGroupName **   
El nombre del grupo de subredes. Este valor se almacena como una cadena en minúsculas. El grupo de subred predeterminado no se puede modificar.   
Limitaciones: debe coincidir con el nombre de un `DBSubnetGroup` existente. No debe ser predeterminado.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Obligatorio: sí

 **SubnetIds. SubnetIdentifier**N.   
La subred Amazon EC2 IDs para el grupo de subredes.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** DBSubnetGroupDescription **   
La descripción del grupo de subredes.  
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBSubnetGroup **   
Información detallada sobre un grupo de subredes.   
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)

## Errores
<a name="API_ModifyDBSubnetGroup_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Las subredes del grupo de subredes deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.  
Código de estado HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** DBSubnetQuotaExceededFault **   
La solicitud le haría exceder el número permitido de subredes en un grupo de subredes.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** SubnetAlreadyInUse **   
La subred ya está en uso en la zona de disponibilidad.  
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyDBSubnetGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

Modifica una suscripción existente de notificación de eventos de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_ModifyEventSubscription_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SubscriptionName **   
El nombre de la suscripción de notificación de eventos de Amazon DocumentDB.  
Tipo: cadena  
Obligatorio: sí

 ** Enabled **   
 Un valor booleano; establecida en true `true` para activar la suscripción.   
Tipo: Booleano  
Obligatorio: no

 **EventCategories. EventCategory**N.   
 Una lista de las categorías de eventos para un `SourceType` a los que desea suscribirse.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** SnsTopicArn **   
El Nombre de recurso de Amazon (ARN) del tema SNS creado para la notificación de eventos. El ARN es creado por Amazon SNS al crear un tema y suscribirse a él.  
Tipo: cadena  
Requerido: no

 ** SourceType **   
El tipo de origen que está generando los eventos. Por ejemplo, si desea recibir una notificación de eventos generados por una instancia, defina este parámetro como `db-instance`. Si no se especifica este valor, se devuelven todos los eventos.  
Valores válidos: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipo: cadena  
Requerido: no

## Elementos de respuesta
<a name="API_ModifyEventSubscription_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EventSubscription **   
Información detallada sobre un evento al que se ha suscrito.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Errores
<a name="API_ModifyEventSubscription_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
Ha alcanzado el número máximo de suscripciones a eventos.   
Código de estado HTTP: 400

 ** SNSInvalidTopic **   
Amazon SNS ha respondido que hay un problema con el tema especificado.   
Código de estado HTTP: 400

 ** SNSNoAuthorization **   
No tiene permiso para publicar en el tema SNS Nombre de recurso de Amazon (ARN).   
Código de estado HTTP: 400

 ** SNSTopicArnNotFound **   
El nombre de recurso de Amazon (ARN) del tema de SNS no existe.   
Código de estado HTTP: 404

 ** SubscriptionCategoryNotFound **   
La categoría proporcionada no existe.   
Código de estado HTTP: 404

 ** SubscriptionNotFound **   
El nombre de la suscripción no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_ModifyEventSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Modifica una configuración para un clúster global de Amazon DocumentDB. Puede cambiar uno o más parámetros de configuración (por ejemplo, la protección contra la eliminación) o el identificador del clúster global especificando estos parámetros y los nuevos valores de la solicitud.

**nota**  
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_ModifyGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** GlobalClusterIdentifier **   
El identificador del clúster que se va a modificar. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un clúster existente.
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

 ** DeletionProtection **   
Indica si el clúster global tiene habilitada la protección contra eliminación. El clúster global no se puede eliminar cuando está habilitada la protección contra eliminación.   
Tipo: Booleano  
Obligatorio: no

 ** NewGlobalClusterIdentifier **   
El nuevo identificador de un clúster global al modificar un clúster global. Este valor se almacena como una cadena en minúsculas.  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).

  El primer carácter debe ser una letra

  No se pueden incluir dos guiones consecutivos ni acabar con guion.
Ejemplo: `my-cluster2`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: no

## Elementos de respuesta
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Errores
<a name="API_ModifyGlobalCluster_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_ModifyGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

Es posible que necesite reiniciar su instancia, normalmente por razones de mantenimiento. Por ejemplo, si realiza determinados cambios o si modifica el grupo de parámetros de clúster asociado a la instancia, deberá reiniciar la instancia para que los cambios surtan efecto. 

Cuando se reinicia una instancia, se reinicia el servicio del motor de base de datos. Al reiniciar una instancia, se produce una interrupción momentánea, durante la cual su estado se establece en *rebooting*. 

## Parámetros de la solicitud
<a name="API_RebootDBInstance_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBInstanceIdentifier **   
El identificador de instancias. Este parámetro se almacena como una cadena en minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBInstance` existente.
Tipo: cadena  
Obligatorio: sí

 ** ForceFailover **   
 Cuando `true`, el reinicio se realiza a través de una conmutación por error Multi-AZ.   
Restricción no se puede especificar `true` si la instancia no se ha configurado para Multi-AZ.  
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_RebootDBInstance_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBInstance **   
Información detallada sobre una instancia.   
Tipo: objeto [DBInstance](API_DBInstance.md)

## Errores
<a name="API_RebootDBInstance_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_RebootDBInstance_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Separa un clúster secundario de Amazon DocumentDB de un clúster global. El clúster se convierte en un clúster independiente con capacidad de lectura y escritura en lugar de ser de solo lectura y recibir datos de un clúster principal ubicado en una región diferente. 

**nota**  
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_RemoveFromGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DbClusterIdentifier **   
El Nombre de recurso de Amazon (ARN) que identifica el clúster separado del clúster global de Amazon DocumentDB.   
Tipo: cadena  
Obligatorio: sí

 ** GlobalClusterIdentifier **   
El identificador de clúster que se va a separar del clúster global de Amazon DocumentDB.   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

## Elementos de respuesta
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Errores
<a name="API_RemoveFromGlobalCluster_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_RemoveFromGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

Elimina un identificador de origen de una suscripción a notificaciones de eventos de Amazon DocumentDB existente.

## Parámetros de la solicitud
<a name="API_RemoveSourceIdentifierFromSubscription_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** SourceIdentifier **   
 El identificador de origen que se va a eliminar de la suscripción, por ejemplo, el identificador de instancias para una instancia o el nombre de un grupo de seguridad.   
Tipo: cadena  
Obligatorio: sí

 ** SubscriptionName **   
El nombre de la suscripción a notificaciones de eventos de Amazon DocumentDB del que desea eliminar un identificador de origen.  
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** EventSubscription **   
Información detallada sobre un evento al que se ha suscrito.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Errores
<a name="API_RemoveSourceIdentifierFromSubscription_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** SourceNotFound **   
No se ha encontrado el origen solicitado.   
Código de estado HTTP: 404

 ** SubscriptionNotFound **   
El nombre de la suscripción no existe.   
Código de estado HTTP: 404

## Véase también
<a name="API_RemoveSourceIdentifierFromSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Elimina las etiquetas de metadatos de un recurso de Amazon DocumentDB.

## Parámetros de la solicitud
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** ResourceName **   
El recurso de Amazon DocumentDB del que se eliminan las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN).  
Tipo: cadena  
Obligatorio: sí

 **TagKeys.Miembro.**   
La clave de la etiqueta (nombre) de la etiqueta que se va a eliminar.  
Tipo: matriz de cadenas  
Obligatorio: sí

## Errores
<a name="API_RemoveTagsFromResource_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` no hace referencia a una instancia existente.   
Código de estado HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` no hace referencia a una instantánea existente.   
Código de estado HTTP: 404

## Véase también
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 Modifica los parámetros de un grupo de parámetros de clúster al valor predeterminado. Para restablecer parámetros específicos, envíe una lista de lo siguiente: `ParameterName` y `ApplyMethod`. Para restablecer el grupo de parámetros de clúster completo, especifique los parámetros de `DBClusterParameterGroupName` y `ResetAllParameters`. 

 Cuando restablece todo el grupo, los parámetros dinámicos se actualizan de forma inmediata y los parámetros estáticos se establecen en `pending-reboot` para su aplicación la próxima vez que se reinicie la instancia de base de datos.

## Parámetros de la solicitud
<a name="API_ResetDBClusterParameterGroup_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster que se va a restablecer.  
Tipo: cadena  
Obligatorio: sí

 **Parameters.Parameter.N**   
Una lista de nombres de parámetros en el grupo de parámetros de clúster que se va a restablecer a los valores predeterminados. No puede utilizar este parámetro si el parámetro `ResetAllParameters` está establecido en `true`.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obligatorio: no

 ** ResetAllParameters **   
Un valor que se establece en `true` para restablecer todos los parámetros en el grupo de parámetros de clúster a sus valores predeterminados, y en `false` en caso contrario. No puede utilizar este parámetro si hay una lista de nombres de parámetros especificados para el parámetro `Parameters`.  
Tipo: Booleano  
Obligatorio: no

## Elementos de respuesta
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros de clúster.  
Restricciones:  
+ Debe tener de 1 a 255 letras o números.
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Este valor se almacena como una cadena en minúsculas.
Tipo: cadena

## Errores
<a name="API_ResetDBClusterParameterGroup_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` no hace referencia a un grupo de parámetros existente.   
Código de estado HTTP: 404

 ** InvalidDBParameterGroupState **   
El grupo de parámetros está en uso o se encuentra en un estado que no es válido. Si intenta eliminar el grupo de parámetros, no puede eliminarlo cuando el grupo de parámetros se encuentra en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_ResetDBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

Crea un nuevo clúster desde una instantánea o una instantánea del clúster.

Si se especifica una instantánea, el clúster de destino se crea a partir de la instantánea de base de datos de origen con una configuración predeterminada y grupo de seguridad predeterminado.

Si se especifica una instantánea del clúster, el clúster de destino se crea a partir del clúster de origen con la misma configuración que el clúster de base de datos de origen original, salvo que el nuevo clúster se crea con el grupo de seguridad predeterminado.

## Parámetros de la solicitud
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El nombre del clúster que se va a crear a partir de la instantánea o de la instantánea del clúster. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Ejemplo: `my-snapshot-id`   
Tipo: cadena  
Obligatorio: sí

 ** Engine **   
Motor que se va a usar para el clúster nuevo.  
Predeterminado: igual que el de origen.  
Restricción: debe ser compatible con el motor del origen.  
Tipo: cadena  
Obligatorio: sí

 ** SnapshotIdentifier **   
Identificador de la instantánea o instantánea del clúster desde la que se debe realizar la restauración.  
Puede utilizar el nombre o el Nombre de recurso de Amazon (ARN) para especificar una instantánea del clúster. Sin embargo, puede utilizar únicamente el ARN para especificar una instantánea.  
Restricciones:  
+ Debe coincidir con el identificador de una instantánea existente.
Tipo: cadena  
Obligatorio: sí

 **AvailabilityZones. AvailabilityZone**N.   
Proporciona la lista de zonas de disponibilidad de Amazon EC2 donde se pueden crear las instancias del clúster de base de datos.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** DBClusterParameterGroupName **   
El nombre del grupo de parámetros del clúster de base de datos que desea asociar a este clúster de base de datos.  
 *Tipo*: cadena.       *Obligatorio:* no  
Si se omite este argumento, se utiliza el grupo de parámetros de clúster de base de datos predeterminado. Si se suministra, debe coincidir con el nombre de un grupo de parámetros de clúster de base de datos predeterminado existente. La cadena debe contener de 1 a 255 caracteres, letras, números o guiones. El primer carácter debe ser una letra y no puede terminar con un guion o contener dos guiones seguidos.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroupName **   
El nombre del grupo de subredes que se va a usar para el clúster nuevo.  
Limitaciones: si se suministra, debe coincidir con el nombre de un `DBSubnetGroup` existente.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.  
Tipo: Booleano  
Obligatorio: no

 **EnableCloudwatchLogsExports.Miembro.**   
Una lista de los tipos de registro que deben estar habilitados para la exportación a Amazon CloudWatch Logs.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** EngineVersion **   
La versión del motor que se va a usar para el clúster nuevo.  
Tipo: cadena  
Requerido: no

 ** KmsKeyId **   
El identificador AWS KMS clave que se debe utilizar al restaurar un clúster cifrado a partir de una instantánea de base de datos o de un clúster.  
El identificador de AWS KMS clave es el nombre de recurso de Amazon (ARN) de la clave de AWS KMS cifrado. Si va a restaurar un clúster con el mismo Cuenta de AWS propietario de la clave de AWS KMS cifrado utilizada para cifrar el nuevo clúster, puede utilizar el alias de la AWS KMS clave en lugar del ARN para AWS KMS la clave de cifrado.  
Si no se especifica un valor para el parámetro `KmsKeyId`, ocurre lo siguiente:  
+ Si la instantánea o la instantánea del clúster están cifradas, el clúster restaurado se cifra con la AWS KMS clave que se utilizó para cifrar la instantánea o la instantánea del clúster. `SnapshotIdentifier`
+ Si la instantánea o el clúster de `SnapshotIdentifier` no está cifrada, el clúster de base de datos restaurado no está cifrado.
Tipo: cadena  
Requerido: no

 ** NetworkType **   
El tipo de red del clúster.  
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. A `DBSubnetGroup` solo admite el IPv4 protocolo o los IPv6 protocolos IPv4 y (`DUAL`).  
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: cadena  
Requerido: no

 ** Port **   
El número de puerto en el que el nuevo clúster acepta las conexiones.  
Restricciones: el valor debe estar entre `1150` y `65535`.  
Valor predeterminado: el mismo puerto que el clúster original.  
Tipo: entero  
Obligatorio: no

 ** ServerlessV2ScalingConfiguration **   
Contiene la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatorio: no

 ** StorageType **   
El tipo de almacenamiento que se va a asociar al clúster de base de datos.  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Tipo: cadena  
Requerido: no

 **Tags.Tag.N**   
Las etiquetas que se van a asignar al clúster restaurado.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Una lista de grupos de seguridad de la nube privada virtual (VPC) a la que pertenecerá el nuevo clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

## Elementos de respuesta
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Errores
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
El usuario ya tiene un clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** DBClusterQuotaExceededFault **   
No se puede crear el clúster porque ha alcanzado la cuota de clústeres máxima permitida.  
Código de estado HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` no hace referencia a una instantánea existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
El clúster no tiene capacidad suficiente para la operación actual.  
Código de estado HTTP: 403

 ** InsufficientStorageClusterCapacity **   
No hay bastante almacenamiento disponible para la acción en curso. Es posible que pueda resolver este error mediante la actualización de su grupo de subredes para utilizar diferentes zonas de disponibilidad que tienen más almacenamiento disponible.   
Código de estado HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** InvalidDBSnapshotState **   
El estado de la instantánea no permite la eliminación.  
Código de estado HTTP: 400

 ** InvalidRestoreFault **   
No puede restaurar desde una copia de seguridad de una nube privada virtual (VPC) a una instancia de base de datos que no sea de VPC.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Se ha producido un error al acceder a una AWS KMS clave.  
Código de estado HTTP: 400

 ** NetworkTypeNotSupported **   
El tipo de red no es compatible con `DBSubnetGroup` ni con la versión del motor de base de datos.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

## Véase también
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

Restaura un clúster a un punto arbitrario en el tiempo. Los usuarios pueden restaurar a cualquier punto en el tiempo antes de `LatestRestorableTime` durante un máximo de `BackupRetentionPeriod` días. El clúster de destino se crea a partir del clúster de base de datos de origen con la misma configuración que el clúster original, salvo que el nuevo clúster se crea con el grupo de seguridad predeterminado. 

## Parámetros de la solicitud
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El nombre del nuevo clúster que se va a crear.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Tipo: cadena  
Obligatorio: sí

 ** SourceDBClusterIdentifier **   
El identificador del clúster de origen desde el que se va a restaurar.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBCluster` existente.
Tipo: cadena  
Obligatorio: sí

 ** DBSubnetGroupName **   
El nombre del grupo de subredes que se va a usar para el clúster nuevo.  
Limitaciones: si se suministra, debe coincidir con el nombre de un `DBSubnetGroup` existente.  
Ejemplo: `mySubnetgroup`   
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.  
Tipo: Booleano  
Obligatorio: no

 **EnableCloudwatchLogsExports.Miembro.**   
Una lista de los tipos de registro que deben estar habilitados para la exportación a Amazon CloudWatch Logs.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** KmsKeyId **   
El identificador AWS KMS clave que se utilizará al restaurar un clúster cifrado a partir de un clúster cifrado.  
El identificador de AWS KMS clave es el nombre de recurso de Amazon (ARN) de la clave de AWS KMS cifrado. Si va a restaurar un clúster con el mismo Cuenta de AWS propietario de la clave de AWS KMS cifrado utilizada para cifrar el nuevo clúster, puede utilizar el alias de la AWS KMS clave en lugar del ARN para AWS KMS la clave de cifrado.  
Puede restaurar en un clúster nuevo y cifrarlo con una AWS KMS clave diferente de la AWS KMS clave utilizada para cifrar el clúster de origen. El nuevo clúster de base de datos se cifra con la AWS KMS clave identificada por el `KmsKeyId` parámetro.  
Si no se especifica un valor para el parámetro `KmsKeyId`, ocurre lo siguiente:  
+ Si el clúster está cifrado, el clúster restaurado se cifra con la AWS KMS clave que se utilizó para cifrar el clúster de origen.
+ Si el clúster no está cifrado, el clúster restaurado no estará cifrado.
Si `DBClusterIdentifier` se refiere a un clúster que no está cifrado, se rechaza la solicitud de restauración.  
Tipo: cadena  
Requerido: no

 ** NetworkType **   
El tipo de red del clúster.  
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. A `DBSubnetGroup` solo admite el IPv4 protocolo o los IPv6 protocolos IPv4 y (`DUAL`).  
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: cadena  
Requerido: no

 ** Port **   
El número de puerto en el que el nuevo clúster acepta las conexiones.  
Restricciones: el valor debe estar entre `1150` y `65535`.   
Predeterminado: el puerto predeterminado para el motor.  
Tipo: entero  
Obligatorio: no

 ** RestoreToTime **   
La fecha y la hora a la que se va a restaurar el clúster.  
Valores válidos: una hora en formato de tiempo universal coordinado (UTC).  
Restricciones:  
+ Debe ser anterior a la última hora restaurable de la instancia.
+ Debe especificarse si no se proporciona el parámetro `UseLatestRestorableTime`.
+ No se puede especificar si el parámetro `UseLatestRestorableTime` es `true`.
+ No se puede especificar si el parámetro `RestoreType` es `copy-on-write`.
Ejemplo: `2015-03-07T23:45:00Z`   
Tipo: marca temporal  
Obligatorio: no

 ** RestoreType **   
El tipo de restauración que se va a realizar. Puede especificar uno de los siguientes valores:  
+  `full-copy`: el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.
+  `copy-on-write`: el nuevo clúster de base de datos se restaura como un clon del clúster de la base de datos de origen.
Restricciones: no puede especificar `copy-on-write` si la versión del motor del clúster de base de datos de origen es anterior a la 1.11.  
Si no especifica un valor `RestoreType`, el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.  
Tipo: cadena  
Requerido: no

 ** ServerlessV2ScalingConfiguration **   
Contiene la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obligatorio: no

 ** StorageType **   
El tipo de almacenamiento que se va a asociar al clúster de base de datos.  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Tipo: cadena  
Requerido: no

 **Tags.Tag.N**   
Las etiquetas que se van a asignar al clúster restaurado.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

 ** UseLatestRestorableTime **   
Un valor que se establece en `true` para restaurar el clúster a la hora de la última copia de seguridad restaurable y `false` en caso contrario.   
Valor predeterminado: `false`   
Restricciones: no se puede especificar si se proporciona el parámetro `RestoreToTime`.  
Tipo: Booleano  
Obligatorio: no

 **VpcSecurityGroupIds. VpcSecurityGroupId**N.   
Una lista de grupos de seguridad de VPC a los que pertenece el clúster nuevo.  
Tipo: matriz de cadenas  
Obligatorio: no

## Elementos de respuesta
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Errores
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
El usuario ya tiene un clúster con el identificador concreto.  
Código de estado HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** DBClusterQuotaExceededFault **   
No se puede crear el clúster porque ha alcanzado la cuota de clústeres máxima permitida.  
Código de estado HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` no hace referencia a una instantánea de un clúster existente.   
Código de estado HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` no hace referencia a un grupo de subredes existente.   
Código de estado HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
El clúster no tiene capacidad suficiente para la operación actual.  
Código de estado HTTP: 403

 ** InsufficientStorageClusterCapacity **   
No hay bastante almacenamiento disponible para la acción en curso. Es posible que pueda resolver este error mediante la actualización de su grupo de subredes para utilizar diferentes zonas de disponibilidad que tienen más almacenamiento disponible.   
Código de estado HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
El valor proporcionado no es un estado de instantánea de clúster válido.  
Código de estado HTTP: 400

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBSnapshotState **   
El estado de la instantánea no permite la eliminación.  
Código de estado HTTP: 400

 ** InvalidRestoreFault **   
No puede restaurar desde una copia de seguridad de una nube privada virtual (VPC) a una instancia de base de datos que no sea de VPC.  
Código de estado HTTP: 400

 ** InvalidSubnet **   
La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).  
Código de estado HTTP: 400

 ** InvalidVPCNetworkStateFault **   
El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.  
Código de estado HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Se ha producido un error al acceder a una AWS KMS clave.  
Código de estado HTTP: 400

 ** NetworkTypeNotSupported **   
El tipo de red no es compatible con `DBSubnetGroup` ni con la versión del motor de base de datos.  
Código de estado HTTP: 400

 ** StorageQuotaExceeded **   
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.  
Código de estado HTTP: 400

## Véase también
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

Reinicia el clúster detenido que está especificado por `DBClusterIdentifier`. Para obtener más información, consulte [Cómo detener e iniciar un clúster de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parámetros de la solicitud
<a name="API_StartDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster que se va a reiniciar. Ejemplo: `docdb-2019-05-28-15-24-52`   
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_StartDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Errores
<a name="API_StartDBCluster_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_StartDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

Detiene el clúster en ejecución especificado por `DBClusterIdentifier`. El estado del clúster debe ser *disponible*. Para obtener más información, consulte [Cómo detener e iniciar un clúster de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parámetros de la solicitud
<a name="API_StopDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
El identificador del clúster que se va a pausar. Ejemplo: `docdb-2019-05-28-15-24-52`   
Tipo: cadena  
Obligatorio: sí

## Elementos de respuesta
<a name="API_StopDBCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Errores
<a name="API_StopDBCluster_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_StopDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

Cambia el clúster de Amazon DocumentDB secundario especificado para que sea el nuevo clúster de Amazon DocumentDB principal del clúster de base de datos global.

## Parámetros de la solicitud
<a name="API_SwitchoverGlobalCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** GlobalClusterIdentifier **   
El identificador del clúster de base de datos global de Amazon DocumentDB que va a hacer la transición. El identificador es la clave única asignada por el usuario cuando se creó el clúster. Dicho de otro modo, es el nombre del clúster global. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un clúster global existente (base de datos global de Amazon DocumentDB).
+ Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

 ** TargetDbClusterIdentifier **   
El identificador del clúster secundario de Amazon DocumentDB que desea promover para que sea el nuevo principal del clúster de base de datos global. Utilice el nombre de recurso de Amazon (ARN) como identificador para que Amazon DocumentDB pueda localizar el clúster en su región. AWS   
Restricciones:  
+ Debe coincidir con el identificador de un clúster secundario existente.
+ Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: sí

## Elementos de respuesta
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

El servicio devuelve el siguiente elemento.

 ** GlobalCluster **   
Tipo de datos que representa un clúster global de Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Errores
<a name="API_SwitchoverGlobalCluster_Errors"></a>

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` no hace referencia a un clúster global existente.  
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidGlobalClusterStateFault **   
La operación solicitada no se puede realizar mientras el clúster esté en este estado.  
Código de estado HTTP: 400

## Véase también
<a name="API_SwitchoverGlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) 

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

Los clústeres elásticos de Amazon DocumentDB admiten las siguientes acciones:
+  [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>

El tipo de acción de mantenimiento pendiente que se aplica a este recurso.

## Sintaxis de la solicitud
<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"
}
```

## Parámetros de solicitud del URI
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
La acción de mantenimiento pendiente que se aplica a este recurso.  
Las acciones válidas son:  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Obligatorio: sí

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Un valor que indica el tipo de solicitud de alta o deshace una solicitud de alta. Una solicitud de alta de tipo `IMMEDIATE` no se puede deshacer.  
Tipo: cadena  
Valores válidos: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Obligatorio: sí

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
El Nombre de recurso de Amazon (ARN) Amazon DocumentDB del recurso al que se aplica la acción de mantenimiento pendiente.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Obligatorio: sí

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Una fecha específica para aplicar la acción de mantenimiento pendiente. Obligatorio si opt-in-type es `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Obligatorio: no

## Sintaxis de la respuesta
<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"
   }
}
```

## Elementos de respuesta
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
El resultado de la acción de mantenimiento pendiente que se aplica.  
Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

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

Copia una instantánea de un clúster elástico.

## Sintaxis de la solicitud
<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"
}
```

## Parámetros de solicitud del URI
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
El identificador del Nombre de recurso de Amazon (ARN) de la instantánea del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
El identificador de la nueva instantánea del clúster elástico que se va a crear a partir de la instantánea del clúster de origen. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
Ejemplo: `elastic-cluster-snapshot-5`   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.  
Obligatorio: sí

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Establézcalo en `true` para copiar todas las etiquetas de la instantánea del clúster de origen a la instantánea del clúster de destino. El valor predeterminado es `false`.  
Tipo: Booleano  
Obligatorio: no

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
El identificador de clave de AWS KMS de una instantánea de clúster elástico cifrada. El ID de clave de AWS KMS es el nombre de recurso de Amazon (ARN), el identificador de clave de AWS KMS o el alias de clave de AWS KMS de la clave de cifrado de AWS KMS.  
Si copia una instantánea de un clúster elástico cifrada de su AWS cuenta, puede especificar un valor `KmsKeyId` para cifrar la copia con una nueva clave de cifrado de AWS S KMS. Si no especifica ningún valor para `KmsKeyId`, la copia de la instantánea del clúster elástico se cifra con la misma clave de `AWS` KMS que la instantánea del clúster elástico de origen.  
Si intenta copiar una instantánea del clúster elástico sin cifrar y especificar un valor para el parámetro `KmsKeyId`, se devuelve un error.  
Tipo: cadena  
Requerido: no

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
Las etiquetas que se van a asignar a la instantánea del clúster elástico.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Obligatorio: no

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Devuelve información sobre una instantánea específica del clúster elástico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ServiceQuotaExceededException **   
Se ha superado la cuota de servicio para la acción.  
Código de estado HTTP: 402

 ** ThrottlingException **   
ThrottlingException se emitirá cuando se rechace la solicitud debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

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

Crea un nuevo clúster elástico de Amazon DocumentDB y devuelve su estructura de clúster.

## Sintaxis de la solicitud
<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" ]
}
```

## Parámetros de solicitud del URI
<a name="API_elastic_CreateCluster_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_elastic_CreateCluster_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
El nombre del administrador de clústeres elásticos de Amazon DocumentDB.  
 *Restricciones*:  
+ Debe tener de 1 a 63 letras o números.
+ El primer carácter debe ser una letra.
+ No puede ser una palabra reservada.
Tipo: cadena  
Obligatorio: sí

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
La contraseña del administrador de clústeres elásticos de Amazon DocumentDB. La contraseña puede contener cualquier carácter ASCII imprimible.  
 *Restricciones*:  
+ Debe contener de 8 a 100 caracteres.
+ No puede contener una barra inclinada (/), comillas dobles (“ ”) ni el símbolo de “arroba” (@).
Tipo: cadena  
Obligatorio: sí

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
El tipo de autenticación utilizado para determinar dónde buscar la contraseña que se usa para acceder al clúster elástico. Los tipos válidos son `PLAIN_TEXT` o `SECRET_ARN`.  
Tipo: cadena  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obligatorio: sí

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
El nombre del nuevo clúster elástico. Este parámetro se almacena como una cadena en minúsculas.  
 *Restricciones*:  
+ Deben contener de 1 a 63 caracteres (letras, números o guiones).
+ El primer carácter debe ser una letra.
+ No puede terminar con un guion ni contener dos guiones consecutivos.
 *Ejemplo*: `my-cluster`   
Tipo: cadena  
Obligatorio: sí

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
El número de v CPUs asignado a cada fragmento del clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.  
Tipo: entero  
Obligatorio: sí

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
El número de particiones asignadas al clúster elástico. El máximo es 32.  
Tipo: entero  
Obligatorio: sí

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
El número de días durante los que se conservan las instantáneas de base de datos automáticas.  
Tipo: entero  
Obligatorio: no

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
El token de cliente del clúster elástico.  
Tipo: cadena  
Requerido: no

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
El identificador de clave de KMS que se debe utilizar para cifrar el nuevo clúster elástico.  
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS.  
Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.  
Tipo: cadena  
Requerido: no

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina `backupRetentionPeriod`.  
Tipo: cadena  
Requerido: no

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Predeterminado*: un período de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS, que se produce en un día aleatorio de la semana.  
 *Días válidos*: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
 *Restricciones*: plazo mínimo de 30 minutos.  
Tipo: cadena  
Requerido: no

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
El número de instancias de réplica que se aplica a todas las particiones del clúster elástico. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.  
Tipo: entero  
Obligatorio: no

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
La subred Amazon EC2 IDs para el nuevo clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
Las etiquetas que se van a asignar al nuevo clúster elástico.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Obligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad EC2 VPC para asociar con el nuevo clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_CreateCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
El nuevo clúster elástico que se ha creado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ServiceQuotaExceededException **   
Se ha superado la cuota de servicio para la acción.  
Código de estado HTTP: 402

 ** ThrottlingException **   
ThrottlingException se lanzará cuando se rechace la solicitud debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_CreateCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

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

Crea una instantánea de un clúster elástico.

## Sintaxis de la solicitud
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

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

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

## Parámetros de solicitud del URI
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
El identificador ARN del clúster elástico del que desea crear una instantánea.  
Tipo: cadena  
Obligatorio: sí

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
Nombre de la nueva instantánea del clúster elástico.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.  
Obligatorio: sí

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
Las etiquetas que se van a asignar a la instantánea del nuevo clúster elástico.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Obligatorio: no

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Devuelve información sobre la nueva instantánea del clúster elástico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ServiceQuotaExceededException **   
Se ha superado la cuota de servicio para la acción.  
Código de estado HTTP: 402

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

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

Elimine un clúster elástico.

## Sintaxis de la solicitud
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico que se va a eliminar.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_DeleteCluster_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Devuelve información sobre el clúster eliminado recientemente.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

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

Eliminación de una instantánea de un clúster elástico.

## Sintaxis de la solicitud
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
El identificador ARN de la instantánea del clúster elástico que se va a eliminar.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Devuelve información sobre una instantánea del clúster elástico recién detectada.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

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

Devuelve información sobre un clúster elástico específico.

## Sintaxis de la solicitud
<a name="API_elastic_GetCluster_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_GetCluster_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_GetCluster_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_GetCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Devuelve información sobre un clúster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_GetCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

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

Devuelve información sobre una instantánea específica del clúster elástico

## Sintaxis de la solicitud
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
El identificador ARN de la instantánea del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Devuelve información sobre una instantánea específica del clúster elástico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

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

Recupera todas las acciones de mantenimiento pendientes.

## Sintaxis de la solicitud
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Recupera las acciones de mantenimiento pendientes para un nombre de recurso de Amazon (ARN) específico.  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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"
   }
}
```

## Elementos de respuesta
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.  
Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

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

Devuelve información sobre los clústeres elásticos de Amazon DocumentDB aprovisionados.

## Sintaxis de la solicitud
<a name="API_elastic_ListClusters_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_ListClusters_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
El número máximo de resultados de instantáneas de clúster elástico que se reciben en la respuesta.  
Rango válido: valor mínimo de 1. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por `max-results`.  
Si no hay más datos en la respuesta, no se devolverá el `nextToken`.

## Cuerpo de la solicitud
<a name="API_elastic_ListClusters_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

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

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

## Elementos de respuesta
<a name="API_elastic_ListClusters_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Lista de clústeres elásticos de Amazon DocumentDB.  
Tipo: matriz de objetos [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por `max-results`.  
Si no hay más datos en la respuesta, no se devolverá el `nextToken`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_ListClusters_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

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

Devuelve información sobre las instantáneas de un clúster elástico especificado.

## Sintaxis de la solicitud
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
El número máximo de resultados de instantáneas de clúster elástico que se reciben en la respuesta.  
Rango válido: valor mínimo de 20. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por `max-results`.  
Si no hay más datos en la respuesta, no se devolverá el `nextToken`.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:  
+  `automated`- Devuelva todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su AWS cuenta.
+  `manual`- Devuelva todas las instantáneas del clúster que haya creado manualmente para su cuenta. AWS 

## Cuerpo de la solicitud
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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"
      }
   ]
}
```

## Elementos de respuesta
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por `max-results`.  
Si no hay más datos en la respuesta, no se devolverá el `nextToken`.  
Tipo: cadena

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Una lista de instantáneas de un clúster elástico específico.  
Tipo: matriz de objetos [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ThrottlingException **   
ThrottlingException se emitirá cuando se rechace la solicitud debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

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

Recupera una lista de todas las acciones de mantenimiento pendientes.

## Sintaxis de la solicitud
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
El número máximo de registros que se debe incluir en la respuesta. Si el número de registros es superior al valor `maxResults` especificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.  
Rango válido: valor mínimo de 1. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `maxResults`.

## Cuerpo de la solicitud
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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"
      }
   ]
}
```

## Elementos de respuesta
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.  
Tipo: matriz de objetos [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Un token de paginación opcional proporcionado por una solicitud anterior. Si se muestra este parámetro, las respuestas solo incluyen registros más allá del marcador, hasta el valor especificado por `maxResults`.  
Tipo: cadena

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

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

Enumera todas las etiquetas de un recurso de clúster elástico

## Sintaxis de la solicitud
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
El identificador de ARN del recurso de clúster elástico.  
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 1011.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

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

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

## Elementos de respuesta
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
La lista de etiquetas del recurso de clúster elástico especificado.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

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

Restaura un clúster elástico desde una instantánea.

## Sintaxis de la solicitud
<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" ]
}
```

## Parámetros de solicitud del URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
El identificador ARN de la instantánea del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
El nombre del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
El identificador de clave de KMS que se debe utilizar para cifrar el nuevo clúster elástico de Amazon DocumentDB.  
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS.  
Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.  
Tipo: cadena  
Requerido: no

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
La capacidad de cada partición del nuevo clúster elástico restaurado.  
Tipo: entero  
Obligatorio: no

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
El número de instancias de réplica que se aplica a todas las particiones del clúster elástico. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.  
Tipo: entero  
Obligatorio: no

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
La subred Amazon EC2 IDs para el clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Una lista de los nombres de etiquetas que se van a asignar al clúster elástico restaurado, en forma de una matriz de pares clave-valor, en la que la clave es el nombre de la etiqueta y el valor es el valor de la clave.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Obligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Devuelve información sobre el clúster elástico restaurado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ServiceQuotaExceededException **   
Se ha superado la cuota de servicio para la acción.  
Código de estado HTTP: 402

 ** ThrottlingException **   
ThrottlingException se lanzará cuando se rechace la solicitud debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

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

Reinicia el clúster elástico detenido que está especificado por `clusterARN`.

## Sintaxis de la solicitud
<a name="API_elastic_StartCluster_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_StartCluster_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_StartCluster_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_StartCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Devuelve información sobre un clúster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_StartCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

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

Detiene el clúster elástico en ejecución especificado por `clusterArn`. El estado del clúster elástico debe ser *disponible*. 

## Sintaxis de la solicitud
<a name="API_elastic_StopCluster_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_StopCluster_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_StopCluster_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_StopCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Devuelve información sobre un clúster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_StopCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

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

Añade etiquetas de metadatos a un recurso de clúster elástico

## Sintaxis de la solicitud
<a name="API_elastic_TagResource_RequestSyntax"></a>

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

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

## Parámetros de solicitud del URI
<a name="API_elastic_TagResource_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
El identificador de ARN del recurso de clúster elástico.  
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 1011.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_TagResource_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
Las etiquetas asignadas al recurso de clúster elástico.  
Tipo: mapa de cadena a cadena  
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.  
Patrón de clave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.  
Obligatorio: sí

## Sintaxis de la respuesta
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de respuesta
<a name="API_elastic_TagResource_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_TagResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

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

Elimina etiquetas de metadatos de un recurso de clúster elástico

## Sintaxis de la solicitud
<a name="API_elastic_UntagResource_RequestSyntax"></a>

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

## Parámetros de solicitud del URI
<a name="API_elastic_UntagResource_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
El identificador de ARN del recurso de clúster elástico.  
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 1011.  
Obligatorio: sí

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
Las claves de etiqueta que se van a eliminar del recurso de clúster elástico.  
Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 50 artículos.  
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 128.  
Patrón: `(?!aws:)[a-zA-Z+-=._:/]+`   
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_UntagResource_RequestBody"></a>

La solicitud no tiene un cuerpo de la solicitud.

## Sintaxis de la respuesta
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de respuesta
<a name="API_elastic_UntagResource_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando la solicitud haya sido denegada debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_UntagResource_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

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

Modifica un clúster elástico. Esto incluye actualizar el nombre de usuario y la contraseña del administrador, actualizar la versión de la API y configurar una ventana de copia de seguridad y una ventana de mantenimiento

## Sintaxis de la solicitud
<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" ]
}
```

## Parámetros de solicitud del URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

La solicitud utiliza los siguientes parámetros URI.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
El identificador ARN del clúster elástico.  
Obligatorio: sí

## Cuerpo de la solicitud
<a name="API_elastic_UpdateCluster_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
La contraseña asociada al administrador del clúster elástico. Esta contraseña puede contener cualquier carácter ASCII imprimible, excepto barra inclinada (/), comillas dobles (") o el símbolo de “arroba” (@).  
 *Limitaciones*: debe contener de 8 a 100 caracteres.  
Tipo: cadena  
Requerido: no

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
El tipo de autenticación utilizado para determinar dónde buscar la contraseña que se usa para acceder al clúster elástico. Los tipos válidos son `PLAIN_TEXT` o `SECRET_ARN`.  
Tipo: cadena  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obligatorio: no

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
El número de días durante los que se conservan las instantáneas de base de datos automáticas.  
Tipo: entero  
Obligatorio: no

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
El token de cliente del clúster elástico.  
Tipo: cadena  
Requerido: no

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina `backupRetentionPeriod`.  
Tipo: cadena  
Requerido: no

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Predeterminado*: un período de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS, que se produce en un día aleatorio de la semana.  
 *Días válidos*: lunes, martes, miércoles, jueves, viernes, sábado, domingo  
 *Restricciones*: plazo mínimo de 30 minutos.  
Tipo: cadena  
Requerido: no

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
El número de v CPUs asignado a cada fragmento del clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.  
Tipo: entero  
Obligatorio: no

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
El número de particiones asignadas al clúster elástico. El máximo es 32.  
Tipo: entero  
Obligatorio: no

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
El número de instancias de réplica que se aplica a todas las particiones del clúster elástico. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.  
Tipo: entero  
Obligatorio: no

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
La subred Amazon EC2 IDs para el clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: no

## Sintaxis de la respuesta
<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" ]
   }
}
```

## Elementos de respuesta
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Devuelve información sobre el clúster elástico actualizado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** AccessDeniedException **   
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.    
 ** message **   
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403

 ** ConflictException **   
Se ha producido un conflicto de acceso.    
 ** resourceId **   
El identificador del recurso en el que se produjo un conflicto de acceso.  
 ** resourceType **   
El tipo del recurso en el que se produjo un conflicto de acceso.
Código de estado HTTP: 409

 ** InternalServerException **   
Se ha producido un error en el servidor interno.  
Código de estado HTTP: 500

 ** ResourceNotFoundException **   
No se pudo encontrar el recurso especificado.    
 ** message **   
Un mensaje de error que describe el error.  
 ** resourceId **   
El identificador del recurso que no se pudo encontrar.  
 ** resourceType **   
El tipo del recurso que no se pudo encontrar.
Código de estado HTTP: 404

 ** ThrottlingException **   
ThrottlingException se lanzará cuando se rechace la solicitud debido a la limitación de la solicitud.    
 ** retryAfterSeconds **   
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429

 ** ValidationException **   
Estructura que define una excepción de validación.    
 ** fieldList **   
Una lista de los campos en los que se produjo la excepción de validación.  
 ** message **   
Un mensaje de error que describe la excepción de validación.  
 ** reason **   
El motivo por el que se produjo la excepción de validación (uno de los siguientes: `unknownOperation`, `cannotParse`, `fieldValidationFailed` o `other`).
Código de estado HTTP: 400

## Véase también
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) 

# Data Types
<a name="API_Types"></a>

Los siguientes tipos de datos son compatibles con Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

Los siguientes tipos de datos son compatibles con los clústeres elásticos de Amazon DocumentDB:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

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

Los siguientes tipos de datos son compatibles con Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

Información sobre una zona de disponibilidad.

## Contenido
<a name="API_AvailabilityZone_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Name **   
El nombre de la zona de disponibilidad.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_AvailabilityZone_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

# Certificate
<a name="API_Certificate"></a>

Certificado de una entidad de certificación (CA) para una Cuenta de AWS.

## Contenido
<a name="API_Certificate_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** CertificateArn **   
El nombre de recurso de Amazon (ARN) para el certificado.  
Ejemplo:: `arn:aws:rds:us-east-1::cert:rds-ca-2019`   
Tipo: cadena  
Requerido: no

 ** CertificateIdentifier **   
La clave única que identifica un certificado.  
Ejemplo:: `rds-ca-2019`   
Tipo: cadena  
Requerido: no

 ** CertificateType **   
Escriba el nombre del certificado.  
Ejemplo:: `CA`   
Tipo: cadena  
Requerido: no

 ** Thumbprint **   
La huella digital del certificado.  
Tipo: cadena  
Requerido: no

 ** ValidFrom **   
La fecha y hora de inicio a partir de la cual el certificado es válido.  
Ejemplo:: `2019-07-31T17:57:09Z`   
Tipo: marca temporal  
Obligatorio: no

 ** ValidTill **   
La fecha y hora después de la cual el certificado no es válido.  
Ejemplo:: `2024-07-31T17:57:09Z`   
Tipo: marca temporal  
Obligatorio: no

## Véase también
<a name="API_Certificate_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) 

# CertificateDetails
<a name="API_CertificateDetails"></a>

Devuelve los detalles del certificado de servidor de la instancia de base de datos.

Para obtener más información, consulte [Cómo actualizar los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [Cómo cifrar datos en tránsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) en la *Guía para desarrolladores de Amazon DocumentDB*.

## Contenido
<a name="API_CertificateDetails_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** CAIdentifier **   
El identificador CA del certificado de CA que usado para el certificado de servidor de la instancia de base de datos.  
Tipo: cadena  
Requerido: no

 ** ValidTill **   
La fecha de vencimiento del certificado de servidor de la instancia de base de datos.  
Tipo: marca temporal  
Obligatorio: no

## Véase también
<a name="API_CertificateDetails_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) 

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

La opción de configuración para los tipos de registro que se debe habilitar para la exportación a Registros de Amazon CloudWatch para una instancia o un clúster específico.

Las matrices `EnableLogTypes` y `DisableLogTypes` determinan qué registros se exportarán (o no) a CloudWatch Logs. Los valores de estas matrices dependen del motor que se utilice.

## Contenido
<a name="API_CloudwatchLogsExportConfiguration_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DisableLogTypes.member.N **   
La lista de tipos de registros que desea deshabilitar.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** EnableLogTypes.member.N **   
La lista de tipos de registros que desea habilitar.  
Tipo: matriz de cadenas  
Obligatorio: no

## Véase también
<a name="API_CloudwatchLogsExportConfiguration_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

Contiene el secreto administrado por Amazon DocumentDB en Secrets Manager de AWS para la contraseña del usuario maestro.

## Contenido
<a name="API_ClusterMasterUserSecret_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** KmsKeyId **   
El identificador de la clave de AWS KMS que se utiliza para cifrar el secreto.  
Tipo: cadena  
Requerido: no

 ** SecretArn **   
El nombre de recurso de Amazon (ARN) del secreto.  
Tipo: cadena  
Requerido: no

 ** SecretStatus **   
El estado del secreto.  
Otros valores de estado posibles son:  
+ en creación: se está creando el secreto.
+ activo: el secreto está disponible para su uso y rotación normales.
+ en rotación: se está rotando el secreto.
+ dañado: el secreto se puede usar para acceder a las credenciales de la base de datos, pero no se puede rotar. Un secreto puede tener este estado si, por ejemplo, se cambian los permisos para que Amazon DocumentDB ya no pueda acceder al secreto ni a la clave de KMS del secreto.

  Cuando un secreto tiene este estado, puede corregir la condición que provocó el estado. De forma alternativa, modifique la instancia para desactivar la administración automática de las credenciales de la base de datos y, a continuación, modifique la instancia para activar la administración automática de las credenciales de la base de datos.
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_ClusterMasterUserSecret_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) 

# DBCluster
<a name="API_DBCluster"></a>

Información detallada sobre un clúster. 

## Contenido
<a name="API_DBCluster_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AssociatedRoles.DBClusterRole.N **   
Proporciona una lista de los roles AWS Identity and Access Management (IAM) que están asociados con un clúster de base de datos. Los roles de IAM asociados a un clúster conceden permisos para que dicho clúster acceda a otros servicios de AWS en su nombre.  
Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md)  
Obligatorio: no

 ** AvailabilityZones.AvailabilityZone.N **   
Proporciona la lista de zonas de disponibilidad de Amazon EC2 en las que se pueden crear instancias en el clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** BackupRetentionPeriod **   
Especifica el número de días durante los que se retienen las instantáneas automáticas.  
Tipo: entero  
Obligatorio: no

 ** CloneGroupId **   
Identifica el grupo de clones al que está asociado el clúster de base de datos.  
Tipo: cadena  
Requerido: no

 ** ClusterCreateTime **   
Especifica la hora a la que se creó el clúster, en tiempo universal coordinado (UTC).  
Tipo: marca temporal  
Obligatorio: no

 ** DBClusterArn **   
El Nombre de recurso de Amazon (ARN) para el clúster.  
Tipo: cadena  
Requerido: no

 ** DBClusterIdentifier **   
Contiene un identificador de clúster suministrado por el usuario. Este identificador es la clave única que identifica un clúster.  
Tipo: cadena  
Requerido: no

 ** DBClusterMembers.DBClusterMember.N **   
Proporciona la lista de instancias que componen el clúster.  
Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md)  
Obligatorio: no

 ** DBClusterParameterGroup **   
Especifica el nombre del grupo de parámetros de clúster para el clúster.  
Tipo: cadena  
Requerido: no

 ** DbClusterResourceId **   
El identificador inmutable único de Región de AWS para el clúster. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS del clúster.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroup **   
Especifica información sobre el grupo de subred asociado con el clúster, incluido el nombre, la descripción y subredes en el grupo de subred.  
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.  
Tipo: Booleano  
Obligatorio: no

 ** EarliestRestorableTime **   
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.  
Tipo: marca temporal  
Obligatorio: no

 ** EnabledCloudwatchLogsExports.member.N **   
Una lista de tipos de registro para los que este clúster está configurado para exportar a los Registros de Amazon CloudWatch.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** Endpoint **   
Especifica el punto de conexión para la instancia principal del clúster.  
Tipo: cadena  
Requerido: no

 ** Engine **   
Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Indica la versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** HostedZoneId **   
Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.  
Tipo: cadena  
Requerido: no

 ** IOOptimizedNextAllowedModificationTime **   
La próxima vez, podrá modificar el clúster de Amazon DocumentDB para utilizar el tipo de almacenamiento iopt1.  
Tipo: marca temporal  
Obligatorio: no

 ** KmsKeyId **   
Si `StorageEncrypted` es `true`, el identificador de la clave de AWS KMS para el clúster cifrado.  
Tipo: cadena  
Requerido: no

 ** LatestRestorableTime **   
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.  
Tipo: marca temporal  
Obligatorio: no

 ** MasterUsername **   
Contiene el nombre de usuario maestro para el clúster.  
Tipo: cadena  
Requerido: no

 ** MasterUserSecret **   
El secreto administrado por Amazon DocumentDB en Secrets Manager de AWS para la contraseña del usuario maestro.  
Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)  
Obligatorio: no

 ** MultiAZ **   
Especifica si el clúster tiene instancias en varias zonas de disponibilidad.  
Tipo: Booleano  
Obligatorio: no

 ** NetworkType **   
El tipo de red del clúster.  
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. Un `DBSubnetGroup` admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (`DUAL`).  
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: cadena  
Requerido: no

 ** PercentProgress **   
Especifica el progreso de la operación como porcentaje.  
Tipo: cadena  
Requerido: no

 ** Port **   
Especifica el puerto en el que escucha el motor de la base de datos.  
Tipo: entero  
Obligatorio: no

 ** PreferredBackupWindow **   
Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad `BackupRetentionPeriod`.   
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).  
Tipo: cadena  
Requerido: no

 ** ReaderEndpoint **   
El punto de conexión del lector para el clúster. El punto de conexión del lector de un clúster equilibra la carga de las conexiones entre las réplicas de Amazon DocumentDB que están disponibles en un clúster. A medida que los clientes solicitan nuevas conexiones al punto de conexión del lector, Amazon DocumentDB distribuye las solicitudes de conexión entre las réplicas de Amazon DocumentDB del clúster. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de Amazon DocumentDB del clúster.   
Si se produce una conmutación por error y la réplica de Amazon DocumentDB a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de Amazon DocumentDB del clúster, puede volver a conectarse al punto de conexión del lector.  
Tipo: cadena  
Requerido: no

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
Contiene uno o más identificadores de los clústeres secundarios asociados a este clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** ReplicationSourceIdentifier **   
Contiene el identificador del clúster de origen si este clúster es secundario.  
Tipo: cadena  
Requerido: no

 ** ServerlessV2ScalingConfiguration **   
La configuración de escalado de un clúster de Amazon DocumentDB sin servidor.  
Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)  
Obligatorio: no

 ** Status **   
Especifica el estado actual de este clúster de base de datos.  
Tipo: cadena  
Requerido: no

 ** StorageEncrypted **   
Especifica si el clúster está cifrado.  
Tipo: Booleano  
Obligatorio: no

 ** StorageType **   
Tipo de almacenamiento asociado al clúster  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Tipo: cadena  
Requerido: no

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Una lista de grupos de seguridad de la nube privada virtual (VPC) a las que pertenece el clúster.  
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obligatorio: no

## Véase también
<a name="API_DBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) 

# DBClusterMember
<a name="API_DBClusterMember"></a>

Contiene información sobre una instancia que forma parte de un clúster de base de datos.

## Contenido
<a name="API_DBClusterMember_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBClusterParameterGroupStatus **   
Especifica el estado del grupo de parámetros de clúster de base de datos para este miembro del clúster de base de datos.  
Tipo: cadena  
Requerido: no

 ** DBInstanceIdentifier **   
Especifica el identificador de la instancia de este miembro del clúster.  
Tipo: cadena  
Requerido: no

 ** IsClusterWriter **   
El valor que es `true` si el miembro del clúster es la instancia principal del clúster de base de datos y `false` en caso contrario.  
Tipo: Booleano  
Obligatorio: no

 ** PromotionTier **   
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.   
Tipo: entero  
Obligatorio: no

## Véase también
<a name="API_DBClusterMember_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) 

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

Información detallada sobre un grupo de parámetros de clúster. 

## Contenido
<a name="API_DBClusterParameterGroup_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBClusterParameterGroupArn **   
El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster.  
Tipo: cadena  
Requerido: no

 ** DBClusterParameterGroupName **   
Proporciona el nombre del grupo de parámetros de clúster.  
Tipo: cadena  
Requerido: no

 ** DBParameterGroupFamily **   
Proporciona el nombre de la familia del grupo de parámetros con el que este grupo de parámetros de clúster es compatible.  
Tipo: cadena  
Requerido: no

 ** Description **   
Proporciona la descripción especificada por el usuario para este grupo de parámetros de clúster.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBClusterParameterGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) 

# DBClusterRole
<a name="API_DBClusterRole"></a>

Describe un rol de AWS Identity and Access Management (IAM)que está asociado con un clúster de base de datos.

## Contenido
<a name="API_DBClusterRole_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** RoleArn **   
El Nombre de recurso de Amazon (ARN) del rol de IAM asociado al clúster de base de datos.  
Tipo: cadena  
Requerido: no

 ** Status **   
Describe el estado de asociación entre el rol de IAM y el clúster. La propiedad del `Status` devuelve uno de los siguientes valores:  
+  `ACTIVE`: el ARN del rol de IAM se asocia con el clúster de base de datos y se puede utilizar para obtener acceso a otros servicios de AWS en su nombre.
+  `PENDING`: el ARN del rol de IAM se está asociando al clúster.
+  `INVALID`: el ARN del rol de IAM se asocia con el clúster, pero el clúster no puede asumir el rol de IAM para acceder a otros servicios de AWS en su nombre.
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBClusterRole_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) 

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

Información detallada sobre una instantánea de un clúster. 

## Contenido
<a name="API_DBClusterSnapshot_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AvailabilityZones.AvailabilityZone.N **   
Proporciona la lista de zonas de disponibilidad del EC2 de Amazon donde se pueden restaurar las instancias de la instantánea del clúster.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** ClusterCreateTime **   
Especifica la hora a la que se creó el clúster, en tiempo universal coordinado (UTC).  
Tipo: marca temporal  
Obligatorio: no

 ** DBClusterIdentifier **   
Especifica el identificador del clúster, del clúster a partir del cual se creó esta instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** DBClusterSnapshotArn **   
El Nombre de recurso de Amazon (ARN) de la instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** DBClusterSnapshotIdentifier **   
Especifica el identificador de la instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** Engine **   
Especifica el nombre del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Proporciona la versión del motor de base de datos para esta instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** KmsKeyId **   
Si `StorageEncrypted` es `true`, el identificador de la clave de AWS KMS para la instantánea del clúster de base de datos cifrada.  
Tipo: cadena  
Requerido: no

 ** MasterUsername **   
Proporciona el nombre de usuario maestro para la instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** PercentProgress **   
Especifica el porcentaje de la estimación de los datos que se han transferido.  
Tipo: entero  
Obligatorio: no

 ** Port **   
Especifica el puerto que el clúster estaba escuchando en el momento de la instantánea.  
Tipo: entero  
Obligatorio: no

 ** SnapshotCreateTime **   
Proporciona la hora a la que se tomó la instantánea, en UTC.  
Tipo: marca temporal  
Obligatorio: no

 ** SnapshotType **   
Proporciona el tipo de instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** SourceDBClusterSnapshotArn **   
Si la instantánea del clúster se ha copiado de una instantánea de clúster de origen, el ARN para la instantánea del clúster de origen; de lo contrario, es un valor nulo.  
Tipo: cadena  
Requerido: no

 ** Status **   
Especifica el estado de esta instantánea del clúster.  
Tipo: cadena  
Requerido: no

 ** StorageEncrypted **   
Especifica si la instantánea del clúster está cifrada.  
Tipo: Booleano  
Obligatorio: no

 ** StorageType **   
Tipo de almacenamiento asociado a la instantánea del clúster  
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.  
Valores válidos para el tipo de almacenamiento: `standard | iopt1`   
El valor predeterminado es `standard `   
Tipo: cadena  
Requerido: no

 ** VpcId **   
Otorga el ID de la nube privada virtual (VPC) asociado a la instantánea del clúster.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) 

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

Contiene el nombre y los valores de un atributo de instantánea del clúster manual.

Los atributos de la instantánea del clúster manual se utilizan para autorizar a otras Cuentas de AWS la restauración de una instantánea de clúster manual.

## Contenido
<a name="API_DBClusterSnapshotAttribute_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AttributeName **   
El nombre del atributo de la instantánea del clúster manual.  
El atributo llamado `restore` se refiere a la lista de Cuentas de AWS que tienen permiso para copiar o restaurar la instantánea del clúster manual.  
Tipo: cadena  
Requerido: no

 ** AttributeValues.AttributeValue.N **   
Los valores del atributo de la instantánea del clúster manual.  
Si el campo `AttributeName` se establece en `restore`, este elemento devuelve una lista de ID de Cuentas de AWS con autorización para copiar o restaurar la instantánea del clúster manual. Si el valor de `all` está en la lista, la instantánea del clúster manual es pública y está disponible para cualquier Cuenta de AWS para su copia o restauración.  
Tipo: matriz de cadenas  
Obligatorio: no

## Véase también
<a name="API_DBClusterSnapshotAttribute_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) 

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

Información detallada sobre los atributos asociados a una instantánea de clúster.

## Contenido
<a name="API_DBClusterSnapshotAttributesResult_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
La lista de atributos y valores para la instantánea del clúster.  
Tipo: matriz de objetos [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)  
Obligatorio: no

 ** DBClusterSnapshotIdentifier **   
El identificador de la instantánea del clúster al que se aplican los atributos.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBClusterSnapshotAttributesResult_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 Información detallada sobre la versión de un motor. 

## Contenido
<a name="API_DBEngineVersion_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBEngineDescription **   
La descripción del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** DBEngineVersionDescription **   
La descripción de la versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** DBParameterGroupFamily **   
El nombre de la familia de grupos de parámetros para el motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** Engine **   
El nombre del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Número de versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** ExportableLogTypes.member.N **   
Los tipos de registros que el motor de base de datos tiene disponibles para la exportación a Registros de Amazon CloudWatch.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** ServerlessV2FeaturesSupport **   
Especifica cualquier propiedad o límite de Amazon DocumentDB sin servidor que difiera entre las versiones del motor de Amazon DocumentDB. Puede probar los valores de este atributo cuando decide qué versión de Amazon DocumentDB va a utilizar en un clúster nuevo o actualizado. También puede recuperar la versión de un clúster existente y comprobar si esa versión admite determinadas características de Amazon DocumentDB sin servidor antes de intentar utilizarlas.  
Tipo: objeto [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)  
Obligatorio: no

 ** SupportedCACertificateIdentifiers.member.N **   
Una lista de los identificadores de certificados de CA compatibles.  
Para obtener más información, consulte [Cómo actualizar los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [Cómo cifrar datos en tránsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) en la *Guía para desarrolladores de Amazon DocumentDB*.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** SupportsCertificateRotationWithoutRestart **   
Indica si la versión del motor admite la rotación del certificado del servidor sin reiniciar la instancia de la base de datos.  
Tipo: Booleano  
Obligatorio: no

 ** SupportsLogExportsToCloudwatchLogs **   
Un valor que indica si la versión del motor admite la exportación de los tipos de registro especificados por `ExportableLogTypes` a CloudWatch Logs.  
Tipo: Booleano  
Obligatorio: no

 ** ValidUpgradeTarget.UpgradeTarget.N **   
Una lista de versiones de motor a la que esta versión del motor de base de datos se puede actualizar.  
Tipo: matriz de objetos [UpgradeTarget](API_UpgradeTarget.md)  
Obligatorio: no

## Véase también
<a name="API_DBEngineVersion_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) 

# DBInstance
<a name="API_DBInstance"></a>

Información detallada sobre una instancia. 

## Contenido
<a name="API_DBInstance_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AutoMinorVersionUpgrade **   
No se aplica. Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.  
Tipo: Booleano  
Obligatorio: no

 ** AvailabilityZone **   
Especifica el nombre de la Zona de Disponibilidad en la que se encuentra la instancia.  
Tipo: cadena  
Requerido: no

 ** BackupRetentionPeriod **   
Especifica el número de días durante los que se retienen las instantáneas automáticas.  
Tipo: entero  
Obligatorio: no

 ** CACertificateIdentifier **   
El identificador del certificado de CA para esta instancia de base de datos.  
Tipo: cadena  
Requerido: no

 ** CertificateDetails **   
Los detalles del certificado de servidor de la instancia de base de datos.  
Tipo: objeto [CertificateDetails](API_CertificateDetails.md)  
Obligatorio: no

 ** CopyTagsToSnapshot **   
Es un valor que indica si se deben copiar las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.  
Tipo: Booleano  
Obligatorio: no

 ** DBClusterIdentifier **   
Contiene el nombre del clúster al que pertenece la instancia si ésta es miembro de un clúster.  
Tipo: cadena  
Requerido: no

 ** DBInstanceArn **   
El nombre de recurso de Amazon (ARN) de la instancia.  
Tipo: cadena  
Requerido: no

 ** DBInstanceClass **   
Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia.  
Tipo: cadena  
Requerido: no

 ** DBInstanceIdentifier **   
Contiene un identificador de base de datos proporcionado por el usuario. Este identificador es la clave única que identifica una instancia.  
Tipo: cadena  
Requerido: no

 ** DBInstanceStatus **   
Especifica el estado actual de esta base de datos.  
Tipo: cadena  
Requerido: no

 ** DbiResourceId **   
El identificador inmutable único de la Región de AWS para la instancia. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS para la instancia.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroup **   
Especifica información sobre el grupo de subred asociado a la instancia, incluido el nombre, la descripción y subredes en el grupo de subred.  
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)  
Obligatorio: no

 ** EnabledCloudwatchLogsExports.member.N **   
Una lista de tipos de registro para los que esta instancia está configurada para exportar a CloudWatch Logs.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** Endpoint **   
Especifica el punto de conexión.  
Tipo: objeto [Endpoint](API_Endpoint.md)  
Obligatorio: no

 ** Engine **   
Proporciona el nombre del motor de base de datos que se va a usar para esta instancia.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Indica la versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** InstanceCreateTime **   
Proporciona la fecha y hora en que se creó la instancia.  
Tipo: marca temporal  
Obligatorio: no

 ** KmsKeyId **   
 Si `StorageEncrypted` es `true`, el identificador de clave AWS KMS para la instancia encriptada.   
Tipo: cadena  
Requerido: no

 ** LatestRestorableTime **   
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.  
Tipo: marca temporal  
Obligatorio: no

 ** PendingModifiedValues **   
Especifica que los cambios a la instancia están pendientes. Este elemento solo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.  
Tipo: objeto [PendingModifiedValues](API_PendingModifiedValues.md)  
Obligatorio: no

 ** PerformanceInsightsEnabled **   
Establézcalo en `true` si la Información de rendimiento de Amazon RDS está habilitada para la instancia de base de datos; de lo contrario, el valor es `false`.  
Tipo: Booleano  
Obligatorio: no

 ** PerformanceInsightsKMSKeyId **   
El identificador de la clave de AWS KMS para el cifrado de datos de Performance Insights. El ID de clave de AWS KMS es el nombre de recurso de Amazon (ARN), el identificador de clave de AWS KMS o el alias de clave de AWS KMS de la clave de cifrado de AWS KMS.  
Tipo: cadena  
Requerido: no

 ** PreferredBackupWindow **   
 Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad `BackupRetentionPeriod`.   
Tipo: cadena  
Requerido: no

 ** PreferredMaintenanceWindow **   
Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).  
Tipo: cadena  
Requerido: no

 ** PromotionTier **   
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.  
Tipo: entero  
Obligatorio: no

 ** PubliclyAccessible **   
No admitido. Actualmente, Amazon DocumentDB no admite puntos de conexión públicos. El valor de `PubliclyAccessible` es siempre `false`.  
Tipo: Booleano  
Obligatorio: no

 ** StatusInfos.DBInstanceStatusInfo.N **   
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.  
Tipo: matriz de objetos [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)  
Obligatorio: no

 ** StorageEncrypted **   
Especifica si la instancia está encriptada o no.  
Tipo: Booleano  
Obligatorio: no

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia.  
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obligatorio: no

## Véase también
<a name="API_DBInstance_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) 

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

Proporciona una lista de información de estado para una instancia.

## Contenido
<a name="API_DBInstanceStatusInfo_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Message **   
Detalles del error si hay un error para la instancia. Si la instancia no se encuentra en un estado de error, este valor aparece en blanco.  
Tipo: cadena  
Requerido: no

 ** Normal **   
Un valor booleano que es `true` si la instancia funciona con normalidad o `false` si la instancia se encuentra en un estado de error.  
Tipo: Booleano  
Obligatorio: no

 ** Status **   
Estado de la instancia. Para una réplica `StatusType` de lectura, los valores pueden ser `replicating`, error, `stopped` o `terminated`.  
Tipo: cadena  
Requerido: no

 ** StatusType **   
Actualmente, este valor es “`read replication`”.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBInstanceStatusInfo_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) 

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

Información detallada sobre un grupo de subredes. 

## Contenido
<a name="API_DBSubnetGroup_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBSubnetGroupArn **   
El Nombre de recurso de Amazon (ARN) para el grupo de subred de base de datos.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroupDescription **   
Proporciona la descripción del grupo de subred.  
Tipo: cadena  
Requerido: no

 ** DBSubnetGroupName **   
El nombre del grupo de subred.  
Tipo: cadena  
Requerido: no

 ** SubnetGroupStatus **   
Proporciona el estado del grupo de subred.  
Tipo: cadena  
Requerido: no

 ** Subnets.Subnet.N **   
Información detallada sobre una o varias subredes dentro de un grupo de subredes.  
Tipo: matriz de objetos [Subnet](API_Subnet.md)  
Obligatorio: no

 ** SupportedNetworkTypes.member.N **   
El tipo de red del grupo de subredes de base de datos.  
Valores válidos: `IPV4` \$1 `DUAL`   
Un `DBSubnetGroup` admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (DOBLE).  
Tipo: matriz de cadenas  
Obligatorio: no

 ** VpcId **   
Proporciona el ID de la nube privada virtual (VPC) del grupo de subredes.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_DBSubnetGroup_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) 

# Endpoint
<a name="API_Endpoint"></a>

Información de red para acceder a un clúster o a una instancia. Los programas cliente deben especificar un punto de conexión válido para acceder a estos recursos de Amazon DocumentDB.

## Contenido
<a name="API_Endpoint_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Address **   
Especifica la dirección DNS de la instancia.  
Tipo: cadena  
Requerido: no

 ** HostedZoneId **   
Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.  
Tipo: cadena  
Requerido: no

 ** Port **   
Especifica el puerto en el que escucha el motor de la base de datos.  
Tipo: entero  
Obligatorio: no

## Véase también
<a name="API_Endpoint_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) 

# EngineDefaults
<a name="API_EngineDefaults"></a>

Contiene el resultado de una invocación correcta de la operación `DescribeEngineDefaultClusterParameters`. 

## Contenido
<a name="API_EngineDefaults_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBParameterGroupFamily **   
El nombre de la familia del grupo de parámetros de clúster para la que devolver información de los parámetros del motor.  
Tipo: cadena  
Requerido: no

 ** Marker **   
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.  
Tipo: cadena  
Requerido: no

 ** Parameters.Parameter.N **   
Los parámetros de una familia de grupos de parámetros de clúster concreta.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obligatorio: no

## Véase también
<a name="API_EngineDefaults_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) 

# Event
<a name="API_Event"></a>

Información detallada sobre un evento.

## Contenido
<a name="API_Event_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Date **   
Especifica la fecha y la hora del evento.  
Tipo: marca temporal  
Obligatorio: no

 ** EventCategories.EventCategory.N **   
Especifica la categoría para el evento.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** Message **   
Proporciona el texto de este evento.  
Tipo: cadena  
Requerido: no

 ** SourceArn **   
El Nombre de recurso de Amazon (ARN) para el evento.  
Tipo: cadena  
Requerido: no

 ** SourceIdentifier **   
Proporciona el identificador del origen del evento.  
Tipo: cadena  
Requerido: no

 ** SourceType **   
Especifica el tipo de origen para este evento.  
Tipo: cadena  
Valores válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obligatorio: no

## Véase también
<a name="API_Event_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) 

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

Un tipo de fuente de eventos, acompañado de uno o más nombres de categorías de eventos.

## Contenido
<a name="API_EventCategoriesMap_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** EventCategories.EventCategory.N **   
Las categorías de eventos para el tipo de origen especificado.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** SourceType **   
El tipo de origen al que pertenecen las categorías devueltas.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_EventCategoriesMap_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) 

# EventSubscription
<a name="API_EventSubscription"></a>

Información detallada sobre un evento al que se ha suscrito.

## Contenido
<a name="API_EventSubscription_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** CustomerAwsId **   
La cuenta de cliente de AWS asociada a la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

 ** CustSubscriptionId **   
El ID de la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

 ** Enabled **   
Un valor booleano que indica si la suscripción está habilitada. Un valor de `true` indica que se ha activado la suscripción.  
Tipo: Booleano  
Obligatorio: no

 ** EventCategoriesList.EventCategory.N **   
Una lista de categorías de eventos para la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** EventSubscriptionArn **   
El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.  
Tipo: cadena  
Requerido: no

 ** SnsTopicArn **   
El ARN del tema de la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

 ** SourceIdsList.SourceId.N **   
Una lista de ID de origen para la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** SourceType **   
El tipo de origen para la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

 ** Status **   
El estado de la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Restricciones:  
Puede ser uno de los siguientes: `creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist`   
El estado `no-permission` indica que Amazon DocumentDB ya no tiene permiso para publicar en el tema de SNS. El estado `topic-not-exist` indica que el tema se eliminó después de crear la suscripción.  
Tipo: cadena  
Requerido: no

 ** SubscriptionCreationTime **   
La hora a la que se creó la suscripción a notificaciones de eventos de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_EventSubscription_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) 

# FailoverState
<a name="API_FailoverState"></a>

Contiene el estado de las operaciones programadas o en proceso en un clúster global de Amazon DocumentDB. Este tipo de datos está vacío a menos que se haya programado o esté en curso una operación de conmutación o conmutación por error en el clúster global.

## Contenido
<a name="API_FailoverState_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** FromDbClusterArn **   
El nombre de recurso de Amazon (ARN) del clúster de Amazon DocumentDB que se está degradando actualmente y que está asociado a este estado.  
Tipo: cadena  
Requerido: no

 ** IsDataLossAllowed **   
Indica si la operación es una conmutación global o una conmutación por error global. Si se permite la pérdida de datos, la operación es una conmutación por error global. De lo contrario, se trata de una conmutación.  
Tipo: Booleano  
Obligatorio: no

 ** Status **   
El estado actual del clúster global. Los valores posibles son los siguientes:  
+  **pendiente**: el servicio recibió una solicitud de conmutación o conmutación por error del clúster global. El clúster principal del clúster global y el clúster secundario especificado se están verificando antes de que comience la operación.
+  **conmutación por error**: el clúster secundario elegido pasa a ser el nuevo clúster principal para realizar la conmutación por error del clúster global.
+  **cancelación: se canceló** la solicitud de conmutación o conmutación por error del clúster global y el clúster principal y el clúster secundario seleccionado vuelven a sus estados anteriores.
Tipo: cadena  
Valores válidos: `pending | failing-over | cancelling`   
Obligatorio: no

 ** ToDbClusterArn **   
El nombre de recurso de Amazon (ARN) del clúster de Amazon DocumentDB que se está promocionando actualmente y que está asociado a este estado.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_FailoverState_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) 

# Filter
<a name="API_Filter"></a>

Un conjunto de valores de filtro con nombre, que se utiliza para devolver una lista de resultados más específica. Puede usar un filtro que coincida con un conjunto de recursos según criterios específicos, como los ID.

No se admite el uso de comodines en los filtros.

## Contenido
<a name="API_Filter_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Name **   
El nombre del filtro. Los nombres de filtros distinguen entre mayúsculas y minúsculas.  
Tipo: cadena  
Obligatorio: sí

 ** Values.Value.N **   
Uno o varios valores de filtros. Los valores de filtro distinguen entre mayúsculas y minúsculas.  
Tipo: matriz de cadenas  
Obligatorio: sí

## Véase también
<a name="API_Filter_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) 

# GlobalCluster
<a name="API_GlobalCluster"></a>

Tipo de datos que representa un clúster global de Amazon DocumentDB.

## Contenido
<a name="API_GlobalCluster_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DatabaseName **   
El nombre predeterminado de la base de datos del nuevo clúster global.  
Tipo: cadena  
Requerido: no

 ** DeletionProtection **   
La configuración de protección contra eliminación para el nuevo clúster global.  
Tipo: Booleano  
Obligatorio: no

 ** Engine **   
El motor de base de datos Amazon DocumentDB utilizado por el clúster global.   
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Indica la versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** FailoverState **   
Objeto de datos que contiene todas las propiedades del estado actual de un proceso de conmutación o conmutación por error en curso o pendiente para este clúster global. Este objeto está vacío a menos que se haya llamado a la `FailoverGlobalCluster` operación `SwitchoverGlobalCluster` o en este clúster global.  
Tipo: objeto [FailoverState](API_FailoverState.md)  
Obligatorio: no

 ** GlobalClusterArn **   
El Nombre de recurso de Amazon (ARN) para el clúster global.  
Tipo: cadena  
Requerido: no

 ** GlobalClusterIdentifier **   
Contiene un identificador de clúster global suministrado por el usuario. Este identificador es la clave única que identifica un clúster global.   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.  
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatorio: no

 ** GlobalClusterMembers.GlobalClusterMember.N **   
La lista de clústeres IDs para los clústeres secundarios del clúster global. Actualmente está limitada a un elemento.   
Tipo: matriz de objetos [GlobalClusterMember](API_GlobalClusterMember.md)  
Obligatorio: no

 ** GlobalClusterResourceId **   
El identificador inmutable Región de AWS y único de la región para el clúster de bases de datos global. Este identificador se encuentra en las entradas de AWS CloudTrail registro siempre que se accede a la clave maestra AWS KMS del cliente (CMK) del clúster.   
Tipo: cadena  
Requerido: no

 ** Status **   
Especifica el estado actual de este clúster global.  
Tipo: cadena  
Requerido: no

 ** StorageEncrypted **   
Configuración de cifrado de almacenamiento para el clúster global.  
Tipo: Booleano  
Obligatorio: no

 ** TagList.Tag.N **   
Una lista de etiquetas de clúster globales.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obligatorio: no

## Véase también
<a name="API_GlobalCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) 

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

Estructura de datos con información sobre cualquier clúster primario y secundario asociado a un clúster global de Amazon DocumentDB. 

## Contenido
<a name="API_GlobalClusterMember_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** DBClusterArn **   
El Nombre de recurso de Amazon (ARN) para cada clúster de Amazon DocumentDB.  
Tipo: cadena  
Requerido: no

 ** IsWriter **   
 Especifica si el clúster de Amazon DocumentDB es el clúster primario (es decir, tiene capacidad de lectura y escritura) para el clúster global de Amazon DocumentDB al que está asociado.   
Tipo: Booleano  
Obligatorio: no

 ** Readers.member.N **   
El Nombre de recurso de Amazon (ARN) para cada clúster secundario de solo lectura asociado al clúster global de Amazon DocumentDB.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** SynchronizationStatus **   
El estado de sincronización de cada clúster de Amazon DocumentDB del clúster global.  
Tipo: cadena  
Valores válidos: `connected | pending-resync`   
Obligatorio: no

## Véase también
<a name="API_GlobalClusterMember_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) 

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

Las opciones disponibles para una instancia.

## Contenido
<a name="API_OrderableDBInstanceOption_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AvailabilityZones.AvailabilityZone.N **   
Una lista de zonas de disponibilidad para una instancia.  
Tipo: matriz de objetos [AvailabilityZone](API_AvailabilityZone.md)  
Obligatorio: no

 ** DBInstanceClass **   
La clase de instancia de una instancia.  
Tipo: cadena  
Requerido: no

 ** Engine **   
El tipo de motor de una instancia.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
La versión de motor de una instancia.  
Tipo: cadena  
Requerido: no

 ** LicenseModel **   
El modelo de licencia de una instancia.  
Tipo: cadena  
Requerido: no

 ** StorageType **   
El tipo de almacenamiento que se va a asociar al clúster de base de datos  
Tipo: cadena  
Requerido: no

 ** Vpc **   
Indica si una instancia es una nube privada virtual (VPC).  
Tipo: Booleano  
Obligatorio: no

## Véase también
<a name="API_OrderableDBInstanceOption_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) 

# Parameter
<a name="API_Parameter"></a>

Información detallada sobre un parámetro individual.

## Contenido
<a name="API_Parameter_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AllowedValues **   
Especifica el rango de valores válido del parámetro.  
Tipo: cadena  
Requerido: no

 ** ApplyMethod **   
Indica cuándo deben aplicarse actualizaciones de parámetros.  
Tipo: cadena  
Valores válidos: `immediate | pending-reboot`   
Obligatorio: no

 ** ApplyType **   
Especifica el tipo de parámetros específicos del motor.  
Tipo: cadena  
Requerido: no

 ** DataType **   
Especifica el tipo de datos válidos para el parámetro.  
Tipo: cadena  
Requerido: no

 ** Description **   
Proporciona una descripción del parámetro.  
Tipo: cadena  
Requerido: no

 ** IsModifiable **   
 Indica si el parámetro se puede modificar (`true`) o no (`false`). Algunos parámetros tienen implicaciones de seguridad u operativas que impiden que puedan cambiarse.   
Tipo: Booleano  
Obligatorio: no

 ** MinimumEngineVersion **   
La versión del motor más antigua al que se puede aplicar el parámetro.  
Tipo: cadena  
Requerido: no

 ** ParameterName **   
Especifica el nombre del parámetro.  
Tipo: cadena  
Requerido: no

 ** ParameterValue **   
Especifica el valor del parámetro. Debe ser uno o más de los `AllowedValues` para los parámetros del clúster en formato CSV:  
Los valores válidos son:  
+  `enabled`: el clúster acepta conexiones seguras mediante TLS, versión 1.0 a 1.3. 
+  `disabled`: el clúster no acepta conexiones seguras mediante TLS. 
+  `fips-140-3`: el clúster solo acepta conexiones seguras según los requisitos de la publicación 140-3 de las Normas Federales de Procesamiento de la Información (FIPS). Esto solamente se admite a partir de los clústeres de Amazon DocumentDB 5.0 (versión del motor 3.0.3727) en las siguientes regiones: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
+  `tls1.2+`: el clúster acepta conexiones seguras mediante TLS, versión 1.2 y superiores. Solo se admite a partir de Amazon DocumentDB 4.0 (versión de motor 2.0.10980) y Amazon DocumentDB 5.0 (versión de motor 3.0.11051).
+  `tls1.3+`: el clúster acepta conexiones seguras mediante TLS, versión 1.3 y superiores. Solo se admite a partir de Amazon DocumentDB 4.0 (versión de motor 2.0.10980) y Amazon DocumentDB 5.0 (versión de motor 3.0.11051).
Tipo: cadena  
Requerido: no

 ** Source **   
Indica el origen del valor del parámetro.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_Parameter_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) 

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

Una lista de los tipos de registro cuya configuración sigue pendiente. Estos tipos de registro están en proceso de activación o desactivación.

## Contenido
<a name="API_PendingCloudwatchLogsExports_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** LogTypesToDisable.member.N **   
Tipos de registro que están en proceso de habilitarse. Una vez habilitados, estos tipos de logs se exportan a Registros de Amazon CloudWatch.  
Tipo: matriz de cadenas  
Obligatorio: no

 ** LogTypesToEnable.member.N **   
Tipos de registro que están en proceso de desactivación. Una vez desactivados, estos tipos de registro no se exportan a CloudWatch Logs.  
Tipo: matriz de cadenas  
Obligatorio: no

## Véase también
<a name="API_PendingCloudwatchLogsExports_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) 

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.

## Contenido
<a name="API_PendingMaintenanceAction_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Action **   
El tipo de acción de mantenimiento pendiente disponible para el recurso.  
Tipo: cadena  
Requerido: no

 ** AutoAppliedAfterDate **   
La fecha del periodo de mantenimiento cuando se aplica la acción. La acción de mantenimiento se aplica al recurso durante su primer periodo de mantenimiento después de esta fecha. Si se especifica esta fecha, se omite cualquier solicitud de alta `next-maintenance`.  
Tipo: marca temporal  
Obligatorio: no

 ** CurrentApplyDate **   
La fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso.  
Tipo: marca temporal  
Obligatorio: no

 ** Description **   
Una descripción que proporciona información más detallada sobre la acción de mantenimiento.  
Tipo: cadena  
Requerido: no

 ** ForcedApplyDate **   
La fecha en que se aplica automáticamente la acción de mantenimiento. La acción de mantenimiento se aplica al recurso en esta fecha independientemente del periodo de mantenimiento para el recurso. Si se especifica esta fecha, se omite cualquier solicitud de alta `immediate`.  
Tipo: marca temporal  
Obligatorio: no

 ** OptInStatus **   
Indica el tipo de solicitud de alta que se ha recibido para el recurso.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_PendingMaintenanceAction_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK de para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) 

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 Uno o más ajustes modificados para una instancia. Estos ajustes modificados se han solicitado, pero aún no se han aplicado.

## Contenido
<a name="API_PendingModifiedValues_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AllocatedStorage **   
 Contiene el tamaño nuevo de `AllocatedStorage` correspondiente a la instancia que se aplicará o que se está aplicando.   
Tipo: entero  
Obligatorio: no

 ** BackupRetentionPeriod **   
Especifica el número de días pendientes durante los que se conservan las copias de seguridad automatizadas.  
Tipo: entero  
Obligatorio: no

 ** CACertificateIdentifier **   
Especifica el identificador del certificado de CA para la instancia de base de datos.  
Tipo: cadena  
Requerido: no

 ** DBInstanceClass **   
 Contiene la nueva `DBInstanceClass` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.   
Tipo: cadena  
Requerido: no

 ** DBInstanceIdentifier **   
 Contiene la nueva `DBInstanceIdentifier` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.   
Tipo: cadena  
Requerido: no

 ** DBSubnetGroupName **   
El nuevo grupo de subredes de la instancia.   
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
Indica la versión del motor de base de datos.  
Tipo: cadena  
Requerido: no

 ** Iops **   
Especifica el nuevo valor de IOPS aprovisionadas correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.  
Tipo: entero  
Obligatorio: no

 ** LicenseModel **   
El modelo de licencia para la instancia.  
Valores válidos: `license-included`, `bring-your-own-license`, `general-public-license`   
Tipo: cadena  
Requerido: no

 ** MasterUserPassword **   
Contiene el cambio pendiente o actualmente en curso de las credenciales maestras para la instancia.  
Tipo: cadena  
Requerido: no

 ** MultiAZ **   
Indica que la instancia Single-AZ va a cambiar a una implementación Multi-AZ.  
Tipo: Booleano  
Obligatorio: no

 ** PendingCloudwatchLogsExports **   
Una lista de los tipos de registro cuya configuración sigue pendiente. Estos tipos de registro están en proceso de activación o desactivación.  
Tipo: objeto [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)  
Obligatorio: no

 ** Port **   
Especifica el puerto pendiente para la instancia.  
Tipo: entero  
Obligatorio: no

 ** StorageType **   
Especifica el tipo de almacenamiento que se va a asociar con la instancia.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_PendingModifiedValues_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) 

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

Representa la salida de [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md). 

## Contenido
<a name="API_ResourcePendingMaintenanceActions_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.  
Tipo: matriz de objetos [PendingMaintenanceAction](API_PendingMaintenanceAction.md)  
Obligatorio: no

 ** ResourceIdentifier **   
El Nombre de recurso de Amazon (ARN) del recurso que tiene acciones de mantenimiento pendiente.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_ResourcePendingMaintenanceActions_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK de para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

Especifica cualquier propiedad o límite de Amazon DocumentDB sin servidor que difiera entre las versiones del motor de Amazon DocumentDB. Puede probar los valores de este atributo cuando decide qué versión de Amazon DocumentDB va a utilizar en un clúster nuevo o actualizado. También puede recuperar la versión de un clúster existente y comprobar si esa versión admite determinadas características de Amazon DocumentDB sin servidor antes de intentar utilizarlas.

## Contenido
<a name="API_ServerlessV2FeaturesSupport_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** MaxCapacity **   
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.  
Tipo: Doble  
Obligatorio: no

 ** MinCapacity **   
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.  
Tipo: Doble  
Obligatorio: no

## Véase también
<a name="API_ServerlessV2FeaturesSupport_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

Establece la configuración de escalado del clúster de Amazon DocumentDB sin servidor.

## Contenido
<a name="API_ServerlessV2ScalingConfiguration_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** MaxCapacity **   
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.  
Tipo: Doble  
Obligatorio: no

 ** MinCapacity **   
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.  
Tipo: Doble  
Obligatorio: no

## Véase también
<a name="API_ServerlessV2ScalingConfiguration_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

Recupera la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.

## Contenido
<a name="API_ServerlessV2ScalingConfigurationInfo_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** MaxCapacity **   
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.   
Tipo: Doble  
Obligatorio: no

 ** MinCapacity **   
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.  
Tipo: Doble  
Obligatorio: no

## Véase también
<a name="API_ServerlessV2ScalingConfigurationInfo_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 

# Subnet
<a name="API_Subnet"></a>

 Información detallada sobre una subred. 

## Contenido
<a name="API_Subnet_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** SubnetAvailabilityZone **   
Especifica la Zona de Disponibilidad para la subred.  
Tipo: objeto [AvailabilityZone](API_AvailabilityZone.md)  
Obligatorio: no

 ** SubnetIdentifier **   
Especifica el identificador de la subred.  
Tipo: cadena  
Requerido: no

 ** SubnetStatus **   
Especifica el estado de la subred.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_Subnet_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) 

# Tag
<a name="API_Tag"></a>

Metadatos asignados a un recurso de Amazon DocumentDB que consta de un par clave-valor.

## Contenido
<a name="API_Tag_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Key **   
El nombre obligatorio de la etiqueta. El valor de cadena puede tener una longitud de entre 1 y 128 caracteres Unicode y no puede llevar el prefijo “`aws:`“ ni “`rds:`“. La cadena puede contener únicamente el conjunto de letras, dígitos y espacio en blanco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”).  
Tipo: cadena  
Requerido: no

 ** Value **   
Valor de cadena opcional de la etiqueta. El valor de cadena puede tener una longitud de entre 1 y 256 caracteres Unicode y no puede llevar el prefijo “`aws:`“ ni “`rds:`“. La cadena puede contener únicamente el conjunto de letras, dígitos y espacio en blanco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”).  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_Tag_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) 

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

La versión del motor de base de datos a la que puede actualizarse una instancia.

## Contenido
<a name="API_UpgradeTarget_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** AutoUpgrade **   
Un valor que indica si la versión de destino se aplica a cualquier instancia de la base de datos de origen que se haya establecido `AutoMinorVersionUpgrade` en `true`.  
Tipo: Booleano  
Obligatorio: no

 ** Description **   
La versión del motor de base de datos a la que puede actualizarse una instancia.  
Tipo: cadena  
Requerido: no

 ** Engine **   
El nombre del motor de base de datos de destino de actualización.  
Tipo: cadena  
Requerido: no

 ** EngineVersion **   
El número de versión del motor de base de datos de destino de actualización.  
Tipo: cadena  
Requerido: no

 ** IsMajorVersionUpgrade **   
Un valor que indica si un motor de base de datos se actualiza a una versión principal.  
Tipo: Booleano  
Obligatorio: no

## Véase también
<a name="API_UpgradeTarget_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) 

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

Se utiliza como elemento de respuesta para consultas sobre la pertenencia a grupos de seguridad de la nube privada virtual (VPC).

## Contenido
<a name="API_VpcSecurityGroupMembership_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** Status **   
El estado del grupo de seguridad de VPC.  
Tipo: cadena  
Requerido: no

 ** VpcSecurityGroupId **   
El nombre del grupo de seguridad de VPC.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_VpcSecurityGroupMembership_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) 

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

Los siguientes tipos de datos son compatibles con los clústeres elásticos de Amazon DocumentDB:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Cluster
<a name="API_elastic_Cluster"></a>

Devuelve información sobre un clúster elástico específico.

## Contenido
<a name="API_elastic_Cluster_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
El nombre del administrador de los clústeres elásticos.  
Tipo: cadena  
Obligatorio: sí

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
El tipo de autenticación del clúster elástico.  
Tipo: cadena  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obligatorio: sí

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
El identificador ARN del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
La URL que se usa para conectarse al clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
El nombre del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
El identificador de clave de KMS que se debe utilizar para cifrar el clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
Tipo: cadena  
Obligatorio: sí

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
La cantidad de vCPU asignadas a cada partición de clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.  
Tipo: número entero  
Obligatorio: sí

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
El número de particiones asignadas al clúster elástico. El máximo es 32.  
Tipo: número entero  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
Estado del clúster elástico.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Los ID de subredes de Amazon EC2 para el clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
El número de días durante los que se conservan las instantáneas de base de datos automáticas.  
Tipo: entero  
Obligatorio: no

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina `backupRetentionPeriod`.  
Tipo: cadena  
Requerido: no

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
El número de instancias de réplica que se aplica a todas las particiones del clúster. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.  
Tipo: entero  
Obligatorio: no

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
El número total de particiones en el clúster.  
Tipo: matriz de objetos [Shard](API_elastic_Shard.md)  
Obligatorio: no

## Véase también
<a name="API_elastic_Cluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Lista de clústeres elásticos de Amazon DocumentDB.

## Contenido
<a name="API_elastic_ClusterInList_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterInList-clusterArn"></a>
El identificador ARN del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterName **   <a name="documentdb-Type-elastic_ClusterInList-clusterName"></a>
El nombre del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-status"></a>
Estado del clúster elástico.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

## Véase también
<a name="API_elastic_ClusterInList_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) 

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

Devuelve información sobre una instantánea específica del clúster elástico.

## Contenido
<a name="API_elastic_ClusterSnapshot_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
El nombre del administrador de los clústeres elásticos.  
Tipo: cadena  
Obligatorio: sí

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
El identificador ARN del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** kmsKeyId **   <a name="documentdb-Type-elastic_ClusterSnapshot-kmsKeyId"></a>
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS. Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.   
Tipo: cadena  
Obligatorio: sí

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
El identificador ARN de la instantánea del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
La hora a la que se creó la instantánea del clúster elástico en Tiempo Universal Coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
Nombre de la instantánea del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
Estado de la instantánea del clúster elástico.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

 ** subnetIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
Los ID de subredes de Amazon EC2 para el clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** snapshotType **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:  
+  `automated`: devuelve todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su cuenta de AWS.
+  `manual`: devuelve todas las instantáneas del clúster que haya creado manualmente para su cuenta de AWS.
Tipo: cadena  
Valores válidos: `MANUAL | AUTOMATED`   
Obligatorio: no

## Véase también
<a name="API_elastic_ClusterSnapshot_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

Lista de instantáneas de un clúster elástico.

## Contenido
<a name="API_elastic_ClusterSnapshotInList_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-clusterArn"></a>
El identificador ARN del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotArn"></a>
El identificador ARN de la instantánea del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotCreationTime"></a>
La hora a la que se creó la instantánea del clúster elástico en Tiempo Universal Coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotName"></a>
Nombre de la instantánea del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-status"></a>
Estado de la instantánea del clúster elástico.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

## Véase también
<a name="API_elastic_ClusterSnapshotInList_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) 

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

Recupera los detalles de las acciones de mantenimiento pendientes.

## Contenido
<a name="API_elastic_PendingMaintenanceActionDetails_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
Muestra la acción específica de una acción de mantenimiento pendiente.  
Tipo: cadena  
Obligatorio: sí

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
Muestra la fecha del período de mantenimiento cuando se aplica la acción. La acción de mantenimiento se aplica al recurso durante su primer periodo de mantenimiento después de esta fecha. Si se especifica esta fecha, se omite cualquier solicitud de `optInType` de `NEXT_MAINTENANCE`.  
Tipo: cadena  
Requerido: no

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
Muestra la fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso.  
Tipo: cadena  
Requerido: no

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
Muestra una descripción que proporciona información más detallada sobre la acción de mantenimiento.  
Tipo: cadena  
Requerido: no

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
Muestra la fecha en que se aplica automáticamente la acción de mantenimiento. La acción de mantenimiento se aplica al recurso en esta fecha independientemente del periodo de mantenimiento para el recurso. Si se especifica esta fecha, se omite cualquier solicitud de `optInType` de `IMMEDIATE`.  
Tipo: cadena  
Requerido: no

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
Muestra el tipo de solicitud de `optInType` que se ha recibido para el recurso.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_elastic_PendingMaintenanceActionDetails_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.

## Contenido
<a name="API_elastic_ResourcePendingMaintenanceAction_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.  
Tipo: matriz de objetos [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)  
Obligatorio: no

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
El Nombre de recurso de Amazon (ARN) Amazon DocumentDB del recurso al que se aplica la acción de mantenimiento pendiente.  
Tipo: cadena  
Requerido: no

## Véase también
<a name="API_elastic_ResourcePendingMaintenanceAction_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 

# Shard
<a name="API_elastic_Shard"></a>

El nombre de la partición.

## Contenido
<a name="API_elastic_Shard_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
La hora a la que se creó la partición, en tiempo universal coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
El ID de la partición.  
Tipo: cadena  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_Shard-status"></a>
El estado actual de la partición.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

## Véase también
<a name="API_elastic_Shard_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) 

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

Un campo específico en el que se produjo una excepción de validación determinada.

## Contenido
<a name="API_elastic_ValidationExceptionField_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
Un mensaje de error que describe la excepción de validación en este campo.  
Tipo: cadena  
Obligatorio: sí

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
El nombre del campo en el que se produjo la excepción de validación.  
Tipo: cadena  
Obligatorio: sí

## Véase también
<a name="API_elastic_ValidationExceptionField_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField) 

# Errores comunes
<a name="CommonErrors"></a>

En esta sección, se enumeran los errores comunes a las acciones de la API de todos los servicios de AWS. En el caso de los errores específicos de una acción de la API de este servicio, consulte el tema de dicha acción de la API.

 **AccessDeniedException**   
No tiene acceso suficiente para realizar esta acción.  
Código de estado HTTP: 400

 **IncompleteSignature**   
La firma de solicitud no se ajusta a los estándares de AWS.  
Código de estado HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
El procesamiento de la solicitud ha devuelto un error debido a un error o una excepción desconocidos.  
Código de estado HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
La acción u operación solicitada no es válida. Compruebe que la acción se ha escrito correctamente.  
Código de estado HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
El certificado X.509 o el ID de clave de acceso de AWS proporcionado no existen en nuestros registros.  
Código de estado HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
No tiene permiso para realizar esta acción.  
Código de estado HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
El ID de clave de acceso de AWS necesita una suscripción al servicio.  
Código de estado HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
La solicitud llegó al servicio más de 15 minutos después de la marca de fecha en la solicitud o más de 15 minutos después de la fecha de vencimiento de la solicitud (por ejemplo, para las URL prefirmadas) o la marca de fecha de la solicitud corresponde a una hora futura en más de 15 minutos.  
Código de estado HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.  
Código de estado HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
La solicitud fue denegada debido a una limitación de la solicitud.  
Código de estado HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
La entrada no satisface las limitaciones que especifica un servicio de AWS.  
Código de estado HTTP: 400

# Parámetros comunes
<a name="CommonParameters"></a>

La siguiente lista contiene los parámetros que utilizan todas las acciones para firmar solicitudes de Signature Version 4 con una cadena de consulta. Los parámetros específicos de acción se enumeran en el tema correspondiente a la acción. Para obtener más información sobre Signature Version 4, consulte [Firma de solicitudes API de AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) en la *Guía del usuario de IAM*.

 **Action**   <a name="CommonParameters-Action"></a>
Las acciones que se van a realizar.  
Tipo: cadena  
Obligatorio: sí

 **Version**   <a name="CommonParameters-Version"></a>
La versión de la API para la que está escrita la solicitud, expresada en el formato AAAA-MM-DD.  
Tipo: cadena  
Obligatorio: sí

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
El algoritmo de hash que utilizó para crear la solicitud de firma.  
Condición: especifique este parámetro cuando incluya información de autenticación en una cadena de consulta en lugar de en el encabezado de autorización HTTP.  
Tipo: cadena  
Valores válidos: `AWS4-HMAC-SHA256`   
Obligatorio: condicional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
El valor del ámbito de la credencial, que es una cadena que incluye la clave de acceso, la fecha, la región a la que se dirige, el servicio que solicita y una cadena de terminación (“aws4\$1request”). El valor se expresa en el siguiente formato: *access\$1key*/*AAAAMMDD*/*region*/*service*/aws4\$1request.  
Para obtener más información, consulte [Crear una solicitud API de AWS firmada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) en la *Guía del usuario de IAM*.  
Condición: especifique este parámetro cuando incluya información de autenticación en una cadena de consulta en lugar de en el encabezado de autorización HTTP.  
Tipo: cadena  
Obligatorio: condicional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
La fecha utilizada para crear la firma. El formato debe ser ISO 8601 formato básico (AAAAMMDD‘T’HHMMSS‘Z’). Por ejemplo, la siguiente fecha y hora es un valor válido de X-Amz-Date para `20120325T120000Z`.  
Condición: X-Amz-Date es opcional en todas las solicitudes; se puede utilizar para anular la fecha empleada a fin de firmar las solicitudes. Si el encabezado Date se especifica en el formato básico ISO 8601, no se requiere X-Amz-Date. Cuando se usa X-Amz-Date, siempre anula el valor del encabezado Date. Para obtener más información, consulte [Elementos de una firma de solicitud API de AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) en la *Guía del usuario de IAM*.  
Tipo: cadena  
Obligatorio: condicional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
El token de seguridad temporal que se obtuvo mediante una llamada a AWS Security Token Service (AWS STS). Para obtener una lista de servicios compatibles con las credenciales de seguridad temporales de AWS STS, consulte [Servicios de AWS que funcionan con IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) en la *Guía del usuario de IAM*.  
Condición: si utiliza credenciales de seguridad temporales de AWS STS, debe incluir el token de seguridad.  
Tipo: cadena  
Obligatorio: condicional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Especifica la firma codificada hexadecimal que se calculó a partir de la cadena que se va a firmar y la clave de firma derivada.  
Condición: especifique este parámetro cuando incluya información de autenticación en una cadena de consulta en lugar de en el encabezado de autorización HTTP.  
Tipo: cadena  
Obligatorio: condicional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Especifica todos los encabezados HTTP que se incluyeron como parte de la solicitud canónica. Para obtener más información acerca de especificar encabezados firmados, consulte [Crear una solicitud API de AWS firmada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) en la *Guía del usuario de IAM*.  
Condición: especifique este parámetro cuando incluya información de autenticación en una cadena de consulta en lugar de en el encabezado de autorización HTTP.  
Tipo: cadena  
Obligatorio: condicional