Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

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

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

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

Il tipo di azione di manutenzione in sospeso da applicare alla risorsa.

## Sintassi della richiesta
<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"
}
```

## Parametri della richiesta URI:
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

La richiesta non utilizza parametri URI.

## Corpo della richiesta
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
L'azione di manutenzione in sospeso da applicare alla risorsa.  
Le operazioni valide sono:  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Obbligatorio: sì

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Un valore che specifica il tipo di richiesta di consenso esplicito o ne annulla una. Una richiesta di consenso esplicito di tipo `IMMEDIATE` non può essere annullata.  
Tipo: String  
Valori validi: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Obbligatorio: sì

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
Amazon DocumentDB Amazon Resource Name (ARN) della risorsa a cui si applica l'azione di manutenzione in sospeso.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Obbligatorio: sì

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Una data specifica per applicare l'azione di manutenzione in sospeso. Necessario se opt-in-type è `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Obbligatorio: no

## Sintassi della risposta
<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"
   }
}
```

## Elementi di risposta
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
L'output dell'azione di manutenzione in sospeso applicata.  
Tipo: oggetto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

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

Copia un'istantanea di un cluster elastico.

## Sintassi della richiesta
<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"
}
```

## Parametri della richiesta URI
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
L'identificatore Amazon Resource Name (ARN) dello snapshot del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
L'identificatore del nuovo snapshot del cluster elastico da creare a partire dallo snapshot del cluster di origine. Questo parametro non distingue tra maiuscole e minuscole.  
Vincoli:  
+ Deve contenere da 1 a 63 lettere, numeri o trattini.
+ Il primo carattere deve essere una lettera.
+ Non può terminare con un trattino o contenere due trattini consecutivi.
Ad esempio: `elastic-cluster-snapshot-5`   
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 63 caratteri.  
Obbligatorio: sì

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Impostare su `true` per copiare tutti i tag dallo snapshot del cluster di origine allo snapshot del cluster elastico di destinazione. Il valore predefinito è `false`.  
Tipo: Booleano  
Obbligatorio: no

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
L'ID della chiave AWS KMS per un'istantanea crittografata del cluster elastico. L'ID della chiave AWS KMS è l'Amazon Resource Name (ARN) AWS , l'identificatore della chiave KMS o AWS l'alias della chiave KMS per la chiave di crittografia KMS. AWS   
Se copi un'istantanea del cluster elastico crittografato dal tuo AWS account, puoi specificare un valore per crittografare la copia con una nuova chiave `KmsKeyId` di crittografia S KMS. AWS Se non specifichi un valore per`KmsKeyId`, la copia dello snapshot del cluster elastico viene crittografata con la stessa chiave `AWS` KMS dello snapshot del cluster elastico di origine.  
Se si copia uno snapshot del cluster elastico non crittografato e si specifica un valore per il `KmsKeyId` parametro, viene restituito un errore.  
▬Tipo: stringa  
Obbligatorio: no

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
I tag da assegnare allo snapshot del cluster elastico.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Obbligatorio: no

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Restituisce informazioni su uno specifico snapshot del cluster elastico.  
Tipo: oggetto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ServiceQuotaExceededException **   
La quota di servizio per l'azione è stata superata.  
Codice di stato HTTP: 402

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

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

Crea un nuovo cluster elastico Amazon DocumentDB e ne restituisce la struttura del cluster.

## Sintassi della richiesta
<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" ]
}
```

## Parametri della richiesta URI:
<a name="API_elastic_CreateCluster_RequestParameters"></a>

La richiesta non utilizza parametri URI.

## Corpo della richiesta
<a name="API_elastic_CreateCluster_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Il nome dell'amministratore dei cluster elastici di Amazon DocumentDB.  
 *Vincoli*:  
+ Deve contenere da 1 a 63 lettere o numeri.
+ Il primo carattere deve essere una lettera.
+ Non può essere una parola riservata.
Tipo: stringa  
Obbligatorio: sì

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
La password per l'amministratore dei cluster elastici di Amazon DocumentDB. La password può contenere qualsiasi carattere ASCII stampabile.  
 *Vincoli*:  
+ Deve contenere da 8 a 100 caratteri.
+ Non può contenere una barra (/), virgolette doppie («) o il simbolo «at» (@).
Tipo: stringa  
Obbligatorio: sì

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
Il tipo di autenticazione utilizzato per determinare dove recuperare la password utilizzata per accedere al cluster elastico. I tipi validi sono `PLAIN_TEXT` o`SECRET_ARN`.  
Tipo: String  
Valori validi: `PLAIN_TEXT | SECRET_ARN`   
Obbligatorio: sì

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
Il nome del nuovo cluster elastico. Questo parametro è archiviato come stringa in minuscolo.  
 *Vincoli*:  
+ Deve contenere da 1 a 63 lettere, numeri o trattini.
+ Il primo carattere deve essere una lettera.
+ Non può terminare con un trattino o contenere due trattini consecutivi.
 *Esempio*: `my-cluster`   
Tipo: stringa  
Obbligatorio: sì

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
Il numero di v CPUs assegnato a ciascun frammento di cluster elastico. Il massimo è 64. I valori consentiti sono 2, 4, 8, 16, 32, 64.  
Tipo: numero intero  
Obbligatorio: sì

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
Il numero di shard assegnati al cluster elastico. Il massimo è 32.  
Tipo: numero intero  
Obbligatorio: sì

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
Il numero di giorni per i quali vengono conservate le istantanee automatiche.  
Tipo: Integer  
Obbligatorio: no

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
Il token client per il cluster elastico.  
▬Tipo: stringa  
Obbligatorio: no

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
L'identificatore della chiave KMS da utilizzare per crittografare il nuovo cluster elastico.  
L'identificatore della chiave KMS è l'Amazon Resource Name (ARN) per la chiave di crittografia KMS. Se stai creando un cluster utilizzando lo stesso account Amazon che possiede questa chiave di crittografia KMS, puoi utilizzare l'alias della chiave KMS anziché l'ARN come chiave di crittografia KMS.  
Se non viene specificata una chiave di crittografia, Amazon DocumentDB utilizza la chiave di crittografia predefinita creata da KMS per l'account. Il tuo account ha una chiave di crittografia predefinita diversa per ogni regione Amazon.  
▬Tipo: stringa  
Obbligatorio: no

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
L'intervallo di tempo giornaliero durante il quale vengono creati i backup automatici, se i backup automatici sono abilitati, come determinato da. `backupRetentionPeriod`  
▬Tipo: stringa  
Obbligatorio: no

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
Intervallo temporale settimanale nel fuso orario UTC (Universal Coordinated Time) durante il quale può verificarsi la manutenzione dei sistemi.  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Impostazione predefinita*: una finestra di 30 minuti selezionata a caso da un intervallo di tempo di 8 ore per ciascuna Regione AWS, che si verifica in un giorno casuale della settimana.  
 *Giorni validi*: lun, mar, mer, gio, ven, sab, dom  
 *Vincoli*: finestra di un minimo di 30 minuti.  
▬Tipo: stringa  
Obbligatorio: no

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
Il numero di istanze di replica che si applicano a tutti gli shard del cluster elastico. `shardInstanceCount`Il valore 1 indica che esiste un'istanza di writer e tutte le istanze aggiuntive sono repliche che possono essere utilizzate per le letture e per migliorare la disponibilità.  
Tipo: Integer  
Obbligatorio: no

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
La sottorete Amazon EC2 IDs per il nuovo cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
I tag da assegnare al nuovo cluster elastico.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Obbligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Un elenco di gruppi di sicurezza VPC EC2 da associare al nuovo cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_CreateCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
Il nuovo cluster elastico che è stato creato.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ServiceQuotaExceededException **   
La quota di servizio per l'azione è stata superata.  
Codice di stato HTTP: 402

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_CreateCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

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

Crea un'istantanea di un cluster elastico.

## Sintassi della richiesta
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

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

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

## Parametri della richiesta URI:
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

La richiesta non utilizza parametri URI.

## Corpo della richiesta
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
L'identificatore ARN del cluster elastico di cui si desidera creare un'istantanea.  
Tipo: stringa  
Obbligatorio: sì

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
Il nome della nuova istantanea del cluster elastico.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 63 caratteri.  
Obbligatorio: sì

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
I tag da assegnare alla nuova istantanea del cluster elastico.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Obbligatorio: no

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Restituisce informazioni sulla nuova istantanea del cluster elastico.  
Tipo: oggetto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ServiceQuotaExceededException **   
La quota di servizio per l'azione è stata superata.  
Codice di stato HTTP: 402

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

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

Eliminare un cluster elastico.

## Sintassi della richiesta
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico da eliminare.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_DeleteCluster_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Restituisce informazioni sul cluster elastico appena eliminato.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

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

Eliminare un'istantanea del cluster elastico.

## Sintassi della richiesta
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
L'identificatore ARN dello snapshot del cluster elastico da eliminare.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Restituisce informazioni sullo snapshot del cluster elastico appena eliminato.  
Tipo: oggetto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

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

Restituisce informazioni su un cluster elastico specifico.

## Sintassi della richiesta
<a name="API_elastic_GetCluster_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_GetCluster_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_GetCluster_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_GetCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Restituisce informazioni su un cluster elastico specifico.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_GetCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

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

Restituisce informazioni su uno specifico snapshot del cluster elastico

## Sintassi della richiesta
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
L'identificatore ARN dello snapshot del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Restituisce informazioni su uno specifico snapshot del cluster elastico.  
Tipo: oggetto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

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

Recupera tutte le azioni di manutenzione in sospeso.

## Sintassi della richiesta
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Recupera le azioni di manutenzione in sospeso per uno specifico Amazon Resource Name (ARN).  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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"
   }
}
```

## Elementi di risposta
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Fornisce informazioni su un'operazione di manutenzione in sospeso per una risorsa.  
Tipo: oggetto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

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

Restituisce informazioni sui cluster elastici di Amazon DocumentDB forniti.

## Sintassi della richiesta
<a name="API_elastic_ListClusters_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_ListClusters_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
Il numero massimo di risultati di snapshot del cluster elastico da ricevere nella risposta.  
Intervallo valido: valore minimo di 1. valore massimo pari a 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Un token di impaginazione fornito da una richiesta precedente. Se viene specificato questo parametro, la risposta include solo i record oltre questo token, fino al valore specificato da`max-results`.  
Se non ci sono più dati nella risposta, non `nextToken` verrà restituita.

## Corpo della richiesta
<a name="API_elastic_ListClusters_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

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

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

## Elementi di risposta
<a name="API_elastic_ListClusters_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Un elenco di cluster elastici di Amazon DocumentDB.  
Tipo: matrice di oggetti [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Un token di impaginazione fornito da una richiesta precedente. Se viene specificato questo parametro, la risposta include solo i record oltre questo token, fino al valore specificato da`max-results`.  
Se non ci sono più dati nella risposta, non `nextToken` verrà restituita.  
Tipo: String

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_ListClusters_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

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

Restituisce informazioni sulle istantanee per un cluster elastico specificato.

## Sintassi della richiesta
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
Il numero massimo di risultati di snapshot del cluster elastico da ricevere nella risposta.  
Intervallo valido: valore minimo di 20. valore massimo pari a 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Un token di impaginazione fornito da una richiesta precedente. Se viene specificato questo parametro, la risposta include solo i record oltre questo token, fino al valore specificato da`max-results`.  
Se non ci sono più dati nella risposta, non `nextToken` verrà restituita.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
Il tipo di istantanee del cluster da restituire. È possibile specificare uno dei seguenti valori:  
+  `automated`- Restituisci tutte le istantanee del cluster che Amazon DocumentDB ha creato automaticamente per AWS il tuo account.
+  `manual`- Restituisci tutte le istantanee del cluster che hai creato manualmente per il tuo account. AWS 

## Corpo della richiesta
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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"
      }
   ]
}
```

## Elementi di risposta
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Un token di impaginazione fornito da una richiesta precedente. Se viene specificato questo parametro, la risposta include solo i record oltre questo token, fino al valore specificato da`max-results`.  
Se non ci sono più dati nella risposta, non `nextToken` verrà restituita.  
Tipo: String

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Un elenco di istantanee per un cluster elastico specificato.  
Tipo: matrice di oggetti [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

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

Recupera un elenco di tutte le azioni di manutenzione in sospeso.

## Sintassi della richiesta
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
Il numero massimo di risultati da includere nella risposta. Se esistono più record rispetto al `maxResults` valore specificato, nella risposta viene incluso un token di impaginazione (marker) in modo da poter recuperare i risultati rimanenti.  
Intervallo valido: valore minimo di 1. valore massimo pari a 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Token di paginazione opzionale fornito da una richiesta precedente. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al valore specificato da `maxResults`.

## Corpo della richiesta
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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"
      }
   ]
}
```

## Elementi di risposta
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Fornisce informazioni su un'operazione di manutenzione in sospeso per una risorsa.  
Tipo: matrice di oggetti [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Token di paginazione opzionale fornito da una richiesta precedente. Se viene visualizzato questo parametro, le risposte includeranno solo i record oltre il marker, fino al valore specificato da. `maxResults`  
Tipo: String

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

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

Elenca tutti i tag su una risorsa cluster elastica

## Sintassi della richiesta
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
L'identificatore ARN della risorsa del cluster elastico.  
Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1011.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

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

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

## Elementi di risposta
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
L'elenco di tag per la risorsa del cluster elastico specificata.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stata trovata.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

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

Ripristina un cluster elastico da un'istantanea.

## Sintassi della richiesta
<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" ]
}
```

## Parametri della richiesta URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
L'identificatore ARN dello snapshot del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Il nome del cluster elastico.  
Tipo: stringa  
Obbligatorio: sì

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
L'identificatore di chiave KMS da utilizzare per crittografare il nuovo cluster elastico di cluster Amazon DocumentDB.  
L'identificatore della chiave KMS è l'Amazon Resource Name (ARN) per la chiave di crittografia KMS. Se stai creando un cluster utilizzando lo stesso account Amazon che possiede questa chiave di crittografia KMS, puoi utilizzare l'alias della chiave KMS anziché l'ARN come chiave di crittografia KMS.  
Se non viene specificata una chiave di crittografia qui, Amazon DocumentDB utilizza la chiave di crittografia predefinita creata da KMS per il tuo account. Il tuo account ha una chiave di crittografia predefinita diversa per ogni regione Amazon.  
▬Tipo: stringa  
Obbligatorio: no

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
La capacità di ogni shard nel nuovo cluster elastico ripristinato.  
Tipo: Integer  
Obbligatorio: no

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
Il numero di istanze di replica che si applicano a tutti gli shard del cluster elastico. `shardInstanceCount`Il valore 1 indica che esiste un'istanza di writer e tutte le istanze aggiuntive sono repliche che possono essere utilizzate per le letture e per migliorare la disponibilità.  
Tipo: Integer  
Obbligatorio: no

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
La sottorete Amazon EC2 IDs per il cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Un elenco dei nomi di tag da assegnare al cluster elastico ripristinato, sotto forma di una matrice di coppie chiave-valore in cui la chiave è il nome del tag e il valore è il valore chiave.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Obbligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Un elenco di gruppi di sicurezza VPC EC2 da associare al cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Restituisce informazioni su un cluster elastico ripristinato.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ServiceQuotaExceededException **   
La quota di servizio per l'azione è stata superata.  
Codice di stato HTTP: 402

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta viene rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

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

Riavvia il cluster elastico interrotto specificato da`clusterARN`.

## Sintassi della richiesta
<a name="API_elastic_StartCluster_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_StartCluster_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_StartCluster_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_StartCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Restituisce informazioni su un cluster elastico specifico.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_StartCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

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

Arresta il cluster elastico in esecuzione specificato da`clusterArn`. Il cluster elastico deve essere nello stato *disponibile*. 

## Sintassi della richiesta
<a name="API_elastic_StopCluster_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_StopCluster_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_StopCluster_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_StopCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Restituisce informazioni su un cluster elastico specifico.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_StopCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

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

Aggiunge tag di metadati a una risorsa cluster elastica

## Sintassi della richiesta
<a name="API_elastic_TagResource_RequestSyntax"></a>

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

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

## Parametri della richiesta URI
<a name="API_elastic_TagResource_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
L'identificatore ARN della risorsa del cluster elastico.  
Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1011.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_TagResource_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
I tag assegnati alla risorsa del cluster elastico.  
Tipo: mappatura stringa a stringa  
Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.  
Modello di chiave:`(?!aws:)[a-zA-Z+-=._:/]+`   
Vincoli di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Obbligatorio: sì

## Sintassi della risposta
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementi di risposta
<a name="API_elastic_TagResource_ResponseElements"></a>

Se l'operazione riesce, il servizio invia una risposta HTTP 200 con un corpo HTTP vuoto.

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_TagResource_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

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

Rimuove i tag di metadati da una risorsa cluster elastica

## Sintassi della richiesta
<a name="API_elastic_UntagResource_RequestSyntax"></a>

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

## Parametri della richiesta URI
<a name="API_elastic_UntagResource_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
L'identificatore ARN della risorsa del cluster elastico.  
Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1011.  
Obbligatorio: sì

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
Le chiavi dei tag da rimuovere dalla risorsa del cluster elastico.  
Membri dell'array: numero minimo di 0 elementi. Numero massimo di 50 item.  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 128 caratteri.  
Modello: `(?!aws:)[a-zA-Z+-=._:/]+`   
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_UntagResource_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementi di risposta
<a name="API_elastic_UntagResource_ResponseElements"></a>

Se l'operazione riesce, il servizio invia una risposta HTTP 200 con un corpo HTTP vuoto.

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_UntagResource_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

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

Modifica un cluster elastico. Ciò include l'aggiornamento del nome utente/della password dell'amministratore, l'aggiornamento della versione dell'API e la configurazione di una finestra di backup e di manutenzione

## Sintassi della richiesta
<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" ]
}
```

## Parametri della richiesta URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
L'identificatore ARN del cluster elastico.  
Obbligatorio: sì

## Corpo della richiesta
<a name="API_elastic_UpdateCluster_RequestBody"></a>

La richiesta accetta i seguenti dati in formato JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
La password associata all'amministratore del cluster elastico. Questa password può contenere qualsiasi carattere ASCII stampabile, eccetto la barra (/), le virgolette (") o il simbolo chiocciola (@).  
 *Vincoli*: deve contenere da 8 a 100 caratteri.  
▬Tipo: stringa  
Obbligatorio: no

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
Il tipo di autenticazione utilizzato per determinare dove recuperare la password utilizzata per accedere al cluster elastico. I tipi validi sono `PLAIN_TEXT` o`SECRET_ARN`.  
Tipo: String  
Valori validi: `PLAIN_TEXT | SECRET_ARN`   
Campo obbligatorio: no

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
Il numero di giorni per i quali vengono conservate le istantanee automatiche.  
Tipo: Integer  
Obbligatorio: no

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
Il token client per il cluster elastico.  
▬Tipo: stringa  
Obbligatorio: no

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
L'intervallo di tempo giornaliero durante il quale vengono creati i backup automatici, se i backup automatici sono abilitati, come determinato da. `backupRetentionPeriod`  
▬Tipo: stringa  
Obbligatorio: no

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
Intervallo temporale settimanale nel fuso orario UTC (Universal Coordinated Time) durante il quale può verificarsi la manutenzione dei sistemi.  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Impostazione predefinita*: una finestra di 30 minuti selezionata a caso da un intervallo di tempo di 8 ore per ciascuna Regione AWS, che si verifica in un giorno casuale della settimana.  
 *Giorni validi*: lun, mar, mer, gio, ven, sab, dom  
 *Vincoli*: finestra di un minimo di 30 minuti.  
▬Tipo: stringa  
Obbligatorio: no

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
Il numero di v CPUs assegnato a ogni shard di cluster elastico. Il massimo è 64. I valori consentiti sono 2, 4, 8, 16, 32, 64.  
Tipo: Integer  
Obbligatorio: no

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
Il numero di shard assegnati al cluster elastico. Il massimo è 32.  
Tipo: Integer  
Obbligatorio: no

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
Il numero di istanze di replica che si applicano a tutti gli shard del cluster elastico. `shardInstanceCount`Il valore 1 indica che esiste un'istanza di writer e tutte le istanze aggiuntive sono repliche che possono essere utilizzate per le letture e per migliorare la disponibilità.  
Tipo: Integer  
Obbligatorio: no

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
La sottorete Amazon EC2 IDs per il cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Un elenco di gruppi di sicurezza VPC EC2 da associare al cluster elastico.  
Tipo: array di stringhe  
Obbligatorio: no

## Sintassi della risposta
<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" ]
   }
}
```

## Elementi di risposta
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Restituisce informazioni sul cluster elastico aggiornato.  
Tipo: oggetto [Cluster](API_elastic_Cluster.md)

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

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** AccessDeniedException **   
Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.    
 ** message **   
Un messaggio di errore che spiega perché l'accesso è stato negato.
Codice di stato HTTP: 403

 ** ConflictException **   
C'è stato un conflitto di accesso.    
 ** resourceId **   
L'ID della risorsa in cui si è verificato un conflitto di accesso.  
 ** resourceType **   
Il tipo di risorsa in cui si è verificato un conflitto di accesso.
Codice di stato HTTP: 409

 ** InternalServerException **   
Si è verificato un errore interno del server.  
Codice di stato HTTP: 500

 ** ResourceNotFoundException **   
Impossibile trovare la risorsa specificata.    
 ** message **   
Un messaggio di errore che descrive l'errore.  
 ** resourceId **   
L'ID della risorsa che non è stato possibile individuare.  
 ** resourceType **   
Il tipo di risorsa che non è stato possibile trovare.
Codice di stato HTTP: 404

 ** ThrottlingException **   
ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.    
 ** retryAfterSeconds **   
Il numero di secondi di attesa prima di ritentare l'operazione.
Codice di stato HTTP: 429

 ** ValidationException **   
Una struttura che definisce un'eccezione di convalida.    
 ** fieldList **   
Un elenco dei campi in cui si è verificata l'eccezione di convalida.  
 ** message **   
Un messaggio di errore che descrive l'eccezione di convalida.  
 ** reason **   
Il motivo per cui si è verificata l'eccezione di convalida (uno tra`unknownOperation`, `cannotParse``fieldValidationFailed`, o). `other`
Codice di stato HTTP: 400

## Vedi anche
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)