Autre Neptune APIs

• AddTagsToResource (action)

• ListTagsForResource (action)

• RemoveTagsFromResource (action)

• ApplyPendingMaintenanceAction (action)

• DescribePendingMaintenanceActions (action)

• Décrire DBEngine les versions (action)

• DBEngineVersion (structure)

• EngineDefaults (structure)

• PendingMaintenanceAction (structure)

• ResourcePendingMaintenanceActions (structure)

• UpgradeTarget (structure)

• Tag (structure)

• ResourceName (dans la CLI : --resource-name) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Ressource Amazon Neptune à laquelle les balises sont ajoutées. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

• Tags (dans la CLI : --tags) : obligatoire : tableau d'objets Tag.

  Balises à attribuer à la ressource Amazon Neptune.

Réponse

• Paramètres d'absence de réponse.

Erreurs

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• Filters (dans la CLI : --filters) : tableau d'objets Filtre.

  Ce paramètre n'est actuellement pas pris en charge.

• ResourceName (dans la CLI : --resource-name) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Ressource Amazon Neptune avec balises à répertorier. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

• TagList : tableau d'objets Tag.

  Liste des balises renvoyées par l' ListTagsForResource opération.

Erreurs

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• ResourceName (dans la CLI : --resource-name) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Ressource Amazon Neptune de laquelle les balises sont supprimées. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

• TagKeys (dans la CLI : --tag-keys) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Clé de balise (nom) de la balise à supprimer.

Réponse

• Paramètres d'absence de réponse.

Erreurs

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

• ApplyAction (dans la CLI : --apply-action) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Action de maintenance en attente à appliquer à cette ressource.

  Valeurs valides : system-update, db-upgrade

• OptInType (dans la CLI : --opt-in-type) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Valeur qui spécifie le type de demande de confirmation de l'acceptation ou annule cette dernière. Un type demande de confirmation de l'acceptation de type immediate ne peut pas être annulée.

  Valeurs valides :

  • immediate - Appliquer immédiatement l'action de maintenance.

  • next-maintenance - Appliquer l'action de maintenance pendant le créneau de maintenance suivant pour la ressource.

  • undo-opt-in - Annuler toute demande de confirmation de l'acceptation next-maintenance existante.

• ResourceIdentifier (dans la CLI : --resource-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  ARN (Amazon Resource Name) de la ressource à laquelle s'applique l'action de maintenance en attente. Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

• PendingMaintenanceActionDetails : tableau d'objets PendingMaintenanceAction.

  Liste qui fournit des détails sur les actions de maintenance en attente pour la ressource.

• ResourceIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

  ARN de la ressource qui possède les actions de maintenance en attente.

Erreurs

• ResourceNotFoundFault

• Filters (dans la CLI : --filters) : tableau d'objets Filtre.

  Filtre qui spécifie une ou plusieurs ressources pour lesquelles renvoyer des actions de maintenance en attente.

  Filtres pris en charge :

  • db-cluster-id- Accepte les identifiants de cluster de base de données et les Amazon Resource Names (ARNs) du cluster de bases de données. La liste des résultats inclura uniquement les actions de maintenance en attente pour les clusters de base de données identifiés par ceux-ci ARNs.

  • db-instance-id- Accepte les identifiants d'instance de base de données et les instances ARNs de base de données. La liste des résultats inclura uniquement les actions de maintenance en attente pour les instances de base de données identifiées par celles-ci ARNs.

• Marker (dans la CLI : --marker) : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande DescribePendingMaintenanceActions précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à un nombre d'enregistrements spécifié par MaxRecords.

• MaxRecords(dans la CLI :--max-records) — un IntegerOptional, de type : integer (un entier signé de 32 bits).

  Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur MaxRecords spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats restants.

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

• ResourceIdentifier (dans la CLI : --resource-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  ARN d'une ressource pour laquelle renvoyer des actions de maintenance en attente.

• Marker : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande DescribePendingMaintenanceActions précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à un nombre d'enregistrements spécifié par MaxRecords.

• PendingMaintenanceActions : tableau d'objets ResourcePendingMaintenanceActions.

  Liste des actions de maintenance en attente pour la ressource.

Erreurs

• ResourceNotFoundFault

• DBParameterGroupFamily (dans la CLI : --db-parameter-group-family) : chaîne de type : string (chaîne encodée en UTF-8).

  Nom d'une famille de groupe de paramètres de base de données spécifique pour laquelle renvoyer les détails.

  Contraintes :

  • S'il est fourni, il doit correspondre à un existant DBParameterGroupFamily.

• DefaultOnly (dans la CLI : --default-only) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Indique que seule la version par défaut du moteur spécifié ou de l'association moteur et version majeure est renvoyée.

• Engine (dans la CLI : --engine) : chaîne de type : string (chaîne encodée en UTF-8).

  Moteur de base de données à renvoyer.

• EngineVersion (dans la CLI : --engine-version) : chaîne de type : string (chaîne encodée en UTF-8).

  Version du moteur de base de données à renvoyer.

  Exemple : 5.1.49

• Filters (dans la CLI : --filters) : tableau d'objets Filtre.

  Cette option n'est pas prise en charge actuellement.

• ListSupportedCharacterSets(dans la CLI :--list-supported-character-sets) — a BooleanOptional, de type : boolean (une valeur booléenne (vraie ou fausse)).

  Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre CharacterSetName pour CreateDBInstance, la réponse inclut une liste des jeux de caractères pris en charge pour chaque version de moteur.

• ListSupportedTimezones(dans la CLI :--list-supported-timezones) — a BooleanOptional, de type : boolean (une valeur booléenne (vraie ou fausse)).

  Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre TimeZone pour CreateDBInstance, la réponse inclut une liste des fuseaux horaires pris en charge pour chaque version de moteur.

• Marker (dans la CLI : --marker) : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

• MaxRecords(dans la CLI :--max-records) — un IntegerOptional, de type : integer (un entier signé de 32 bits).

  Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur MaxRecords, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats suivants.

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

• DBEngineVersions : tableau d'objets DBEngineVersion.

  Une liste des éléments DBEngineVersion.

• Marker : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

Champs

• DBEngineDescription : chaîne de type : string (chaîne encodée en UTF-8).

  Description du moteur de base de données.

• DBEngineVersionDescription : chaîne de type : string (chaîne encodée en UTF-8).

  Description de la version du moteur de base de données.

• DBParameterGroupFamily : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la famille de groupe de paramètres de base de données pour le moteur de base de données.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du moteur de base de données.

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

  Le numéro de version du moteur de base de données.

• ExportableLogTypes : chaîne de type : string (chaîne encodée en UTF-8).

  Types de journaux disponibles pour exportation vers CloudWatch Logs par le moteur de base de données.

• SupportedTimezones : tableau d'objets Fuseau horaire.

  Liste des fuseaux horaires pris en charge par ce moteur pour le paramètre Timezone de l'action CreateDBInstance.

• SupportsGlobalDatabases : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec une version de moteur de base de données spécifique.

• SupportsLogExportsToCloudwatchLogs : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Une valeur qui indique si la version du moteur prend en charge l'exportation des types de journaux spécifiés par ExportableLogTypes to CloudWatch Logs.

• SupportsReadReplica : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Indique si la version du moteur de base de données prend en charge les réplicas en lecture.

• ValidUpgradeTarget : tableau d'objets UpgradeTarget.

  Liste des versions de moteur vers lesquelles cette version du moteur de base de données peut être mise à niveau.

Champs

• DBParameterGroupFamily : chaîne de type : string (chaîne encodée en UTF-8).

  Spécifie le nom de la famille de groupe de paramètres de base de données à laquelle s'appliquent les paramètres par défaut du moteur.

• Marker : chaîne de type : string (chaîne encodée en UTF-8).

  Un jeton de pagination facultatif fourni par une EngineDefaults demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

• Parameters : tableau d'objets Paramètre.

  Contient une liste des paramètres par défaut du moteur.

• DescribeEngineDefaultParameters

• DescribeEngineDefaultClusterParameters

Champs

• Action : chaîne de type : string (chaîne encodée en UTF-8).

  Type d'action de maintenance en attente disponible pour la ressource.

• AutoAppliedAfterDate— Il s'agit d'un TStamp, de type : timestamp (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date de la fenêtre de maintenance lorsque l'action est appliquée. L'action de maintenance est appliquée à la ressource lors de sa première fenêtre de maintenance après cette date. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation next-maintenance sont ignorées.

• CurrentApplyDate— Il s'agit d'un TStamp, de type : timestamp (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date effective d'application de l'action de maintenance en attente à la ressource. Cette date tient compte des demandes de confirmation de l'acceptation de compte reçues à partir de l'API ApplyPendingMaintenanceAction (action), le paramètre AutoAppliedAfterDate et le paramètre ForcedApplyDate. Ce champ est vide si une demande de confirmation de l'acceptation n'a pas été reçue et rien n'a été spécifié comme AutoAppliedAfterDate ou ForcedApplyDate.

• Description : chaîne de type : string (chaîne encodée en UTF-8).

  Description fournissant plus de détails sur l'action de maintenance.

• ForcedApplyDate— Il s'agit d'un TStamp, de type : timestamp (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date à laquelle l'action de maintenance est automatiquement appliquée. L'action de maintenance est appliquée à la ressource à cette date indépendamment de la fenêtre de maintenance de la ressource. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation immediate sont ignorées.

• OptInStatus : chaîne de type : string (chaîne encodée en UTF-8).

  Indique le type de demande de confirmation de l'acceptation reçue pour la ressource.

Champs

• PendingMaintenanceActionDetails : tableau d'objets PendingMaintenanceAction.

  Liste qui fournit des détails sur les actions de maintenance en attente pour la ressource.

• ResourceIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

  ARN de la ressource qui possède les actions de maintenance en attente.

• ApplyPendingMaintenanceAction

Champs

• AutoUpgrade : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Une valeur qui indique si la version cible est appliquée à toutes les instances de base de données source AutoMinorVersionUpgrade définies sur true.

• Description : chaîne de type : string (chaîne encodée en UTF-8).

  Version du moteur de base de données vers laquelle une instance de base de données peut être mise à niveau.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du moteur de base de données cible mis à niveau.

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données cible mis à niveau.

• IsMajorVersionUpgrade : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Valeur qui indique si un moteur de base de données est mis à niveau vers une version majeure.

• SupportsGlobalDatabases— Il s'agit d'une BooleanOptional valeur booléenne boolean (vraie ou fausse) du type : (valeur booléenne).

  Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec la version de moteur cible.

Champs

• Key : chaîne de type : string (chaîne encodée en UTF-8).

  Une clé est le nom obligatoire de la balise. La valeur de la chaîne peut comporter de 1 à 128 caractères Unicode et elle ne peut pas être précédée de la mention aws: ou rds:. La chaîne peut uniquement contenir l'ensemble de lettres, de chiffres et d'espaces Unicode, '_', '.', '/', '=', '+', '-' (regex Java : "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

• Value : chaîne de type : string (chaîne encodée en UTF-8).

  Une valeur est la valeur facultative de la balise. La valeur de la chaîne peut comporter de 1 à 256 caractères Unicode et elle ne peut pas être précédée de la mention aws: ou rds:. La chaîne peut uniquement contenir l'ensemble de lettres, de chiffres et d'espaces Unicode, '_', '.', '/', '=', '+', '-' (regex Java : "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").