Autres API Neptune - Amazon Neptune
AddTagsToResourceListTagsForResourceRemoveTagsFromResourceApplyPendingMaintenanceActionDescribePendingMaintenanceActionsDescribeDBEngineVersions________________________DBEngineVersionEngineDefaultsPendingMaintenanceActionResourcePendingMaintenanceActionsUpgradeTargetTag

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Autres API Neptune

Actions :

Structures :

AddTagsToResource (action)

        Le nom AWS CLI de cette API est : add-tags-to-resource.

Ajoute des balises de métadonnées à une ressource Amazon Neptune. Ces balises peuvent être utilisées avec des rapports de répartition des coûts pour suivre les coûts associés aux ressources Amazon Neptune, ou dans une instruction de condition d'une stratégie IAM pour Amazon Neptune.

Demande

  • 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

ListTagsForResource (action)

        Le nom AWS CLI de cette API est : list-tags-for-resource.

Répertorie toutes les balises sur une ressource Amazon Neptune.

Demande

  • 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).

Réponse

  • TagList : tableau d'objets Tag.

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

Erreurs

RemoveTagsFromResource (action)

        Le nom AWS CLI de cette API est : remove-tags-from-resource.

Supprime des balises de métadonnées d'une ressource Amazon Neptune.

Demande

  • 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

ApplyPendingMaintenanceAction (action)

        Le nom AWS CLI de cette API est : apply-pending-maintenance-action.

Applique une action de maintenance en attente à une ressource (par exemple, à une instance de base de données).

Demande

  • 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).

Réponse

Décrit les actions de maintenance en attente pour une ressource.

  • 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

DescribePendingMaintenanceActions (action)

        Le nom AWS CLI de cette API est : describe-pending-maintenance-actions.

Renvoie une liste des ressources (par exemple, des instances de base de données) ayant au moins une action de maintenance en attente.

Demande

  • 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 bases de données et les Amazon Resource Names (ARN) de cluster de bases de données. La liste des résultats inclut uniquement les actions de maintenance en attente pour les clusters de bases de données identifiés par ces ARN.

    • db-instance-id - Accepte des identifiants d'instance DB et des ARN d'instance de base de données. La liste des résultats inclut uniquement les actions de maintenance en attente pour les instances de base de données identifiées par ces ARN.

  • 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) : élément IntegerOptional de type : integer (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.

Réponse

  • 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

DescribeDBEngineVersions (action)

        Le nom AWS CLI de cette API est : describe-db-engine-versions.

Renvoie une liste des moteurs de base de données disponibles.

Demande

  • 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 :

    • Si la valeur est fournie, doit correspondre à un paramètre DBParameterGroupFamily existant.

  • 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) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

    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) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

    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) : élément IntegerOptional de type : integer (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.

Réponse

  • 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.

Structures :

DBEngineVersion (structure)

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBEngineVersions (action).

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 dans le moteur de base de données pour être exportés vers CloudWatch Logs.

  • 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).

    Valeur qui indique si la version de moteur prend en charge l'exportation des types de journaux spécifiés par ExportableLogTypes vers 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.

EngineDefaults (structure)

Contient le résultat d'une invocation réussie de l'action DescribeEngineDefaultParameters (action).

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

    Jeton de pagination facultatif fourni par une demande EngineDefaults 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.

EngineDefaults est utilisé comme élément de réponse pour :

PendingMaintenanceAction (structure)

Fournit des informations sur une action de maintenance en attente pour une ressource.

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 : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 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 : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 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 : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 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.

ResourcePendingMaintenanceActions (structure)

Décrit les actions de maintenance en attente pour une 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.

ResourcePendingMaintenanceActions est utilisé comme élément de réponse pour :

UpgradeTarget (structure)

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

Champs

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

    Valeur qui indique si la version cible est appliquée aux instances de base de données source pour lesquelles AutoMinorVersionUpgrade est défini 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

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

Tag (structure)

Métadonnée attribuée à une ressource Amazon Neptune composée d'une paire clé-valeur.

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}_.:/=+\\-]*)$").