Sonstige Neptune-APIs

• AddTagsToResource (Aktion)

• ListTagsForResource (Aktion)

• RemoveTagsFromResource (Aktion)

• ApplyPendingMaintenanceAction (Aktion)

• DescribePendingMaintenanceActions (Aktion)

• DescribeDBEngineVersions (Aktion)

• DBEngineVersion (Struktur)

• EngineDefaults (Struktur)

• PendingMaintenanceAction (Struktur)

• ResourcePendingMaintenanceActions (Struktur)

• UpgradeTarget (Struktur)

• Tag (Struktur)

• ResourceName  (in der CLI: --resource-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Amazon Neptune-Ressource, der die Tags hinzugefügt werden. Dieser Wert ist ein Amazon-Ressourcenname (ARN). Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

• Tags  (in der CLI: --tags) – Erforderlich: Ein Array von Tag-Objekten.

  Die Tags, die der Amazon Neptune-Ressource zugewiesen werden sollen.

Antwort

• Keine Antwortparameter.

Fehler

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

  Dieser Parameter wird derzeit nicht unterstützt.

• ResourceName  (in der CLI: --resource-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die aufzulistende Amazon Neptune-Ressource mit Tags. Dieser Wert ist ein Amazon-Ressourcenname (ARN). Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

• TagList – Ein Array mit Tag-Objekten.

  Liste von Tags, die von der ListTagsForResource-Operation zurückgegeben werden.

Fehler

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• ResourceName  (in der CLI: --resource-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Amazon Neptune-Ressource, von der die Tags entfernt werden. Dieser Wert ist ein Amazon-Ressourcenname (ARN). Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

• TagKeys  (in der CLI: --tag-keys) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Tag-Schlüssel (Name) des zu entfernenden Tags.

Antwort

• Keine Antwortparameter.

Fehler

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• ApplyAction  (in der CLI: --apply-action) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die anstehende Wartungsaktion, die auf diese Ressource angewendet werden soll.

  Zulässige Werte: system-update, db-upgrade

• OptInType  (in der CLI: --opt-in-type) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  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.

• ResourceIdentifier  (in der CLI: --resource-identifier) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Amazon-Ressourcenname (ARN) der Ressource, auf die sich die anstehende Wartungsaktion bezieht. Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

• PendingMaintenanceActionDetails – Ein Array mit PendingMaintenanceAction-Objekten.

  Eine Liste mit Details zu den ausstehenden Wartungsaktionen für die Ressource.

• ResourceIdentifier – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der ARN der Ressource, die ausstehende Wartungsaktionen hat.

Fehler

• ResourceNotFoundFault

• Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

  Ein Filter, der eine oder mehrere Ressourcen angibt, für die ausstehende Wartungsaktionen zurückgegeben werden sollen.

  Unterstützte Filter:

  • db-cluster-id – Akzeptiert DB-Cluster-Kennungen und DB-Cluster-ARNs (Amazon Resource Names, Amazon-Ressourcennamen). In der Ergebnisliste werden nur die ausstehenden Wartungsaktionen für die DB-Cluster aufgeführt, die diesen ARNs entsprechen.

  • db-instance-id – Akzeptiert DB-Instance-Kennungen und DB-Instance-ARNs. In der Ergebnisliste werden nur die ausstehenden Wartungsaktionen für die DB-Instances aufgeführt, die diesen ARNs entsprechen.

• Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Ein optionales Paginierungstoken, das von einer vorherigen DescribePendingMaintenanceActions-Anforderung bereitgestellt wird. Wenn dieser Parameter angegeben ist, enthält die Antwort nur Datensätze jenseits der Markierung bis zu einer Anzahl von Datensätzen, die durch MaxRecords festgelegt wurde.

• MaxRecords  (in der CLI: --max-records) – IntegerOptional-Wert vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

  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: Mindestwert 20, Höchstwert 100.

• ResourceIdentifier  (in der CLI: --resource-identifier) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der ARN einer Ressource, für die ausstehende Wartungsaktionen zurückgegeben werden sollen.

• Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Ein optionales Paginierungstoken, das von einer vorherigen DescribePendingMaintenanceActions-Anforderung bereitgestellt wird. Wenn dieser Parameter angegeben ist, enthält die Antwort nur Datensätze jenseits der Markierung bis zu einer Anzahl von Datensätzen, die durch MaxRecords festgelegt wurde.

• PendingMaintenanceActions – Ein Array mit ResourcePendingMaintenanceActions-Objekten.

  Eine Liste ausstehender Wartungsaktionen für die Ressource.

Fehler

• ResourceNotFoundFault

• DBParameterGroupFamily  (in der CLI: --db-parameter-group-family) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Name einer spezifischen DB-Parametergruppenfamilie, für die Details zurückgegeben werden sollen.

  Einschränkungen:

  • Falls angegeben, muss der Wert mit einer vorhandenen DBParameterGroupFamily übereinstimmen.

• DefaultOnly  (in der CLI: --default-only) – boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Gibt an, dass nur die standardmäßige Version der angegebenen Engine oder Kombination aus Engine und Hauptversion zurückgegeben wird.

• Engine  (in der CLI: --engine) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die zurückzugebende Datenbank-Engine.

• EngineVersion  (in der CLI: --engine-version) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die zurückzugebende Datenbank-Engine-Version.

  Beispiel: 5.1.49

• Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

  Wird derzeit nicht unterstützt.

• ListSupportedCharacterSets  (in der CLI: --list-supported-character-sets) – BooleanOptional-Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  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.

• ListSupportedTimezones  (in der CLI: --list-supported-timezones) – BooleanOptional-Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  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.

• Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  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.

• MaxRecords  (in der CLI: --max-records) – IntegerOptional-Wert vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

  Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr als der Wert MaxRecords verfügbar ist, wird ein als Markierung bezeichneter Paginierungs-Token zur Antwort hinzugefügt, damit die folgenden Ergebnisse abgerufen werden können.

  Standard: 100

  Einschränkungen: Mindestwert 20, Höchstwert 100.

• DBEngineVersions – Ein Array mit DBEngineVersion-Objekten.

  Eine Liste mit DBEngineVersion-Elementen.

• Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  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.

Felder

• DBEngineDescription – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Beschreibung der Datenbank-Engine.

• DBEngineVersionDescription – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Beschreibung der Datenbank-Engine-Version.

• DBParameterGroupFamily – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Name der Familie der DB-Parametergruppe für die Datenbank-Engine.

• Engine – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Name der Datenbank-Engine.

• EngineVersion – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Versionsnummer des Datenbank-Engines.

• ExportableLogTypes – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Protokolltypen, die die Datenbank-Engine zum Exportieren an CloudWatch Logs verfügbar hat.

• SupportedTimezones – Dies ist ein Array von Zeitzone-Objekten.

  Eine Liste der von dieser Engine für den Parameter Timezone der Aktion CreateDBInstance unterstützten Zeitzonen.

• SupportsGlobalDatabases – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Ein Wert, der angibt, ob Sie globale Aurora-Datenbanken mit einer bestimmten DB-Engine-Version verwenden können.

• SupportsLogExportsToCloudwatchLogs – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Ein Wert, der angibt, ob die Engine-Version das Exportieren der durch ExportableLogTypes festgelegten Protokolltypen an CloudWatch Logs unterstützt.

• SupportsReadReplica – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Gibt an, ob die Datenbank-Engine-Version Read Replicas unterstützt.

• ValidUpgradeTarget – Dies ist ein Array von UpgradeTarget-Objekten.

  Eine Liste der Engine-Versionen, auf die diese Datenbank-Engine-Version aktualisiert werden kann.

Felder

• DBParameterGroupFamily – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Gibt den Namen der DB-Parametergruppenfamilie an, auf die die Standard-Parameter der Engine angewendet werden.

• Marker – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Ein optionales Paginierungs-Token, das von einer vorherigen EngineDefaults-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.

• Parameters – Dies ist ein Array von Parameter-Objekten.

  Enthält eine Liste der Standardparameter der Engine.

• DescribeEngineDefaultParameters

• DescribeEngineDefaultClusterParameters

Felder

• Action – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Typ der ausstehenden Wartungsaktion, die für die Ressource verfügbar ist.

• AutoAppliedAfterDate – ein TStamp vom Typ timestamp (ein Zeitpunkt, allgemein definiert als Offset von Mitternacht 01.01.1970).

  Das Datum des Wartungsfensters, in dem die Aktion angewendet wird. Die Wartungsaktion wird während ihres ersten Wartungsfensters nach diesem Datum auf die Ressource angewendet. Wenn dieses Datum angegeben ist, werden alle next-maintenance-Opt-In-Anfragen ignoriert.

• CurrentApplyDate – ein TStamp vom Typ timestamp (ein Zeitpunkt, allgemein definiert als Offset von Mitternacht 01.01.1970).

  Das Datum des Inkrafttretens, wenn die ausstehende Wartungsaktion auf die Ressource angewendet wird. Dieses Datum berücksichtigt Opt-In-Anfragen, die von der ApplyPendingMaintenanceAction (Aktion)-API, von AutoAppliedAfterDate und von ForcedApplyDate erhalten wurden. Dieser Wert ist leer, wenn eine Opt-In-Anforderung nicht empfangen wurde und nichts für AutoAppliedAfterDate oder ForcedApplyDate angegeben wurde.

• Description – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Eine Beschreibung, die weitere Details zu der Wartungsaktion bereitstellt.

• ForcedApplyDate – ein TStamp vom Typ timestamp (ein Zeitpunkt, allgemein definiert als Offset von Mitternacht 01.01.1970).

  Das Datum, an dem die Wartungsaktion automatisch angewendet wird. Die Wartungsaktion wird ungeachtet des Wartungsfensters für die Ressource an diesem Datum auf die Ressource angewendet. Wenn dieses Datum angegeben ist, werden alle immediate-Opt-In-Anfragen ignoriert.

• OptInStatus – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Gibt den Typ der Opt-in-Anforderung an, die für die Ressource empfangen wurde.

Felder

• PendingMaintenanceActionDetails – Dies ist ein Array von PendingMaintenanceAction-Objekten.

  Eine Liste mit Details zu den ausstehenden Wartungsaktionen für die Ressource.

• ResourceIdentifier – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der ARN der Ressource, die ausstehende Wartungsaktionen hat.

• ApplyPendingMaintenanceAction

Felder

• AutoUpgrade – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Ein Wert, der angibt, ob die Zielversion auf Quell-DB-Instances angewendet wird, bei denen "AutoMinorVersionUpgrade" auf "true" festgelegt ist.

• Description – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Version der Datenbank-Engine, auf die eine DB-Instance aktualisiert werden kann.

• Engine – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Der Name der Upgrade-Zieldatenbank-Engine.

• EngineVersion – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Versionsnummer der Upgrade-Zieldatenbank-Engine.

• IsMajorVersionUpgrade – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Ein Wert, der angibt, ob eine Datenbank-Engine auf eine Hauptversion aktualisiert wird.

• SupportsGlobalDatabases – Dies ist ein BooleanOptional-Wert vom Typ: boolean (ein boolescher Wert (wahr oder falsch)).

  Ein Wert, der angibt, ob Sie globale Neptune-Datenbanken mit der Version der Ziel-Engine verwenden können.

Felder

• Key – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Ein Schlüssel ist der erforderliche Name des Tags. Der Zeichenfolgenwert kann aus 1 bis 128 Unicode-Zeichen bestehen. Ihm darf kein „aws:“ oder „rds:“ als Präfix vorangestellt werden. Die Zeichenfolge darf nur Unicode-Zeichen, Ziffern, Leerzeichen sowie „_“, „.“, „/“, „=“, „+“, „-“ enthalten (Java-Regex: „^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)“).

• Value – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Ein Wert ist der optionale Wert des Tags. Der Zeichenfolgenwert kann aus 1 bis 128 Unicode-Zeichen bestehen. Ihm darf kein „aws:“ oder „rds:“ als Präfix vorangestellt werden. Die Zeichenfolge darf nur Unicode-Zeichen, Ziffern, Leerzeichen sowie „_“, „.“, „/“, „=“, „+“, „-“ enthalten (Java-Regex: „^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)“).