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.

# 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)