Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# Aktionen
Die folgenden Aktionen werden unterstützt von Amazon DocumentDB (with MongoDB compatibility):
+ [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md)
+ [AddTagsToResource](API_AddTagsToResource.md)
+ [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md)
+ [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md)
+ [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md)
+ [CreateDBCluster](API_CreateDBCluster.md)
+ [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md)
+ [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md)
+ [CreateDBInstance](API_CreateDBInstance.md)
+ [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md)
+ [CreateEventSubscription](API_CreateEventSubscription.md)
+ [CreateGlobalCluster](API_CreateGlobalCluster.md)
+ [DeleteDBCluster](API_DeleteDBCluster.md)
+ [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md)
+ [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md)
+ [DeleteDBInstance](API_DeleteDBInstance.md)
+ [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md)
+ [DeleteEventSubscription](API_DeleteEventSubscription.md)
+ [DeleteGlobalCluster](API_DeleteGlobalCluster.md)
+ [DescribeCertificates](API_DescribeCertificates.md)
+ [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md)
+ [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md)
+ [DescribeDBClusters](API_DescribeDBClusters.md)
+ [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md)
+ [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md)
+ [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md)
+ [DescribeDBInstances](API_DescribeDBInstances.md)
+ [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md)
+ [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md)
+ [DescribeEventCategories](API_DescribeEventCategories.md)
+ [DescribeEvents](API_DescribeEvents.md)
+ [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md)
+ [DescribeGlobalClusters](API_DescribeGlobalClusters.md)
+ [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md)
+ [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md)
+ [FailoverDBCluster](API_FailoverDBCluster.md)
+ [FailoverGlobalCluster](API_FailoverGlobalCluster.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ModifyDBCluster](API_ModifyDBCluster.md)
+ [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md)
+ [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md)
+ [ModifyDBInstance](API_ModifyDBInstance.md)
+ [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md)
+ [ModifyEventSubscription](API_ModifyEventSubscription.md)
+ [ModifyGlobalCluster](API_ModifyGlobalCluster.md)
+ [RebootDBInstance](API_RebootDBInstance.md)
+ [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md)
+ [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md)
+ [RemoveTagsFromResource](API_RemoveTagsFromResource.md)
+ [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md)
+ [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md)
+ [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md)
+ [StartDBCluster](API_StartDBCluster.md)
+ [StopDBCluster](API_StopDBCluster.md)
+ [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md)
Die folgenden Aktionen werden von Amazon DocumentDB Elastic Clusters unterstützt:
+ [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md)
+ [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md)
+ [CreateCluster](API_elastic_CreateCluster.md)
+ [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md)
+ [DeleteCluster](API_elastic_DeleteCluster.md)
+ [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md)
+ [GetCluster](API_elastic_GetCluster.md)
+ [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md)
+ [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md)
+ [ListClusters](API_elastic_ListClusters.md)
+ [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md)
+ [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md)
+ [ListTagsForResource](API_elastic_ListTagsForResource.md)
+ [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md)
+ [StartCluster](API_elastic_StartCluster.md)
+ [StopCluster](API_elastic_StopCluster.md)
+ [TagResource](API_elastic_TagResource.md)
+ [UntagResource](API_elastic_UntagResource.md)
+ [UpdateCluster](API_elastic_UpdateCluster.md)
# Amazon DocumentDB (with MongoDB compatibility)
Die folgenden Aktionen werden unterstützt von Amazon DocumentDB (with MongoDB compatibility):
+ [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md)
+ [AddTagsToResource](API_AddTagsToResource.md)
+ [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md)
+ [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md)
+ [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md)
+ [CreateDBCluster](API_CreateDBCluster.md)
+ [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md)
+ [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md)
+ [CreateDBInstance](API_CreateDBInstance.md)
+ [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md)
+ [CreateEventSubscription](API_CreateEventSubscription.md)
+ [CreateGlobalCluster](API_CreateGlobalCluster.md)
+ [DeleteDBCluster](API_DeleteDBCluster.md)
+ [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md)
+ [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md)
+ [DeleteDBInstance](API_DeleteDBInstance.md)
+ [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md)
+ [DeleteEventSubscription](API_DeleteEventSubscription.md)
+ [DeleteGlobalCluster](API_DeleteGlobalCluster.md)
+ [DescribeCertificates](API_DescribeCertificates.md)
+ [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md)
+ [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md)
+ [DescribeDBClusters](API_DescribeDBClusters.md)
+ [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md)
+ [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md)
+ [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md)
+ [DescribeDBInstances](API_DescribeDBInstances.md)
+ [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md)
+ [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md)
+ [DescribeEventCategories](API_DescribeEventCategories.md)
+ [DescribeEvents](API_DescribeEvents.md)
+ [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md)
+ [DescribeGlobalClusters](API_DescribeGlobalClusters.md)
+ [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md)
+ [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md)
+ [FailoverDBCluster](API_FailoverDBCluster.md)
+ [FailoverGlobalCluster](API_FailoverGlobalCluster.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ModifyDBCluster](API_ModifyDBCluster.md)
+ [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md)
+ [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md)
+ [ModifyDBInstance](API_ModifyDBInstance.md)
+ [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md)
+ [ModifyEventSubscription](API_ModifyEventSubscription.md)
+ [ModifyGlobalCluster](API_ModifyGlobalCluster.md)
+ [RebootDBInstance](API_RebootDBInstance.md)
+ [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md)
+ [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md)
+ [RemoveTagsFromResource](API_RemoveTagsFromResource.md)
+ [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md)
+ [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md)
+ [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md)
+ [StartDBCluster](API_StartDBCluster.md)
+ [StopDBCluster](API_StopDBCluster.md)
+ [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md)
# AddSourceIdentifierToSubscription
Fügt eine Quell-ID einem Abonnement für Ereignisbenachrichtigungen hinzu.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SourceIdentifier **
Die Kennung der hinzuzufügenden Ereignisquelle:
+ Wenn der Quelltyp eine Instanz ist, `DBInstanceIdentifier` muss a angegeben werden.
+ Wenn der Quelltyp eine Sicherheitsgruppe ist, `DBSecurityGroupName` muss a angegeben werden.
+ Wenn der Quelltyp eine Parametergruppe ist, `DBParameterGroupName` muss a angegeben werden.
+ Wenn der Quelltyp ein Snapshot ist, `DBSnapshotIdentifier` muss a angegeben werden.
Typ: Zeichenfolge
Erforderlich: Ja
** SubscriptionName **
Der Name des Amazon DocumentDB DocumentDB-Abonnements für Ereignisbenachrichtigungen, zu dem Sie eine Quell-ID hinzufügen möchten.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** EventSubscription **
Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.
Typ: [EventSubscription](API_EventSubscription.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** SourceNotFound **
Die angeforderte Quelle konnte nicht gefunden werden.
HTTP-Statuscode: 404
** SubscriptionNotFound **
Der Abonnementname ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
# AddTagsToResource
Fügt einer Amazon DocumentDB DocumentDB-Ressource Metadaten-Tags hinzu. Sie können diese Tags in Kostenzuordnungsberichten verwenden, um Kosten nachzuverfolgen, die mit Amazon DocumentDB-Ressourcen verbunden sind, oder in einer `Condition` Abrechnung in einer AWS Identity and Access Management (IAM-) Richtlinie für Amazon DocumentDB.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** ResourceName **
Die Amazon DocumentDB DocumentDB-Ressource, zu der die Tags hinzugefügt werden. Dieser Wert ist ein Amazon-Ressourcenname.
Typ: Zeichenfolge
Erforderlich: Ja
**Tags.Tag.N**
Die Tags, die der Amazon DocumentDB DocumentDB-Ressource zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Ja
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Snapshot.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource)
# ApplyPendingMaintenanceAction
Wendet eine ausstehende Wartungsaktion auf eine Ressource an (z. B. auf eine Amazon DocumentDB DocumentDB-Instance).
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** ApplyAction **
Die anstehende Wartungsaktion, die auf diese Ressource angewendet werden soll.
Zulässige Werte: `system-update`, `db-upgrade`
Typ: Zeichenfolge
Erforderlich: Ja
** OptInType **
Ein Wert, der die Art der Opt-in-Anfrage angibt oder eine Opt-in-Anfrage rückgängig macht. Eine Opt-in-Anfrage vom Typ `immediate` kann nicht rückgängig gemacht werden.
Zulässige Werte:
+ `immediate` – Die Wartungsmaßnahme sofort anwenden.
+ `next-maintenance` – Die Wartungsaktion im nächsten Wartungsfenster für die Ressource anwenden.
+ `undo-opt-in` – Alle bestehenden `next-maintenance`-Opt-In-Anfragen stornieren.
Typ: Zeichenfolge
Erforderlich: Ja
** ResourceIdentifier **
Der Amazon-Ressourcenname (ARN) der Ressource, auf die sich die anstehende Wartungsaktion bezieht.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** ResourcePendingMaintenanceActions **
Stellt die Ausgabe von dar[ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).
Typ: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
** ResourceNotFoundFault **
Die angegebene Ressourcen-ID wurde nicht gefunden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
# CopyDBClusterParameterGroup
Kopiert die angegebene Cluster-Parametergruppe.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SourceDBClusterParameterGroupIdentifier **
Der Bezeichner oder der Amazon-Ressourcenname (ARN) für die Quell-Cluster-Parametergruppe.
Einschränkungen:
+ Muss eine gültige Cluster-Parametergruppe angeben.
+ Wenn sich die Quellcluster-Parametergruppe in derselben Datei AWS-Region wie die Kopie befindet, geben Sie eine gültige Parametergruppen-ID an, z. B.`my-db-cluster-param-group`, oder einen gültigen ARN.
+ Wenn sich die Quellparametergruppe in einer anderen AWS-Region als der Kopie befindet, geben Sie einen gültigen Cluster-Parametergruppen-ARN an, z. B.`arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
Typ: Zeichenfolge
Erforderlich: Ja
** TargetDBClusterParameterGroupDescription **
Eine Beschreibung für die kopierte Cluster-Parametergruppe.
Typ: Zeichenfolge
Erforderlich: Ja
** TargetDBClusterParameterGroupIdentifier **
Der Bezeichner für die kopierte Cluster-Parametergruppe.
Einschränkungen:
+ Kann nicht Null, leer oder negativ sein.
+ Muss zwischen 1 und 255 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-cluster-param-group1`
Typ: Zeichenfolge
Erforderlich: Ja
**Stichworte.Tag.N**
Die Tags, die der Parametergruppe zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterParameterGroup **
Detaillierte Informationen zu einer Cluster-Parametergruppe.
Typ: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupAlreadyExists **
Eine Parametergruppe mit demselben Namen ist bereits vorhanden.
HTTP-Statuscode: 400
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** DBParameterGroupQuotaExceeded **
Diese Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Parametergruppen überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
# CopyDBClusterSnapshot
Kopiert einen Snapshot eines Clusters.
Um einen Cluster-Snapshot aus einem gemeinsam genutzten manuellen Cluster-Snapshot zu kopieren, `SourceDBClusterSnapshotIdentifier` muss es sich um den Amazon-Ressourcennamen (ARN) des gemeinsam genutzten Cluster-Snapshots handeln. Sie können einen freigegebenen DB-Cluster-Snapshot, ob verschlüsselt oder nicht, nur in dieselbe AWS-Region kopieren.
Um den Kopiervorgang abzubrechen, nachdem er ausgeführt wurde, löschen Sie den Ziel-Cluster-Snapshot, der identifiziert wurde, `TargetDBClusterSnapshotIdentifier` solange sich dieser Cluster-Snapshot im *Kopierstatus* befindet.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SourceDBClusterSnapshotIdentifier **
Die ID des zu kopierenden Cluster-Snapshots. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Es muss ein gültiger Cluster-Snapshot mit *verfügbarem* Status angegeben werden.
+ Wenn sich der Quell-Cluster-Snapshot in derselben Datei AWS-Region wie die Kopie befindet, geben Sie eine gültige Snapshot-ID an.
+ Wenn sich der Quell-Cluster-Snapshot in einem anderen Konto befindet AWS-Region oder einem anderen AWS Konto gehört, geben Sie den Snapshot-ARN an.
Beispiel: `my-cluster-snapshot1`
Typ: Zeichenfolge
Erforderlich: Ja
** TargetDBClusterSnapshotIdentifier **
Die ID des neuen Cluster-Snapshots, der aus dem Quell-Cluster-Snapshot erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-cluster-snapshot2`
Typ: Zeichenfolge
Erforderlich: Ja
** CopyTags **
Wird auf gesetzt, `true` um alle Tags aus dem Quell-Cluster-Snapshot in den Ziel-Cluster-Snapshot zu kopieren, andernfalls. `false` Der Standardwert ist `false`.
Typ: Boolesch
Erforderlich: Nein
** KmsKeyId **
Die AWS KMS Schlüssel-ID für einen verschlüsselten Cluster-Snapshot. Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN), die AWS KMS Schlüssel-ID oder der AWS KMS Schlüsselalias für den AWS KMS Verschlüsselungsschlüssel.
Wenn Sie einen verschlüsselten Cluster-Snapshot von Ihrem kopieren AWS-Konto, können Sie einen Wert angeben, `KmsKeyId` um die Kopie mit einem neuen AWS KMS Verschlüsselungsschlüssel zu verschlüsseln. Wenn Sie keinen Wert für angeben`KmsKeyId`, wird die Kopie des Cluster-Snapshots mit demselben AWS KMS Schlüssel verschlüsselt wie der Quell-Cluster-Snapshot.
Wenn Sie einen verschlüsselten Cluster-Snapshot, der gemeinsam genutzt wird AWS-Konto, von einem anderen kopieren, müssen Sie einen Wert für angeben`KmsKeyId`.
Um einen verschlüsselten Cluster-Snapshot in einen anderen `KmsKeyId` zu kopieren AWS-Region, geben Sie die AWS KMS Schlüssel-ID ein, mit der Sie die Kopie des Cluster-Snapshots in der Zielregion verschlüsseln möchten. AWS KMS Verschlüsselungsschlüssel sind spezifisch für AWS-Region das Land, in dem sie erstellt wurden, und Sie können keine Verschlüsselungsschlüssel von einem AWS-Region in einem anderen AWS-Region verwenden.
Wenn Sie einen unverschlüsselten Cluster-Snapshot kopieren und einen Wert für den `KmsKeyId` Parameter angeben, wird ein Fehler zurückgegeben.
Typ: Zeichenfolge
Erforderlich: Nein
** PreSignedUrl **
Die URL, die eine mit Signature Version 4 signierte Anfrage für die `CopyDBClusterSnapshot` API-Aktion enthält AWS-Region , die den zu kopierenden Quell-Cluster-Snapshot enthält. Sie müssen den `PreSignedUrl` Parameter verwenden, wenn Sie einen Cluster-Snapshot von einem anderen kopieren AWS-Region.
Wenn Sie ein AWS SDK-Tool oder das verwenden AWS CLI, können Sie `SourceRegion` (oder `--source-region` für AWS CLI) angeben, anstatt es `PreSignedUrl` manuell anzugeben. Durch die Angabe wird `SourceRegion` automatisch eine vorsignierte URL generiert, bei der es sich um eine gültige Anforderung für den Vorgang handelt, die in der Quelle ausgeführt werden kann. AWS-Region
Bei der vorsignierten URL muss es sich um eine gültige Anforderung für die `CopyDBClusterSnapshot` API-Aktion handeln, die in der Quelle ausgeführt werden kann AWS-Region , die den zu kopierenden Cluster-Snapshot enthält. Die vorsignierte URL-Anforderung muss die folgenden Parameterwerte enthalten:
+ `SourceRegion`- Die ID der Region, die den zu kopierenden Snapshot enthält.
+ `SourceDBClusterSnapshotIdentifier`— Die Kennung für den verschlüsselten Cluster-Snapshot, der kopiert werden soll. Dieser Bezeichner muss im ARN-Format (Amazon-Ressourcenname) der Quell- AWS-Region angegeben werden. Wenn Sie beispielsweise einen verschlüsselten Cluster-Snapshot von us-east-1 kopieren AWS-Region, `SourceDBClusterSnapshotIdentifier` sieht Ihr etwa wie folgt aus:. `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`
+ `TargetDBClusterSnapshotIdentifier`- Die Kennung für den neuen Cluster-Snapshot, der erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Typ: Zeichenfolge
Erforderlich: Nein
**Stichworte.Tag.N**
Die Tags, die dem Cluster-Snapshot zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterSnapshot **
Detaillierte Informationen zu einem Cluster-Snapshot.
Typ: [DBClusterSnapshot](API_DBClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterSnapshotAlreadyExistsFault **
Sie haben bereits einen Cluster-Snapshot mit der angegebenen Kennung.
HTTP-Statuscode: 400
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** KMSKeyNotAccessibleFault **
Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.
HTTP-Statuscode: 400
** SnapshotQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Snapshots überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot)
# CreateDBCluster
Erstellt einen neuen Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die Cluster-ID. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-cluster`
Typ: Zeichenfolge
Erforderlich: Ja
** Engine **
Der Name der Datenbank-Engine, die für diesen Cluster verwendet werden soll.
Zulässige Werte: `docdb`
Typ: Zeichenfolge
Erforderlich: Ja
**AvailabilityZones. AvailabilityZone**N
Eine Liste der Amazon EC2 Availability Zones, in denen Instances im DB-Cluster erstellt werden können.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** BackupRetentionPeriod **
Die Anzahl von Tagen, über die automatische Backups aufbewahrt werden. Sie müssen einen Mindestwert von 1 angeben.
Standard: 1
Einschränkungen:
+ Muss ein Wert zwischen 1 und 35 sein.
Typ: Ganzzahl
Erforderlich: Nein
** DBClusterParameterGroupName **
Der Name der Parameter-Gruppe, die mit diesem Cluster zu verknüpfen ist.
Typ: Zeichenfolge
Erforderlich: Nein
** DBSubnetGroupName **
Eine DB-Subnetzgruppe, die diesem DB-Cluster zugeordnet werden soll.
Einschränkungen: Der Wert muss mit dem Namen einer vorhandenen `DBSubnetGroup` übereinstimmen. Der Name darf nicht default sein.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Nein
** DeletionProtection **
Gibt an, ob dieser Cluster gelöscht werden kann. Wenn `DeletionProtection` aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und `DeletionProtection` deaktiviert wurde. `DeletionProtection`schützt Cluster davor, versehentlich gelöscht zu werden.
Typ: Boolesch
Erforderlich: Nein
**EnableCloudwatchLogsExports.Mitglied.N**
Eine Liste von Protokolltypen, die für den Export nach Amazon CloudWatch Logs aktiviert werden müssen. Sie können Prüf- oder Profiler-Protokolle aktivieren. Weitere Informationen finden Sie unter [Amazon DocumentDB DocumentDB-Ereignisse prüfen und Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) [DocumentDB-Operationen profilieren](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** EngineVersion **
Die Versionsnummer der zu verwendenden Datenbank-Engine. Die `--engine-version` wird standardmäßig auf die neueste Hauptversion des Moduls festgelegt. Bei Produktions-Workloads empfehlen wir, diesen Parameter explizit mit der beabsichtigten Hauptversion zu deklarieren.
Typ: Zeichenfolge
Erforderlich: Nein
** GlobalClusterIdentifier **
Die Cluster-ID des neuen globalen Clusters.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Nein
** KmsKeyId **
Die AWS KMS Schlüssel-ID für einen verschlüsselten Cluster.
Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN) für den AWS KMS Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben Cluster erstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, der zum Verschlüsseln des neuen Clusters verwendet wird, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.
Wenn ein Verschlüsselungsschlüssel in `KmsKeyId` nicht angegeben ist:
+ Wenn der `StorageEncrypted`-Parameter `true` lautet, verwendet Amazon DocumentDB Ihren Standard-Verschlüsselungsschlüssel.
AWS KMS erstellt den Standard-Verschlüsselungsschlüssel für Ihren AWS-Konto. Ihr AWS-Konto hat für jeden einen anderen Standard-Verschlüsselungsschlüssel AWS-Regionen.
Typ: Zeichenfolge
Erforderlich: Nein
** ManageMasterUserPassword **
Gibt an, ob das Masterbenutzerpasswort mit Amazon Web Services Secrets Manager verwaltet werden soll.
Einschränkung: Sie können das Masterbenutzer-Passwort nicht mit Amazon Web Services Secrets Manager verwalten, wenn `MasterUserPassword` es angegeben ist.
Typ: Boolesch
Erforderlich: Nein
** MasterUsername **
Der Name des Masterbenutzers für diesen DB-Cluster.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben oder Zahlen enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf kein Wort sein, das für die ausgewählte Datenbank-Engine reserviert ist.
Typ: Zeichenfolge
Erforderlich: Nein
** MasterUserPassword **
Das Passwort für den Masterbenutzer der Datenbank. Dieses Passwort kann alle druckbaren ASCII-Zeichen, außer Schrägstrich (/), doppeltes Anführungszeichen (") oder das "At"-Zeichen (@), enthalten.
Einschränkungen: Muss 8 bis 100 Zeichen enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** MasterUserSecretKmsKeyId **
Die Amazon Web Services KMS-Schlüssel-ID zur Verschlüsselung eines Geheimnisses, das automatisch im Amazon Web Services Secrets Manager generiert und verwaltet wird. Diese Einstellung ist nur gültig, wenn das Masterbenutzerkennwort von Amazon DocumentDB im Amazon Web Services Secrets Manager für den DB-Cluster verwaltet wird.
Die Amazon Web Services KMS-Schlüssel-ID ist der Schlüssel-ARN, die Schlüssel-ID, der Alias-ARN oder der Aliasname für den KMS-Schlüssel. Um einen KMS-Schlüssel in einem anderen Amazon Web Services Services-Konto zu verwenden, geben Sie den Schlüssel-ARN oder den Alias-ARN an.
Wenn Sie nichts angeben`MasterUserSecretKmsKeyId`, wird der `aws/secretsmanager` KMS-Schlüssel zur Verschlüsselung des Geheimnisses verwendet. Wenn sich das Geheimnis in einem anderen Amazon Web Services Services-Konto befindet, können Sie den `aws/secretsmanager` KMS-Schlüssel nicht verwenden, um das Geheimnis zu verschlüsseln, und Sie müssen einen vom Kunden verwalteten KMS-Schlüssel verwenden.
Es gibt einen Standard-KMS-Schlüssel für Ihr Amazon Web Services Services-Konto. Ihr Amazon Web Services Services-Konto hat für jede Amazon Web Services Services-Region einen anderen Standard-KMS-Schlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** NetworkType **
Der Netzwerktyp des Clusters.
Der Netzwerktyp wird durch den für den Cluster `DBSubnetGroup` angegebenen Netzwerktyp bestimmt. A `DBSubnetGroup` kann nur das IPv4 Protokoll oder die IPv4 und die IPv6 Protokolle (`DUAL`) unterstützen.
Weitere Informationen finden Sie unter [DocumentDB-Cluster in einer VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) im Amazon DocumentDB Developer Guide.
Zulässige Werte: `IPV4` \$1 `DUAL`
Typ: Zeichenfolge
Erforderlich: Nein
** Port **
Die Portnummer, auf der die Instances im Cluster Verbindungen akzeptieren.
Typ: Ganzzahl
Erforderlich: Nein
** PreferredBackupWindow **
Der tägliche Zeitraum, in dem automatische Sicherungen erstellt werden, wenn diese mit dem Parameter `BackupRetentionPeriod` aktiviert sind.
Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird.
Einschränkungen:
+ Muss im Format `hh24:mi-hh24:mi` angegeben werden.
+ Muss in Universal Coordinated Time (UTC) angegeben werden.
+ Darf nicht mit dem bevorzugten Wartungsfenster in Konflikt treten.
+ Muss mindestens 30 Minuten betragen.
Typ: Zeichenfolge
Erforderlich: Nein
** PreferredMaintenanceWindow **
Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).
Format: `ddd:hh24:mi-ddd:hh24:mi`
Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem 8-Stunden-Zeitblock ausgewählt wird und an einem zufälligen Wochentag stattfindet. AWS-Region
Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So
Einschränkungen: mindestens 30-Minuten-Zeitfenster.
Typ: Zeichenfolge
Erforderlich: Nein
** PreSignedUrl **
Wird derzeit nicht unterstützt.
Typ: Zeichenfolge
Erforderlich: Nein
** ServerlessV2ScalingConfiguration **
Enthält die Skalierungskonfiguration eines serverlosen Amazon DocumentDB-Clusters.
Typ: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) Objekt
Erforderlich: Nein
** StorageEncrypted **
Gibt an, ob der Cluster verschlüsselt ist.
Typ: Boolesch
Erforderlich: Nein
** StorageType **
Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.
Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im *Amazon DocumentDB Developer Guide*.
Gültige Werte für den Speichertyp - `standard | iopt1`
Der Standardwert ist `standard `
Wenn Sie einen Amazon DocumentDB-Cluster mit dem Speichertyp auf erstellen`iopt1`, wird der Speichertyp in der Antwort zurückgegeben. Der Speichertyp wird nicht zurückgegeben, wenn Sie ihn auf `standard` setzen.
Typ: Zeichenfolge
Erforderlich: Nein
**Stichworte.Tag.N**
Die Tags, die dem Cluster zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
**VpcSecurityGroupIds. VpcSecurityGroupId**N
Eine Liste der EC2-VPC-Sicherheitsgruppen, die mit diesem Cluster verknüpft werden sollen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Sie haben bereits einen Cluster mit der angegebenen Kennung.
HTTP-Statuscode: 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName`bezieht sich nicht auf eine bestehende Cluster-Parametergruppe.
HTTP-Statuscode: 404
** DBClusterQuotaExceededFault **
Der Cluster kann nicht erstellt werden, da Sie das maximal zulässige Kontingent an Clustern erreicht haben.
HTTP-Statuscode: 403
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBSubnetGroupDoesNotCoverEnoughAZs **
Subnetze in der Subnetzgruppe sollten mindestens zwei Availability Zones abdecken, es sei denn, es gibt nur eine Availability Zone.
HTTP-Statuscode: 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** GlobalClusterNotFoundFault **
Das bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InsufficientStorageClusterCapacity **
Für die aktuelle Aktion ist nicht genügend Speicherplatz verfügbar. Möglicherweise können Sie diesen Fehler beheben, indem Sie Ihre Subnetzgruppe so aktualisieren, dass sie verschiedene Availability Zones verwendet, in denen mehr Speicherplatz verfügbar ist.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
** InvalidDBSubnetGroupStateFault **
Die Subnetzgruppe kann nicht gelöscht werden, da sie verwendet wird.
HTTP-Statuscode: 400
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Zustand befindet.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** KMSKeyNotAccessibleFault **
Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.
HTTP-Statuscode: 400
** NetworkTypeNotSupported **
Der Netzwerktyp wird `DBSubnetGroup` weder von der DB-Engine-Version noch von der DB-Engine-Version unterstützt.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instances verfügbar ist.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster)
# CreateDBClusterParameterGroup
Erstellt eine neue Cluster-Parametergruppe.
Parameter in einer Cluster-Parametergruppe gelten für alle Instances in einem Cluster.
Zu Beginn wird eine Cluster-Parametergruppe mit den Standardparametern für die Datenbank-Engine erstellt, die von den Instances im Cluster verwendet wird. In Amazon DocumentDB können Sie keine direkten Änderungen an der `default.docdb3.6` Cluster-Parametergruppe vornehmen. Wenn Ihr Amazon DocumentDB-Cluster die Standard-Cluster-Parametergruppe verwendet und Sie einen Wert darin ändern möchten, müssen Sie zuerst [eine neue Parametergruppe erstellen](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) oder [eine bestehende Parametergruppe kopieren](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), sie ändern und dann die geänderte Parametergruppe auf Ihren Cluster anwenden. Damit die neue Cluster-Parametergruppe und die zugehörigen Einstellungen wirksam werden, müssen Sie anschließend die Instances im Cluster ohne Failover neu starten. Weitere Informationen finden Sie unter [Ändern von Amazon DocumentDB-Cluster-Parametergruppen](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html).
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name der Cluster-Parametergruppe.
Einschränkungen:
+ Darf nicht dem Namen einer vorhandenen `DBClusterParameterGroup` entsprechen.
Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Typ: Zeichenfolge
Erforderlich: Ja
** DBParameterGroupFamily **
Der Name der Cluster-Parametergruppenfamilie.
Typ: Zeichenfolge
Erforderlich: Ja
** Description **
Die Beschreibung der Cluster-Parametergruppe.
Typ: Zeichenfolge
Erforderlich: Ja
**Stichworte.Tag.N**
Die Tags, die der Cluster-Parametergruppe zugeordnet werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterParameterGroup **
Detaillierte Informationen zu einer Cluster-Parametergruppe.
Typ: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupAlreadyExists **
Eine Parametergruppe mit demselben Namen ist bereits vorhanden.
HTTP-Statuscode: 400
** DBParameterGroupQuotaExceeded **
Diese Anforderung würde dazu führen, dass Sie die zulässige Anzahl von Parametergruppen überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
# CreateDBClusterSnapshot
Erstellt einen Snapshot eines Clusters.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die ID des Clusters, für den ein Snapshot erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBCluster` übereinstimmen.
Beispiel: `my-cluster`
Typ: Zeichenfolge
Erforderlich: Ja
** DBClusterSnapshotIdentifier **
Die ID des Cluster-Snapshots. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-cluster-snapshot1`
Typ: Zeichenfolge
Erforderlich: Ja
**Stichworte.Tag.N**
Die Tags, die dem Cluster-Snapshot zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterSnapshot **
Detaillierte Informationen zu einem Cluster-Snapshot.
Typ: [DBClusterSnapshot](API_DBClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBClusterSnapshotAlreadyExistsFault **
Sie haben bereits einen Cluster-Snapshot mit der angegebenen Kennung.
HTTP-Statuscode: 400
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** SnapshotQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Snapshots überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot)
# CreateDBInstance
Erzeugt eine neue Instanz.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die ID des Clusters, zu dem die Instance gehört.
Typ: Zeichenfolge
Erforderlich: Ja
** DBInstanceClass **
Die Rechen- und Speicherkapazität der Instance, beispielsweise `db.r5.large`.
Typ: Zeichenfolge
Erforderlich: Ja
** DBInstanceIdentifier **
Die Instance-ID. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `mydbinstance`
Typ: Zeichenfolge
Erforderlich: Ja
** Engine **
Der Name der Datenbank-Engine, die für diese Instance verwendet werden soll.
Zulässiger Wert: `docdb`
Typ: Zeichenfolge
Erforderlich: Ja
** AutoMinorVersionUpgrade **
Dieser Parameter gilt nicht für Amazon DocumentDB. Amazon DocumentDB führt unabhängig vom eingestellten Wert keine kleineren Versions-Upgrades durch.
Standard: `false`
Typ: Boolesch
Erforderlich: Nein
** AvailabilityZone **
Die Amazon EC2-Availability-Zone, in der die Instance erstellt wird.
Standard: Eine zufällige, vom System gewählte Availability Zone in der Availability Zone des Endpunkts. AWS-Region
Beispiel: `us-east-1d`
Typ: Zeichenfolge
Erforderlich: Nein
** CACertificateIdentifier **
Die CA-Zertifikatskennung, die für das Serverzertifikat der DB-Instance verwendet werden soll.
Weitere Informationen finden Sie unter [Aktualisieren Ihrer Amazon DocumentDB-TLS-Zertifikate](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) und [Verschlüsseln von Daten bei der Übertragung im](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) *Amazon DocumentDB-Entwicklerhandbuch*.
Typ: Zeichenfolge
Erforderlich: Nein
** CopyTagsToSnapshot **
Ein Wert, der angibt, ob Tags aus der DB-Instance in Snapshots der DB-Instance kopiert werden sollen. Standardmäßig werden Tags nicht kopiert.
Typ: Boolesch
Erforderlich: Nein
** EnablePerformanceInsights **
Ein Wert, der angibt, ob Performance Insights für die DB-Instance aktiviert werden sollen. Weitere Informationen finden Sie unter [Verwenden von Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
Typ: Boolesch
Erforderlich: Nein
** PerformanceInsightsKMSKeyId **
Die AWS KMS Schlüssel-ID für die Verschlüsselung von Performance Insights Insights-Daten.
Die AWS KMS Schlüssel-ID ist der Schlüssel-ARN, die Schlüssel-ID, der Alias-ARN oder der Aliasname für den KMS-Schlüssel.
Wenn Sie keinen Wert für PerformanceInsights KMSKey Id angeben, verwendet Amazon DocumentDB Ihren Standard-KMS-Schlüssel. Es gibt einen Standard-KMS-Schlüssel für Ihr Amazon Web Services Services-Konto. Ihr Amazon Web Services Services-Konto hat für jede Amazon Web Services Services-Region einen anderen Standard-KMS-Schlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** PreferredMaintenanceWindow **
Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).
Format: `ddd:hh24:mi-ddd:hh24:mi`
Die Standardeinstellung ist ein Zeitfenster von 30 Minuten, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird und an einem zufälligen Wochentag stattfindet.
Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So
Einschränkungen: mindestens 30-Minuten-Zeitfenster.
Typ: Zeichenfolge
Erforderlich: Nein
** PromotionTier **
Ein Wert, der die Reihenfolge angibt, in der ein Amazon DocumentDB DocumentDB-Replikat nach einem Ausfall der vorhandenen primären Instance zur primären Instance heraufgestuft wird.
Standard: 1
Gültige Werte: 0-15
Typ: Ganzzahl
Erforderlich: Nein
**Stichworte.Tag.N**
Die Tags, die der Instance zugewiesen werden sollen. Sie können einer Instance bis zu 10 Tags zuweisen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBInstance **
Detaillierte Informationen zu einer Instanz.
Typ: [DBInstance](API_DBInstance.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AuthorizationNotFound **
Die angegebene CIDR-IP oder Amazon EC2-Sicherheitsgruppe ist für die angegebene Sicherheitsgruppe nicht autorisiert.
Amazon DocumentDB ist möglicherweise auch nicht autorisiert, die erforderlichen Aktionen in Ihrem Namen mithilfe von IAM durchzuführen.
HTTP-Statuscode: 404
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBInstanceAlreadyExists **
Sie haben bereits eine Instanz mit der angegebenen ID.
HTTP-Statuscode: 400
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** DBSecurityGroupNotFound **
`DBSecurityGroupName`bezieht sich nicht auf eine bestehende Sicherheitsgruppe.
HTTP-Statuscode: 404
** DBSubnetGroupDoesNotCoverEnoughAZs **
Subnetze in der Subnetzgruppe sollten mindestens zwei Availability Zones abdecken, es sei denn, es gibt nur eine Availability Zone.
HTTP-Statuscode: 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** InstanceQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Instanzen überschreiten.
HTTP-Statuscode: 400
** InsufficientDBInstanceCapacity **
Die angegebene Instanzklasse ist in der angegebenen Availability Zone nicht verfügbar.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** KMSKeyNotAccessibleFault **
Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instanzen verfügbar ist.
HTTP-Statuscode: 400
** StorageTypeNotSupported **
Der angegebene Speicher `StorageType` kann der DB-Instance nicht zugeordnet werden.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance)
# CreateDBSubnetGroup
Erstellt eine neue Subnetzgruppe. Subnetzgruppen müssen mindestens ein Subnetz in mindestens zwei Availability Zones in der enthalten. AWS-Region
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBSubnetGroupDescription **
Die Beschreibung für die Subnetzgruppe.
Typ: Zeichenfolge
Erforderlich: Ja
** DBSubnetGroupName **
Der Name für die Subnetzgruppe. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen: Darf nicht mehr als 255 Buchstaben, Ziffern, Punkte, Unterstriche, Leerzeichen und Bindestriche enthalten. Der Name darf nicht default sein.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Ja
**SubnetIds. SubnetIdentifier**N
Das Amazon EC2-Subnetz IDs für die Subnetzgruppe.
Typ: Zeichenfolgen-Array
Erforderlich: Ja
**Stichworte.Tag.N**
Das Tag, das der Subnetzgruppe zugeordnet werden soll.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBSubnetGroup **
Detaillierte Informationen zu einer Subnetzgruppe.
Typ: [DBSubnetGroup](API_DBSubnetGroup.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBSubnetGroupAlreadyExists **
`DBSubnetGroupName`wird bereits von einer vorhandenen Subnetzgruppe verwendet.
HTTP-Statuscode: 400
** DBSubnetGroupDoesNotCoverEnoughAZs **
Subnetze in der Subnetzgruppe sollten mindestens zwei Availability Zones abdecken, es sei denn, es gibt nur eine Availability Zone.
HTTP-Statuscode: 400
** DBSubnetGroupQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Subnetzgruppen überschreiten.
HTTP-Statuscode: 400
** DBSubnetQuotaExceededFault **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Subnetzen in einer Subnetzgruppe überschreiten.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup)
# CreateEventSubscription
Erstellt ein Abonnement für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen. Für diese Aktion ist ein Thema mit dem Amazon Resource Name (ARN) erforderlich, das mithilfe der Amazon DocumentDB DocumentDB-Konsole, der Amazon SNS SNS-Konsole oder der Amazon SNS SNS-API erstellt wurde. Um einen ARN mit Amazon SNS zu erhalten, müssen Sie ein Thema in Amazon SNS erstellen und das Thema abonnieren. Der ARN wird in der Amazon SNS SNS-Konsole angezeigt.
Sie können den Typ der Quelle (`SourceType`) angeben, über die Sie benachrichtigt werden möchten. Sie können auch eine Liste der Amazon DocumentDB DocumentDB-Quellen (`SourceIds`) bereitstellen, die die Ereignisse auslösen, und Sie können eine Liste von Ereigniskategorien (`EventCategories`) für Ereignisse bereitstellen, über die Sie benachrichtigt werden möchten. Sie können beispielsweise angeben`SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` und`EventCategories = Availability, Backup`.
Wenn Sie sowohl als auch angeben `SourceIds` (z. B. `SourceType = db-instance` und`SourceIdentifier = myDBInstance1`), werden Sie über alle `db-instance` Ereignisse für die angegebene Quelle informiert. `SourceType` Wenn Sie eine angeben, `SourceType` aber keine angeben`SourceIdentifier`, erhalten Sie eine Benachrichtigung über die Ereignisse für diesen Quelltyp für alle Ihre Amazon DocumentDB DocumentDB-Quellen. Wenn Sie weder das noch das `SourceType` angeben, werden Sie über Ereignisse informiert`SourceIdentifier`, die aus allen Amazon DocumentDB DocumentDB-Quellen generiert wurden, die zu Ihrem Kundenkonto gehören.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SnsTopicArn **
Der Amazon-Ressourcenname (ARN) des SNS-Themas, das für die Ereignisbenachrichtigung erstellt wurde. Amazon SNS erstellt den ARN, wenn Sie ein Thema erstellen und es abonnieren.
Typ: Zeichenfolge
Erforderlich: Ja
** SubscriptionName **
Der Name des Abonnements.
Einschränkungen: Der Name muss weniger als 255 Zeichen lang sein.
Typ: Zeichenfolge
Erforderlich: Ja
** Enabled **
Ein boolescher Wert. Wird auf gesetzt, `true` um das Abonnement zu aktivieren, gesetzt auf, `false` um das Abonnement zu erstellen, aber nicht zu aktivieren.
Typ: Boolesch
Erforderlich: Nein
**EventCategories. EventCategory**N
Eine Liste der Veranstaltungskategorien für eine`SourceType`, die Sie abonnieren möchten.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
**SourceIds. SourceId**N
Die Liste der IDs der Ereignisquellen, für die Ereignisse zurückgegeben werden. Wenn nicht angegeben, werden alle Quellen zur Antwort hinzugefügt. Eine ID muss mit einem Buchstaben beginnen und darf nur ASCII-Buchstaben, Ziffern und Bindestriche enthalten; sie darf nicht mit einem Bindestrich oder zwei aufeinander folgenden Bindestrichen enden.
Einschränkungen:
+ Wenn `SourceIds` angegeben, `SourceType` muss auch angegeben werden.
+ Wenn der Quelltyp eine Instanz ist, `DBInstanceIdentifier` muss a angegeben werden.
+ Wenn der Quelltyp eine Sicherheitsgruppe ist, `DBSecurityGroupName` muss a angegeben werden.
+ Wenn der Quelltyp eine Parametergruppe ist, `DBParameterGroupName` muss a angegeben werden.
+ Wenn der Quelltyp ein Snapshot ist, `DBSnapshotIdentifier` muss a angegeben werden.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** SourceType **
Der Typ der Quelle, die die Ereignisse generiert. Wenn Sie beispielsweise über Ereignisse informiert werden möchten, die von einer Instanz generiert wurden, würden Sie diesen Parameter auf setzen`db-instance`. Wenn der Wert nicht angegeben ist, werden alle Ereignisse zurückgegeben.
Gültige Werte: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`
Typ: Zeichenfolge
Erforderlich: Nein
**Tags.Tag.N**
Die Tags, die dem Event-Abonnement zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** EventSubscription **
Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.
Typ: [EventSubscription](API_EventSubscription.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** EventSubscriptionQuotaExceeded **
Sie haben die maximale Anzahl von Event-Abonnements erreicht.
HTTP-Statuscode: 400
** SNSInvalidTopic **
Amazon SNS hat geantwortet, dass es ein Problem mit dem angegebenen Thema gibt.
HTTP-Statuscode: 400
** SNSNoAuthorization **
Sie sind nicht berechtigt, zum SNS-Thema Amazon Resource Name (ARN) zu veröffentlichen.
HTTP-Statuscode: 400
** SNSTopicArnNotFound **
Das SNS-Thema Amazon Resource Name (ARN) existiert nicht.
HTTP-Statuscode: 404
** SourceNotFound **
Die angeforderte Quelle konnte nicht gefunden werden.
HTTP-Statuscode: 404
** SubscriptionAlreadyExist **
Der angegebene Abonnementname ist bereits vorhanden.
HTTP-Statuscode: 400
** SubscriptionCategoryNotFound **
Die angegebene Kategorie ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription)
# CreateGlobalCluster
Erstellt einen globalen Amazon DocumentDB-Cluster, der sich über mehrere AWS-Regionen erstrecken kann. Der globale Cluster enthält einen primären Cluster mit Lese- und Schreibfunktion und bis zu 10 schreibgeschützte sekundäre Cluster. Global Clusters verwendet speicherbasierte schnelle Replikation über Regionen hinweg mit Latenzen von weniger als einer Sekunde. Dabei wird eine dedizierte Infrastruktur verwendet, ohne dass die Leistung Ihrer Workloads beeinträchtigt wird.
Sie können einen globalen Cluster erstellen, der zunächst leer ist, und ihm dann einen primären und einen sekundären hinzufügen. Oder Sie können während des Erstellungsvorgangs einen vorhandenen Cluster angeben, der dann zum primären Cluster des globalen Clusters wird.
**Anmerkung**
Diese Aktion gilt nur für Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** GlobalClusterIdentifier **
Die Cluster-ID des neuen globalen Clusters.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
** DatabaseName **
Der Name für Ihre Datenbank mit bis zu 64 alphanumerischen Zeichen. Wenn Sie keinen Namen angeben, erstellt Amazon DocumentDB keine Datenbank in dem globalen Cluster, den Sie erstellen.
Typ: Zeichenfolge
Erforderlich: Nein
** DeletionProtection **
Die Löschschutzeinstellung für den neuen globalen Cluster. Der globale Cluster kann nicht gelöscht werden, wenn der Löschschutz aktiviert ist.
Typ: Boolesch
Erforderlich: Nein
** Engine **
Der Name der Datenbank-Engine, die für diesen Cluster verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
** EngineVersion **
Die Engine-Version des globalen Clusters.
Typ: Zeichenfolge
Erforderlich: Nein
** SourceDBClusterIdentifier **
Der Amazon-Ressourcenname (ARN), der als primärer Cluster des globalen Clusters verwendet werden soll. Dieser Parameter ist optional.
Typ: Zeichenfolge
Erforderlich: Nein
** StorageEncrypted **
Die Einstellung für die Speicherverschlüsselung für den neuen globalen Cluster.
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** GlobalClusterAlreadyExistsFault **
`GlobalClusterIdentifier` ist bereits vorhanden. Wählen Sie eine neue globale Cluster-ID (eindeutiger Name), um einen neuen globalen Cluster zu erstellen.
HTTP-Statuscode: 400
** GlobalClusterQuotaExceededFault **
Die Anzahl der globalen Cluster für dieses Konto hat bereits den zulässigen Höchstwert erreicht.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster)
# DeleteDBCluster
Löscht einen zuvor bereitgestellten Cluster. Wenn Sie einen Cluster löschen, werden alle automatisierten Backups für diesen Cluster gelöscht und können nicht wiederhergestellt werden. Manuelle DB-Cluster-Snapshots des angegebenen Clusters werden nicht gelöscht.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die Cluster-ID für den zu löschenden Cluster. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit einem vorhandenen übereinstimmen`DBClusterIdentifier`.
Typ: Zeichenfolge
Erforderlich: Ja
** FinalDBSnapshotIdentifier **
Die Cluster-Snapshot-ID des neuen Cluster-Snapshots, der erstellt wurde, wenn auf gesetzt `SkipFinalSnapshot` ist`false`.
Die Angabe dieses Parameters und das Setzen des `SkipFinalShapshot` Parameters `true` auf führen zu einem Fehler.
Einschränkungen:
+ Muss aus 1 bis 255 Buchstaben, Zahlen oder Bindestrichen bestehen.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** SkipFinalSnapshot **
Bestimmt, ob ein letzter Cluster-Snapshot erstellt wird, bevor der Cluster gelöscht wird. Wenn angegeben, `true` wird kein Cluster-Snapshot erstellt. Wenn angegeben, `false` wird ein Cluster-Snapshot erstellt, bevor der DB-Cluster gelöscht wird.
Wenn `SkipFinalSnapshot` ja`false`, müssen Sie einen `FinalDBSnapshotIdentifier` Parameter angeben.
Standard: `false`
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBClusterSnapshotAlreadyExistsFault **
Sie haben bereits einen Cluster-Snapshot mit der angegebenen Kennung.
HTTP-Statuscode: 400
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** SnapshotQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Snapshots überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster)
# DeleteDBClusterParameterGroup
Löscht eine angegebene Cluster-Parametergruppe. Die zu löschende Cluster-Parametergruppe kann keinem Cluster zugeordnet werden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name der Cluster-Parametergruppe.
Einschränkungen:
+ Muss der Name einer vorhandenen Cluster-Parametergruppe sein.
+ Sie können eine Standard-Cluster-Parametergruppe nicht löschen.
+ Kann keinem Cluster zugeordnet werden.
Typ: Zeichenfolge
Erforderlich: Ja
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** InvalidDBParameterGroupState **
Die Parametergruppe wird verwendet oder befindet sich in einem Status, der nicht gültig ist. Wenn Sie versuchen, die Parametergruppe zu löschen, können Sie sie nicht löschen, wenn sich die Parametergruppe in diesem Status befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
# DeleteDBClusterSnapshot
Löscht einen Cluster-Snapshot. Wenn der Snapshot gerade kopiert wird, wird der Kopiervorgang beendet.
**Anmerkung**
Der Cluster-Snapshot muss sich in dem `available` Zustand befinden, in dem er gelöscht werden kann.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterSnapshotIdentifier **
Die ID des Cluster-Snapshots, der gelöscht werden soll.
Einschränkungen: Muss der Name eines vorhandenen Cluster-Snapshots im `available` Status sein.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterSnapshot **
Detaillierte Informationen zu einem Cluster-Snapshot.
Typ: [DBClusterSnapshot](API_DBClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
# DeleteDBInstance
Löscht eine zuvor bereitgestellte Instanz.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBInstanceIdentifier **
Die Instanz-ID für die zu löschende Instanz. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit dem Namen einer vorhandenen Instanz übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBInstance **
Detaillierte Informationen zu einer Instanz.
Typ: [DBInstance](API_DBInstance.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBSnapshotAlreadyExists **
`DBSnapshotIdentifier`wird bereits von einem vorhandenen Snapshot verwendet.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
** SnapshotQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Snapshots überschreiten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance)
# DeleteDBSubnetGroup
Löscht eine Subnetzgruppe.
**Anmerkung**
Die angegebene Datenbanksubnetzgruppe muss nicht mit beliebigen DB-Instances verknüpft werden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBSubnetGroupName **
Der Name der zu löschenden Datenbanksubnetzgruppe.
Sie können die Standardsubnetzgruppe nicht löschen.
Einschränkungen:
Muss dem Namen einer vorhandenen `DBSubnetGroup` entsprechen. Der Name darf nicht default sein.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Ja
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** InvalidDBSubnetGroupStateFault **
Die Subnetzgruppe kann nicht gelöscht werden, da sie verwendet wird.
HTTP-Statuscode: 400
** InvalidDBSubnetStateFault **
Das Subnetz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup)
# DeleteEventSubscription
Löscht ein Abonnement für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SubscriptionName **
Der Name des Amazon DocumentDB DocumentDB-Abonnements für Ereignisbenachrichtigungen, das Sie löschen möchten.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** EventSubscription **
Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.
Typ: [EventSubscription](API_EventSubscription.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** InvalidEventSubscriptionState **
Möglicherweise ändert jemand anderes ein Abonnement. Warten Sie ein paar Sekunden und versuchen Sie es erneut.
HTTP-Statuscode: 400
** SubscriptionNotFound **
Der Abonnementname ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription)
# DeleteGlobalCluster
Löscht einen globalen Cluster. Der primäre und der sekundäre Cluster müssen bereits getrennt oder gelöscht sein, bevor versucht wird, einen globalen Cluster zu löschen.
**Anmerkung**
Diese Aktion gilt nur für Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** GlobalClusterIdentifier **
Die Cluster-ID des globalen Clusters, der gelöscht wird.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** GlobalClusterNotFoundFault **
Der bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Zustand befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster)
# DescribeCertificates
Gibt eine Liste von Zertifikaten der Zertifizierungsstelle (CA) zurück, die Amazon DocumentDB dafür AWS-Konto bereitgestellt hat.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** CertificateIdentifier **
Die vom Benutzer angegebene Zertifikats-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen für das angegebene Zertifikat zurückgegeben. Wenn dieser Parameter weggelassen wird, wird eine Liste mit bis zu `MaxRecords` Zertifikaten zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Beschränkungen
+ Muss mit einem vorhandenen übereinstimmen`CertificateIdentifier`.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen `DescribeCertificates`-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert `MaxRecords` angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen:
+ Mindestens: 20
+ Maximum: 100
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**Zertifikate.Zertifikate.N**
Eine Liste von Zertifikaten dafür. AWS-Konto
Typ: Array von [Certificate](API_Certificate.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das bereitgestellt wird, wenn die Anzahl der abgerufenen Datensätze größer als `MaxRecords` ist. Wenn dieser Parameter angegeben ist, gibt die Markierung den nächsten Datensatz in der Liste an. Wenn Sie den Wert von `Marker` in den nächsten Aufruf aufnehmen, `DescribeCertificates` erhalten Sie die nächste Seite mit Zertifikaten.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** CertificateNotFound **
`CertificateIdentifier`bezieht sich nicht auf ein vorhandenes Zertifikat.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates)
# DescribeDBClusterParameterGroups
Gibt eine Liste von `DBClusterParameterGroup`-Beschreibungen zurück. Wenn ein `DBClusterParameterGroupName` Parameter angegeben ist, enthält die Liste nur die Beschreibung der angegebenen Cluster-Parametergruppe.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name einer bestimmten Cluster-Parametergruppe, für die Details zurückgegeben werden sollen.
Einschränkungen:
+ Falls angegeben, muss er mit dem Namen einer vorhandenen Datei übereinstimmen`DBClusterParameterGroup`.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBClusterParameterGroups. DBClusterParameterGroup**N
Eine Liste von Cluster-Parametergruppen.
Typ: Array von [DBClusterParameterGroup](API_DBClusterParameterGroup.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
# DescribeDBClusterParameters
Gibt die detaillierte Parameterliste für eine bestimmte Cluster-Parametergruppe zurück.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name einer bestimmten Cluster-Parametergruppe, für die Parameterdetails zurückgegeben werden sollen.
Einschränkungen:
+ Falls angegeben, muss er mit dem Namen einer vorhandenen Datei übereinstimmen`DBClusterParameterGroup`.
Typ: Zeichenfolge
Erforderlich: Ja
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** Source **
Dieser Wert gibt an, dass nur die Parameter für eine bestimmte Quelle zurückgegeben werden sollen. Parameterquellen können `engine`, `service` oder `customer` sein.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
**Parameter.Parameter.N**
Gibt eine Liste der Parameter für die Cluster-Parametergruppe zurück.
Typ: Array von [Parameter](API_Parameter.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters)
# DescribeDBClusters
Gibt Informationen über bereitgestellte Amazon DocumentDB-Cluster zurück. Dieser API-Vorgang unterstützt die Paginierung. Für bestimmte Verwaltungsfunktionen wie Cluster- und Instance-Lebenszyklusmanagement nutzt Amazon DocumentDB Betriebstechnologie, die mit Amazon RDS und Amazon Neptune gemeinsam genutzt wird. Verwenden Sie den `filterName=engine,Values=docdb` Filterparameter, um nur Amazon DocumentDB-Cluster zurückzugeben.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die vom Benutzer angegebene Cluster-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen aus dem spezifischen Cluster zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Falls angegeben, muss er mit einem vorhandenen übereinstimmen`DBClusterIdentifier`.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Ein Filter, der einen oder mehrere zu beschreibende Cluster angibt.
Unterstützte Filter:
+ `db-cluster-id`- Akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur Informationen zu den Clustern, die durch diese ARNs identifiziert wurden.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBClusters. DBCluster**N
Eine Liste von Clustern.
Typ: Array von [DBCluster](API_DBCluster.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters)
# DescribeDBClusterSnapshotAttributes
Gibt eine Liste von Cluster-Snapshot-Attributnamen und -werten für einen manuellen DB-Cluster-Snapshot zurück.
Wenn Sie Snapshots mit anderen teilen AWS-Konten, werden das `restore` Attribut und eine Liste der IDs Personen `DescribeDBClusterSnapshotAttributes` zurückgegeben AWS-Konten , die berechtigt sind, den manuellen Cluster-Snapshot zu kopieren oder wiederherzustellen. Wenn `all` es in der Werteliste für das `restore` Attribut enthalten ist, ist der manuelle Cluster-Snapshot öffentlich und kann von allen AWS-Konten kopiert oder wiederhergestellt werden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterSnapshotIdentifier **
Der Bezeichner für den Cluster-Snapshot, für den die Attribute beschrieben werden sollen.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterSnapshotAttributesResult **
Detaillierte Informationen zu den Attributen, die einem Cluster-Snapshot zugeordnet sind.
Typ: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
# DescribeDBClusterSnapshots
Gibt Informationen über Cluster-Snapshots zurück. Dieser API-Vorgang unterstützt Paginierung.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die ID des Clusters, für den die Liste der Cluster-Snapshots abgerufen werden soll. Dieser Parameter kann nicht mit dem `DBClusterSnapshotIdentifier` Parameter verwendet werden. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Falls angegeben, muss er mit dem Bezeichner eines vorhandenen identisch sein`DBCluster`.
Typ: Zeichenfolge
Erforderlich: Nein
** DBClusterSnapshotIdentifier **
Eine spezifische Cluster-Snapshot-ID, die beschrieben werden soll. Dieser Parameter kann nicht mit dem `DBClusterIdentifier` Parameter verwendet werden. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Falls angegeben, muss er mit dem Bezeichner eines vorhandenen identisch sein`DBClusterSnapshot`.
+ Wenn diese Kennung für einen automatisierten Snapshot ist, muss auch der Parameter `SnapshotType` angegeben werden.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** IncludePublic **
Ist auf eingestellt`true`, um manuelle Cluster-Snapshots einzubeziehen, die öffentlich sind und von jedem kopiert oder wiederhergestellt werden können. AWS-Konto`false` Der Standardwert ist `false`.
Typ: Boolesch
Erforderlich: Nein
** IncludeShared **
Legt fest, `true` dass auch gemeinsam genutzte manuelle Cluster-Snapshots von anderen Benutzern aufgenommen werden AWS-Konten , für AWS-Konto deren Kopieren oder Wiederherstellung die entsprechenden Rechte erteilt wurden, und aus anderen Gründen. `false` Der Standardwert ist `false`.
Typ: Boolesch
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, wird ein Paginierungstoken (Markierung) in die Antwort aufgenommen, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** SnapshotType **
Der Typ der Cluster-Snapshots, die zurückgegeben werden sollen. Sie können einen der folgenden Werte angeben:
+ `automated`- Gibt alle Cluster-Snapshots zurück, die Amazon DocumentDB automatisch für Sie erstellt hat. AWS-Konto
+ `manual`- Gibt alle Cluster-Snapshots zurück, die Sie manuell für Ihren erstellt haben. AWS-Konto
+ `shared`- Gibt alle manuellen Cluster-Snapshots zurück, die für Sie freigegeben wurden. AWS-Konto
+ `public`- Gibt alle Cluster-Snapshots zurück, die als öffentlich markiert wurden.
Wenn Sie keinen `SnapshotType` Wert angeben, werden sowohl automatisierte als auch manuelle Cluster-Snapshots zurückgegeben. Sie können gemeinsam genutzte Cluster-Snapshots in diese Ergebnisse einbeziehen, indem Sie den `IncludeShared` Parameter auf setzen. `true` Sie können öffentliche Cluster-Snapshots in diese Ergebnisse einbeziehen, indem Sie den `IncludePublic` Parameter auf setzen. `true`
Die Parameter `IncludePublic` und `IncludeShared` gelten nicht für `SnapshotType`-Werte von `manual` oder `automated`. Der Parameter `IncludePublic` gilt nicht, wenn `SnapshotType` auf `shared` festgelegt ist. Der Parameter `IncludeShared` gilt nicht, wenn `SnapshotType` auf `public` festgelegt ist.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBClusterSchnappschüsse. DBClusterSchnappschuss.N**
Stellt eine Liste von Cluster-Snapshots bereit.
Typ: Array von [DBClusterSnapshot](API_DBClusterSnapshot.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
# DescribeDBEngineVersions
Gibt eine Liste der verfügbaren Engines zurück.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBParameterGroupFamily **
Der Name einer bestimmten Parametergruppenfamilie, für die Details zurückgegeben werden sollen.
Einschränkungen:
+ Falls angegeben, muss er mit einem vorhandenen übereinstimmen`DBParameterGroupFamily`.
Typ: Zeichenfolge
Erforderlich: Nein
** DefaultOnly **
Gibt an, dass nur die standardmäßige Version der angegebenen Engine oder Kombination aus Engine und Hauptversion zurückgegeben wird.
Typ: Boolesch
Erforderlich: Nein
** Engine **
Die zurückzugebende Datenbank-Engine.
Typ: Zeichenfolge
Erforderlich: Nein
** EngineVersion **
Die zurückzugebende Datenbank-Engine-Version.
Beispiel: `3.6.0`
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** ListSupportedCharacterSets **
Wenn dieser Parameter angegeben ist und die angeforderte Engine den Parameter `CharacterSetName` für `CreateDBInstance` unterstützt, enthält die Antwort eine Liste der unterstützten Zeichensätze für jede Engine-Version.
Typ: Boolesch
Erforderlich: Nein
** ListSupportedTimezones **
Wenn dieser Parameter angegeben ist und die angeforderte Engine den Parameter `TimeZone` für `CreateDBInstance` unterstützt, enthält die Antwort eine Liste der unterstützten Zeitzonen für jede Engine-Version.
Typ: Boolesch
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBEngineVersionen. DBEngineVersion.N**
Detaillierte Informationen zu einer oder mehreren Engine-Versionen.
Typ: Array von [DBEngineVersion](API_DBEngineVersion.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions)
# DescribeDBInstances
Gibt Informationen über bereitgestellte Amazon DocumentDB DocumentDB-Instances zurück. Diese API unterstützt Paginierung.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBInstanceIdentifier **
Die vom Benutzer angegebene Instance-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen von der jeweiligen Instanz zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Falls angegeben, muss er mit dem Bezeichner einer vorhandenen übereinstimmen`DBInstance`.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Ein Filter, der eine oder mehrere zu beschreibende Instanzen angibt.
Unterstützte Filter:
+ `db-cluster-id`- Akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur die Informationen über die Instances, die den Clustern zugeordnet sind, die durch diese ARNs identifiziert werden.
+ `db-instance-id`- Akzeptiert Instanzkennungen und Instanzen ARNs. Die Ergebnisliste enthält nur die Informationen über die Instanzen, die durch diese ARNs identifiziert werden.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBInstances. DBInstance**N
Detaillierte Informationen zu einer oder mehreren Instanzen.
Typ: Array von [DBInstance](API_DBInstance.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances)
# DescribeDBSubnetGroups
Gibt eine Liste von `DBSubnetGroup`-Beschreibungen zurück. Wenn a angegeben `DBSubnetGroupName` ist, enthält die Liste nur die Beschreibungen der angegebenen`DBSubnetGroup`.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBSubnetGroupName **
Der Name der Subnetzgruppe, für die Details zurückgegeben werden sollen.
Typ: Zeichenfolge
Erforderlich: Nein
**Filters.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**DBSubnetGruppen. DBSubnetGruppe.N**
Detaillierte Informationen zu einer oder mehreren Subnetzgruppen.
Typ: Array von [DBSubnetGroup](API_DBSubnetGroup.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups)
# DescribeEngineDefaultClusterParameters
Gibt die Standard-Engine- und System-Parameterinformationen für die Cluster-Datenbank-Engine zurück.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBParameterGroupFamily **
Der Name der Cluster-Parametergruppenfamilie, für die die Engine-Parameterinformationen zurückgegeben werden sollen.
Typ: Zeichenfolge
Erforderlich: Ja
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** EngineDefaults **
Enthält das Ergebnis eines erfolgreichen Aufrufs der `DescribeEngineDefaultClusterParameters` Operation.
Typ: [EngineDefaults](API_EngineDefaults.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
# DescribeEventCategories
Zeigt eine Liste der Kategorien für alle Ereignisquelltypen oder – falls angegeben – für einen angegebenen Quelltyp an.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** SourceType **
Der Typ der Quelle, die die Ereignisse generiert.
Zulässige Werte: `db-instance`, `db-parameter-group`, `db-security-group`
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
**EventCategoriesMapList. EventCategoriesMap**N
Eine Liste von Karten mit Event-Kategorien.
Typ: Array von [EventCategoriesMap](API_EventCategoriesMap.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories)
# DescribeEvents
Gibt Ereignisse zurück, die sich auf Instances, Sicherheitsgruppen, Snapshots und DB-Parametergruppen der letzten 14 Tage beziehen. Sie können Ereignisse abrufen, die für eine bestimmte DB-Instance, Sicherheitsgruppe, einen Snapshot oder eine Parametergruppe spezifisch sind, indem Sie den Namen als Parameter angeben. Standardmäßig werden die Ereignisse der letzten Stunde zurückgegeben.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** Duration **
Die Anzahl der Minuten, in denen Ereignisse abgerufen werden sollen.
Standard: 60
Typ: Ganzzahl
Erforderlich: Nein
** EndTime **
Das Ende des Zeitintervalls, für das Ereignisse abgerufen werden sollen, angegeben im ISO 8601-Format.
Beispiel: 2009-07-08T18:00Z
Typ: Zeitstempel
Erforderlich: Nein
**EventCategories. EventCategory**N
Eine Liste von Ereigniskategorien, die Benachrichtigungen für ein Abonnement für Ereignisbenachrichtigungen auslösen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** SourceIdentifier **
ID der Ereignisquelle, für die Ereignisse zurückgegeben werden. Wenn nicht angegeben, werden alle Quellen zur Antwort hinzugefügt.
Einschränkungen:
+ Wenn `SourceIdentifier` angegeben, `SourceType` muss es auch angegeben werden.
+ Wenn der Quelltyp ist`DBInstance`, `DBInstanceIdentifier` muss a angegeben werden.
+ Wenn der Quelltyp ist`DBSecurityGroup`, `DBSecurityGroupName` muss a angegeben werden.
+ Wenn der Quelltyp ist`DBParameterGroup`, `DBParameterGroupName` muss a angegeben werden.
+ Wenn der Quelltyp ist`DBSnapshot`, `DBSnapshotIdentifier` muss a angegeben werden.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** SourceType **
Die Ereignisquelle zum Abrufen von Ereignissen. Wenn kein Wert angegeben ist, werden alle Ereignisse zurückgegeben.
Typ: Zeichenfolge
Zulässige Werte: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`
Erforderlich: Nein
** StartTime **
Der Beginn des Zeitintervalls, für das Ereignisse abgerufen werden sollen, angegeben im ISO 8601-Format.
Beispiel: 2009-07-08T18:00Z
Typ: Zeitstempel
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**Events.Event.N**
Detaillierte Informationen zu einer oder mehreren Veranstaltungen.
Typ: Array von [Event](API_Event.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents)
# DescribeEventSubscriptions
Listet alle Abonnementbeschreibungen für ein Kundenkonto auf. Die Beschreibung für ein Abonnement umfasst `SubscriptionName``SNSTopicARN`,`CustomerID`,`SourceType`,`SourceID`,`CreationTime`, und`Status`.
Wenn Sie eine angeben`SubscriptionName`, wird die Beschreibung für dieses Abonnement aufgeführt.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** SubscriptionName **
Der Name des Amazon DocumentDB DocumentDB-Abonnements für Ereignisbenachrichtigungen, das Sie beschreiben möchten.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Service zurückgegeben.
**EventSubscriptionsList. EventSubscription**N
Eine Liste von Event-Abonnements.
Typ: Array von [EventSubscription](API_EventSubscription.md)-Objekten
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** SubscriptionNotFound **
Der Abonnementname ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions)
# DescribeGlobalClusters
Gibt Informationen über globale Amazon DocumentDB-Cluster zurück. Diese API unterstützt Paginierung.
**Anmerkung**
Diese Aktion gilt nur für Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
**Filters.Filter.N**
Ein Filter, der einen oder mehrere globale DB-Cluster spezifiziert, die beschrieben werden sollen.
Unterstützte Filter: `db-cluster-id` akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur Informationen zu den Clustern, die durch diese ARNs identifiziert wurden.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** GlobalClusterIdentifier **
Die vom Benutzer angegebene Cluster-ID. Wenn dieser Parameter angegeben ist, werden nur Informationen aus dem spezifischen Cluster zurückgegeben. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen `DescribeGlobalClusters`-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken, das als Markierung bezeichnet wird, in der Antwort enthalten, sodass Sie die verbleibenden Ergebnisse abrufen können.
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
**GlobalClusters. GlobalClusterMember**N
Typ: Array von [GlobalCluster](API_GlobalCluster.md)-Objekten
** Marker **
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** GlobalClusterNotFoundFault **
Das bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters)
# DescribeOrderableDBInstanceOptions
Gibt eine Liste bestellbarer Instanzoptionen für die angegebene Engine zurück.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** Engine **
Der Name der Engine, für die Instanzoptionen abgerufen werden sollen.
Typ: Zeichenfolge
Erforderlich: Ja
** DBInstanceClass **
Der Filterwert der Instanzklasse. Geben Sie diesen Parameter an, um nur die verfügbaren Angebote anzuzeigen, die der angegebenen Instanzklasse entsprechen.
Typ: Zeichenfolge
Erforderlich: Nein
** EngineVersion **
Der Filterwert der Engine-Version. Geben Sie diesen Parameter an, um nur die verfügbaren Angebote anzuzeigen, die der angegebenen Engine-Version entsprechen.
Typ: Zeichenfolge
Erforderlich: Nein
**Filter.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** LicenseModel **
Der Filterwert des Lizenzmodells. Geben Sie diesen Parameter an, um nur die verfügbaren Angebote anzuzeigen, die dem angegebenen Lizenzmodell entsprechen.
Typ: Zeichenfolge
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** Vpc **
Der Wert des VPC-Filters (Virtual Private Cloud). Geben Sie diesen Parameter an, um nur die verfügbaren VPC- oder Nicht-VPC-Angebote anzuzeigen.
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
**Bestellbare Optionen.Bestellbare DBInstance Option.N DBInstance**
Die Optionen, die für eine bestimmte bestellbare Instanz verfügbar sind.
Typ: Array von [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
# DescribePendingMaintenanceActions
Gibt eine Liste von Ressourcen (z. B. Instanzen) zurück, für die mindestens eine Wartungsaktion aussteht.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
**Filter.Filter.N**
Ein Filter, der eine oder mehrere Ressourcen angibt, für die ausstehende Wartungsaktionen zurückgegeben werden sollen.
Unterstützte Filter:
+ `db-cluster-id`- Akzeptiert Cluster-Identifikatoren und Cluster-Amazon-Ressourcennamen (ARNs). Die Ergebnisliste enthält nur ausstehende Wartungsaktionen für die Cluster, die durch diese ARNs identifiziert wurden.
+ `db-instance-id`- Akzeptiert Instanzkennungen und Instanzen ARNs. Die Ergebnisliste enthält nur ausstehende Wartungsaktionen für die DB-Instances, die durch diese ARNs identifiziert wurden.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
Erforderlich: Nein
** MaxRecords **
Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene `MaxRecords` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Standard: 100
Einschränkungen: Mindestwert 20, Höchstwert 100.
Typ: Ganzzahl
Erforderlich: Nein
** ResourceIdentifier **
Der ARN einer Ressource, für die ausstehende Wartungsaktionen zurückgegeben werden sollen.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Die folgenden Elemente werden vom Dienst zurückgegeben.
** Marker **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `MaxRecords` angegebenen Wert.
Typ: Zeichenfolge
**PendingMaintenanceActions. ResourcePendingMaintenanceActions**N
Die anzuwendenden Wartungsmaßnahmen.
Typ: Array von [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** ResourceNotFoundFault **
Die angegebene Ressourcen-ID wurde nicht gefunden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
# FailoverDBCluster
Erzwingt einen Failover für einen Cluster.
Bei einem Failover für einen Cluster wird eine der Amazon DocumentDB DocumentDB-Repliken (schreibgeschützte Instances) im Cluster zur primären Instance (Cluster-Writer) heraufgestuft.
Wenn die primäre Instance ausfällt, wechselt Amazon DocumentDB automatisch zu einem Amazon DocumentDB DocumentDB-Replikat, falls eines existiert. Sie können ein Failover erzwingen, wenn Sie einen Ausfall einer primären Instance zum Testen simulieren möchten.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Eine Cluster-ID, für die ein Failover erzwungen werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBCluster` übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Nein
** TargetDBInstanceIdentifier **
Der Name der Instance, die zur primären Instance hochgestuft werden soll.
Sie müssen die Instance-ID für ein Amazon DocumentDB DocumentDB-Replikat im Cluster angeben. Beispiel, `mydbcluster-replica1`.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster)
# FailoverGlobalCluster
Wertet den angegebenen sekundären DB-Cluster zum primären DB-Cluster im globalen Cluster heran, wenn ein Failover eines globalen Clusters auftritt.
Verwenden Sie diesen Vorgang, um auf ein ungeplantes Ereignis zu reagieren, z. B. eine regionale Katastrophe in der Primärregion. Ein Failover kann zum Verlust von Schreibtransaktionsdaten führen, die vor dem Eintreten des Failover-Ereignisses nicht auf die gewählte Sekundärseite repliziert wurden. Der Wiederherstellungsprozess, der eine DB-Instance auf dem ausgewählten sekundären DB-Cluster zur primären Writer-DB-Instance hochstuft, garantiert jedoch, dass sich die Daten in einem transaktionskonsistenten Zustand befinden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** GlobalClusterIdentifier **
Die ID des globalen Amazon DocumentDB-Clusters, auf den dieser Vorgang angewendet werden soll. Die Kennung ist der eindeutige Schlüssel, den der Benutzer bei der Erstellung des Clusters zugewiesen hat. Mit anderen Worten, es ist der Name des globalen Clusters.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen globalen Clusters übereinstimmen.
+ Mindestlänge 1. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
** TargetDbClusterIdentifier **
Die ID des sekundären Amazon DocumentDB-Clusters, den Sie zum primären für den globalen Cluster heraufstufen möchten. Verwenden Sie den Amazon Resource Name (ARN) für die Kennung, damit Amazon DocumentDB den Cluster in seiner AWS Region lokalisieren kann.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen sekundären Clusters übereinstimmen.
+ Mindestlänge 1. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
** AllowDataLoss **
Gibt an, ob Datenverlust für diesen globalen Clustervorgang zulässig ist. Wenn Datenverlust zugelassen wird, wird ein globaler Failover-Vorgang ausgelöst.
Wenn Sie nichts angeben`AllowDataLoss`, wird für den globalen Clustervorgang standardmäßig ein Switchover verwendet.
Einschränkungen:
+ Kann nicht zusammen mit dem Parameter angegeben werden. `Switchover`
Typ: Boolesch
Erforderlich: Nein
** Switchover **
Gibt an, ob dieser globale Datenbankcluster umgeschaltet werden soll.
Einschränkungen:
+ Kann nicht zusammen mit dem `AllowDataLoss` Parameter angegeben werden.
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** GlobalClusterNotFoundFault **
Das bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Status befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster)
# ListTagsForResource
Listet alle Tags auf einer Amazon DocumentDB DocumentDB-Ressource auf.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** ResourceName **
Die Amazon DocumentDB DocumentDB-Ressource mit Tags, die aufgelistet werden sollen. Dieser Wert ist ein Amazon-Ressourcenname (ARN).
Typ: Zeichenfolge
Erforderlich: Ja
**Filters.Filter.N**
Dieser Parameter wird derzeit nicht unterstützt.
Typ: Array von [Filter](API_Filter.md)-Objekten
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
**TagList.Tag.N**
Eine Liste mit einem oder mehreren Tags.
Typ: Array von [Tag](API_Tag.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Snapshot.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource)
# ModifyDBCluster
Ändert eine Einstellung für einen Amazon DocumentDB-Cluster. Sie können einen oder mehrere Datenbank-Konfigurationsparameter ändern, indem Sie diese Parameter und die neuen Werte in der Anforderung angeben.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die Cluster-ID für den Cluster, der geändert wird. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBCluster` übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
** AllowMajorVersionUpgrade **
Ein Wert, der angibt, ob Major-Versionsupgrades erlaubt sind.
Einschränkungen:
+ Sie müssen Hauptversionsupgrades zulassen, wenn Sie einen Wert für den `EngineVersion` Parameter angeben, der eine andere Hauptversion als die aktuelle Version des Clusters ist.
+ Da einige Parameter versionsspezifisch sind, erfordert ihre Änderung die Ausführung eines neuen `ModifyDBCluster` API-Aufrufs, nachdem die interne MVU abgeschlossen ist.
Die Ausführung einer MVU wirkt sich direkt auf die folgenden Parameter aus:
+ `MasterUserPassword`
+ `NewDBClusterIdentifier`
+ `VpcSecurityGroupIds`
+ `Port`
Typ: Boolesch
Erforderlich: Nein
** ApplyImmediately **
Ein Wert, der angibt, ob die Änderungen in dieser Anforderung und alle ausstehenden Änderungen unabhängig von der `PreferredMaintenanceWindow` Einstellung für den Cluster so schnell wie möglich asynchron angewendet werden. Wenn dieser Parameter auf gesetzt ist`false`, werden Änderungen am Cluster im nächsten Wartungsfenster übernommen.
Der `ApplyImmediately` Parameter wirkt sich nur auf die `MasterUserPassword` Werte `NewDBClusterIdentifier` und aus. Wenn Sie diesen Parameterwert auf setzen`false`, werden die Änderungen an den `MasterUserPassword` Werten `NewDBClusterIdentifier` und im nächsten Wartungsfenster übernommen. Alle anderen Änderungen werden sofort übernommen, unabhängig von dem Wert des Parameters `ApplyImmediately`.
Standard: `false`
Typ: Boolesch
Erforderlich: Nein
** BackupRetentionPeriod **
Die Anzahl von Tagen, über die automatische Backups aufbewahrt werden. Sie müssen einen Mindestwert von 1 angeben.
Standard: 1
Einschränkungen:
+ Muss ein Wert zwischen 1 und 35 sein.
Typ: Ganzzahl
Erforderlich: Nein
** CloudwatchLogsExportConfiguration **
Die Konfigurationseinstellung für die Protokolltypen, die für den Export nach Amazon CloudWatch Logs für eine bestimmte Instance oder einen bestimmten Cluster aktiviert werden sollen. Die `DisableLogTypes` Arrays `EnableLogTypes` und bestimmen, welche Protokolle in Logs exportiert (oder nicht exportiert) werden CloudWatch .
Typ: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) Objekt
Erforderlich: Nein
** DBClusterParameterGroupName **
Der Name der Cluster-Parametergruppe, die für den Cluster verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
** DeletionProtection **
Gibt an, ob dieser Cluster gelöscht werden kann. Wenn `DeletionProtection` aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und `DeletionProtection` deaktiviert wurde. `DeletionProtection`schützt Cluster davor, versehentlich gelöscht zu werden.
Typ: Boolesch
Erforderlich: Nein
** EngineVersion **
Die Versionsnummer der Datenbank-Engine, auf die ein Upgrade durchgeführt werden soll. Das Ändern dieses Parameters führt zu einem Nutzungsausfall. Die Änderung wird im nächsten Wartungsfenster übernommen, es sei denn, `ApplyImmediately` ist aktiviert.
Verwenden Sie den folgenden Befehl, um alle verfügbaren Engine-Versionen für Amazon DocumentDB aufzulisten:
`aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`
Typ: Zeichenfolge
Erforderlich: Nein
** ManageMasterUserPassword **
Gibt an, ob das Masterbenutzerpasswort mit Amazon Web Services Secrets Manager verwaltet werden soll. Wenn der Cluster das Masterbenutzerkennwort nicht mit Amazon Web Services Secrets Manager verwaltet, können Sie diese Verwaltung aktivieren. In diesem Fall können Sie nichts angeben`MasterUserPassword`. Wenn der Cluster das Masterbenutzer-Passwort bereits mit Amazon Web Services Secrets Manager verwaltet und Sie angeben, dass das Master-Benutzerpasswort nicht mit Amazon Web Services Secrets Manager verwaltet wird, müssen Sie angeben`MasterUserPassword`. In diesem Fall löscht Amazon DocumentDB das Geheimnis und verwendet das neue Passwort für den Masterbenutzer, das von angegeben wurde. `MasterUserPassword`
Typ: Boolesch
Erforderlich: Nein
** MasterUserPassword **
Das Passwort für den Masterbenutzer der Datenbank. Dieses Passwort kann alle druckbaren ASCII-Zeichen, außer Schrägstrich (/), doppeltes Anführungszeichen (") oder das "At"-Zeichen (@), enthalten.
Einschränkungen: Muss 8 bis 100 Zeichen enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** MasterUserSecretKmsKeyId **
Die Amazon Web Services KMS-Schlüssel-ID zur Verschlüsselung eines Geheimnisses, das automatisch im Amazon Web Services Secrets Manager generiert und verwaltet wird.
Diese Einstellung ist nur gültig, wenn die beiden folgenden Bedingungen erfüllt sind:
+ Der Cluster verwaltet das Masterbenutzer-Passwort in Amazon Web Services Secrets Manager nicht. Wenn der Cluster das Masterbenutzerkennwort bereits in Amazon Web Services Secrets Manager verwaltet, können Sie den KMS-Schlüssel, der zur Verschlüsselung des Geheimnisses verwendet wird, nicht ändern.
+ Sie aktivieren `ManageMasterUserPassword` die Verwaltung des Masterbenutzer-Passworts in Amazon Web Services Secrets Manager. Wenn Sie das Gerät einschalten `ManageMasterUserPassword` und nichts angeben`MasterUserSecretKmsKeyId`, wird der `aws/secretsmanager` KMS-Schlüssel zur Verschlüsselung des Geheimnisses verwendet. Wenn sich das Geheimnis in einem anderen Amazon Web Services Services-Konto befindet, können Sie den `aws/secretsmanager` KMS-Schlüssel nicht verwenden, um das Geheimnis zu verschlüsseln, und Sie müssen einen vom Kunden verwalteten KMS-Schlüssel verwenden.
Die Amazon Web Services KMS-Schlüssel-ID ist der Schlüssel-ARN, die Schlüssel-ID, der Alias-ARN oder der Aliasname für den KMS-Schlüssel. Um einen KMS-Schlüssel in einem anderen Amazon Web Services Services-Konto zu verwenden, geben Sie den Schlüssel-ARN oder den Alias-ARN an.
Es gibt einen Standard-KMS-Schlüssel für Ihr Amazon Web Services Services-Konto. Ihr Amazon Web Services Services-Konto hat für jede Amazon Web Services Services-Region einen anderen Standard-KMS-Schlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** NetworkType **
Der Netzwerktyp des Clusters.
Der Netzwerktyp wird durch den für den Cluster `DBSubnetGroup` angegebenen Netzwerktyp bestimmt. A `DBSubnetGroup` kann nur das IPv4 Protokoll oder die IPv4 und die IPv6 Protokolle (`DUAL`) unterstützen.
Weitere Informationen finden Sie unter [DocumentDB-Cluster in einer VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) im Amazon DocumentDB Developer Guide.
Zulässige Werte: `IPV4` \$1 `DUAL`
Typ: Zeichenfolge
Erforderlich: Nein
** NewDBClusterIdentifier **
Die neue Cluster-ID für den Cluster beim Umbenennen eines Clusters. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-cluster2`
Typ: Zeichenfolge
Erforderlich: Nein
** Port **
Die Nummer des Ports, an dem der Cluster Verbindungen akzeptiert.
Einschränkungen: Muss ein Wert von bis sein. `1150` `65535`
Standard: Derselbe Port wie der ursprüngliche Cluster.
Typ: Ganzzahl
Erforderlich: Nein
** PreferredBackupWindow **
Der tägliche Zeitraum, in dem automatische Sicherungen erstellt werden, wenn diese mit dem Parameter `BackupRetentionPeriod` aktiviert sind.
Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird.
Einschränkungen:
+ Muss im Format `hh24:mi-hh24:mi` angegeben werden.
+ Muss in Universal Coordinated Time (UTC) angegeben werden.
+ Darf nicht mit dem bevorzugten Wartungsfenster in Konflikt treten.
+ Muss mindestens 30 Minuten betragen.
Typ: Zeichenfolge
Erforderlich: Nein
** PreferredMaintenanceWindow **
Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).
Format: `ddd:hh24:mi-ddd:hh24:mi`
Die Standardeinstellung ist ein 30-minütiges Fenster, das nach dem Zufallsprinzip aus einem 8-Stunden-Zeitblock ausgewählt wird und an einem zufälligen Wochentag stattfindet. AWS-Region
Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So
Einschränkungen: mindestens 30-Minuten-Zeitfenster.
Typ: Zeichenfolge
Erforderlich: Nein
** RotateMasterUserPassword **
Gibt an, ob das von Amazon Web Services Secrets Manager verwaltete Geheimnis für das Masterbenutzerkennwort rotiert werden soll.
Diese Einstellung ist nur gültig, wenn das Masterbenutzerkennwort von Amazon DocumentDB im Amazon Web Services Secrets Manager für den Cluster verwaltet wird. Der geheime Wert enthält das aktualisierte Passwort.
Einschränkung: Sie müssen die Änderung sofort anwenden, wenn Sie das Masterbenutzerkennwort ändern.
Typ: Boolesch
Erforderlich: Nein
** ServerlessV2ScalingConfiguration **
Enthält die Skalierungskonfiguration eines serverlosen Amazon DocumentDB-Clusters.
Typ: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) Objekt
Erforderlich: Nein
** StorageType **
Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.
Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im *Amazon DocumentDB Developer Guide*.
Gültige Werte für den Speichertyp - `standard | iopt1`
Der Standardwert ist `standard `
Typ: Zeichenfolge
Erforderlich: Nein
**VpcSecurityGroupIds. VpcSecurityGroupId**N
Eine Liste der Virtual Private Cloud (VPC) -Sicherheitsgruppen, zu denen der Cluster gehören wird.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Sie haben bereits einen Cluster mit der angegebenen Kennung.
HTTP-Statuscode: 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName`bezieht sich nicht auf eine bestehende Cluster-Parametergruppe.
HTTP-Statuscode: 404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
** InvalidDBSecurityGroupState **
Der Status der Sicherheitsgruppe lässt kein Löschen zu.
HTTP-Statuscode: 400
** InvalidDBSubnetGroupStateFault **
Die Subnetzgruppe kann nicht gelöscht werden, da sie verwendet wird.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** NetworkTypeNotSupported **
Der Netzwerktyp wird `DBSubnetGroup` weder von der DB-Engine-Version noch von der DB-Engine-Version unterstützt.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instances verfügbar ist.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster)
# ModifyDBClusterParameterGroup
Ändert die Parameter einer Cluster-Parametergruppe. Wenn Sie mehr als einen Parameter ändern möchten, übergeben Sie eine Liste mit den folgenden Optionen: `ParameterName`, `ParameterValue` und `ApplyMethod`. Pro Anforderung können maximal 20 Parameter geändert werden.
**Anmerkung**
Änderungen an dynamischen Parametern werden sofort angewendet. Änderungen an statischen Parametern erfordern einen Neustart oder ein Wartungsfenster, bevor die Änderung wirksam wird.
**Wichtig**
Nachdem Sie eine Cluster-Parametergruppe erstellt haben, sollten Sie mindestens fünf Minuten warten, bevor Sie das erste Cluster erstellen, das diese Cluster-Parametergruppe als Standardparametergruppe verwendet. Dadurch kann Amazon DocumentDB die Erstellungsaktion vollständig abschließen, bevor die Parametergruppe als Standard für einen neuen Cluster verwendet wird. Dieser Schritt ist besonders wichtig für Parameter, die beim Erstellen der Standarddatenbank für einen Cluster von kritischer Bedeutung sind, z. B. den Zeichensatz für die Standarddatenbank, der durch den Parameter `character_set_database` definiert wird.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name der zu ändernden Cluster-Parametergruppe.
Typ: Zeichenfolge
Erforderlich: Ja
**Parameters.Parameter.N**
Eine Liste der Parameter in der Cluster-Parametergruppe, die geändert werden sollen.
Typ: Array von [Parameter](API_Parameter.md)-Objekten
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterParameterGroupName **
Der Name einer Cluster-Parametergruppe.
Einschränkungen:
+ Muss aus 1 bis 255 Buchstaben oder Zahlen bestehen.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** InvalidDBParameterGroupState **
Die Parametergruppe wird verwendet, oder sie befindet sich in einem Status, der nicht gültig ist. Wenn Sie versuchen, die Parametergruppe zu löschen, können Sie sie nicht löschen, wenn sich die Parametergruppe in diesem Status befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
# ModifyDBClusterSnapshotAttribute
Fügt einem manuellen Cluster-Snapshot ein Attribut und Werte hinzu oder entfernt ein Attribut und Werte daraus.
Um einen manuellen Cluster-Snapshot gemeinsam mit anderen zu verwenden AWS-Konten, geben Sie das `restore` als an und verwenden Sie den `ValuesToAdd` Parameter`AttributeName`, um eine Liste IDs der Personen hinzuzufügen AWS-Konten , die berechtigt sind, den manuellen Cluster-Snapshot wiederherzustellen. Verwenden Sie den Wert`all`, um den manuellen Cluster-Snapshot öffentlich zu machen, was bedeutet, dass er von allen kopiert oder wiederhergestellt werden kann AWS-Konten. Fügen Sie nicht den `all` Wert für manuelle Cluster-Snapshots hinzu, die private Informationen enthalten, die nicht für alle AWS-Konten verfügbar sein sollen. Wenn ein manueller Cluster-Snapshot verschlüsselt ist, kann er gemeinsam genutzt werden, jedoch nur, indem eine Liste der AWS-Konto IDs für den `ValuesToAdd` Parameter autorisierten Personen angegeben wird. Sie können in diesem Fall `all` nicht als Wert für diesen Parameter verwenden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** AttributeName **
Der Name des Cluster-Snapshot-Attributs, das geändert werden soll.
Um die Autorisierung anderer AWS-Konten zum Kopieren oder Wiederherstellen eines manuellen Cluster-Snapshots zu verwalten, legen Sie diesen Wert auf fest`restore`.
Typ: Zeichenfolge
Erforderlich: Ja
** DBClusterSnapshotIdentifier **
Der Bezeichner für den Cluster-Snapshot, für den die Attribute geändert werden sollen.
Typ: Zeichenfolge
Erforderlich: Ja
**ValuesToAdd. AttributeValue**N
Eine Liste von Cluster-Snapshot-Attributen, die zu dem von `AttributeName` angegebenen Attribut hinzugefügt werden sollen.
Um andere Benutzer AWS-Konten zum Kopieren oder Wiederherstellen eines manuellen Cluster-Snapshots zu autorisieren, legen Sie fest, dass diese Liste einen oder mehrere AWS-Konto IDs enthält. Um den manuellen Cluster-Snapshot durch einen beliebigen Benutzer wiederherstellbar zu machen AWS-Konto, setzen Sie ihn auf. `all` Fügen Sie keinen `all` Wert für manuelle Cluster-Snapshots hinzu, die private Informationen enthalten, die nicht für alle verfügbar sein sollen. AWS-Konten
Typ: Zeichenfolgen-Array
Erforderlich: Nein
**ValuesToRemove. AttributeValue**N
Eine Liste von Cluster-Snapshot-Attributen, die aus dem von `AttributeName` angegebenen Attribut entfernt werden sollen.
Um anderen die Autorisierung AWS-Konten zum Kopieren oder Wiederherstellen eines manuellen Cluster-Snapshots zu entziehen, legen Sie fest, dass diese Liste einen oder mehrere AWS-Konto Identifikatoren enthält. Um anderen Benutzern die Autorisierung AWS-Konto zum Kopieren oder Wiederherstellen des Cluster-Snapshots zu entziehen, setzen Sie sie auf`all`. Wenn Sie angeben`all`, kann ein AWS-Konto Benutzer, dessen Konto-ID dem `restore` Attribut explizit hinzugefügt wurde, trotzdem einen manuellen Cluster-Snapshot kopieren oder wiederherstellen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterSnapshotAttributesResult **
Detaillierte Informationen zu den Attributen, die einem Cluster-Snapshot zugeordnet sind.
Typ: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** SharedSnapshotQuotaExceeded **
Sie haben die maximale Anzahl an Konten überschritten, für die Sie einen manuellen DB-Snapshot freigeben können.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
# ModifyDBInstance
Ändert die Einstellungen für eine Instanz. Sie können einen oder mehrere Datenbank-Konfigurationsparameter ändern, indem Sie diese Parameter und die neuen Werte in der Anforderung angeben.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBInstanceIdentifier **
Die Instance-ID. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBInstance` übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
** ApplyImmediately **
Gibt an, ob die Änderungen in dieser Anforderung und alle ausstehenden Änderungen unabhängig von der `PreferredMaintenanceWindow` Einstellung für die Instanz so schnell wie möglich asynchron angewendet werden.
Wenn dieser Parameter auf gesetzt ist`false`, werden Änderungen an der Instanz im nächsten Wartungsfenster übernommen. Einige Parameteränderungen können zu einem Ausfall führen und werden beim nächsten Neustart übernommen.
Standard: `false`
Typ: Boolesch
Erforderlich: Nein
** AutoMinorVersionUpgrade **
Dieser Parameter gilt nicht für Amazon DocumentDB. Amazon DocumentDB führt unabhängig vom eingestellten Wert keine kleineren Versions-Upgrades durch.
Typ: Boolesch
Erforderlich: Nein
** CACertificateIdentifier **
Gibt das Zertifikat an, das mit der Instance verknüpft werden muss.
Typ: Zeichenfolge
Erforderlich: Nein
** CertificateRotationRestart **
Gibt an, ob die DB-Instance neu gestartet wird, wenn Sie Ihr SSL/TLS Zertifikat rotieren.
Standardmäßig wird die DB-Instance neu gestartet, wenn Sie Ihr SSL/TLS Zertifikat rotieren. Das Zertifikat wird erst aktualisiert, wenn die DB-Instance neu gestartet wird.
Legen Sie diesen Parameter nur fest, wenn Sie ihn *nicht* verwenden SSL/TLS , um eine Verbindung zur DB-Instance herzustellen.
Wenn Sie eine Verbindung SSL/TLS zur DB-Instance herstellen, finden Sie weitere Informationen unter [Aktualisieren Ihrer Amazon DocumentDB-TLS-Zertifikate](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) und [Verschlüsseln von Daten bei der Übertragung im](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) *Amazon DocumentDB-Entwicklerhandbuch*.
Typ: Boolesch
Erforderlich: Nein
** CopyTagsToSnapshot **
Ein Wert, der angibt, ob alle Tags aus der DB-Instance in Snapshots der DB-Instance kopiert werden sollen. Standardmäßig werden Tags nicht kopiert.
Typ: Boolesch
Erforderlich: Nein
** DBInstanceClass **
Die neue Rechen- und Speicherkapazität der Instance; zum Beispiel`db.r5.large`. Nicht alle Instanzklassen sind in allen verfügbar AWS-Regionen.
Wenn Sie die Instanzklasse ändern, kommt es während der Änderung zu einem Ausfall. Die Änderung wird während des nächsten Wartungsfensters angewendet, es sei denn, `ApplyImmediately` wird für diese Anforderung als `true` angegeben.
Standard: Verwendet die vorhandene Einstellung.
Typ: Zeichenfolge
Erforderlich: Nein
** EnablePerformanceInsights **
Ein Wert, der angibt, ob Performance Insights für die DB-Instance aktiviert werden sollen. Weitere Informationen finden Sie unter [Verwenden von Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
Typ: Boolesch
Erforderlich: Nein
** NewDBInstanceIdentifier **
Die neue Instanz-ID für die Instanz beim Umbenennen einer Instanz. Wenn Sie die Instanz-ID ändern, erfolgt sofort ein Instanzneustart, wenn Sie dies `Apply Immediately` auf `true` einstellen. Er erfolgt während des nächsten Wartungsfensters, wenn Sie `Apply Immediately` auf eingestellt haben`false`. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `mydbinstance`
Typ: Zeichenfolge
Erforderlich: Nein
** PerformanceInsightsKMSKeyId **
Die AWS KMS Schlüssel-ID für die Verschlüsselung von Performance Insights Insights-Daten.
Die AWS KMS Schlüssel-ID ist der Schlüssel-ARN, die Schlüssel-ID, der Alias-ARN oder der Aliasname für den KMS-Schlüssel.
Wenn Sie keinen Wert für PerformanceInsights KMSKey Id angeben, verwendet Amazon DocumentDB Ihren Standard-KMS-Schlüssel. Es gibt einen Standard-KMS-Schlüssel für Ihr Amazon Web Services Services-Konto. Ihr Amazon Web Services Services-Konto hat für jede Amazon Web Services Services-Region einen anderen Standard-KMS-Schlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** PreferredMaintenanceWindow **
Der wöchentliche Zeitraum (in UTC), in dem Systemwartungen durchgeführt werden können, die möglicherweise zu einem Nutzungsausfall führen. Eine Änderung dieses Parameters führt nicht zu einem Ausfall, außer in der folgenden Situation, und die Änderung wird so schnell wie möglich asynchron angewendet. Wenn ausstehende Aktionen vorhanden sind, die einen Neustart verursachen, und das Wartungsfenster so geändert wird, dass es die aktuelle Uhrzeit enthält, führt eine Änderung dieses Parameters zu einem Neustart der Instanz. Wenn Sie dieses Fenster auf die aktuelle Uhrzeit verschieben, müssen zwischen der aktuellen Uhrzeit und dem Ende des Fensters mindestens 30 Minuten liegen, um sicherzustellen, dass ausstehende Änderungen übernommen werden.
Standard: Verwendet die vorhandene Einstellung.
Format: `ddd:hh24:mi-ddd:hh24:mi`
Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So
Einschränkungen: Muss mindestens 30 Minuten dauern.
Typ: Zeichenfolge
Erforderlich: Nein
** PromotionTier **
Ein Wert, der die Reihenfolge angibt, in der ein Amazon DocumentDB DocumentDB-Replikat nach einem Ausfall der vorhandenen primären Instance zur primären Instance heraufgestuft wird.
Standard: 1
Gültige Werte: 0-15
Typ: Ganzzahl
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBInstance **
Detaillierte Informationen zu einer Instanz.
Typ: [DBInstance](API_DBInstance.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AuthorizationNotFound **
Die angegebene CIDR-IP oder Amazon EC2-Sicherheitsgruppe ist für die angegebene Sicherheitsgruppe nicht autorisiert.
Amazon DocumentDB ist möglicherweise auch nicht autorisiert, die erforderlichen Aktionen in Ihrem Namen mithilfe von IAM durchzuführen.
HTTP-Statuscode: 404
** CertificateNotFound **
`CertificateIdentifier`bezieht sich nicht auf ein vorhandenes Zertifikat.
HTTP-Statuscode: 404
** DBInstanceAlreadyExists **
Sie haben bereits eine Instanz mit der angegebenen ID.
HTTP-Statuscode: 400
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** DBSecurityGroupNotFound **
`DBSecurityGroupName`bezieht sich nicht auf eine bestehende Sicherheitsgruppe.
HTTP-Statuscode: 404
** DBUpgradeDependencyFailure **
Das Upgrade ist fehlgeschlagen, weil eine Ressource, von der der abhängt, nicht geändert werden kann.
HTTP-Statuscode: 400
** InsufficientDBInstanceCapacity **
Die angegebene Instanzklasse ist in der angegebenen Availability Zone nicht verfügbar.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
** InvalidDBSecurityGroupState **
Der Status der Sicherheitsgruppe erlaubt kein Löschen.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instances verfügbar ist.
HTTP-Statuscode: 400
** StorageTypeNotSupported **
Der angegebene Speicher `StorageType` kann der DB-Instance nicht zugeordnet werden.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance)
# ModifyDBSubnetGroup
Ändert eine bestehende Subnetzgruppe. Subnetzgruppen müssen mindestens ein Subnetz in mindestens zwei Availability Zones in der enthalten. AWS-Region
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBSubnetGroupName **
Der Name für die Subnetzgruppe. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert. Sie können die Standardsubnetzgruppe nicht ändern.
Einschränkungen: Der Wert muss mit dem Namen einer vorhandenen `DBSubnetGroup` übereinstimmen. Der Name darf nicht default sein.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Ja
**SubnetIds. SubnetIdentifier**N
Das Amazon EC2-Subnetz IDs für die Subnetzgruppe.
Typ: Zeichenfolgen-Array
Erforderlich: Ja
** DBSubnetGroupDescription **
Die Beschreibung für die Subnetzgruppe.
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** DBSubnetGroup **
Detaillierte Informationen zu einer Subnetzgruppe.
Typ: [DBSubnetGroup](API_DBSubnetGroup.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBSubnetGroupDoesNotCoverEnoughAZs **
Subnetze in der Subnetzgruppe sollten mindestens zwei Availability Zones abdecken, es sei denn, es gibt nur eine Availability Zone.
HTTP-Statuscode: 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** DBSubnetQuotaExceededFault **
Die Anfrage würde dazu führen, dass Sie die zulässige Anzahl von Subnetzen in einer Subnetzgruppe überschreiten.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** SubnetAlreadyInUse **
Das Subnetz wird bereits in der Availability Zone verwendet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup)
# ModifyEventSubscription
Ändert ein vorhandenes Abonnement für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SubscriptionName **
Der Name des Abonnements für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen.
Typ: Zeichenfolge
Erforderlich: Ja
** Enabled **
Ein boolescher Wert; wird auf gesetzt, um das Abonnement `true` zu aktivieren.
Typ: Boolesch
Erforderlich: Nein
**EventCategories. EventCategory**N
Eine Liste der Veranstaltungskategorien für eine`SourceType`, die Sie abonnieren möchten.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** SnsTopicArn **
Der Amazon-Ressourcenname (ARN) des SNS-Themas, das für die Ereignisbenachrichtigung erstellt wurde. Der ARN wird von Amazon SNS erstellt, wenn Sie ein Thema erstellen und es abonnieren.
Typ: Zeichenfolge
Erforderlich: Nein
** SourceType **
Der Typ der Quelle, die die Ereignisse generiert. Wenn Sie beispielsweise über Ereignisse informiert werden möchten, die von einer Instanz generiert wurden, setzen Sie diesen Parameter auf`db-instance`. Wenn der Wert nicht angegeben ist, werden alle Ereignisse zurückgegeben.
Zulässige Werte: `db-instance`, `db-parameter-group`, `db-security-group`
Typ: Zeichenfolge
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** EventSubscription **
Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.
Typ: [EventSubscription](API_EventSubscription.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** EventSubscriptionQuotaExceeded **
Sie haben die maximale Anzahl von Event-Abonnements erreicht.
HTTP-Statuscode: 400
** SNSInvalidTopic **
Amazon SNS hat geantwortet, dass es ein Problem mit dem angegebenen Thema gibt.
HTTP-Statuscode: 400
** SNSNoAuthorization **
Sie sind nicht berechtigt, zum SNS-Thema Amazon Resource Name (ARN) zu veröffentlichen.
HTTP-Statuscode: 400
** SNSTopicArnNotFound **
Das SNS-Thema Amazon Resource Name (ARN) existiert nicht.
HTTP-Statuscode: 404
** SubscriptionCategoryNotFound **
Die angegebene Kategorie ist nicht vorhanden.
HTTP-Statuscode: 404
** SubscriptionNotFound **
Der Abonnementname ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription)
# ModifyGlobalCluster
Ändern Sie eine Einstellung für einen globalen Amazon DocumentDB-Cluster. Sie können einen oder mehrere Konfigurationsparameter (zum Beispiel: Löschschutz) oder die globale Cluster-ID ändern, indem Sie diese Parameter und die neuen Werte in der Anfrage angeben.
**Anmerkung**
Diese Aktion gilt nur für Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** GlobalClusterIdentifier **
Der Bezeichner für den globalen Cluster, der geändert wird. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit der ID eines vorhandenen globalen Clusters übereinstimmen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
** DeletionProtection **
Gibt an, ob für den globalen Cluster der Löschschutz aktiviert ist. Der globale Cluster kann nicht gelöscht werden, wenn der Löschschutz aktiviert ist.
Typ: Boolesch
Erforderlich: Nein
** NewGlobalClusterIdentifier **
Der neue Bezeichner für einen globalen Cluster, wenn Sie einen globalen Cluster ändern. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
Das erste Zeichen muss ein Buchstabe sein.
Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten
Beispiel: `my-cluster2`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** GlobalClusterNotFoundFault **
Der bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Zustand befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster)
# RebootDBInstance
Möglicherweise müssen Sie Ihre Instance neu starten, normalerweise aus Wartungsgründen. Wenn Sie beispielsweise bestimmte Änderungen vornehmen oder wenn Sie die Cluster-Parametergruppe ändern, die der Instance zugeordnet ist, müssen Sie die Instance neu starten, damit die Änderungen wirksam werden.
Durch den Neustart einer Instance wird der Datenbank-Engine-Service neu gestartet. *Der Neustart einer Instance führt zu einem kurzzeitigen Ausfall, bei dem der Instance-Status auf Neustart gesetzt wird.*
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBInstanceIdentifier **
Die Instance-ID. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBInstance` übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
** ForceFailover **
Wenn`true`, wird der Neustart über ein Multi-AZ-Failover durchgeführt.
Einschränkung: Sie können nicht angeben, `true` ob die Instance nicht für Multi-AZ konfiguriert ist.
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBInstance **
Detaillierte Informationen zu einer Instanz.
Typ: [DBInstance](API_DBInstance.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance)
# RemoveFromGlobalCluster
Trennt einen sekundären Amazon DocumentDB-Cluster von einem globalen Cluster. Der Cluster wird zu einem eigenständigen Cluster mit Lese- und Schreibfunktion, anstatt schreibgeschützt zu sein und Daten von einem Primärcluster in einer anderen Region zu empfangen.
**Anmerkung**
Diese Aktion gilt nur für Amazon DocumentDB-Cluster.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DbClusterIdentifier **
Der Amazon-Ressourcenname (ARN), der den Cluster identifiziert, der vom globalen Amazon DocumentDB-Cluster getrennt wurde.
Typ: Zeichenfolge
Erforderlich: Ja
** GlobalClusterIdentifier **
Die Cluster-ID, die vom globalen Amazon DocumentDB-Cluster getrennt werden soll.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** GlobalClusterNotFoundFault **
Das bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Zustand befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster)
# RemoveSourceIdentifierFromSubscription
Entfernt eine Quell-ID aus einem bestehenden Abonnement für Amazon DocumentDB DocumentDB-Ereignisbenachrichtigungen.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** SourceIdentifier **
Die Quell-ID, die aus dem Abonnement entfernt werden soll, z. B. die Instance-ID für eine Instance oder der Name einer Sicherheitsgruppe.
Typ: Zeichenfolge
Erforderlich: Ja
** SubscriptionName **
Der Name des Amazon DocumentDB DocumentDB-Abonnements für Ereignisbenachrichtigungen, aus dem Sie eine Quell-ID entfernen möchten.
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Service zurückgegeben.
** EventSubscription **
Detaillierte Informationen zu einer Veranstaltung, die Sie abonniert haben.
Typ: [EventSubscription](API_EventSubscription.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** SourceNotFound **
Die angeforderte Quelle konnte nicht gefunden werden.
HTTP-Statuscode: 404
** SubscriptionNotFound **
Der Abonnementname ist nicht vorhanden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
# RemoveTagsFromResource
Entfernt Metadaten-Tags aus einer Amazon DocumentDB DocumentDB-Ressource.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** ResourceName **
Die Amazon DocumentDB DocumentDB-Ressource, aus der die Tags entfernt wurden. Dieser Wert ist ein Amazon-Ressourcenname (ARN).
Typ: Zeichenfolge
Erforderlich: Ja
**TagKeys.Mitglied.N**
Der Tag-Schlüssel (Name) des zu entfernenden Tags.
Typ: Zeichenfolgen-Array
Erforderlich: Ja
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBInstanceNotFound **
`DBInstanceIdentifier`bezieht sich nicht auf eine bestehende Instanz.
HTTP-Statuscode: 404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Snapshot.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource)
# ResetDBClusterParameterGroup
Ändert die Parameter einer Cluster-Parametergruppe auf den Standardwert. Um bestimmte Parameter zurückzusetzen, reichen Sie eine Liste mit den folgenden Angaben ein: `ParameterName` und`ApplyMethod`. Um die gesamte Cluster-Parametergruppe zurückzusetzen, geben Sie die `ResetAllParameters` Parameter `DBClusterParameterGroupName` und an.
Wenn Sie die gesamte Gruppe zurücksetzen, werden die dynamischen Parameter sofort aktualisiert, und die statischen Parameter werden so eingestellt, `pending-reboot` dass sie beim nächsten Neustart der DB-Instance wirksam werden.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterParameterGroupName **
Der Name der zurückzusetzenden Cluster-Parametergruppe.
Typ: Zeichenfolge
Erforderlich: Ja
**Parameters.Parameter.N**
Eine Liste von Parameternamen in der Cluster-Parametergruppe, die auf die Standardwerte zurückgesetzt werden sollen. Sie können den Parameter nicht verwenden, wenn der Parameter `ResetAllParameters` auf `true` festgelegt ist.
Typ: Array von [Parameter](API_Parameter.md)-Objekten
Erforderlich: Nein
** ResetAllParameters **
Ein Wert, auf den festgelegt ist`true`, um alle Parameter in der Cluster-Parametergruppe auf ihre Standardwerte zurückzusetzen und `false` andernfalls. Diesen Parameter können Sie nicht verwenden, wenn es eine Liste von Parameternamen für `Parameters` gibt.
Typ: Boolesch
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBClusterParameterGroupName **
Der Name einer Cluster-Parametergruppe.
Einschränkungen:
+ Muss aus 1 bis 255 Buchstaben oder Zahlen bestehen.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`bezieht sich nicht auf eine bestehende Parametergruppe.
HTTP-Statuscode: 404
** InvalidDBParameterGroupState **
Die Parametergruppe wird verwendet, oder sie befindet sich in einem Status, der nicht gültig ist. Wenn Sie versuchen, die Parametergruppe zu löschen, können Sie sie nicht löschen, wenn sich die Parametergruppe in diesem Status befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
# RestoreDBClusterFromSnapshot
Erstellt einen neuen Cluster aus einem Snapshot oder Cluster-Snapshot.
Wenn ein Snapshot angegeben ist, wird der Zielcluster aus dem Quell-DB-Snapshot mit einer Standardkonfiguration und einer Standardsicherheitsgruppe erstellt.
Wenn ein Cluster-Snapshot angegeben ist, wird der Zielcluster aus dem Quellclusterwiederherstellungspunkt mit derselben Konfiguration wie der ursprüngliche Quell-DB-Cluster erstellt, mit der Ausnahme, dass der neue Cluster mit der Standardsicherheitsgruppe erstellt wird.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Der Name des Clusters, der aus dem Snapshot oder Cluster-Snapshot erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `my-snapshot-id`
Typ: Zeichenfolge
Erforderlich: Ja
** Engine **
Die Datenbank-Engine, die für den neuen Cluster verwendet werden soll.
Standard: Entspricht der Quelle.
Einschränkung: Muss mit der Engine der Quelle kompatibel sein.
Typ: Zeichenfolge
Erforderlich: Ja
** SnapshotIdentifier **
Die Kennung für den Snapshot oder den Cluster-Snapshot, der zur Wiederherstellung verwendet werden soll.
Sie können entweder den Namen oder den Amazon-Ressourcennamen (ARN) verwenden, um einen Cluster-Snapshot festzulegen. Sie können jedoch auch nur den ARN verwenden, um einen Snapshot festzulegen.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen Snapshots übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
**AvailabilityZones. AvailabilityZone**N
Stellt die Liste der Amazon EC2 Availability Zones bereit, in denen Instances im wiederhergestellten DB-Cluster erstellt werden können.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** DBClusterParameterGroupName **
Der Name der DB-Cluster-Parametergruppe, die mit diesem DB-Cluster verknüpft werden soll.
*Typ:* Zeichenfolge. *Erforderlich:* Nein.
Wenn dieses Argument weggelassen wird, wird die standardmäßige DB-Cluster-Parametergruppe verwendet. Falls angegeben, muss sie mit dem Namen einer vorhandenen Standard-DB-Cluster-Parametergruppe übereinstimmen. Die Zeichenfolge muss aus 1 bis 255 Buchstaben, Zahlen oder Bindestrichen bestehen. Das erste Zeichen muss ein Buchstabe sein und darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** DBSubnetGroupName **
Der Name der Subnetzgruppe, die für den neuen Cluster verwendet werden soll.
Einschränkungen: Falls angegeben, muss er mit dem Namen einer vorhandenen `DBSubnetGroup` Datei übereinstimmen.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Nein
** DeletionProtection **
Gibt an, ob dieser Cluster gelöscht werden kann. Wenn `DeletionProtection` aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und `DeletionProtection` deaktiviert wurde. `DeletionProtection`schützt Cluster davor, versehentlich gelöscht zu werden.
Typ: Boolesch
Erforderlich: Nein
**EnableCloudwatchLogsExports.Mitglied.N**
Eine Liste von Protokolltypen, die für den Export nach Amazon CloudWatch Logs aktiviert sein müssen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** EngineVersion **
Die Version der Datenbank-Engine, die für den neuen Cluster verwendet werden soll.
Typ: Zeichenfolge
Erforderlich: Nein
** KmsKeyId **
Die AWS KMS Schlüssel-ID, die bei der Wiederherstellung eines verschlüsselten Clusters aus einem DB-Snapshot oder Cluster-Snapshot verwendet werden soll.
Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN) für den AWS KMS Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben wiederherstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, mit dem der neue Cluster verschlüsselt wurde, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.
Wenn Sie keinen Wert für den `KmsKeyId`-Parameter angeben, geschieht folgendes:
+ Wenn der Snapshot oder Cluster-Snapshot verschlüsselt `SnapshotIdentifier` ist, wird der wiederhergestellte Cluster mit dem AWS KMS Schlüssel verschlüsselt, der zum Verschlüsseln des Snapshots oder Cluster-Snapshots verwendet wurde.
+ Wenn der Snapshot oder der Cluster-Snapshot nicht verschlüsselt `SnapshotIdentifier` ist, ist der wiederhergestellte DB-Cluster nicht verschlüsselt.
Typ: Zeichenfolge
Erforderlich: Nein
** NetworkType **
Der Netzwerktyp des Clusters.
Der Netzwerktyp wird durch den für den Cluster `DBSubnetGroup` angegebenen Netzwerktyp bestimmt. A `DBSubnetGroup` kann nur das IPv4 Protokoll oder die IPv4 und die IPv6 Protokolle (`DUAL`) unterstützen.
Weitere Informationen finden Sie unter [DocumentDB-Cluster in einer VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) im Amazon DocumentDB Developer Guide.
Zulässige Werte: `IPV4` \$1 `DUAL`
Typ: Zeichenfolge
Erforderlich: Nein
** Port **
Die Portnummer, auf der der neue Cluster Verbindungen akzeptiert.
Einschränkungen: Muss ein Wert von `1150` bis sein`65535`.
Standard: Derselbe Port wie der ursprüngliche Cluster.
Typ: Ganzzahl
Erforderlich: Nein
** ServerlessV2ScalingConfiguration **
Enthält die Skalierungskonfiguration eines serverlosen Amazon DocumentDB-Clusters.
Typ: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) Objekt
Erforderlich: Nein
** StorageType **
Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.
Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im *Amazon DocumentDB Developer Guide*.
Gültige Werte für den Speichertyp - `standard | iopt1`
Der Standardwert ist `standard `
Typ: Zeichenfolge
Erforderlich: Nein
**Tags.Tag.N**
Die Tags, die dem wiederhergestellten Cluster zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
**VpcSecurityGroupIds. VpcSecurityGroupId**N
Eine Liste der Virtual Private Cloud (VPC) -Sicherheitsgruppen, zu denen der neue Cluster gehören wird.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Sie haben bereits einen Cluster mit der angegebenen Kennung.
HTTP-Statuscode: 400
** DBClusterQuotaExceededFault **
Der Cluster kann nicht erstellt werden, da Sie das maximal zulässige Kontingent an Clustern erreicht haben.
HTTP-Statuscode: 403
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Snapshot.
HTTP-Statuscode: 404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** InsufficientDBClusterCapacityFault **
Der Cluster verfügt nicht über genügend Kapazität für den aktuellen Vorgang.
HTTP-Statuscode: 403
** InsufficientStorageClusterCapacity **
Für die aktuelle Aktion ist nicht genügend Speicherplatz verfügbar. Möglicherweise können Sie diesen Fehler beheben, indem Sie Ihre Subnetzgruppe so aktualisieren, dass sie verschiedene Availability Zones verwendet, in denen mehr Speicherplatz verfügbar ist.
HTTP-Statuscode: 400
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** InvalidDBSnapshotState **
Der Status des Snapshots erlaubt kein Löschen.
HTTP-Statuscode: 400
** InvalidRestoreFault **
Sie können keine Wiederherstellung von einem Virtual Private Cloud (VPC) -Backup auf eine Nicht-VPC-DB-Instance durchführen.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** KMSKeyNotAccessibleFault **
Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.
HTTP-Statuscode: 400
** NetworkTypeNotSupported **
Der Netzwerktyp wird `DBSubnetGroup` weder von der DB-Engine-Version noch von der DB-Engine-Version unterstützt.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instances verfügbar ist.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instanzen verfügbar ist.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
# RestoreDBClusterToPointInTime
Stellt einen Cluster zu einem beliebigen Zeitpunkt wieder her. Benutzer können den Zustand jedes beliebigen Zeitpunkts vor `LatestRestorableTime` bis zu `BackupRetentionPeriod` Tagen wiederherstellen. Der Zielcluster wird aus dem Quellcluster mit derselben Konfiguration wie der ursprüngliche Cluster erstellt, mit der Ausnahme, dass der neue Cluster mit der Standardsicherheitsgruppe erstellt wird.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Der Name des neuen Clusters, der erstellt werden soll.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Typ: Zeichenfolge
Erforderlich: Ja
** SourceDBClusterIdentifier **
Die Kennung des Quell-Clusters, von dem wiederhergestellt werden soll.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen `DBCluster` übereinstimmen.
Typ: Zeichenfolge
Erforderlich: Ja
** DBSubnetGroupName **
Der Name der Subnetzgruppe, die für den neuen Cluster verwendet werden soll.
Einschränkungen: Falls angegeben, muss er mit dem Namen eines vorhandenen `DBSubnetGroup` übereinstimmen.
Beispiel: `mySubnetgroup`
Typ: Zeichenfolge
Erforderlich: Nein
** DeletionProtection **
Gibt an, ob dieser Cluster gelöscht werden kann. Wenn `DeletionProtection` aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und `DeletionProtection` deaktiviert wurde. `DeletionProtection`schützt Cluster davor, versehentlich gelöscht zu werden.
Typ: Boolesch
Erforderlich: Nein
**EnableCloudwatchLogsExports.Mitglied.N**
Eine Liste von Protokolltypen, die für den Export nach Amazon CloudWatch Logs aktiviert sein müssen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** KmsKeyId **
Die AWS KMS Schlüssel-ID, die bei der Wiederherstellung eines verschlüsselten Clusters aus einem verschlüsselten Cluster verwendet werden soll.
Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN) für den AWS KMS Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben wiederherstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, mit dem der neue Cluster verschlüsselt wurde, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.
Sie können auf einem neuen Cluster wiederherstellen und den neuen Cluster mit einem AWS KMS Schlüssel verschlüsseln, der sich von dem Schlüssel unterscheidet, der AWS KMS zum Verschlüsseln des Quellclusters verwendet wurde. Der neue DB-Cluster wird mit dem durch den Parameter identifizierten AWS KMS Schlüssel verschlüsselt. `KmsKeyId`
Wenn Sie keinen Wert für den `KmsKeyId`-Parameter angeben, geschieht folgendes:
+ Wenn der Cluster verschlüsselt ist, wird der wiederhergestellte Cluster mit dem AWS KMS Schlüssel verschlüsselt, der zur Verschlüsselung des Quellclusters verwendet wurde.
+ Wenn der Cluster nicht verschlüsselt ist, ist der wiederhergestellte Cluster nicht verschlüsselt.
Wenn es `DBClusterIdentifier` sich auf einen Cluster bezieht, der nicht verschlüsselt ist, wird die Wiederherstellungsanforderung abgelehnt.
Typ: Zeichenfolge
Erforderlich: Nein
** NetworkType **
Der Netzwerktyp des Clusters.
Der Netzwerktyp wird durch den für den Cluster `DBSubnetGroup` angegebenen Netzwerktyp bestimmt. A `DBSubnetGroup` kann nur das IPv4 Protokoll oder die IPv4 und die IPv6 Protokolle (`DUAL`) unterstützen.
Weitere Informationen finden Sie unter [DocumentDB-Cluster in einer VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) im Amazon DocumentDB Developer Guide.
Zulässige Werte: `IPV4` \$1 `DUAL`
Typ: Zeichenfolge
Erforderlich: Nein
** Port **
Die Portnummer, auf der der neue Cluster Verbindungen akzeptiert.
Einschränkungen: Muss ein Wert von `1150` bis sein`65535`.
Standard: Der Standardanschluss für die Engine.
Typ: Ganzzahl
Erforderlich: Nein
** RestoreToTime **
Das Datum und die Uhrzeit für die Wiederherstellung des Clusters.
Gültige Werte: Eine Uhrzeit im UTC-Format (Universal Coordinated Time).
Einschränkungen:
+ Muss vor dem letzten wiederherstellbaren Zeitpunkt für die Instance liegen.
+ Muss angegeben werden, wenn der Parameter `UseLatestRestorableTime` nicht angegeben ist.
+ Kann nicht angegeben werden, wenn der Parameter `UseLatestRestorableTime` auf `true` festgelegt ist.
+ Kann nicht angegeben werden, wenn der Parameter `RestoreType` auf `copy-on-write` festgelegt ist.
Beispiel: `2015-03-07T23:45:00Z`
Typ: Zeitstempel
Erforderlich: Nein
** RestoreType **
Der Typ der auszuführenden Wiederherstellung. Sie können einen der folgenden Werte angeben:
+ `full-copy` – Der neue DB-Cluster wird als vollständige Kopie des Quell-DB-Clusters wiederhergestellt.
+ `copy-on-write` – Der neue DB-Cluster wird als Klon des Quell-DB-Clusters wiederhergestellt.
Einschränkungen: Sie können `copy-on-write` nicht angeben, wenn die Engine-Version des Quell-DB-Clusters älter als 1.11 ist.
Wenn Sie keinen Wert für `RestoreType` angeben, wird der neue DB-Cluster als vollständige Kopie des Quell-DB-Clusters wiederhergestellt.
Typ: Zeichenfolge
Erforderlich: Nein
** ServerlessV2ScalingConfiguration **
Enthält die Skalierungskonfiguration eines serverlosen Amazon DocumentDB-Clusters.
Typ: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) Objekt
Erforderlich: Nein
** StorageType **
Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.
Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im *Amazon DocumentDB Developer Guide*.
Gültige Werte für den Speichertyp - `standard | iopt1`
Der Standardwert ist `standard `
Typ: Zeichenfolge
Erforderlich: Nein
**Tags.Tag.N**
Die Tags, die dem wiederhergestellten Cluster zugewiesen werden sollen.
Typ: Array von [Tag](API_Tag.md)-Objekten
Erforderlich: Nein
** UseLatestRestorableTime **
Ein Wert, der auf `true` festgelegt ist, um den Cluster auf den letzten wiederherstellbaren Sicherungszeitpunkt wiederherzustellen, und sonst `false` anzeigt.
Standard: `false`
Einschränkungen: Darf nicht angegeben werden, wenn der Parameter `RestoreToTime` angegeben ist.
Typ: Boolesch
Erforderlich: Nein
**VpcSecurityGroupIds. VpcSecurityGroupId**N
Eine Liste der VPC-Sicherheitsgruppen, zu denen der neue Cluster gehört.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Sie haben bereits einen Cluster mit der angegebenen Kennung.
HTTP-Statuscode: 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** DBClusterQuotaExceededFault **
Der Cluster kann nicht erstellt werden, da Sie das maximal zulässige Kontingent an Clustern erreicht haben.
HTTP-Statuscode: 403
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`bezieht sich nicht auf einen vorhandenen Cluster-Snapshot.
HTTP-Statuscode: 404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`bezieht sich nicht auf eine bestehende Subnetzgruppe.
HTTP-Statuscode: 404
** InsufficientDBClusterCapacityFault **
Der Cluster verfügt nicht über genügend Kapazität für den aktuellen Vorgang.
HTTP-Statuscode: 403
** InsufficientStorageClusterCapacity **
Für die aktuelle Aktion ist nicht genügend Speicherplatz verfügbar. Möglicherweise können Sie diesen Fehler beheben, indem Sie Ihre Subnetzgruppe so aktualisieren, dass sie verschiedene Availability Zones verwendet, in denen mehr Speicherplatz verfügbar ist.
HTTP-Statuscode: 400
** InvalidDBClusterSnapshotStateFault **
Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.
HTTP-Statuscode: 400
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBSnapshotState **
Der Status des Snapshots erlaubt kein Löschen.
HTTP-Statuscode: 400
** InvalidRestoreFault **
Sie können keine Wiederherstellung von einem Virtual Private Cloud (VPC) -Backup auf eine Nicht-VPC-DB-Instance durchführen.
HTTP-Statuscode: 400
** InvalidSubnet **
Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.
HTTP-Statuscode: 400
** InvalidVPCNetworkStateFault **
Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.
HTTP-Statuscode: 400
** KMSKeyNotAccessibleFault **
Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.
HTTP-Statuscode: 400
** NetworkTypeNotSupported **
Der Netzwerktyp wird `DBSubnetGroup` weder von der DB-Engine-Version noch von der DB-Engine-Version unterstützt.
HTTP-Statuscode: 400
** StorageQuotaExceeded **
Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instances verfügbar ist.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
# StartDBCluster
Startet den gestoppten Cluster neu, der von `DBClusterIdentifier` angegeben ist. Weitere Informationen finden Sie unter Einen [Amazon DocumentDB-Cluster beenden und starten](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die ID des Clusters, der neu gestartet werden soll. Beispiel: `docdb-2019-05-28-15-24-52`
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster)
# StopDBCluster
Stoppt den laufenden Cluster, der von angegeben ist`DBClusterIdentifier`. Der Cluster muss sich im Status „*Verfügbar*“ befinden. Weitere Informationen finden Sie unter Einen [Amazon DocumentDB-Cluster beenden und starten](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** DBClusterIdentifier **
Die Kennung des Clusters, der gestoppt werden soll. Beispiel: `docdb-2019-05-28-15-24-52`
Typ: Zeichenfolge
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** DBCluster **
Detaillierte Informationen zu einem Cluster.
Typ: [DBCluster](API_DBCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidDBInstanceState **
Die angegebene Instanz befindet sich nicht im Status „*Verfügbar*“.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster)
# SwitchoverGlobalCluster
Schaltet den angegebenen sekundären Amazon DocumentDB-Cluster in den neuen primären Amazon DocumentDB-Cluster im globalen Datenbank-Cluster um.
## Anforderungsparameter
Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).
** GlobalClusterIdentifier **
Die Kennung des globalen Amazon DocumentDB DocumentDB-Datenbank-Clusters, zu dem gewechselt werden soll. Die Kennung ist der eindeutige Schlüssel, den der Benutzer bei der Erstellung des Clusters zugewiesen hat. Mit anderen Worten, es ist der Name des globalen Clusters. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss mit der ID eines vorhandenen globalen Clusters (globale Amazon DocumentDB DocumentDB-Datenbank) übereinstimmen.
+ Mindestlänge 1. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
** TargetDbClusterIdentifier **
Die ID des sekundären Amazon DocumentDB-Clusters, der zum neuen primären Cluster für den globalen Datenbank-Cluster heraufgestuft werden soll. Verwenden Sie den Amazon Resource Name (ARN) für die Kennung, damit Amazon DocumentDB den Cluster in seiner AWS Region lokalisieren kann.
Einschränkungen:
+ Muss mit der Kennung eines vorhandenen sekundären Clusters übereinstimmen.
+ Mindestlänge 1. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.
Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Erforderlich: Ja
## Antwortelemente
Das folgende Element wird vom Dienst zurückgegeben.
** GlobalCluster **
Ein Datentyp, der einen globalen Amazon DocumentDB-Cluster darstellt.
Typ: [GlobalCluster](API_GlobalCluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`bezieht sich nicht auf einen vorhandenen Cluster.
HTTP-Statuscode: 404
** GlobalClusterNotFoundFault **
Das bezieht sich `GlobalClusterIdentifier` nicht auf einen vorhandenen globalen Cluster.
HTTP-Statuscode: 404
** InvalidDBClusterStateFault **
Der Cluster befindet sich nicht in einem gültigen Zustand.
HTTP-Statuscode: 400
** InvalidGlobalClusterStateFault **
Der angeforderte Vorgang kann nicht ausgeführt werden, solange sich der Cluster in diesem Status befindet.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster)
# Amazon DocumentDB Elastic Clusters
Die folgenden Aktionen werden von Amazon DocumentDB Elastic Clusters unterstützt:
+ [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
Der Typ der ausstehenden Wartungsaktion, die auf die Ressource angewendet werden soll.
## Anforderungssyntax
```
POST /pending-action HTTP/1.1
Content-type: application/json
{
"applyAction": "string",
"applyOn": "string",
"optInType": "string",
"resourceArn": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Die ausstehende Wartungsaktion, die auf die Ressource angewendet werden soll.
Gültige Aktionen sind:
+ `ENGINE_UPDATE `
+ `ENGINE_UPGRADE`
+ `SECURITY_UPDATE`
+ `OS_UPDATE`
+ `MASTER_USER_PASSWORD_UPDATE`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Ja
** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Ein Wert, der die Art der Opt-In-Anfrage angibt oder eine Opt-In-Anfrage rückgängig macht. Eine Opt-in-Anfrage vom Typ `IMMEDIATE` kann nicht rückgängig gemacht werden.
Typ: Zeichenfolge
Zulässige Werte: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`
Erforderlich: Ja
** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Der Amazon DocumentDB Amazon Resource Name (ARN) der Ressource, für die die ausstehende Wartungsaktion gilt.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Ja
** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Ein bestimmtes Datum, an dem die ausstehende Wartungsmaßnahme angewendet werden soll. Erforderlich, wenn opt-in-type ein `APPLY_ON` ist. Format: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourcePendingMaintenanceAction": {
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **
Die Ausgabe der ausstehenden Wartungsaktion, die gerade ausgeführt wird.
Typ: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
# CopyClusterSnapshot
Kopiert einen Snapshot eines elastischen Clusters.
## Anforderungssyntax
```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json
{
"copyTags": boolean,
"kmsKeyId": "string",
"tags": {
"string" : "string"
},
"targetSnapshotName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) -Bezeichner des Elastic Cluster-Snapshots.
Erforderlich: Ja
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Die Kennung des neuen Elastic Cluster-Snapshots, der aus dem Quell-Cluster-Snapshot erstellt werden soll. Bei diesem Parameter wird nicht zwischen Groß- und Kleinschreibung unterschieden.
Einschränkungen:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
Beispiel: `elastic-cluster-snapshot-5`
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 63 Zeichen.
Erforderlich: Ja
** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Wird auf gesetzt, `true` um alle Tags aus dem Quell-Cluster-Snapshot in den Elastic Cluster-Ziel-Snapshot zu kopieren. Der Standardwert ist `false`.
Typ: Boolesch
Erforderlich: Nein
** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Die AWS KMS-Schlüssel-ID für einen verschlüsselten Elastic Cluster-Snapshot. Die AWS KMS-Schlüssel-ID ist der Amazon-Ressourcenname (ARN), die AWS KMS-Schlüssel-ID oder der AWS KMS-Schlüsselalias für den AWS KMS-Verschlüsselungsschlüssel.
Wenn Sie einen verschlüsselten Elastic Cluster-Snapshot von Ihrem AWS Konto kopieren, können Sie einen Wert angeben, `KmsKeyId` um die Kopie mit einem neuen AWS S KMS-Verschlüsselungsschlüssel zu verschlüsseln. Wenn Sie keinen Wert für angeben`KmsKeyId`, wird die Kopie des Elastic Cluster-Snapshots mit demselben `AWS` KMS-Schlüssel verschlüsselt wie der Elastic Cluster-Quell-Snapshot.
Wenn Sie einen unverschlüsselten Elastic Cluster-Snapshot kopieren und einen Wert für den `KmsKeyId` Parameter angeben, wird ein Fehler zurückgegeben.
Typ: Zeichenfolge
Erforderlich: Nein
** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Die Tags, die dem Elastic Cluster-Snapshot zugewiesen werden sollen.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Nein
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **
Gibt Informationen zu einem bestimmten Elastic Cluster-Snapshot zurück.
Typ: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ServiceQuotaExceededException **
Das Dienstkontingent für die Aktion wurde überschritten.
HTTP-Statuscode: 402
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Drosselung der Anfrage abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
# CreateCluster
Erstellt einen neuen elastischen Amazon DocumentDB-Cluster und gibt dessen Clusterstruktur zurück.
## Anforderungssyntax
```
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" ]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **
Der Name des Amazon DocumentDB Elastic Clusters-Administrators.
*Einschränkungen*:
+ Muss zwischen 1 und 63 Buchstaben oder Zahlen enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Dies darf kein reserviertes Wort sein.
Typ: Zeichenfolge
Erforderlich: Ja
** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **
Das Passwort für den Amazon DocumentDB Elastic Clusters-Administrator. Das Passwort kann alle druckbaren ASCII-Zeichen enthalten.
*Einschränkungen*:
+ Muss 8 bis 100 Zeichen enthalten.
+ Darf keinen Schrägstrich (/), doppelte Anführungszeichen („) oder das „at“ -Symbol (@) enthalten.
Typ: Zeichenfolge
Erforderlich: Ja
** [authType](#API_elastic_CreateCluster_RequestSyntax) **
Der Authentifizierungstyp, der verwendet wird, um zu bestimmen, wo das für den Zugriff auf den Elastic Cluster verwendete Passwort abgerufen werden soll. Gültige Typen sind `PLAIN_TEXT` oder`SECRET_ARN`.
Typ: Zeichenfolge
Zulässige Werte: `PLAIN_TEXT | SECRET_ARN`
Erforderlich: Ja
** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **
Der Name des neuen elastischen Clusters. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.
*Einschränkungen*:
+ Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.
+ Das erste Zeichen muss ein Buchstabe sein.
+ Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.
*Beispiel*: `my-cluster`
Typ: Zeichenfolge
Erforderlich: Ja
** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **
Die Anzahl von v, die jedem elastischen CPUs Cluster-Shard zugewiesen sind. Das Maximum ist 64. Zulässige Werte sind 2, 4, 8, 16, 32, 64.
Typ: Ganzzahl
Erforderlich: Ja
** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **
Die Anzahl der Shards, die dem elastischen Cluster zugewiesen sind. Das Maximum ist 32.
Typ: Ganzzahl
Erforderlich: Ja
** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **
Die Anzahl der Tage, für die automatische Snapshots aufbewahrt werden.
Typ: Ganzzahl
Erforderlich: Nein
** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **
Das Client-Token für den Elastic Cluster.
Typ: Zeichenfolge
Erforderlich: Nein
** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **
Die KMS-Schlüssel-ID, die zum Verschlüsseln des neuen Elastic Clusters verwendet werden soll.
Die Kennung für den KMS-Schlüssel ist der Amazon-Ressourcenname (ARN) für den KMS-Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben Amazon-Konto erstellen, dem dieser KMS-Verschlüsselungsschlüssel gehört, können Sie den KMS-Schlüsselalias anstelle des ARN als KMS-Verschlüsselungsschlüssel verwenden.
Wenn kein Verschlüsselungsschlüssel angegeben ist, verwendet Amazon DocumentDB den Standardverschlüsselungsschlüssel, den KMS für Ihr Konto erstellt. Ihr Konto hat für jede Amazon-Region einen anderen Standard-Verschlüsselungsschlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **
Der tägliche Zeitraum, in dem automatische Backups erstellt werden, wenn automatische Backups aktiviert sind, wie von der festgelegt`backupRetentionPeriod`.
Typ: Zeichenfolge
Erforderlich: Nein
** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **
Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).
*Format*: `ddd:hh24:mi-ddd:hh24:mi`
*Standard*: Ein 30-Minuten-Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird und an einem zufälligen Wochentag stattfindet.
*Gültige Tage*: Mo, Di, Mi, Do, Fr, Sa, So
*Einschränkungen*: mindestens 30-Minuten-Zeitfenster.
Typ: Zeichenfolge
Erforderlich: Nein
** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **
Die Anzahl der Replikatinstanzen, die für alle Shards im Elastic Cluster gelten. Ein `shardInstanceCount` Wert von 1 bedeutet, dass es eine Writer-Instance gibt, und alle weiteren Instances sind Replikate, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.
Typ: Ganzzahl
Erforderlich: Nein
** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **
Das Amazon EC2-Subnetz IDs für den neuen Elastic Cluster.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** [tags](#API_elastic_CreateCluster_RequestSyntax) **
Die Tags, die dem neuen Elastic Cluster zugewiesen werden sollen.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Nein
** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **
Eine Liste von EC2-VPC-Sicherheitsgruppen, die dem neuen Elastic Cluster zugeordnet werden sollen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **
Der neue elastische Cluster, der erstellt wurde.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ServiceQuotaExceededException **
Das Dienstkontingent für die Aktion wurde überschritten.
HTTP-Statuscode: 402
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Drosselung der Anfrage abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster)
# CreateClusterSnapshot
Erstellt einen Snapshot eines elastischen Clusters.
## Anforderungssyntax
```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json
{
"clusterArn": "string",
"snapshotName": "string",
"tags": {
"string" : "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Die ARN-ID des Elastic Clusters, von dem Sie einen Snapshot erstellen möchten.
Typ: Zeichenfolge
Erforderlich: Ja
** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Der Name des neuen Elastic Cluster-Snapshots.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 63 Zeichen.
Erforderlich: Ja
** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Die Tags, die dem neuen Elastic Cluster-Snapshot zugewiesen werden sollen.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Nein
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **
Gibt Informationen über den neuen Elastic Cluster-Snapshot zurück.
Typ: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ServiceQuotaExceededException **
Das Dienstkontingent für die Aktion wurde überschritten.
HTTP-Statuscode: 402
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Drosselung der Anfrage abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
# DeleteCluster
Löschen Sie einen elastischen Cluster.
## Anforderungssyntax
```
DELETE /cluster/clusterArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **
Die ARN-ID des Elastic Clusters, der gelöscht werden soll.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **
Gibt Informationen über den neu gelöschten Elastic Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster)
# DeleteClusterSnapshot
Löschen Sie einen Elastic Cluster-Snapshot.
## Anforderungssyntax
```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **
Die ARN-ID des Elastic Cluster-Snapshots, der gelöscht werden soll.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **
Gibt Informationen über den neu gelöschten Elastic Cluster-Snapshot zurück.
Typ: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
# GetCluster
Gibt Informationen über einen bestimmten elastischen Cluster zurück.
## Anforderungssyntax
```
GET /cluster/clusterArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **
Die ARN-ID des elastischen Clusters.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_GetCluster_ResponseSyntax) **
Gibt Informationen über einen bestimmten elastischen Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster)
# GetClusterSnapshot
Gibt Informationen zu einem bestimmten Elastic Cluster-Snapshot zurück
## Anforderungssyntax
```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **
Die ARN-ID des Elastic Cluster-Snapshots.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **
Gibt Informationen zu einem bestimmten Elastic Cluster-Snapshot zurück.
Typ: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
# GetPendingMaintenanceAction
Ruft alle ausstehenden Wartungsaktionen ab.
## Anforderungssyntax
```
GET /pending-action/resourceArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **
Ruft ausstehende Wartungsaktionen für einen bestimmten Amazon-Ressourcennamen (ARN) ab.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourcePendingMaintenanceAction": {
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **
Stellt Informationen über eine ausstehende Wartungsaktion für eine Ressource bereit.
Typ: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zur Durchführung einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
# ListClusters
Gibt Informationen über bereitgestellte elastische Amazon DocumentDB-Cluster zurück.
## Anforderungssyntax
```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [maxResults](#API_elastic_ListClusters_RequestSyntax) **
Die maximale Anzahl von Elastic Cluster-Snapshot-Ergebnissen, die in der Antwort empfangen werden sollen.
Gültiger Bereich: Mindestwert 1. Maximalwert 100.
** [nextToken](#API_elastic_ListClusters_RequestSyntax) **
Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von `max-results` angegebenen Wert.
Wenn die Antwort keine weiteren Daten enthält, `nextToken` werden sie nicht zurückgegeben.
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"clusterArn": "string",
"clusterName": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [clusters](#API_elastic_ListClusters_ResponseSyntax) **
Eine Liste elastischer Amazon DocumentDB-Cluster.
Typ: Array von [ClusterInList](API_elastic_ClusterInList.md)-Objekten
** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **
Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von `max-results` angegebenen Wert.
Wenn die Antwort keine weiteren Daten enthält, `nextToken` werden sie nicht zurückgegeben.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters)
# ListClusterSnapshots
Gibt Informationen über Snapshots für einen angegebenen elastischen Cluster zurück.
## Anforderungssyntax
```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Die ARN-ID des elastischen Clusters.
** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Die maximale Anzahl von Elastic Cluster-Snapshot-Ergebnissen, die in der Antwort empfangen werden sollen.
Gültiger Bereich: Mindestwert von 20. Maximalwert 100.
** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von `max-results` angegebenen Wert.
Wenn die Antwort keine weiteren Daten enthält, `nextToken` werden sie nicht zurückgegeben.
** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Der Typ der Cluster-Snapshots, die zurückgegeben werden sollen. Sie können einen der folgenden Werte angeben:
+ `automated`- Gibt alle Cluster-Snapshots zurück, die Amazon DocumentDB automatisch für Ihr AWS Konto erstellt hat.
+ `manual`- Gibt alle Cluster-Snapshots zurück, die Sie manuell für Ihr Konto erstellt haben. AWS
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"snapshots": [
{
"clusterArn": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"status": "string"
}
]
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **
Ein Paginierungstoken, das durch eine vorherige Anfrage bereitgestellt wurde. Wenn dieser Parameter angegeben ist, umfasst die Antwort nur Datensätze, die über dieses Token hinausgehen, bis zu dem von `max-results` angegebenen Wert.
Wenn die Antwort keine weiteren Daten enthält, `nextToken` werden sie nicht zurückgegeben.
Typ: Zeichenfolge
** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **
Eine Liste von Snapshots für einen bestimmten Elastic Cluster.
Typ: Array von [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
# ListPendingMaintenanceActions
Ruft eine Liste aller ausstehenden Wartungsaktionen ab.
## Anforderungssyntax
```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **
Die maximale Anzahl von Ergebnissen, die in die Antwort aufgenommen werden sollen. Wenn mehr Datensätze als der angegebene `maxResults` Wert vorhanden sind, ist ein Paginierungstoken (Markierung) in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.
Gültiger Bereich: Mindestwert 1. Maximalwert 100.
** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch `maxResults` angegebenen Wert.
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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"
}
]
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **
Stellt Informationen über eine ausstehende Wartungsaktion für eine Ressource bereit.
Typ: Array von [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)-Objekten
** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **
Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn dieser Parameter angezeigt wird, enthalten die Antworten nur Datensätze, die sich hinter der Markierung befinden, bis zu dem von `maxResults` angegebenen Wert.
Typ: Zeichenfolge
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
# ListTagsForResource
Listet alle Tags auf einer Elastic Cluster-Ressource auf
## Anforderungssyntax
```
GET /tags/resourceArn HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **
Die ARN-ID der Elastic Cluster-Ressource.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1011.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **
Die Liste der Tags für die angegebene Elastic Cluster-Ressource.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource)
# RestoreClusterFromSnapshot
Stellt einen elastischen Cluster aus einem Snapshot wieder her.
## Anforderungssyntax
```
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" ]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Die ARN-ID des Elastic Cluster-Snapshots.
Erforderlich: Ja
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Der Name des elastischen Clusters.
Typ: Zeichenfolge
Erforderlich: Ja
** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Die KMS-Schlüssel-ID, die zur Verschlüsselung des neuen Amazon DocumentDB DocumentDB-Elastic-Clusters-Clusters verwendet werden soll.
Die Kennung für den KMS-Schlüssel ist der Amazon-Ressourcenname (ARN) für den KMS-Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben Amazon-Konto erstellen, dem dieser KMS-Verschlüsselungsschlüssel gehört, können Sie den KMS-Schlüsselalias anstelle des ARN als KMS-Verschlüsselungsschlüssel verwenden.
Wenn hier kein Verschlüsselungsschlüssel angegeben ist, verwendet Amazon DocumentDB den Standardverschlüsselungsschlüssel, den KMS für Ihr Konto erstellt. Ihr Konto hat für jede Amazon-Region einen anderen Standard-Verschlüsselungsschlüssel.
Typ: Zeichenfolge
Erforderlich: Nein
** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Die Kapazität jedes Shards im neuen wiederhergestellten Elastic Cluster.
Typ: Ganzzahl
Erforderlich: Nein
** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Die Anzahl der Replikatinstanzen, die für alle Shards im Elastic Cluster gelten. Ein `shardInstanceCount` Wert von 1 bedeutet, dass es eine Writer-Instance gibt, und alle weiteren Instances sind Replikate, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.
Typ: Ganzzahl
Erforderlich: Nein
** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Das Amazon EC2-Subnetz IDs für den Elastic Cluster.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Eine Liste der Tag-Namen, die dem wiederhergestellten Elastic Cluster zugewiesen werden sollen, in Form einer Reihe von Schlüssel-Wert-Paaren, wobei der Schlüssel der Tag-Name und der Wert der Schlüsselwert ist.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Nein
** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Eine Liste von EC2-VPC-Sicherheitsgruppen, die dem Elastic Cluster zugeordnet werden sollen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **
Gibt Informationen über den wiederhergestellten elastischen Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ServiceQuotaExceededException **
Das Dienstkontingent für die Aktion wurde überschritten.
HTTP-Statuscode: 402
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Drosselung der Anfrage abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
# StartCluster
Startet den gestoppten Elastic Cluster neu, der von `clusterARN` angegeben ist.
## Anforderungssyntax
```
POST /cluster/clusterArn/start HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **
Die ARN-ID des elastischen Clusters.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_StartCluster_ResponseSyntax) **
Gibt Informationen über einen bestimmten elastischen Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster)
# StopCluster
Stoppt den laufenden Elastic Cluster, der von angegeben ist`clusterArn`. Der elastische Cluster muss sich im Status „*Verfügbar*“ befinden.
## Anforderungssyntax
```
POST /cluster/clusterArn/stop HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **
Die ARN-ID des elastischen Clusters.
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_StopCluster_ResponseSyntax) **
Gibt Informationen über einen bestimmten elastischen Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster)
# TagResource
Fügt einer Elastic Cluster-Ressource Metadaten-Tags hinzu
## Anforderungssyntax
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [resourceArn](#API_elastic_TagResource_RequestSyntax) **
Die ARN-ID der Elastic Cluster-Ressource.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1011.
Erforderlich: Ja
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [tags](#API_elastic_TagResource_RequestSyntax) **
Die Tags, die der Elastic Cluster-Ressource zugewiesen sind.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `(?!aws:)[a-zA-Z+-=._:/]+`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource)
# UntagResource
Entfernt Metadaten-Tags aus einer Elastic Cluster-Ressource
## Anforderungssyntax
```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **
Die ARN-ID der Elastic Cluster-Ressource.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1011.
Erforderlich: Ja
** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **
Die Tag-Schlüssel, die aus der Elastic Cluster-Ressource entfernt werden sollen.
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 50 Elemente.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`
Erforderlich: Ja
## Anforderungstext
Der Anforderung besitzt keinen Anforderungstext.
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource)
# UpdateCluster
Ändert einen elastischen Cluster. Dazu gehören die Aktualisierung von Admin-Benutzername/Passwort, die Aktualisierung der API-Version und die Einrichtung eines Backup-Fensters und eines Wartungsfensters
## Anforderungssyntax
```
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" ]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **
Die ARN-ID des elastischen Clusters.
Erforderlich: Ja
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **
Das dem Elastic Cluster-Administrator zugeordnete Passwort. Dieses Passwort kann alle druckbaren ASCII-Zeichen, außer Schrägstrich (/), doppeltes Anführungszeichen (") oder das "At"-Zeichen (@), enthalten.
*Einschränkungen*: Muss zwischen 8 und 100 Zeichen enthalten.
Typ: Zeichenfolge
Erforderlich: Nein
** [authType](#API_elastic_UpdateCluster_RequestSyntax) **
Der Authentifizierungstyp, der verwendet wird, um zu bestimmen, wo das für den Zugriff auf den Elastic Cluster verwendete Passwort abgerufen werden soll. Gültige Typen sind `PLAIN_TEXT` oder`SECRET_ARN`.
Typ: Zeichenfolge
Zulässige Werte: `PLAIN_TEXT | SECRET_ARN`
Erforderlich: Nein
** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **
Die Anzahl der Tage, für die automatische Snapshots aufbewahrt werden.
Typ: Ganzzahl
Erforderlich: Nein
** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **
Das Client-Token für den Elastic Cluster.
Typ: Zeichenfolge
Erforderlich: Nein
** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **
Der tägliche Zeitraum, in dem automatische Backups erstellt werden, wenn automatische Backups aktiviert sind, wie durch den festgelegt`backupRetentionPeriod`.
Typ: Zeichenfolge
Erforderlich: Nein
** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **
Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).
*Format*: `ddd:hh24:mi-ddd:hh24:mi`
*Standard*: Ein 30-Minuten-Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird und an einem zufälligen Wochentag stattfindet.
*Gültige Tage*: Mo, Di, Mi, Do, Fr, Sa, So
*Einschränkungen*: mindestens 30-Minuten-Zeitfenster.
Typ: Zeichenfolge
Erforderlich: Nein
** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **
Die Anzahl von v, die jedem elastischen Cluster-Shard CPUs zugewiesen ist. Das Maximum ist 64. Zulässige Werte sind 2, 4, 8, 16, 32, 64.
Typ: Ganzzahl
Erforderlich: Nein
** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **
Die Anzahl der Shards, die dem elastischen Cluster zugewiesen sind. Das Maximum ist 32.
Typ: Ganzzahl
Erforderlich: Nein
** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **
Die Anzahl der Replikatinstanzen, die für alle Shards im Elastic Cluster gelten. Ein `shardInstanceCount` Wert von 1 bedeutet, dass es eine Writer-Instance gibt, und alle weiteren Instances sind Replikate, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.
Typ: Ganzzahl
Erforderlich: Nein
** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **
Das Amazon EC2-Subnetz IDs für den Elastic Cluster.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **
Eine Liste von EC2-VPC-Sicherheitsgruppen, die dem Elastic Cluster zugeordnet werden sollen.
Typ: Zeichenfolgen-Array
Erforderlich: Nein
## Antwortsyntax
```
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" ]
}
}
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **
Gibt Informationen über den aktualisierten Elastic Cluster zurück.
Typ: [Cluster](API_elastic_Cluster.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).
** AccessDeniedException **
Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.
** message **
Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.
HTTP-Statuscode: 403
** ConflictException **
Es gab einen Zugriffskonflikt.
** resourceId **
Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
** resourceType **
Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.
HTTP-Statuscode: 409
** InternalServerException **
Es ist ein interner Serverfehler aufgetreten.
HTTP Status Code: 500
** ResourceNotFoundException **
Die angegebene Ressource konnte nicht gefunden werden.
** message **
Eine Fehlermeldung, die den Fehler beschreibt.
** resourceId **
Die ID der Ressource, die nicht gefunden werden konnte.
** resourceType **
Der Typ der Ressource, die nicht gefunden werden konnte.
HTTP-Statuscode: 404
** ThrottlingException **
ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.
** retryAfterSeconds **
Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.
HTTP-Statuscode: 429
** ValidationException **
Eine Struktur, die eine Validierungsausnahme definiert.
** fieldList **
Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.
** message **
Eine Fehlermeldung, die die Validierungsausnahme beschreibt.
** reason **
Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von `unknownOperation` `cannotParse``fieldValidationFailed`,, oder`other`).
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)