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. # Référence de l'API de données Amazon Neptune Ce chapitre décrit les opérations de l'API de données Neptune que vous pouvez utiliser pour charger les données, y accéder et les gérer dans le graphe Neptune. L'API de données Neptune fournit une prise en charge de kit SDK pour le chargement de données, l'exécution de requêtes, l'obtention d'informations sur vos données et l'exécution d'opérations de machine learning. Elle prend en charge les langages de requête Gremlin et openCypher dans Neptune et est disponible dans tous les langages de kit SDK. Elle signe automatiquement les demandes d'API et simplifie considérablement l'intégration de Neptune dans les applications. **Contents** + [Moteur de plan de données Neptune, réinitialisation rapide et structure générale APIs](data-api-dp-environment-APIs.md) + [GetEngineStatus (action)](data-api-dp-environment-APIs.md#GetEngineStatus) + [ExecuteFastReset (action)](data-api-dp-environment-APIs.md#ExecuteFastReset) + [*Structures de fonctionnement du moteur :*](data-api-dp-environment-APIs.md#data-api-dp-environment-APIs-engine-operation-structures-spacer) + [QueryLanguageVersion (structure)](data-api-dp-environment-APIs.md#QueryLanguageVersion) + [FastResetToken (structure)](data-api-dp-environment-APIs.md#FastResetToken) + [Requête Neptune APIs](data-api-dp-queries.md) + [ExecuteGremlinQuery (action)](data-api-dp-queries.md#ExecuteGremlinQuery) + [ExecuteGremlinExplainQuery (action)](data-api-dp-queries.md#ExecuteGremlinExplainQuery) + [ExecuteGremlinProfileQuery (action)](data-api-dp-queries.md#ExecuteGremlinProfileQuery) + [ListGremlinQueries (action)](data-api-dp-queries.md#ListGremlinQueries) + [GetGremlinQueryStatus (action)](data-api-dp-queries.md#GetGremlinQueryStatus) + [CancelGremlinQuery (action)](data-api-dp-queries.md#CancelGremlinQuery) + [*Actions de requête openCypher :*](data-api-dp-queries.md#data-api-dp-queries-opencypher-query-actions-spacer) + [ExecuteOpenCypherQuery (action)](data-api-dp-queries.md#ExecuteOpenCypherQuery) + [ExecuteOpenCypherExplainQuery (action)](data-api-dp-queries.md#ExecuteOpenCypherExplainQuery) + [ListOpenCypherQueries (action)](data-api-dp-queries.md#ListOpenCypherQueries) + [GetOpenCypherQueryStatus (action)](data-api-dp-queries.md#GetOpenCypherQueryStatus) + [CancelOpenCypherQuery (action)](data-api-dp-queries.md#CancelOpenCypherQuery) + [*Structures des requêtes :*](data-api-dp-queries.md#data-api-dp-queries-query-structures-spacer) + [QueryEvalStats (structure)](data-api-dp-queries.md#QueryEvalStats) + [GremlinQueryStatus (structure)](data-api-dp-queries.md#GremlinQueryStatus) + [GremlinQueryStatusAttributes (structure)](data-api-dp-queries.md#GremlinQueryStatusAttributes) + [Chargeur en vrac Neptune Data Plane APIs](data-api-dp-loader.md) + [StartLoaderJob (action)](data-api-dp-loader.md#StartLoaderJob) + [GetLoaderJobStatus (action)](data-api-dp-loader.md#GetLoaderJobStatus) + [ListLoaderJobs (action)](data-api-dp-loader.md#ListLoaderJobs) + [CancelLoaderJob (action)](data-api-dp-loader.md#CancelLoaderJob) + [*Structure de chargement en bloc :*](data-api-dp-loader.md#data-api-dp-loader-bulk-load-structure-spacer) + [LoaderIdResult (structure)](data-api-dp-loader.md#LoaderIdResult) + [API de plan de données des flux Neptune](data-api-dp-streams.md) + [GetPropertygraphStream (action)](data-api-dp-streams.md#GetPropertygraphStream) + [*Structures de données de flux :*](data-api-dp-streams.md#data-api-dp-streams-stream-data-structures-spacer) + [PropertygraphRecord (structure)](data-api-dp-streams.md#PropertygraphRecord) + [PropertygraphData (structure)](data-api-dp-streams.md#PropertygraphData) + [Statistiques du plan de données Neptune et résumé du graphique APIs](data-api-dp-statistics.md) + [GetPropertygraphStatistics (action)](data-api-dp-statistics.md#GetPropertygraphStatistics) + [ManagePropertygraphStatistics (action)](data-api-dp-statistics.md#ManagePropertygraphStatistics) + [DeletePropertygraphStatistics (action)](data-api-dp-statistics.md#DeletePropertygraphStatistics) + [GetPropertygraphSummary (action)](data-api-dp-statistics.md#GetPropertygraphSummary) + [*Structures des statistiques :*](data-api-dp-statistics.md#data-api-dp-statistics-statistics-structures-spacer) + [Statistics (structure)](data-api-dp-statistics.md#Statistics) + [StatisticsSummary (structure)](data-api-dp-statistics.md#StatisticsSummary) + [DeleteStatisticsValueMap (structure)](data-api-dp-statistics.md#DeleteStatisticsValueMap) + [RefreshStatisticsIdMap (structure)](data-api-dp-statistics.md#RefreshStatisticsIdMap) + [NodeStructure (structure)](data-api-dp-statistics.md#NodeStructure) + [EdgeStructure (structure)](data-api-dp-statistics.md#EdgeStructure) + [SubjectStructure (structure)](data-api-dp-statistics.md#SubjectStructure) + [PropertygraphSummaryValueMap (structure)](data-api-dp-statistics.md#PropertygraphSummaryValueMap) + [PropertygraphSummary (structure)](data-api-dp-statistics.md#PropertygraphSummary) + [API de traitement de données Neptune ML](data-api-dp-ml-data-processing.md) + [Démarrer MLData ProcessingJob (action)](data-api-dp-ml-data-processing.md#StartMLDataProcessingJob) + [Liste MLData ProcessingJobs (action)](data-api-dp-ml-data-processing.md#ListMLDataProcessingJobs) + [Obtenir MLData ProcessingJob (action)](data-api-dp-ml-data-processing.md#GetMLDataProcessingJob) + [Annuler MLData ProcessingJob (action)](data-api-dp-ml-data-processing.md#CancelMLDataProcessingJob) + [*Structures à usage général du ML :*](data-api-dp-ml-data-processing.md#data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer) + [MlResourceDefinition (structure)](data-api-dp-ml-data-processing.md#MlResourceDefinition) + [MlConfigDefinition (structure)](data-api-dp-ml-data-processing.md#MlConfigDefinition) + [API d'entraînement de modèle Neptune ML](data-api-dp-ml-training.md) + [Démarrer MLModel TrainingJob (action)](data-api-dp-ml-training.md#StartMLModelTrainingJob) + [Liste MLModel TrainingJobs (action)](data-api-dp-ml-training.md#ListMLModelTrainingJobs) + [Obtenir MLModel TrainingJob (action)](data-api-dp-ml-training.md#GetMLModelTrainingJob) + [Annuler MLModel TrainingJob (action)](data-api-dp-ml-training.md#CancelMLModelTrainingJob) + [*Structures d'entraînement des modèles :*](data-api-dp-ml-training.md#data-api-dp-ml-training-model-training-structures-spacer) + [CustomModelTrainingParameters (structure)](data-api-dp-ml-training.md#CustomModelTrainingParameters) + [API de transformation de modèle Neptune ML](data-api-dp-ml-transform.md) + [Démarrer MLModel TransformJob (action)](data-api-dp-ml-transform.md#StartMLModelTransformJob) + [Liste MLModel TransformJobs (action)](data-api-dp-ml-transform.md#ListMLModelTransformJobs) + [Obtenir MLModel TransformJob (action)](data-api-dp-ml-transform.md#GetMLModelTransformJob) + [Annuler MLModel TransformJob (action)](data-api-dp-ml-transform.md#CancelMLModelTransformJob) + [*Structures de transformation de modèle :*](data-api-dp-ml-transform.md#data-api-dp-ml-transform-model-transform-structures-spacer) + [CustomModelTransformParameters (structure)](data-api-dp-ml-transform.md#CustomModelTransformParameters) + [API de point de terminaison d'inférence Neptune ML](data-api-dp-inference.md) + [Créer MLEndpoint (action)](data-api-dp-inference.md#CreateMLEndpoint) + [Liste MLEndpoints (action)](data-api-dp-inference.md#ListMLEndpoints) + [Obtenir MLEndpoint (action)](data-api-dp-inference.md#GetMLEndpoint) + [Supprimer MLEndpoint (action)](data-api-dp-inference.md#DeleteMLEndpoint) + [Exceptions relatives à l'API du plan de données Neptune](data-api-dp-errors.md) + [AccessDeniedException (structure)](data-api-dp-errors.md#AccessDeniedException) + [BadRequestException (structure)](data-api-dp-errors.md#BadRequestException) + [BulkLoadIdNotFoundException (structure)](data-api-dp-errors.md#BulkLoadIdNotFoundException) + [CancelledByUserException (structure)](data-api-dp-errors.md#CancelledByUserException) + [ClientTimeoutException (structure)](data-api-dp-errors.md#ClientTimeoutException) + [ConcurrentModificationException (structure)](data-api-dp-errors.md#ConcurrentModificationException) + [ConstraintViolationException (structure)](data-api-dp-errors.md#ConstraintViolationException) + [ExpiredStreamException (structure)](data-api-dp-errors.md#ExpiredStreamException) + [FailureByQueryException (structure)](data-api-dp-errors.md#FailureByQueryException) + [IllegalArgumentException (structure)](data-api-dp-errors.md#IllegalArgumentException) + [InternalFailureException (structure)](data-api-dp-errors.md#InternalFailureException) + [InvalidArgumentException (structure)](data-api-dp-errors.md#InvalidArgumentException) + [InvalidNumericDataException (structure)](data-api-dp-errors.md#InvalidNumericDataException) + [InvalidParameterException (structure)](data-api-dp-errors.md#InvalidParameterException) + [LoadUrlAccessDeniedException (structure)](data-api-dp-errors.md#LoadUrlAccessDeniedException) + [MalformedQueryException (structure)](data-api-dp-errors.md#MalformedQueryException) + [MemoryLimitExceededException (structure)](data-api-dp-errors.md#MemoryLimitExceededException) + [MethodNotAllowedException (structure)](data-api-dp-errors.md#MethodNotAllowedException) + [MissingParameterException (structure)](data-api-dp-errors.md#MissingParameterException) + [MLResourceNotFoundException (structure)](data-api-dp-errors.md#MLResourceNotFoundException) + [ParsingException (structure)](data-api-dp-errors.md#ParsingException) + [PreconditionsFailedException (structure)](data-api-dp-errors.md#PreconditionsFailedException) + [QueryLimitExceededException (structure)](data-api-dp-errors.md#QueryLimitExceededException) + [QueryLimitException (structure)](data-api-dp-errors.md#QueryLimitException) + [QueryTooLargeException (structure)](data-api-dp-errors.md#QueryTooLargeException) + [ReadOnlyViolationException (structure)](data-api-dp-errors.md#ReadOnlyViolationException) + [S3Exception (structure)](data-api-dp-errors.md#S3Exception) + [ServerShutdownException (structure)](data-api-dp-errors.md#ServerShutdownException) + [StatisticsNotAvailableException (structure)](data-api-dp-errors.md#StatisticsNotAvailableException) + [StreamRecordsNotFoundException (structure)](data-api-dp-errors.md#StreamRecordsNotFoundException) + [ThrottlingException (structure)](data-api-dp-errors.md#ThrottlingException) + [TimeLimitExceededException (structure)](data-api-dp-errors.md#TimeLimitExceededException) + [TooManyRequestsException (structure)](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException (structure)](data-api-dp-errors.md#UnsupportedOperationException) + [UnloadUrlAccessDeniedException (structure)](data-api-dp-errors.md#UnloadUrlAccessDeniedException) # Moteur de plan de données Neptune, réinitialisation rapide et structure générale APIs **Fonctionnement du moteur :** + [GetEngineStatus (action)](#GetEngineStatus) + [ExecuteFastReset (action)](#ExecuteFastReset) **Structures de fonctionnement du moteur :** + [QueryLanguageVersion (structure)](#QueryLanguageVersion) + [FastResetToken (structure)](#FastResetToken) ## GetEngineStatus (action)         Le nom de la AWS CLI pour cette API est :`get-engine-status`. Récupère le statut de la base de données orientée graphe sur l'hôte. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetEngineStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) ce cluster. **Demande** + *Aucun paramètre de demande.* **Réponse** + **dbEngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8). Définissez la version de moteur Neptune exécutée sur votre cluster de bases de données. Si cette version de moteur a été corrigée manuellement depuis sa publication, le numéro de version est préfixé par `Patch-`. + **dfeQueryEngine** : chaîne de type : `string` (chaîne encodée en UTF-8). Définie sur `enabled` si le moteur DFE est complètement activé, ou sur `viaQueryHint` (valeur par défaut) si le moteur DFE n'est utilisé qu'avec les requêtes dont l'indicateur de requête `useDFE` est défini sur. `true` + **features** : tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est un document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Contient des informations d'état sur les fonctionnalités activées sur votre cluster de bases de données. + **gremlin** : objet [QueryLanguageVersion](#QueryLanguageVersion). Contient des informations sur le langage de requête Gremlin disponible sur votre cluster. Plus précisément, il contient un champ de version qui indique la TinkerPop version actuelle utilisée par le moteur. + **labMode** : tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). Contient les paramètres de mode expérimental utilisés par le moteur. + **opencypher** : objet [QueryLanguageVersion](#QueryLanguageVersion). Contient des informations sur le langage de requête openCypher disponible sur votre cluster. Plus précisément, il contient un champ de version qui spécifie la version actuelle d'openCypher utilisée par le moteur. + **role** : chaîne de type : `string` (chaîne encodée en UTF-8). Définie sur `reader` si l'instance est un réplica en lecture ou sur `writer` si l'instance est l'instance principale. + **rollingBackTrxCount** : entier de type : `integer` (entier signé de 32 bits). Si des transactions sont annulées, ce champ est défini sur le nombre de transactions de ce type. S'il n'y en a pas, ce champ ne s'affiche pas. + **rollingBackTrxEarliestStartTime** : chaîne de type : `string` (chaîne encodée en UTF-8). Heure de début de la transaction la plus ancienne annulée. Si aucune transaction n'est annulée, ce champ ne s'affiche pas. + **settings** : tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). Contient des informations sur les paramètres actuels de votre cluster de bases de données. Par exemple, contient le paramètre actuel d'expiration des requêtes du cluster (`clusterQueryTimeoutInMs`). + **sparql** : objet [QueryLanguageVersion](#QueryLanguageVersion). Contient des informations sur le langage de requête SPARQL disponible sur votre cluster. Plus précisément, il contient un champ de version qui spécifie la version actuelle de SPARQL utilisée par le moteur. + **startTime** : chaîne de type : `string` (chaîne encodée en UTF-8). Définie sur l'heure UTC (heure universelle coordonnée) à laquelle le processus serveur actuel a démarré. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Définie sur `healthy` si l'instance ne rencontre aucun problème. Si l'instance est en cours de récupération suite à un incident ou parce qu'elle a été redémarrée et qu'il existe des transactions actives en cours d'exécution depuis le dernier arrêt de serveur, le statut est défini sur `recovery`. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [InternalFailureException](data-api-dp-errors.md#InternalFailureException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## ExecuteFastReset (action)         Le nom de la AWS CLI pour cette API est :`execute-fast-reset`. L'API REST de réinitialisation rapide vous permet de réinitialiser un graphe Neptune rapidement et facilement, en supprimant toutes ses données. La réinitialisation rapide de Neptune est un processus en deux étapes. Vous appelez d'abord `ExecuteFastReset` avec l'attribut `action` défini sur `initiateDatabaseReset`. Cette opération renvoie un jeton UUID que vous incluerez ensuite lors d'un nouvel appel d'`ExecuteFastReset` avec l'attribut `action` défini sur `performDatabaseReset`. Consultez [Vider un cluster de bases de données Amazon Neptune à l'aide de l'API de réinitialisation rapide](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [ResetDatabaseneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) ce cluster. **Demande** + **action** (dans la CLI : `--action`) : *obligatoire :* action de type : `string` (chaîne encodée en UTF-8). Action de réinitialisation rapide. L'une des valeurs suivantes : + **`initiateDatabaseReset`** : cette action génère un jeton unique nécessaire pour effectuer réellement la réinitialisation rapide. + **`performDatabaseReset`** : cette action utilise le jeton généré par l'action `initiateDatabaseReset`pour effectuer réellement la réinitialisation rapide. + **token** (dans la CLI : `--token`) : chaîne de type : `string` (chaîne encodée en UTF-8). Jeton de réinitialisation rapide permettant de lancer la réinitialisation. **Réponse** + **payload** : objet [FastResetToken](#FastResetToken). La valeur `payload` n'est renvoyée que par l'action `initiateDatabaseReset` et contient le jeton unique à utiliser avec l'action `performDatabaseReset`pour effectuer la réinitialisation. + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). La valeur `status` n'est renvoyée que pour l'action `performDatabaseReset` et indique si la demande de réinitialisation rapide est acceptée ou non. **Erreurs** + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [ServerShutdownException](data-api-dp-errors.md#ServerShutdownException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MethodNotAllowedException](data-api-dp-errors.md#MethodNotAllowedException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## *Structures de fonctionnement du moteur :* ## QueryLanguageVersion (structure) Structure permettant d'exprimer la version du langage de requête. **Champs** + **version** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Version du langage de requête. ## FastResetToken (structure) Structure contenant le jeton utilisé pour initier une réinitialisation rapide. **Champs** + **token** : chaîne de type : `string` (chaîne encodée en UTF-8). UUID généré par la base de données lors de l'action `initiateDatabaseReset`, puis utilisé par `performDatabaseReset` pour réinitialiser la base de données. # Requête Neptune APIs **Actions de requête Gremlin :** + [ExecuteGremlinQuery (action)](#ExecuteGremlinQuery) + [ExecuteGremlinExplainQuery (action)](#ExecuteGremlinExplainQuery) + [ExecuteGremlinProfileQuery (action)](#ExecuteGremlinProfileQuery) + [ListGremlinQueries (action)](#ListGremlinQueries) + [GetGremlinQueryStatus (action)](#GetGremlinQueryStatus) + [CancelGremlinQuery (action)](#CancelGremlinQuery) **Actions de requête openCypher :** + [ExecuteOpenCypherQuery (action)](#ExecuteOpenCypherQuery) + [ExecuteOpenCypherExplainQuery (action)](#ExecuteOpenCypherExplainQuery) + [ListOpenCypherQueries (action)](#ListOpenCypherQueries) + [GetOpenCypherQueryStatus (action)](#GetOpenCypherQueryStatus) + [CancelOpenCypherQuery (action)](#CancelOpenCypherQuery) **Structures des requêtes :** + [QueryEvalStats (structure)](#QueryEvalStats) + [GremlinQueryStatus (structure)](#GremlinQueryStatus) + [GremlinQueryStatusAttributes (structure)](#GremlinQueryStatusAttributes) ## ExecuteGremlinQuery (action)         Le nom de la AWS CLI pour cette API est :`execute-gremlin-query`. Cette commande exécute une requête Gremlin. Amazon Neptune est compatible avec Apache TinkerPop 3 et Gremlin. Vous pouvez donc utiliser le langage de traversée Gremlin pour interroger le graphe, comme décrit dans la section The Graph de [la](https://tinkerpop.apache.org/docs/current/reference/#graph) documentation d'Apache 3. TinkerPop Plus d'informations sont également disponibles dans [Accès à un graphe Neptune avec Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html). Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant les actions IAM suivantes dans ce cluster, en fonction de la requête : + [base de données Neptune : ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) + [base de données Neptune : WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) + [base de données Neptune : DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) Notez que la clé de condition [neptune-db ::Garmlin QueryLanguage IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) (voir Clés de condition [disponibles](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) dans les déclarations de politique d'accès aux données de Neptune IAM). **Demande** + **gremlinQuery** (dans la CLI : `--gremlin-query`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). À l'aide de cette API, vous pouvez exécuter des requêtes Gremlin au format chaîne comme vous pouvez le faire avec le point de terminaison HTTP. L'interface est compatible n'importe quelle version Gremlin utilisée par le cluster de bases de données (consultez la [section du client Tinkerpop](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest) pour déterminer les versions de Gremlin prises en charge par votre version de moteur). + **serializer** (dans la CLI : `--serializer`) : chaîne de type : `string` (chaîne encodée en UTF-8). Si la valeur du paramètre est autre que null, les résultats de requête sont renvoyés dans un message de réponse sérialisé au format spécifié par ce paramètre. Consultez la section [GraphSon](https://tinkerpop.apache.org/docs/current/reference/#_graphson) de la TinkerPop documentation pour obtenir la liste des formats actuellement pris en charge. **Réponse** + **meta** : document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Métadonnées relatives à la requête Gremlin. + **requestId** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la requête Gremlin. + **result** : document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Requête Gremlin générée par le serveur. + **status** : objet [GremlinQueryStatusAttributes](#GremlinQueryStatusAttributes). Statut de la requête Gremlin. **Erreurs** + [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [QueryLimitException](data-api-dp-errors.md#QueryLimitException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## ExecuteGremlinExplainQuery (action)         Le nom de la AWS CLI pour cette API est :`execute-gremlin-explain-query`. Exécute une requête Gremlin Explain. Amazon Neptune a ajouté une fonctionnalité Gremlin nommée `explain` qui fournit un outil en libre-service permettant de comprendre l'approche d'exécution adoptée par le moteur Neptune pour la requête. Vous l'appelez en ajoutant un paramètre `explain` à un appel HTTP qui soumet une requête Gremlin. La fonctionnalité explain fournit des informations sur la structure logique des plans d'exécution de requête. Vous pouvez utiliser ces informations pour identifier les goulots d'étranglement potentiels liés à l'évaluation et à l'exécution et pour régler votre requête, comme expliqué dans la section [Réglage des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html). Vous pouvez aussi utiliser des indicateurs de requête pour améliorer les plans d'exécution de requêtes. Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique qui autorise les actions IAM suivantes dans ce cluster, en fonction de la requête : + [base de données Neptune : ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) + [base de données Neptune : WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) + [base de données Neptune : DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) Notez que la clé de condition [neptune-db ::Garmlin QueryLanguage IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) (voir Clés de condition [disponibles](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) dans les déclarations de politique d'accès aux données de Neptune IAM). **Demande** + **gremlinQuery** (dans la CLI : `--gremlin-query`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête Gremlin explain. **Réponse** + **output**— a ReportAsText, de type : `blob` (un bloc de données binaires non interprétées). Blob de texte contenant le résultat de la fonctionnalité explain de Gremlin, comme décrit dans la section [Réglage des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html). **Erreurs** + [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [QueryLimitException](data-api-dp-errors.md#QueryLimitException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## ExecuteGremlinProfileQuery (action)         Le nom de la AWS CLI pour cette API est :`execute-gremlin-profile-query`. Effectue une requête Gremlin Profile, qui effectue une traversée Gremlin spécifique, collecte différentes métriques sur l'exécution et génère en sortie un rapport de profil. Consultez [API de profil Gremlin dans Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) pour plus d'informations. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [ReadDataViaQueryneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) ce cluster. Notez que la clé de condition [neptune-db ::Garmlin QueryLanguage IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) (voir Clés de condition [disponibles](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) dans les déclarations de politique d'accès aux données de Neptune IAM). **Demande** + **chop** (dans la CLI : `--chop`) : entier de type : `integer` (entier signé de 32 bits). Si la valeur du paramètre est différente de zéro, la chaîne de résultats est tronquée à ce nombre de caractères. Si la valeur est zéro, la chaîne contient tous les résultats. + **gremlinQuery** (dans la CLI : `--gremlin-query`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête Gremlin à profiler. + **indexOps** (dans la CLI : `--index-ops`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si cet indicateur est défini sur `TRUE`, les résultats comprennent un rapport détaillé de toutes les opérations d'index qui ont eu lieu au cours de l'exécution et de la sérialisation des requêtes. + **results** (dans la CLI : `--results`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si cet indicateur est défini sur `TRUE`, les résultats de la requête sont collectés et affichés dans le rapport de profil. En cas de valeur `FALSE`, seul le nombre de résultats s'affiche. + **serializer** (dans la CLI : `--serializer`) : chaîne de type : `string` (chaîne encodée en UTF-8). Si la valeur du paramètre est différente de null, les résultats collectés sont renvoyés dans un message de réponse sérialisé au format spécifié par ce paramètre. Consultez l'[API de profil Gremlin dans Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) pour plus d'informations. **Réponse** + **output**— a ReportAsText, de type : `blob` (un bloc de données binaires non interprétées). Blob de texte contenant le résultat de Gremlin Profile. Consultez [API de profil Gremlin dans Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) pour plus d'informations. **Erreurs** + [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [QueryLimitException](data-api-dp-errors.md#QueryLimitException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## ListGremlinQueries (action)         Le nom de la AWS CLI pour cette API est :`list-gremlin-queries`. Répertorie les requêtes Gremlin actives. Consultez la section [API de statut des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) pour plus d'informations sur le résultat. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetQueryStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) ce cluster. Notez que la clé de condition [neptune-db ::Garmlin QueryLanguage IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) (voir Clés de condition [disponibles](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) dans les déclarations de politique d'accès aux données de Neptune IAM). **Demande** + **includeWaiting** (dans la CLI : `--include-waiting`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si ce paramètre est défini sur `TRUE`, la liste renvoyée inclut les requêtes en attente. La valeur par défaut est `FALSE`. **Réponse** + **acceptedQueryCount** : entier de type : `integer` (entier signé de 32 bits). Nombre de requêtes qui ont été acceptées mais qui n'ont pas encore été terminées, y compris les requêtes dans la file d'attente. + **queries** : tableau d'objets [GremlinQueryStatus](#GremlinQueryStatus). Liste des requêtes actuelles. + **runningQueryCount** : entier de type : `integer` (entier signé de 32 bits). Nombre de requêtes Gremlin actuellement en cours d'exécution. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## GetGremlinQueryStatus (action)         Le nom de la AWS CLI pour cette API est :`get-gremlin-query-status`. Génère le statut d'une requête Gremlin spécifiée. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetQueryStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) ce cluster. Notez que la clé de condition [neptune-db ::Garmlin QueryLanguage IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) (voir Clés de condition [disponibles](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) dans les déclarations de politique d'accès aux données de Neptune IAM). **Demande** + **queryId** (dans la CLI : `--query-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la requête Gremlin. **Réponse** + **queryEvalStats** : objet [QueryEvalStats](#QueryEvalStats). Statut d'évaluation de la requête Gremlin. + **queryId** : chaîne de type : `string` (chaîne encodée en UTF-8). ID de la requête dont le statut est renvoyé. + **queryString** : chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête Gremlin. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## CancelGremlinQuery (action)         Le nom de la AWS CLI pour cette API est :`cancel-gremlin-query`. Annule une requête Gremlin. Pour plus d'informations, consultez la section [Annulation de requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [CancelQueryneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) ce cluster. **Demande** + **queryId** (dans la CLI : `--query-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la requête à annuler. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de l'annulation. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## *Actions de requête openCypher :* ## ExecuteOpenCypherQuery (action)         Le nom de la AWS CLI pour cette API est :`execute-open-cypher-query`. Exécute une requête openCypher. Consultez [Accès au graphe de Neptune avec openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html) pour plus d'informations. Neptune prend en charge la création d'applications de graphe à l'aide d'openCypher, qui est actuellement l'un des langages de requête les plus populaires parmi les développeurs travaillant avec des bases de données orientées graphe. Les développeurs, les analystes et les scientifiques des données apprécient la syntaxe déclarative openCypher inspirée de SQL, car sa structure familière facilite l'interrogation des graphes de propriétés. Le langage openCypher a été initialement développé par Neo4j, puis est devenu open source en 2015 et a contribué au [projet openCypher](https://opencypher.org/) sous une licence open source Apache 2. Notez que lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique qui autorise les actions IAM suivantes dans ce cluster, en fonction de la requête : + [base de données Neptune : ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) + [base de données Neptune : WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) + [base de données Neptune : DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) Notez également que la clé de condition [neptune-db : QueryLanguage : OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes OpenCypher (voir [Clés de condition disponibles dans les déclarations de politique d'accès aux données de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) IAM). **Demande** + **openCypherQuery** (dans la CLI : `--open-cypher-query`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête openCypher à exécuter. + **parameters** (dans la CLI : `--parameters`) : chaîne de type : `string` (chaîne encodée en UTF-8). Paramètres de requête openCypher pour l'exécution des requêtes. Pour plus d'informations, consultez [Exemples de requêtes paramétrées openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html). **Réponse** + **results** : *obligatoire :* document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Résultats de la requête openCypher. **Erreurs** + [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException) + [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [QueryLimitException](data-api-dp-errors.md#QueryLimitException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## ExecuteOpenCypherExplainQuery (action)         Le nom de la AWS CLI pour cette API est :`execute-open-cypher-explain-query`. Exécute une demande `explain` openCypher. Pour plus d'informations, consultez [Fonctionnalité explain d'openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [ReadDataViaQueryneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) ce cluster. Notez que la clé de condition [neptune-db : QueryLanguage : OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes OpenCypher (voir [Clés de condition disponibles dans les déclarations de politique d'accès aux données de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) IAM). **Demande** + **explainMode**(dans la CLI :`--explain-mode`) — *Obligatoire :* an OpenCypherExplainMode, de type : `string` (une chaîne codée en UTF-8). Mode `explain` openCypher. Peut avoir l'une des valeurs suivantes : `static`, `dynamic` ou `details`. + **openCypherQuery** (dans la CLI : `--open-cypher-query`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête openCypher. + **parameters** (dans la CLI : `--parameters`) : chaîne de type : `string` (chaîne encodée en UTF-8). Paramètres de requête openCypher. **Réponse** + **results** : *obligatoire :* blob de type : `blob` (bloc de données binaires non interprétées). Blob de texte contenant les résultats `explain` openCypher. **Erreurs** + [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException) + [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [QueryLimitException](data-api-dp-errors.md#QueryLimitException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## ListOpenCypherQueries (action)         Le nom de la AWS CLI pour cette API est :`list-open-cypher-queries`. Répertorie les requêtes openCypher actives. Consultez la section [Point de terminaison d'état Neptune openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) pour plus d'informations. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetQueryStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) ce cluster. Notez que la clé de condition [neptune-db : QueryLanguage : OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes OpenCypher (voir [Clés de condition disponibles dans les déclarations de politique d'accès aux données de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) IAM). **Demande** + **includeWaiting** (dans la CLI : `--include-waiting`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Lorsque ce paramètre est défini sur `TRUE` et qu'aucun autre paramètre n'est présent, des informations d'état sont renvoyées pour les requêtes en attente ainsi que pour les requêtes en cours d'exécution. **Réponse** + **acceptedQueryCount** : entier de type : `integer` (entier signé de 32 bits). Nombre de requêtes qui ont été acceptées mais qui n'ont pas encore été terminées, y compris les requêtes dans la file d'attente. + **queries** : tableau d'objets [GremlinQueryStatus](#GremlinQueryStatus). Liste des requêtes openCypher en cours. + **runningQueryCount** : entier de type : `integer` (entier signé de 32 bits). Nombre de requêtes openCypher en cours d'exécution. **Erreurs** + [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## GetOpenCypherQueryStatus (action)         Le nom de la AWS CLI pour cette API est :`get-open-cypher-query-status`. Récupère le statut d'une requête openCypher spécifiée. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetQueryStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) ce cluster. Notez que la clé de condition [neptune-db : QueryLanguage : OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM peut être utilisée dans le document de politique pour restreindre l'utilisation des requêtes OpenCypher (voir [Clés de condition disponibles dans les déclarations de politique d'accès aux données de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) IAM). **Demande** + **queryId** (dans la CLI : `--query-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la requête openCypher pour laquelle le statut de la requête doit être récupéré. **Réponse** + **queryEvalStats** : objet [QueryEvalStats](#QueryEvalStats). Statut de l'évaluation de la requête openCypher. + **queryId** : chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la requête dont le statut est renvoyé. + **queryString** : chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de requête openCypher. **Erreurs** + [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## CancelOpenCypherQuery (action)         Le nom de la AWS CLI pour cette API est :`cancel-open-cypher-query`. Annule une requête openCypher spécifiée. Consultez la section [Point de terminaison d'état Neptune openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) pour plus d'informations. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [CancelQueryneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) ce cluster. **Demande** + **queryId** (dans la CLI : `--query-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la requête openCypher à annuler. + **silent** (dans la CLI : `--silent`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si ce paramètre est défini sur `TRUE`, l'annulation de la requête openCypher se produit silencieusement. **Réponse** + **payload** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Charge utile d'annulation pour la requête openCypher. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut d'annulation de la requête openCypher. **Erreurs** + [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ParsingException](data-api-dp-errors.md#ParsingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException) ## *Structures des requêtes :* ## QueryEvalStats (structure) Structure permettant de saisir les statistiques relatives aux requêtes, telles que le nombre de requêtes en cours, acceptées ou en attente, ainsi que leurs détails. **Champs** + **cancelled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Valeur définie sur `TRUE` si la requête a été annulée, ou sur FALSE dans le cas contraire. + **elapsed** : entier de type : `integer` (entier signé de 32 bits). Nombre de microsecondes d'exécution de la requête jusqu'ici. + **subqueries** : document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Nombre de sous-requêtes de cette requête. + **waited** : entier de type : `integer` (entier signé de 32 bits). Indique le temps d'attente de la requête, en millisecondes. ## GremlinQueryStatus (structure) Capture le statut d'une requête Gremlin (voir la page [API de statut des requêtes Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html)). **Champs** + **queryEvalStats** : objet [QueryEvalStats](#QueryEvalStats). Statistiques de la requête Gkremlin. + **queryId** : chaîne de type : `string` (chaîne encodée en UTF-8). ID de la requête Gremlin. + **queryString** : chaîne de type : `string` (chaîne encodée en UTF-8). Chaîne de la requête Gremlin. ## GremlinQueryStatusAttributes (structure) Contient les composants de statut d'une requête Gremlin. **Champs** + **attributes** : document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Attributs du statut de la requête Gremlin. + **code** : entier de type : `integer` (entier signé de 32 bits). Code de réponse HTTP renvoyé par la demande de requête Gremlin. + **message** : chaîne de type : `string` (chaîne encodée en UTF-8). Message d'état. # Chargeur en vrac Neptune Data Plane APIs **Actions de chargement en bloc :** + [StartLoaderJob (action)](#StartLoaderJob) + [GetLoaderJobStatus (action)](#GetLoaderJobStatus) + [ListLoaderJobs (action)](#ListLoaderJobs) + [CancelLoaderJob (action)](#CancelLoaderJob) **Structure de chargement en bloc :** + [LoaderIdResult (structure)](#LoaderIdResult) ## StartLoaderJob (action)         Le nom de la AWS CLI pour cette API est :`start-loader-job`. Démarre une tâche de chargeur en bloc Neptune pour charger les données d'un compartiment Amazon S3 dans une instance de base de données Neptune. Consultez la section [Utilisation du chargeur en bloc Amazon Neptune pour ingérer des données](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [StartLoaderJobneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob) ce cluster. **Demande** + **dependencies** (dans la CLI : `--dependencies`) : chaîne de type : `string` (chaîne encodée en UTF-8). Il s'agit d'un paramètre facultatif qui peut subordonner une demande de chargement en file d'attente à la réussite d'une ou de plusieurs tâches précédentes dans la file d'attente. Neptune peut mettre en file d'attente jusqu'à 64 requêtes de chargement à la fois, si leurs paramètres `queueRequest` sont définis sur `"TRUE"`. Le paramètre `dependencies` vous permet de rendre l'exécution d'une telle requête en file d'attente dépendante de la réussite d'une ou de plusieurs requêtes précédentes spécifiées dans la file d'attente. Par exemple, si les charges `Job-A` et `Job-B` sont indépendantes l'une de l'autre, mais que la charge `Job-C` a besoin que `Job-A` et `Job-B` soient terminées avant de commencer, procédez comme suit : 1. Soumettez `load-job-A` et `load-job-B` l'une après l'autre dans n'importe quel ordre, et enregistrez leurs ID de chargement. 1. Soumettez `load-job-C` avec les ID de chargement des deux tâches dans son domaine `dependencies` : **Example** ``` "dependencies" : ["(job_A_load_id)", "(job_B_load_id)"] ``` En raison du paramètre `dependencies`, le chargeur en bloc ne démarrera pas `Job-C` avant que `Job-A` et `Job-B` soient terminées avec succès. Si l'une des d'eux échoue, Job-C ne sera pas exécuté et son statut sera défini sur `LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED`. Vous pouvez configurer plusieurs niveaux de dépendance de cette façon, de sorte que l'échec d'une tâche entraîne l'annulation de toutes les demandes qui en dépendent directement ou indirectement. + **failOnError** (dans la CLI : `--fail-on-error`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). **`failOnError`** : indicateur permettant d'activer un arrêt complet au niveau d'une erreur. *Valeurs autorisées* : `"TRUE"`, `"FALSE"`. *Valeur par défaut* : `"TRUE"`. Lorsque ce paramètre est défini sur `"FALSE"`, le chargeur essaie de charger toutes les données à l'emplacement spécifié, en ignorant les entrées contenant des erreurs. Lorsque ce paramètre est défini sur `"TRUE"`, le chargeur s'arrête dès qu'il rencontre une erreur. Les données chargées jusqu'à ce point persistent. + **format** (dans la CLI : `--format`) : *obligatoire :* format de type : `string` (chaîne encodée en UTF-8). Format des données. Pour plus d'informations sur les formats de données pour la commande `Loader` Neptune, consultez [Formats de chargement de données](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html). **Valeurs autorisées** + **`csv`** pour le [format de données CSV Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html). + **`opencypher`** pour le [format de données CSV openCypher](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html). + **`ntriples`** pour le [format de données N-Triples RDF](https://www.w3.org/TR/n-triples/). + **`nquads`** pour le [format de données N-Quads RDF](https://www.w3.org/TR/n-quads/). + **`rdfxml`** pour le [format de données RDF RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/). + **`turtle`** pour le [format de données Turtle RDF](https://www.w3.org/TR/turtle/). + **iamRoleArn** (dans la CLI : `--iam-role-arn`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Amazon Resource Name (ARN) d'un rôle IAM qui doit être endossé par l'instance de base de données Neptune pour accéder au compartiment S3. L'ARN du rôle IAM fourni ici doit être attaché au cluster de bases de données (consultez [Ajout du rôle IAM à un cluster Amazon Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html)). + **mode** (dans la CLI : `--mode`) : mode de type : `string` (chaîne encodée en UTF-8). Mode de tâche de chargement. *Valeurs autorisées* : `RESUME`, `NEW`, `AUTO` *Valeur par défaut* : `AUTO`. **** + `RESUME` : en mode REPRISE, le chargeur recherche un chargement précédent à partir de cette source et, s'il en trouve un, reprend cette tâche de chargement. Si aucune tâche de chargement précédente n'est trouvée, le chargeur s'arrête. Le chargeur évite de recharger les fichiers qui ont été chargés avec succès lors d'une tâche précédente. Il essaie uniquement de traiter les fichiers ayant échoué. Si vous aviez supprimé des données précédemment chargées à partir de votre cluster Neptune, ces données ne sont pas rechargées dans ce mode. Si une tâche de chargement précédente a chargé tous les fichiers de la même source avec succès, rien n'est rechargé, et le chargeur renvoie une réussite. + `NEW` : le mode NOUVEAU crée une autre demande de chargement sans tenir compte des chargements précédents. Vous pouvez utiliser ce mode pour recharger toutes les données d'une source après la suppression de données précédemment chargées à partir de votre cluster Neptune ou pour charger de nouvelles données disponibles sur la même source. + `AUTO` : en mode AUTO, le chargeur recherche une tâche de chargement précédente à partir de la même source, et s'il en trouve une, reprend cette tâche, exactement comme en mode `RESUME`. Si le chargeur ne trouve pas de tâche de chargement précédente à partir de la même source, il charge toutes les données de la source, exactement comme en mode `NEW`. + **parallelism** (dans la CLI : `--parallelism`) : parallélisme de type : `string` (chaîne encodée en UTF-8). Le paramètre facultatif `parallelism` peut être défini de façon à réduire le nombre de threads utilisés par le processus de chargement en bloc. *Valeurs autorisées* : + `LOW`— Le nombre de threads utilisés est le nombre de v disponibles CPUs divisé par 8. + `MEDIUM`— Le nombre de threads utilisés est le nombre de v disponibles CPUs divisé par 2. + `HIGH`— Le nombre de threads utilisés est le même que le nombre de v disponiblesCPUs. + `OVERSUBSCRIBE`— Le nombre de threads utilisés est le nombre de v disponibles CPUs multiplié par 2. Si cette valeur est utilisée, le chargeur en bloc accepte toutes les ressources disponibles. Cela ne signifie toutefois pas que le paramètre `OVERSUBSCRIBE` entraîne une utilisation du CPU à 100 %. L'opération de chargement étant limitée, I/O l'utilisation maximale du processeur à laquelle on peut s'attendre se situe entre 60 % et 70 %. *Valeur par défaut* : `HIGH` Le paramètre `parallelism` peut parfois entraîner un blocage entre les threads lors du chargement des données openCypher. Lorsque cela se produit, Neptune renvoie le message d'erreur `LOAD_DATA_DEADLOCK`. Vous pouvez généralement résoudre le problème en définissant un paramètre `parallelism` inférieur et en soumettant la commande de chargement à une nouvelle tentative. + **parserConfiguration** (dans la CLI : `--parser-configuration`)  : tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). **`parserConfiguration`** : objet facultatif avec des valeurs de configuration d'analyseur supplémentaires. Chacun des paramètres enfants est également facultatif : **** + **`namedGraphUri`** : graphe par défaut pour tous les formats RDF quand aucun graphe n'est spécifié (pour les formats autres que quadruplets et les entrées NQUAD sans graphe). L’argument par défaut est `https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph`. + **`baseUri`**— L'URI de base pour les formats RDF/XML et Turtle. L’argument par défaut est `https://aws.amazon.com/neptune/default`. + **`allowEmptyStrings`** : les utilisateurs de Gremlin doivent être en mesure de transmettre des valeurs de chaîne vides ("") en tant que propriétés de nœud et d'arête lors du chargement de données CSV. Si la valeur `allowEmptyStrings` est définie sur `false` (valeur par défaut), ces chaînes vides sont traitées comme des valeurs nulles et ne sont pas chargées. Si la valeur `allowEmptyStrings` est définie sur `true`, le chargeur traite les chaînes vides comme des valeurs de propriété valides et les charge en conséquence. + **queueRequest** (dans la CLI : `--queue-request`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Il s'agit d'un paramètre d'indicateur facultatif qui indique si la demande de chargement peut être mise en file d'attente ou non. Vous n'avez pas besoin d'attendre qu'une tâche de chargement soit terminée avant d'émettre la suivante, car Neptune peut mettre en file d'attente jusqu'à 64 tâches à la fois, si leurs paramètres `queueRequest` sont tous définis sur `"TRUE"`. L'ordre de file d'attente des tâches sera first-in-first-out (FIFO). Si le paramètre `queueRequest` est omis ou défini sur `"FALSE"`, la demande de chargement échouera si une autre tâche de chargement est déjà en cours d'exécution. *Valeurs autorisées* : `"TRUE"`, `"FALSE"`. *Valeur par défaut* : `"FALSE"`. + **s3BucketRegion**(dans la CLI :`--s-3-bucket-region`) — *Obligatoire :* un S3BucketRegion, de type : `string` (une chaîne codée en UTF-8). Région Amazon du compartiment S3. Elle doit correspondre à la région Amazon du cluster de bases de données. + **source** (dans la CLI : `--source`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Le paramètre `source` accepte un URI S3 qui identifie un seul fichier, plusieurs fichiers, un dossier ou plusieurs dossiers. Neptune charge tous les fichiers de données dans n'importe quel dossier spécifié. L'URI peut être à l'un des formats suivants. + `s3://(bucket_name)/(object-key-name)` + `https://s3.amazonaws.com/(bucket_name)/(object-key-name)` + `https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)` L'`object-key-name`élément de l'URI est équivalent au paramètre de [préfixe](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters) dans un appel d'[ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)API S3. Il identifie tous les objets du compartiment S3 spécifié dont le nom commence par ce préfixe. Il peut s'agir d'un seul fichier, d'un seul dossier, de plusieurs fichiers et/ou de plusieurs dossiers. Le dossier spécifié peut contenir plusieurs fichiers de sommet et plusieurs fichiers d'arête. + **updateSingleCardinalityProperties** (dans la CLI : `--update-single-cardinality-properties`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). `updateSingleCardinalityProperties` est un paramètre facultatif qui contrôle la façon dont le chargeur en bloc traite une nouvelle valeur pour les propriétés de sommet ou d'arête à cardinalité unique. Il n'est pas pris en charge pour le chargement de données openCypher. *Valeurs autorisées* : `"TRUE"`, `"FALSE"`. *Valeur par défaut* : `"FALSE"`. Par défaut, ou lorsque `updateSingleCardinalityProperties` est explicitement défini sur `"FALSE"`, le chargeur traite une nouvelle valeur comme une erreur, car elle ne respecte pas la cardinalité unique. En revanche, lorsque `updateSingleCardinalityProperties` est défini sur `"TRUE"`, le chargeur en bloc remplace la valeur existante par la nouvelle. Si plusieurs valeurs de propriété de sommet à cardinalité unique ou d'arête sont fournies dans le ou les fichiers source en cours de chargement, la valeur finale à l'issue du chargement en bloc peut être une de ces nouvelles valeurs. Le chargeur garantit uniquement que la valeur existante a été remplacée par une des nouvelles. + **userProvidedEdgeIds** (dans la CLI : `--user-provided-edge-ids`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Ce paramètre est obligatoire uniquement lors du chargement de données OpenCypher contenant une relation. IDs Il doit être inclus et défini `True` lorsque les relations OpenCypher IDs sont explicitement fournies dans les données de chargement (recommandé). Quand `userProvidedEdgeIds` est absent ou défini sur `True`, une colonne `:ID` doit être présente dans chaque fichier de relations inclus dans le chargement. Quand `userProvidedEdgeIds` est présent et défini sur `False`, les fichiers de relations inclus dans le chargement **ne doivent pas** contenir de colonne `:ID`. Au lieu de cela, le chargeur Neptune génère automatiquement un ID pour chaque relation. Il est utile de fournir une relation de IDs manière explicite afin que le chargeur puisse reprendre le chargement après correction d'une erreur dans les données CSV, sans avoir à recharger les relations déjà chargées. Si aucune relation IDs n'a été explicitement attribuée, le chargeur ne peut pas reprendre un chargement défaillant si un fichier de relations a dû être corrigé, et doit à la place recharger toutes les relations. **Réponse** + **payload** : *obligatoire :* tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). Contient une paire nom-valeur `loadId` qui fournit un identifiant pour l'opération de chargement. + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Code de retour HTTP indiquant le statut de la tâche de chargement. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [InternalFailureException](data-api-dp-errors.md#InternalFailureException) + [S3Exception](data-api-dp-errors.md#S3Exception) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## GetLoaderJobStatus (action)         Le nom de la AWS CLI pour cette API est :`get-loader-job-status`. Génère des informations de statut sur une tâche de chargement spécifiée. Neptune conserve une trace des 1 024 tâches de chargement en bloc les plus récentes et stocke les 10 000 dernières informations détaillées d'erreur par tâche. Consultez l'[ Get-Status API Neptune Loader](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) pour plus d'informations. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetLoaderJobStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus) ce cluster. **Demande** + **details** (dans la CLI : `--details`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Indicateur signalant s'il faut ou non inclure des détails autres que le statut général (`TRUE` ou `FALSE` ; la valeur par défaut est `FALSE`). + **errors** (dans la CLI : `--errors`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Indicateur signalant s'il faut ou non inclure une liste des erreurs rencontrées (`TRUE` ou `FALSE` ; la valeur par défaut est `FALSE`). La liste d'erreurs est paginée. Les paramètres `page` et `errorsPerPage` vous permettent de parcourir toutes les erreurs. + **errorsPerPage**(dans la CLI :`--errors-per-page`) — a PositiveInteger, de type : `integer` (un entier signé de 32 bits), au moins 1 ? st ?. Nombre d'erreurs renvoyées sur chaque page (entier positif ; la valeur par défaut est `10`). Valide uniquement si le paramètre `errors` est défini sur `TRUE`. + **loadId** (dans la CLI : `--load-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de chargement de la tâche de chargement dont vous souhaitez obtenir le statut. + **page**(dans la CLI :`--page`) — a PositiveInteger, de type : `integer` (un entier signé de 32 bits), au moins 1 ? st ?. Numéro de la page d'erreur (entier positif ; la valeur par défaut est `1`). Valide uniquement lorsque le paramètre `errors` est défini sur `TRUE`. **Réponse** + **payload** : *obligatoire :* document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Informations sur le statut de la tâche de chargement, dans une mise en page qui pourrait ressembler à ceci : **Example** ``` { "status" : "200 OK", "payload" : { "feedCount" : [ { "LOAD_FAILED" : (number) } ], "overallStatus" : { "fullUri" : "s3://(bucket)/(key)", "runNumber" : (number), "retryNumber" : (number), "status" : "(string)", "totalTimeSpent" : (number), "startTime" : (number), "totalRecords" : (number), "totalDuplicates" : (number), "parsingErrors" : (number), "datatypeMismatchErrors" : (number), "insertErrors" : (number), }, "failedFeeds" : [ { "fullUri" : "s3://(bucket)/(key)", "runNumber" : (number), "retryNumber" : (number), "status" : "(string)", "totalTimeSpent" : (number), "startTime" : (number), "totalRecords" : (number), "totalDuplicates" : (number), "parsingErrors" : (number), "datatypeMismatchErrors" : (number), "insertErrors" : (number), } ], "errors" : { "startIndex" : (number), "endIndex" : (number), "loadId" : "(string), "errorLogs" : [ ] } } } ``` + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Code de réponse HTTP de la demande. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [InternalFailureException](data-api-dp-errors.md#InternalFailureException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## ListLoaderJobs (action)         Le nom de la AWS CLI pour cette API est :`list-loader-jobs`. Récupère la liste des `loadIds` pour toutes les tâches de chargement actives. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [ListLoaderJobsneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs) ce cluster. **Demande** + **includeQueuedLoads** (dans la CLI : `--include-queued-loads`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Paramètre facultatif qui peut être utilisé pour exclure le chargement IDs des demandes de chargement en file d'attente lors de la demande d'une liste de charges IDs en définissant le paramètre sur. `FALSE` La valeur par défaut est `TRUE`. + **limit**(dans la CLI :`--limit`) — a ListLoaderJobsInputLimitInteger, de type : `integer` (un entier signé de 32 bits), pas moins de 1 ou plus de 100 ? 1er ? s. Le nombre de chargements IDs à répertorier. Doit être un entier positif supérieur à zéro et inférieur ou égal à `100` (valeur par défaut). **Réponse** + **payload** : *obligatoire :* objet [LoaderIdResult](#LoaderIdResult). La liste des tâches demandées IDs. + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Renvoie le statut de la demande d'affichage des tâches. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException) + [InternalFailureException](data-api-dp-errors.md#InternalFailureException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## CancelLoaderJob (action)         Le nom de la AWS CLI pour cette API est :`cancel-loader-job`. Annule une tâche de chargement spécifiée. Il s'agit d'une demande HTTP `DELETE`. Consultez l'[ Get-Status API Neptune Loader](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) pour plus d'informations. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [CancelLoaderJobneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob) ce cluster. **Demande** + **loadId** (dans la CLI : `--load-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la tâche à supprimer. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de l'annulation. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [InternalFailureException](data-api-dp-errors.md#InternalFailureException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## *Structure de chargement en bloc :* ## LoaderIdResult (structure) Contient une liste des chargements IDs. **Champs** + **loadIds** : chaîne de type : `string` (chaîne encodée en UTF-8). Une liste de chargements IDs. # API de plan de données des flux Neptune **Actions d'accès aux flux :** + [GetPropertygraphStream (action)](#GetPropertygraphStream) **Structures de données de flux :** + [PropertygraphRecord (structure)](#PropertygraphRecord) + [PropertygraphData (structure)](#PropertygraphData) ## GetPropertygraphStream (action)         Le nom de la AWS CLI pour cette API est :`get-propertygraph-stream`. Obtient un flux pour un graphe de propriétés. La fonctionnalité Neptune Streams vous permet de générer une séquence complète d'entrées de journal des modifications qui enregistrent chaque modification apportée à vos données de graphe au fur et à mesure de leur application. `GetPropertygraphStream` vous permet de collecter ces entrées de journaux de modifications pour un graphe de propriétés. La fonctionnalité Neptune Streams doit être activée sur votre Neptune. DBcluster Pour activer les flux, définissez le paramètre de cluster de bases de données [neptune\$1streams](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) sur `1`. Consultez [Capture des modifications de graphe en temps réel à l'aide des flux Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/streams.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetStreamRecordsneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) ce cluster. Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'une des actions IAM suivantes, en fonction de la requête : Notez que vous pouvez restreindre les requêtes de graphes de propriétés à l'aide des clés de contexte IAM suivantes : + [neptune-db ::Gremlin QueryLanguage](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) + [base de données Neptune : QueryLanguage OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) Consultez [Clés de condition disponibles dans les déclarations de stratégie d'accès aux données IAM Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html). **Demande** + **commitNum** (dans la CLI : `--commit-num`) : long de type : `long` (entier signé de 64 bits). Numéro de validation de l'enregistrement de départ à lire à partir du flux du journal des modifications. Ce paramètre est obligatoire quand `iteratorType` est `AT_SEQUENCE_NUMBER` ou `AFTER_SEQUENCE_NUMBER`, et ignoré quand `iteratorType` indique `TRIM_HORIZON` ou `LATEST`. + **encoding** (dans la CLI : `--encoding`) : encodage de type : `string` (chaîne encodée en UTF-8). Si ce paramètre est défini sur TRUE, Neptune compresse la réponse à l'aide de l'encodage gzip. + **iteratorType**(dans la CLI :`--iterator-type`) — un IteratorType, de type : `string` (une chaîne codée en UTF-8). Les valeurs suivantes sont possibles : + `AT_SEQUENCE_NUMBER` : indique que la lecture doit commencer à partir du numéro de séquence d'événement spécifié conjointement par les paramètres `commitNum` et `opNum`. + `AFTER_SEQUENCE_NUMBER` : indique que la lecture doit commencer juste après le numéro de séquence d'événement spécifié conjointement par les paramètres `commitNum` et `opNum`. + `TRIM_HORIZON` : indique que la lecture doit commencer au niveau du dernier enregistrement non tronqué du système, qui est le plus ancien enregistrement n'ayant pas expiré (pas encore supprimé) dans le flux de journaux des modifications. + `LATEST` : indique que la lecture doit commencer au niveau de l'enregistrement le plus récent dans le système, qui est le dernier enregistrement n'ayant pas expiré (pas encore supprimé) dans le flux de journaux des modifications. + **limit**(dans la CLI :`--limit`) — a GetPropertygraphStreamInputLimitLong, de type : `long` (un entier signé de 64 bits), pas moins de 1 ou plus de 100 000 ? 1er ? s. Spécifie le nombre maximal d'enregistrements à renvoyer. Il existe également une limite de taille de 10 Mo pour la réponse qui ne peut pas être modifiée et qui est prioritaire sur le nombre d'enregistrements spécifié dans le paramètre `limit`. La réponse inclut un enregistrement de dépassement de seuil si la limite de 10 Mo a été atteinte. La plage de valeurs `limit` est comprise entre 1 et 100 000, avec une valeur par défaut de 10. + **opNum** (dans la CLI : `--op-num`) : long de type : `long` (entier signé de 64 bits). Numéro de séquence d'opération au sein de la validation spécifiée à partir duquel commencer la lecture dans les données du flux du journal des modifications. L’argument par défaut est `1`. **Réponse** + **format** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Format de sérialisation pour les enregistrements de modification renvoyés. À l’heure actuelle, la seule valeur prise en charge est `PG_JSON`. + **lastEventId** : *obligatoire :* tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant de séquence de la dernière modification dans la réponse du flux. Un ID d'événement se compose de deux champs : `commitNum` qui identifie une transaction ayant modifié le graphe et `opNum` qui identifie une opération spécifique au sein de cette transaction. **Example** ``` "eventId": { "commitNum": 12, "opNum": 1 } ``` + **lastTrxTimestampInMillis** : *obligatoire :* long facultatif de type : `long` (entier signé de 64 bits). Heure à laquelle la validation de la transaction a été demandée, en millisecondes, à partir de l'Unix Epoch. + **records** : *obligatoire :* tableau d'objets [PropertygraphRecord](#PropertygraphRecord).   Tableau des enregistrements du flux de journaux des modifications sérialisés inclus dans la réponse. + **totalRecords** : *obligatoire :* entier de type : `integer` (entier signé de 32 bits). Nombre total d'enregistrements dans la réponse. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [ExpiredStreamException](data-api-dp-errors.md#ExpiredStreamException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException) + [StreamRecordsNotFoundException](data-api-dp-errors.md#StreamRecordsNotFoundException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ThrottlingException](data-api-dp-errors.md#ThrottlingException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## *Structures de données de flux :* ## PropertygraphRecord (structure) Structure d'un enregistrement de graphe de propriétés. **Champs** + **commitTimestampInMillis** : *obligatoire :* long facultatif de type : `long` (entier signé de 64 bits). Heure à laquelle la validation de la transaction a été demandée, en millisecondes, à partir de l'Unix Epoch. + **data** : *obligatoire :* objet [PropertygraphData](#PropertygraphData). Enregistrement de modification sérialisé Gremlin, SPARQL ou openCypher. + **eventId** : *obligatoire :* tableau de mappage de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est une chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant de séquence de l'enregistrement de modification du flux. + **isLastOp** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Présent uniquement si cette opération est la dernière dans sa transaction. S'il est présent, il est défini sur true. Utile pour s'assurer qu'une transaction est consommée dans son intégralité. + **op** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Opération à l'origine de la modification. ## PropertygraphData (structure) Enregistrement de modification sérialisé Gremlin ou openCypher. **Champs** + **from** : chaîne de type : `string` (chaîne encodée en UTF-8). S'il s'agit d'une arête (type = `e`), ID du sommet `from` ou du nœud source correspondant. + **id** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de l'élément Gremlin ou openCypher. + **key** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Nom de la propriété. Pour les étiquettes d'élément, il s'agit de `label`. + **to** : chaîne de type : `string` (chaîne encodée en UTF-8). S'il s'agit d'une arête (type = `e`), ID du sommet `to` ou du nœud cible correspondant. + **type** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Type de cet élément Gremlin ou openCypher. Doit être l'une des valeurs suivantes : + **`v1`** : étiquette du sommet pour Gremlin ou étiquette du nœud pour openCypher. + **`vp`** : propriétés du sommet pour Gremlin ou propriétés du nœud pour openCypher. + **`e`** : arête et étiquette d'arête pour Gremlin ou relation et type de relation pour openCypher. + **`ep`** : propriétés de l'arête pour Gremlin ou propriétés de la relation pour openCypher. + **value** : *obligatoire :* document de type : `document` (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON). Il s'agit d'un objet JSON qui contient un champ pour la valeur elle-même et un champ pour le type de données JSON de cette valeur : **Example** ``` "value": { "value": "(the new value"), "dataType": "(the JSON datatypenew value") } ``` # Statistiques du plan de données Neptune et résumé du graphique APIs **Actions liées aux statistiques des graphes de propriétés :** + [GetPropertygraphStatistics (action)](#GetPropertygraphStatistics) + [ManagePropertygraphStatistics (action)](#ManagePropertygraphStatistics) + [DeletePropertygraphStatistics (action)](#DeletePropertygraphStatistics) + [GetPropertygraphSummary (action)](#GetPropertygraphSummary) **Structures des statistiques :** + [Statistics (structure)](#Statistics) + [StatisticsSummary (structure)](#StatisticsSummary) + [DeleteStatisticsValueMap (structure)](#DeleteStatisticsValueMap) + [RefreshStatisticsIdMap (structure)](#RefreshStatisticsIdMap) + [NodeStructure (structure)](#NodeStructure) + [EdgeStructure (structure)](#EdgeStructure) + [SubjectStructure (structure)](#SubjectStructure) + [PropertygraphSummaryValueMap (structure)](#PropertygraphSummaryValueMap) + [PropertygraphSummary (structure)](#PropertygraphSummary) ## GetPropertygraphStatistics (action)         Le nom de la AWS CLI pour cette API est :`get-propertygraph-statistics`. Obtient les statistiques du graphe de propriétés (Gremlin et openCypher). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetStatisticsStatusneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) ce cluster. **Demande** + *Aucun paramètre de demande.* **Réponse** + **payload** : *obligatoire :* objet [Statistiques](#Statistics). Statistiques pour les données du graphe de propriétés. + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Code de retour HTTP de la demande. Si la demande aboutit, le code est 200. Consultez la section [Codes d'erreur courants pour les demandes de statistiques DFE](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors) pour obtenir une liste des erreurs courantes. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## ManagePropertygraphStatistics (action)         Le nom de la AWS CLI pour cette API est :`manage-propertygraph-statistics`. Gère la génération et l'utilisation des statistiques des graphes de propriétés. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [ManageStatisticsneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) ce cluster. **Demande** + **mode**(dans la CLI :`--mode`) — a StatisticsAutoGenerationMode, de type : `string` (une chaîne codée en UTF-8). Mode de génération des statistiques. Correspond à `DISABLE_AUTOCOMPUTE`, `ENABLE_AUTOCOMPUTE` ou `REFRESH` (le dernier mode déclenche manuellement la génération de statistiques DFE). **Réponse** + **payload** : objet [RefreshStatisticsIdMap](#RefreshStatisticsIdMap). N'est renvoyé que pour le mode d'actualisation. + **status** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Code de retour HTTP de la demande. Si la demande aboutit, le code est 200. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## DeletePropertygraphStatistics (action)         Le nom de la AWS CLI pour cette API est :`delete-propertygraph-statistics`. Supprime les statistiques pour les données Gremlin et openCypher (graphe de propriétés). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [DeleteStatisticsneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) ce cluster. **Demande** + *Aucun paramètre de demande.* **Réponse** + **payload** : objet [DeleteStatisticsValueMap](#DeleteStatisticsValueMap). Charge utile de la suppression. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut d'annulation. + **statusCode** : entier de type : `integer` (entier signé de 32 bits). Code de réponse HTTP 200 si la suppression a réussi, ou 204 s'il n'y avait aucune statistique à supprimer. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## GetPropertygraphSummary (action)         Le nom de la AWS CLI pour cette API est :`get-propertygraph-summary`. Génère un résumé de graphe de propriétés. Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [GetGraphSummaryneptune-db : IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) ce cluster. **Demande** + **mode**(dans la CLI :`--mode`) — a GraphSummaryType, de type : `string` (une chaîne codée en UTF-8). Le mode peut prendre l'une des deux valeurs suivantes : `BASIC` (valeur par défaut) et `DETAILED`. **Réponse** + **payload** : objet [PropertygraphSummaryValueMap](#PropertygraphSummaryValueMap). Charge utile contenant la réponse de résumé de graphe de propriétés. + **statusCode** : entier de type : `integer` (entier signé de 32 bits). Code de retour HTTP de la demande. Si la demande aboutit, le code est 200. **Erreurs** + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) ## *Structures des statistiques :* ## Statistics (structure) Contient des informations statistiques. Le moteur DFE utilise les informations relatives aux données d'un graphe Neptune pour effectuer des compromis efficaces lors de la planification de l'exécution des requêtes. Ces informations prennent la forme de statistiques qui incluent ce que l'on appelle des ensembles de caractéristiques et des statistiques de prédicats qui contribuent à guider la planification des requêtes. Consultez [Gestion des statistiques à utiliser par le DFE Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html). **Champs** + **active** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Indique si la génération des statistiques est activée. + **autoCompute** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Indique si la génération automatique des statistiques est activée ou non. + **date**— Il s'agit d'un SyntheticTimestamp \$1date\$1time, de type : `string` (une chaîne codée en UTF-8). Heure UTC à laquelle les statistiques DFE ont été générées pour la dernière fois. + **note** : chaîne de type : `string` (chaîne encodée en UTF-8). Remarque concernant les problèmes liés à la non-validité des statistiques. + **signatureInfo** : objet [StatisticsSummary](#StatisticsSummary). Une StatisticsSummary structure qui contient : + `signatureCount` : nombre total de signatures pour tous les ensembles de caractéristiques. + `instanceCount` : nombre total d'instances d'ensembles de caractéristiques. + `predicateCount` : nombre total de prédicats uniques. + **statisticsId** : chaîne de type : `string` (chaîne encodée en UTF-8). Indique l'ID de la génération de statistiques en cours d'exécution. La valeur -1 indique qu'aucune statistique n'a été générée. ## StatisticsSummary (structure) Informations sur les ensembles de caractéristiques générés dans les statistiques. **Champs** + **instanceCount** : entier de type : `integer` (entier signé de 32 bits). Nombre total d'instances d'ensembles de caractéristiques. + **predicateCount** : entier de type : `integer` (entier signé de 32 bits). Nombre total de prédicats uniques. + **signatureCount** : entier de type : `integer` (entier signé de 32 bits). Nombre total de signatures pour tous les ensembles de caractéristiques. ## DeleteStatisticsValueMap (structure) La charge utile pour. DeleteStatistics **Champs** + **active** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Statut actuel des statistiques. + **statisticsId** : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'exécution de la génération de statistiques en cours. ## RefreshStatisticsIdMap (structure) Statistiques pour le mode `REFRESH`. **Champs** + **statisticsId** : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'exécution de la génération de statistiques en cours. ## NodeStructure (structure) Structure d'un nœud. **Champs** + **count** : long de type : `long` (entier signé de 64 bits). Nombre de nœuds dotés de cette structure spécifique. + **distinctOutgoingEdgeLabels** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des différentes étiquettes d'arête sortantes présentes dans cette structure spécifique. + **nodeProperties** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des propriétés de nœud présentes dans cette structure spécifique. ## EdgeStructure (structure) Structure d'une arête. **Champs** + **count** : long de type : `long` (entier signé de 64 bits). Nombre d'arêtes dotées de cette structure spécifique. + **edgeProperties** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des propriétés d'arête présentes dans cette structure spécifique. ## SubjectStructure (structure) Structure de sujet. **Champs** + **count** : long de type : `long` (entier signé de 64 bits). Nombre d'occurrences de cette structure spécifique. + **predicates** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des prédicats présents dans cette structure spécifique. ## PropertygraphSummaryValueMap (structure) Charge utile de la réponse de résumé de graphe de propriétés. **Champs** + **graphSummary** : objet [PropertygraphSummary](#PropertygraphSummary). Résumé du graphe. + **lastStatisticsComputationTime**— Il s'agit d'un SyntheticTimestamp \$1date\$1time, de type : `string` (une chaîne codée en UTF-8). Horodatage, au format ISO 8601, indiquant l'heure à laquelle Neptune a calculé ses statistiques pour la dernière fois. + **version** : chaîne de type : `string` (chaîne encodée en UTF-8). Version de la réponse de résumé de graphe. ## PropertygraphSummary (structure) L'API de résumé de graphe renvoie une liste en lecture seule des étiquettes et des clés de propriété des nœuds et des arêtes, ainsi que le nombre de nœuds, d'arêtes et de propriétés. Consultez [Réponse de résumé pour un graphe de propriétés (PG)](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response). **Champs** + **edgeLabels** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des étiquettes d'arête distinctes dans le graphe. + **edgeProperties**— Ce sont LongValuedMap des objets. Il s'agit d'un tableau cartographique de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est un long de type : `long` (entier signé de 64 bits). Liste des propriétés d'arêtes distinctes dans le graphe et nombre d'arêtes où chaque propriété est utilisée. + **edgeStructures** : tableau d'objets [EdgeStructure](#EdgeStructure). Ce champ n'est présent que lorsque le mode demandé est `DETAILED`. Contient une liste des structures d'arête. + **nodeLabels** : chaîne de type : `string` (chaîne encodée en UTF-8). Liste des étiquettes de nœud distinctes dans le graphe. + **nodeProperties**— Ce sont LongValuedMap des objets. Il s'agit d'un tableau cartographique de paires clé-valeur où :     Chaque clé est une chaîne de type : `string` (chaîne encodée en UTF-8).     Chaque valeur est un long de type : `long` (entier signé de 64 bits). Nombre de propriétés de nœuds distinctes dans le graphe. + **nodeStructures** : tableau d'objets [NodeStructure](#NodeStructure). Ce champ n'est présent que lorsque le mode demandé est `DETAILED`. Contient une liste des structures de nœud. + **numEdgeLabels** : long de type : `long` (entier signé de 64 bits). Nombre d'étiquettes d'arête distinctes dans le graphe. + **numEdgeProperties** : long de type : `long` (entier signé de 64 bits). Nombre de propriétés d'arêtes distinctes dans le graphe. + **numEdges** : long de type : `long` (entier signé de 64 bits). Nombre d'arêtes dans le graphe. + **numNodeLabels** : long de type : `long` (entier signé de 64 bits). Nombre d'étiquettes de nœuds distinctes dans le graphe. + **numNodeProperties** : long de type : `long` (entier signé de 64 bits). Liste des propriétés de nœud distinctes dans le graphe et nombre de nœuds où chaque propriété est utilisée. + **numNodes** : long de type : `long` (entier signé de 64 bits). Nombre de nœuds dans le graphe. + **totalEdgePropertyValues** : long de type : `long` (entier signé de 64 bits). Nombre total d'utilisations de toutes les propriétés d'arête. + **totalNodePropertyValues** : long de type : `long` (entier signé de 64 bits). Nombre total d'utilisations de toutes les propriétés de nœud. # API de traitement de données Neptune ML **Actions de traitement des données :** + [Démarrer MLData ProcessingJob (action)](#StartMLDataProcessingJob) + [Liste MLData ProcessingJobs (action)](#ListMLDataProcessingJobs) + [Obtenir MLData ProcessingJob (action)](#GetMLDataProcessingJob) + [Annuler MLData ProcessingJob (action)](#CancelMLDataProcessingJob) **Structures à usage général du ML :** + [MlResourceDefinition (structure)](#MlResourceDefinition) + [MlConfigDefinition (structure)](#MlConfigDefinition) ## Démarrer MLData ProcessingJob (action)         Le nom de la AWS CLI pour cette API est :`start-ml-data-processing-job`. Crée une tâche de traitement de données Neptune ML pour traiter les données de graphe exportées à partir de Neptune à des fins d'entraînement. Consultez la section [Commande `dataprocessing`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel DataProcessingJob Neptune-DB:Start IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob) ce cluster. **Demande** + **configFileName** (dans la CLI : `--config-file-name`) : chaîne de type : `string` (chaîne encodée en UTF-8). Fichier de spécification de données qui explique comment charger les données de graphe exportées à des fins d'entraînement. Ce fichier est automatiquement généré par le kit d'exportation Neptune. L’argument par défaut est `training-data-configuration.json`. + **id** (dans la CLI : `--id`) : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la nouvelle tâche. La valeur par défaut est un UUID généré automatiquement. + **inputDataS3Location** (dans la CLI : `--input-data-s3-location`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). L'URI de l'emplacement Amazon S3 où vous souhaitez SageMaker télécharger les données nécessaires à l'exécution de la tâche de traitement des données. + **modelType** (dans la CLI : `--model-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'un des deux types de modèles actuellement pris en charge par Neptune ML : modèles de graphes hétérogènes (`heterogeneous`) et graphes de connaissances (`kge`). La valeur par défaut est « aucun ». Si cette valeur n'est pas spécifiée, Neptune ML choisit automatiquement le type de modèle en fonction des données. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). Le nom de ressource Amazon (ARN) d'un rôle IAM qui SageMaker peut assumer l'exécution de tâches en votre nom. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **previousDataProcessingJobId** (dans la CLI : `--previous-data-processing-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'une tâche de traitement des données terminée exécutée sur une version antérieure des données. + **processedDataS3Location** (dans la CLI : `--processed-data-s3-location`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). L'URI de l'emplacement Amazon S3 où vous souhaitez SageMaker enregistrer les résultats d'une tâche de traitement de données. + **processingInstanceType** (dans la CLI : `--processing-instance-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type d'instance ML utilisée lors du traitement des données. Sa mémoire doit être suffisamment grande pour contenir le jeu de données traité. La valeur par défaut est le plus petit type d'instance ml.r5 dont la mémoire est dix fois supérieure à la taille des données de graphe exportées sur le disque. + **processingInstanceVolumeSizeInGB** (dans la CLI : `--processing-instance-volume-size-in-gb`) : entier de type : `integer` (entier signé de 32 bits). Taille du volume de disque de l'instance de traitement. Les données d'entrée et les données traitées étant stockées sur disque, la taille du volume doit être suffisamment grande pour contenir les deux jeux de données. La valeur par défaut est 0. Si ce paramètre n'est pas spécifié ou s'il est égal à 0, Neptune ML choisit automatiquement la taille du volume en fonction de la taille des données. + **processingTimeOutInSeconds** (dans la CLI : `--processing-time-out-in-seconds`) : entier de type : `integer` (entier signé de 32 bits). Délai d'expiration en secondes de la tâche de traitement des données. La valeur par défaut de 86 400 (1 jour). + **s3OutputEncryptionKMSKey** (dans la CLI : `--s-3-output-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (Amazon KMS) SageMaker utilisée pour chiffrer le résultat de la tâche de traitement. La valeur par défaut est Aucun. + **sagemakerIamRoleArn** (dans la CLI : `--sagemaker-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM à SageMaker exécuter. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **securityGroupIds** (dans la CLI : `--security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8). Le groupe de sécurité VPC. IDs La valeur par défaut est Aucun. + **subnets** (dans la CLI : `--subnets`) : chaîne de type : `string` (chaîne encodée en UTF-8). Les sous-réseaux IDs du VPC Neptune. La valeur par défaut est Aucun. + **volumeEncryptionKMSKey** (dans la CLI : `--volume-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (Amazon KMS) SageMaker utilisée pour chiffrer les données sur le volume de stockage attaché aux instances de calcul ML qui exécutent la tâche de formation. La valeur par défaut est Aucun. **Réponse** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN de la tâche de traitement des données. + **creationTimeInMillis** : long de type : `long` (entier signé de 64 bits). Temps nécessaire à la création de la tâche de traitement, en millisecondes. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la nouvelle tâche de traitement de données. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Liste MLData ProcessingJobs (action)         Le nom de la AWS CLI pour cette API est :`list-ml-data-processing-jobs`. Renvoie une liste des tâches de traitement de données Neptune ML. Consultez [Liste des tâches de traitement de données actives à l'aide de la commande dataprocessing Neptune ML](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLData ProcessingJobs Neptune-DB:list IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs) ce cluster. **Demande** + **maxItems**(dans la CLI :`--max-items`) — une liste ListMLDataProcessingJobsInputMaxItemsInteger, de type : `integer` (un entier signé de 32 bits), pas moins de 1 ou plus de 1024 ? 1er ? s. Nombre maximum d'éléments à récupérer (allant de 1 à 1 024, avec une valeur par défaut de 10). + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **ids** : chaîne de type : `string` (chaîne encodée en UTF-8). Une page répertoriant les tâches de traitement de données IDs. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Obtenir MLData ProcessingJob (action)         Le nom de la AWS CLI pour cette API est :`get-ml-data-processing-job`. Extrait des informations sur une tâche de traitement de données spécifiée. Consultez la section [Commande `dataprocessing`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLData ProcessingJobStatus Neptune-DB:Neptune-DB:get IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus) ce cluster. **Demande** + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche de traitement des données à récupérer. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de cette tâche de traitement de données. + **processingJob** : objet [MlResourceDefinition](#MlResourceDefinition). Définition de la tâche de traitement des données. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de la tâche de traitement des données. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Annuler MLData ProcessingJob (action)         Le nom de la AWS CLI pour cette API est :`cancel-ml-data-processing-job`. Annule une tâche de traitement de données Neptune ML. Consultez la section [Commande `dataprocessing`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLData ProcessingJob Neptune-DB:Cancel IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob) ce cluster. **Demande** + **clean** (dans la CLI : `--clean`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). S'il est défini sur `TRUE`, cet indicateur indique que tous les artefacts Neptune ML S3 doivent être supprimés lorsque la tâche est arrêtée. L’argument par défaut est `FALSE`. + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche de traitement de données. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de la demande d'annulation. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## *Structures à usage général du ML :* ## MlResourceDefinition (structure) Définit une ressource Neptune ML. **Champs** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN de la ressource. + **cloudwatchLogUrl** : chaîne de type : `string` (chaîne encodée en UTF-8). URL du CloudWatch journal de la ressource. + **failureReason** : chaîne de type : `string` (chaîne encodée en UTF-8). Raison de l'échec, en cas d'échec. + **name** : chaîne de type : `string` (chaîne encodée en UTF-8). Nom de la ressource. + **outputLocation** : chaîne de type : `string` (chaîne encodée en UTF-8). Emplacement de la sortie. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de la ressource. ## MlConfigDefinition (structure) Contient une configuration Neptune ML. **Champs** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN de la configuration. + **name** : chaîne de type : `string` (chaîne encodée en UTF-8). Nom de la configuration # API d'entraînement de modèle Neptune ML **Actions d'entraînement de modèle :** + [Démarrer MLModel TrainingJob (action)](#StartMLModelTrainingJob) + [Liste MLModel TrainingJobs (action)](#ListMLModelTrainingJobs) + [Obtenir MLModel TrainingJob (action)](#GetMLModelTrainingJob) + [Annuler MLModel TrainingJob (action)](#CancelMLModelTrainingJob) **Structures d'entraînement des modèles :** + [CustomModelTrainingParameters (structure)](#CustomModelTrainingParameters) ## Démarrer MLModel TrainingJob (action)         Le nom de la AWS CLI pour cette API est :`start-ml-model-training-job`. Crée une tâche d'entraînement de modèle Neptune ML. Consultez [Entraînement des modèles à l'aide de la commande `modeltraining`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TrainingJob Neptune-DB:Start IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob) ce cluster. **Demande** + **baseProcessingInstanceType** (dans la CLI : `--base-processing-instance-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type d'instance ML utilisé pour préparer et gérer l'entraînement des modèles ML. Il s'agit d'une instance de CPU choisie en fonction des besoins en mémoire pour le traitement des données et du modèle d'entraînement. + **customModelTrainingParameters** (dans la CLI : `--custom-model-training-parameters`) : objet [CustomModelTrainingParameters](#CustomModelTrainingParameters). Configuration pour l'entraînement d'un modèle personnalisé. Il s'agit d'un objet JSON. + **dataProcessingJobId** (dans la CLI : `--data-processing-job-id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la tâche de traitement des données terminée qui a créé les données avec lesquelles l'entraînement fonctionnera. + **enableManagedSpotTraining** (dans la CLI : `--enable-managed-spot-training`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Optimise le coût d'entraînement des modèles de machine learning à l'aide d'instances Spot Amazon Elastic Compute Cloud. L’argument par défaut est `False`. + **id** (dans la CLI : `--id`) : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la nouvelle tâche. La valeur par défaut est un UUID généré automatiquement. + **maxHPONumberOfTrainingJobs** (dans la CLI : `--max-hpo-number-of-training-jobs`) : entier de type : `integer` (entier signé de 32 bits). Nombre total maximal de tâches d'entraînement à démarrer pour la tâche de réglage des hyperparamètres. La valeur par défaut est 2. Neptune ML ajuste automatiquement les hyperparamètres du modèle de machine learning. Pour obtenir un modèle performant, utilisez au moins 10 tâches (en d'autres termes, définissez la valeur `maxHPONumberOfTrainingJobs` sur 10). En général, plus le réglage est long, meilleurs sont les résultats. + **maxHPOParallelTrainingJobs** (dans la CLI : `--max-hpo-parallel-training-jobs`) : entier de type : `integer` (entier signé de 32 bits). Nombre maximal de tâches d'entraînement à démarrer pour la tâche de réglage des hyperparamètres. La valeur par défaut est 2. Le nombre de tâches parallèles que vous pouvez exécuter est limité par les ressources disponibles sur l'instance d'entraînement. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **previousModelTrainingJobId** (dans la CLI : `--previous-model-training-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'une tâche d'entraînement de modèle terminée que vous souhaitez actualiser progressivement en fonction des données mises à jour. + **s3OutputEncryptionKMSKey** (dans la CLI : `--s-3-output-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (KMS) SageMaker utilisée pour chiffrer le résultat de la tâche de traitement. La valeur par défaut est Aucun. + **sagemakerIamRoleArn** (dans la CLI : `--sagemaker-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM à SageMaker exécuter. Il doit être répertorié dans le groupe de paramètres de votre cluster de base de données, sinon une erreur se produira. + **securityGroupIds** (dans la CLI : `--security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8). Le groupe de sécurité VPC. IDs La valeur par défaut est Aucun. + **subnets** (dans la CLI : `--subnets`) : chaîne de type : `string` (chaîne encodée en UTF-8). Les sous-réseaux IDs du VPC Neptune. La valeur par défaut est Aucun. + **trainingInstanceType** (dans la CLI : `--training-instance-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type d'instance ML utilisé pour l'entraînement des modèles. Tous les modèles Neptune ML prennent en charge l'entraînement de CPU, de GPU et de multiGPU. L’argument par défaut est `ml.p3.2xlarge`. Le choix du type d'instance approprié pour l'entraînement dépend du type de tâche, de la taille du graphe et de votre budget. + **trainingInstanceVolumeSizeInGB** (dans la CLI : `--training-instance-volume-size-in-gb`) : entier de type : `integer` (entier signé de 32 bits). Taille du volume de disque de l'instance d'entraînement. Les données d'entrée et le modèle de sortie étant stockés sur disque, la taille du volume doit être suffisamment grande pour contenir les deux jeux de données. La valeur par défaut est 0. Si elle n'est pas spécifiée ou si elle est égale à 0, Neptune ML sélectionne une taille de volume de disque en fonction de la recommandation générée lors de l'étape de traitement des données. + **trainingTimeOutInSeconds** (dans la CLI : `--training-time-out-in-seconds`) : entier de type : `integer` (entier signé de 32 bits). Délai d'attente en secondes de la tâche d'entraînement. La valeur par défaut de 86 400 (1 jour). + **trainModelS3Location** (dans la CLI : `--train-model-s3-location`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Emplacement dans Amazon S3 où les artefacts de modèle doivent être stockés. + **volumeEncryptionKMSKey** (dans la CLI : `--volume-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (KMS) SageMaker utilisée pour chiffrer les données sur le volume de stockage attaché aux instances de calcul ML qui exécutent la tâche de formation. La valeur par défaut est Aucun. **Réponse** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN de la nouvelle tâche d'entraînement du modèle. + **creationTimeInMillis** : long de type : `long` (entier signé de 64 bits). Temps de création de la tâche d'entraînement du modèle, en millisecondes. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la nouvelle tâche d'entraînement du modèle. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Liste MLModel TrainingJobs (action)         Le nom de la AWS CLI pour cette API est :`list-ml-model-training-jobs`. Répertorie les tâches d'entraînement de modèle Neptune ML. Consultez [Entraînement des modèles à l'aide de la commande `modeltraining`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TrainingJobs Neptune-db:neptune-db:list IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs) ce cluster. **Demande** + **maxItems**(dans la CLI :`--max-items`) — une liste MLModelTrainingJobsInputMaxItemsInteger, de type : `integer` (un entier signé de 32 bits), pas moins de 1 ou plus de 1024 ? 1er ? s. Nombre maximum d'éléments à récupérer (allant de 1 à 1 024, avec une valeur par défaut de 10). + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **ids** : chaîne de type : `string` (chaîne encodée en UTF-8). Une page de la liste des emplois de formation modèles IDs. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Obtenir MLModel TrainingJob (action)         Le nom de la AWS CLI pour cette API est :`get-ml-model-training-job`. Récupère des informations sur une tâche d'entraînement de modèle Neptune ML. Consultez [Entraînement des modèles à l'aide de la commande `modeltraining`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TrainingJobStatus Neptune-DB:Get IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus) ce cluster. **Demande** + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche d'entraînement de modèle à récupérer. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **hpoJob** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Tâche HPO. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de cette tâche d'entraînement de modèle. + **mlModels** : tableau d'objets [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition). Liste des configurations des modèles ML utilisés. + **modelTransformJob** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Tâche de transformation de modèle. + **processingJob** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Tâche de traitement des données. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de la nouvelle tâche d'entraînement du modèle. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Annuler MLModel TrainingJob (action)         Le nom de la AWS CLI pour cette API est :`cancel-ml-model-training-job`. Annule une tâche d'entraînement de modèle Neptune ML. Consultez [Entraînement des modèles à l'aide de la commande `modeltraining`](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TrainingJob Neptune-DB:Cancel IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob) ce cluster. **Demande** + **clean** (dans la CLI : `--clean`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). S'il est défini sur `TRUE`, cet indicateur indique que tous les artefacts Amazon S3 doivent être supprimés lorsque la tâche est arrêtée. L’argument par défaut est `FALSE`. + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche d'entraînement de modèle à annuler. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). État de l'annulation. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## *Structures d'entraînement des modèles :* ## CustomModelTrainingParameters (structure) Contient les paramètres d'entraînement personnalisés des modèles. Consultez [Modèles personnalisés dans Neptune ML.](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html) **Champs** + **sourceS3DirectoryPath** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chemin d'accès vers l'emplacement Amazon S3 où se trouve le module Python implémentant votre modèle. Il doit pointer vers un emplacement Amazon S3 existant valide contenant, au minimum, un script d'entraînement, un script de transformation et un fichier `model-hpo-configuration.json`. + **trainingEntryPointScript** : chaîne de type : `string` (chaîne encodée en UTF-8). Nom du point d'entrée dans votre module d'un script qui effectue l'entraînement du modèle et utilise des hyperparamètres comme arguments de ligne de commande, y compris des hyperparamètres fixes. L’argument par défaut est `training.py`. + **transformEntryPointScript** : chaîne de type : `string` (chaîne encodée en UTF-8). Nom du point d'entrée dans le module d'un script qui doit être exécuté une fois que le modèle le plus approprié issu de la recherche par hyperparamètres a été identifié, afin de calculer les artefacts nécessaires au déploiement du modèle. Il devrait pouvoir s'exécuter sans arguments de ligne de commande. La valeur par défaut est `transform.py`. # API de transformation de modèle Neptune ML **Actions de transformation de modèle :** + [Démarrer MLModel TransformJob (action)](#StartMLModelTransformJob) + [Liste MLModel TransformJobs (action)](#ListMLModelTransformJobs) + [Obtenir MLModel TransformJob (action)](#GetMLModelTransformJob) + [Annuler MLModel TransformJob (action)](#CancelMLModelTransformJob) **Structures de transformation de modèle :** + [CustomModelTransformParameters (structure)](#CustomModelTransformParameters) ## Démarrer MLModel TransformJob (action)         Le nom de la AWS CLI pour cette API est :`start-ml-model-transform-job`. Crée une tâche de transformation de modèle. Consultez [Utilisation d'un modèle entraîné pour générer de nouveaux artefacts de modèle](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TransformJob Neptune-DB:Start IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob) ce cluster. **Demande** + **baseProcessingInstanceType** (dans la CLI : `--base-processing-instance-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type d'instance ML utilisé pour préparer et gérer l'entraînement des modèles ML. Il s'agit d'une instance de calcul ML choisie en fonction des besoins en mémoire pour le traitement des données et du modèle d'entraînement. + **baseProcessingInstanceVolumeSizeInGB** (dans la CLI : `--base-processing-instance-volume-size-in-gb`) : entier de type : `integer` (entier signé de 32 bits). Taille du volume de disque de l'instance d'entraînement, en gigaoctets. La valeur par défaut est 0. Les données d'entrée et le modèle de sortie étant stockés sur disque, la taille du volume doit être suffisamment grande pour contenir les deux jeux de données. Si elle n'est pas spécifiée ou si elle est égale à 0, Neptune ML sélectionne une taille de volume de disque en fonction de la recommandation générée lors de l'étape de traitement des données. + **customModelTransformParameters** (dans la CLI : `--custom-model-transform-parameters`) : objet [CustomModelTransformParameters](#CustomModelTransformParameters). Informations de configuration d'une transformation de modèle à l'aide d'un modèle personnalisé. L'objet `customModelTransformParameters` contient les champs suivants, dont les valeurs doivent être compatibles avec les paramètres de modèle enregistrés lors de la tâche d'entraînement : + **dataProcessingJobId** (dans la CLI : `--data-processing-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'une tâche de traitement des données terminée. Vous devez inclure `dataProcessingJobId` et `mlModelTrainingJobId` ou `trainingJobName`. + **id** (dans la CLI : `--id`) : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la nouvelle tâche. La valeur par défaut est un UUID généré automatiquement. + **mlModelTrainingJobId** (dans la CLI : `--ml-model-training-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID d'une tâche d'entraînement de modèle terminée. Vous devez inclure `dataProcessingJobId` et `mlModelTrainingJobId` ou `trainingJobName`. + **modelTransformOutputS3Location** (dans la CLI : `--model-transform-output-s3-location`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Emplacement dans Amazon S3 où les artefacts de modèle doivent être stockés. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **s3OutputEncryptionKMSKey** (dans la CLI : `--s-3-output-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (KMS) SageMaker utilisée pour chiffrer le résultat de la tâche de traitement. La valeur par défaut est Aucun. + **sagemakerIamRoleArn** (dans la CLI : `--sagemaker-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM à SageMaker exécuter. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **securityGroupIds** (dans la CLI : `--security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8). Le groupe de sécurité VPC. IDs La valeur par défaut est Aucun. + **subnets** (dans la CLI : `--subnets`) : chaîne de type : `string` (chaîne encodée en UTF-8). Les sous-réseaux IDs du VPC Neptune. La valeur par défaut est Aucun. + **trainingJobName** (dans la CLI : `--training-job-name`) : chaîne de type : `string` (chaîne encodée en UTF-8). Le nom d'une tâche de SageMaker formation terminée. Vous devez inclure `dataProcessingJobId` et `mlModelTrainingJobId` ou `trainingJobName`. + **volumeEncryptionKMSKey** (dans la CLI : `--volume-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (KMS) SageMaker utilisée pour chiffrer les données sur le volume de stockage attaché aux instances de calcul ML qui exécutent la tâche de formation. La valeur par défaut est Aucun. **Réponse** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN de la tâche de transformation du modèle. + **creationTimeInMillis** : long de type : `long` (entier signé de 64 bits). Temps de création de la tâche de transformation du modèle, en millisecondes. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la nouvelle tâche de transformation du modèle. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Liste MLModel TransformJobs (action)         Le nom de la AWS CLI pour cette API est :`list-ml-model-transform-jobs`. Renvoie une liste des tâches de transformation du modèle IDs. Consultez [Utilisation d'un modèle entraîné pour générer de nouveaux artefacts de modèle](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TransformJobs Neptune-DB:list IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs) ce cluster. **Demande** + **maxItems**(dans la CLI :`--max-items`) — une liste ListMLModelTransformJobsInputMaxItemsInteger, de type : `integer` (un entier signé de 32 bits), pas moins de 1 ou plus de 1024 ? 1er ? s. Nombre maximum d'éléments à récupérer (allant de 1 à 1 024, avec une valeur par défaut de 10). + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **ids** : chaîne de type : `string` (chaîne encodée en UTF-8). Une page de la liste des transformations du modèle IDs. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Obtenir MLModel TransformJob (action)         Le nom de la AWS CLI pour cette API est :`get-ml-model-transform-job`. Génère des informations sur une tâche de transformation de modèle spécifiée. Consultez [Utilisation d'un modèle entraîné pour générer de nouveaux artefacts de modèle](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TransformJobStatus Neptune-DB:Get IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus) ce cluster. **Demande** + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche de transformation de modèle à récupérer. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **baseProcessingJob** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Tâche de traitement des données de base. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique de la tâche de transformation de modèle à récupérer. + **models** : tableau d'objets [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition). Liste des informations de configuration pour les modèles utilisés. + **remoteModelTransformJob** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Tâche de transformation de modèle à distance. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). Statut de la tâche de transformation du modèle. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Annuler MLModel TransformJob (action)         Le nom de la AWS CLI pour cette API est :`cancel-ml-model-transform-job`. Annule une tâche de transformation de modèle spécifiée. Consultez [Utilisation d'un modèle entraîné pour générer de nouveaux artefacts de modèle](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLModel TransformJob Neptune-DB:Cancel IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob) ce cluster. **Demande** + **clean** (dans la CLI : `--clean`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si cet indicateur est défini sur `TRUE`, tous les artefacts de Neptune ML S3 doivent être supprimés à l'arrêt de la tâche. L’argument par défaut est `FALSE`. + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID unique de la tâche de transformation du modèle à annuler. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). État de l'annulation. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## *Structures de transformation de modèle :* ## CustomModelTransformParameters (structure) Contient les paramètres de transformation personnalisés des modèles. Consultez [Utilisation d'un modèle entraîné pour générer de nouveaux artefacts de modèle](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html). **Champs** + **sourceS3DirectoryPath** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Chemin d'accès vers l'emplacement Amazon S3 où se trouve le module Python implémentant votre modèle. Il doit pointer vers un emplacement Amazon S3 existant valide contenant, au minimum, un script d'entraînement, un script de transformation et un fichier `model-hpo-configuration.json`. + **transformEntryPointScript** : chaîne de type : `string` (chaîne encodée en UTF-8). Nom du point d'entrée dans le module d'un script qui doit être exécuté une fois que le modèle le plus approprié issu de la recherche par hyperparamètres a été identifié, afin de calculer les artefacts nécessaires au déploiement du modèle. Il devrait pouvoir s'exécuter sans arguments de ligne de commande. L’argument par défaut est `transform.py`. # API de point de terminaison d'inférence Neptune ML **Actions du point de terminaison d'inférence :** + [Créer MLEndpoint (action)](#CreateMLEndpoint) + [Liste MLEndpoints (action)](#ListMLEndpoints) + [Obtenir MLEndpoint (action)](#GetMLEndpoint) + [Supprimer MLEndpoint (action)](#DeleteMLEndpoint) ## Créer MLEndpoint (action)         Le nom de la AWS CLI pour cette API est :`create-ml-endpoint`. Crée un point de terminaison d'inférence Neptune ML qui vous permet d'interroger un modèle spécifique construit par le processus d'entraînement des modèles. Consultez [Gestion des points de terminaison d'inférence à l'aide de la commande endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLEndpoint Neptune-DB:Create IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint) ce cluster. **Demande** + **id** (dans la CLI : `--id`) : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique du nouveau point de terminaison d'inférence. Le nom par défaut est un nom horodaté généré automatiquement. + **instanceCount** (dans la CLI : `--instance-count`) : entier de type : `integer` (entier signé de 32 bits). Le nombre minimum d' EC2 instances Amazon à déployer sur un point de terminaison à des fins de prévision. La valeur par défaut est 1. + **instanceType** (dans la CLI : `--instance-type`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type d'instance Neptune ML à utiliser pour la maintenance en ligne. L’argument par défaut est `ml.m5.xlarge`. Le choix de l'instance ML pour un point de terminaison d'inférence dépend du type de tâche, de la taille du graphe et de votre budget. + **mlModelTrainingJobId** (dans la CLI : `--ml-model-training-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID de la tâche d'entraînement de modèle terminée qui a créé le modèle vers lequel le point final d'inférence pointera. Vous devez fournir `mlModelTrainingJobId` ou `mlModelTransformJobId`. + **mlModelTransformJobId** (dans la CLI : `--ml-model-transform-job-id`) : chaîne de type : `string` (chaîne encodée en UTF-8). ID de la tâche de transformation de modèle terminée. Vous devez fournir `mlModelTrainingJobId` ou `mlModelTransformJobId`. + **modelName** (dans la CLI : `--model-name`) : chaîne de type : `string` (chaîne encodée en UTF-8). Type de modèle pour l'entraînement. Par défaut, le modèle Neptune ML est automatiquement basé sur le `modelType` utilisé dans le traitement des données, mais vous pouvez spécifier ici un autre type de modèle. La valeur par défaut est `rgcn` pour les graphes hétérogènes et `kge` pour les graphes de connaissances. La seule valeur valide pour les graphes hétérogènes est `rgcn`. Les valeurs valides pour les graphes de connaissances sont `kge`, `transe`, `distmult` et `rotate`. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM fournissant à Neptune l'accès aux ressources Amazon S3 SageMaker et à celles-ci. Cela doit être indiqué dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. + **update** (dans la CLI : `--update`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si ce paramètre est défini sur `true`, `update` indique qu'il s'agit d'une demande de mise à jour. L’argument par défaut est `false`. Vous devez fournir `mlModelTrainingJobId` ou `mlModelTransformJobId`. + **volumeEncryptionKMSKey** (dans la CLI : `--volume-encryption-kms-key`) : chaîne de type : `string` (chaîne encodée en UTF-8). La clé Amazon Key Management Service (Amazon KMS) SageMaker utilisée pour chiffrer les données sur le volume de stockage attaché aux instances de calcul ML qui exécutent la tâche de formation. La valeur par défaut est Aucun. **Réponse** + **arn** : chaîne de type : `string` (chaîne encodée en UTF-8). ARN du nouveau point de terminaison d'inférence. + **creationTimeInMillis** : long de type : `long` (entier signé de 64 bits). Heure de création du point de terminaison, en millisecondes. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique du point de terminaison d'inférence. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Liste MLEndpoints (action)         Le nom de la AWS CLI pour cette API est :`list-ml-endpoints`. Répertorie les points de terminaison d'inférence existants. Consultez [Gestion des points de terminaison d'inférence à l'aide de la commande endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLEndpoints Neptune-DB:list IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints) ce cluster. **Demande** + **maxItems**(dans la CLI :`--max-items`) — une liste MLEndpointsInputMaxItemsInteger, de type : `integer` (un entier signé de 32 bits), pas moins de 1 ou plus de 1024 ? 1er ? s. Nombre maximum d'éléments à renvoyer (compris entre 1 et 1 024, avec une valeur par défaut de 10). + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **ids** : chaîne de type : `string` (chaîne encodée en UTF-8). Une page de la liste des points de terminaison IDs d'inférence. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Obtenir MLEndpoint (action)         Le nom de la AWS CLI pour cette API est :`get-ml-endpoint`. Récupère les détails d'un point de terminaison d'inférence. Consultez [Gestion des points de terminaison d'inférence à l'aide de la commande endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action [MLEndpointNeptune-DB:Get Status IAM dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus) ce cluster. **Demande** + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique du point de terminaison d'inférence. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM qui fournit à Neptune l'accès aux ressources Amazon S3 et SageMaker à celles-ci. Cela doit être répertorié dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **endpoint** : objet [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition). Définition du point de terminaison. + **endpointConfig** : objet [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition). Configuration du point de terminaison. + **id** : chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique du point de terminaison d'inférence. + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). État du point de terminaison d'inférence. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) ## Supprimer MLEndpoint (action)         Le nom de la AWS CLI pour cette API est :`delete-ml-endpoint`. Annule la création d'un point de terminaison d'inférence Neptune ML. Consultez [Gestion des points de terminaison d'inférence à l'aide de la commande endpoints](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html). Lorsque vous appelez cette opération dans un cluster Neptune sur lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action MLEndpoint Neptune-DB:Delete IAM [dans](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint) ce cluster. **Demande** + **clean** (dans la CLI : `--clean`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false). Si cet indicateur est défini sur `TRUE`, tous les artefacts de Neptune ML S3 doivent être supprimés à l'arrêt de la tâche. L’argument par défaut est `FALSE`. + **id** (dans la CLI : `--id`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Identifiant unique du point de terminaison d'inférence. + **neptuneIamRoleArn** (dans la CLI : `--neptune-iam-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8). L'ARN d'un rôle IAM fournissant à Neptune l'accès aux ressources Amazon S3 SageMaker et à celles-ci. Cela doit être indiqué dans le groupe de paramètres de votre cluster de bases de données. Dans le cas contraire, une erreur se produira. **Réponse** + **status** : chaîne de type : `string` (chaîne encodée en UTF-8). État de l'annulation. **Erreurs** + [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException) + [BadRequestException](data-api-dp-errors.md#BadRequestException) + [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException) + [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException) + [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException) + [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException) + [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException) + [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException) + [MissingParameterException](data-api-dp-errors.md#MissingParameterException) + [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException) + [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException) # Exceptions relatives à l'API du plan de données Neptune **Exceptions :** + [AccessDeniedException (structure)](#AccessDeniedException) + [BadRequestException (structure)](#BadRequestException) + [BulkLoadIdNotFoundException (structure)](#BulkLoadIdNotFoundException) + [CancelledByUserException (structure)](#CancelledByUserException) + [ClientTimeoutException (structure)](#ClientTimeoutException) + [ConcurrentModificationException (structure)](#ConcurrentModificationException) + [ConstraintViolationException (structure)](#ConstraintViolationException) + [ExpiredStreamException (structure)](#ExpiredStreamException) + [FailureByQueryException (structure)](#FailureByQueryException) + [IllegalArgumentException (structure)](#IllegalArgumentException) + [InternalFailureException (structure)](#InternalFailureException) + [InvalidArgumentException (structure)](#InvalidArgumentException) + [InvalidNumericDataException (structure)](#InvalidNumericDataException) + [InvalidParameterException (structure)](#InvalidParameterException) + [LoadUrlAccessDeniedException (structure)](#LoadUrlAccessDeniedException) + [MalformedQueryException (structure)](#MalformedQueryException) + [MemoryLimitExceededException (structure)](#MemoryLimitExceededException) + [MethodNotAllowedException (structure)](#MethodNotAllowedException) + [MissingParameterException (structure)](#MissingParameterException) + [MLResourceNotFoundException (structure)](#MLResourceNotFoundException) + [ParsingException (structure)](#ParsingException) + [PreconditionsFailedException (structure)](#PreconditionsFailedException) + [QueryLimitExceededException (structure)](#QueryLimitExceededException) + [QueryLimitException (structure)](#QueryLimitException) + [QueryTooLargeException (structure)](#QueryTooLargeException) + [ReadOnlyViolationException (structure)](#ReadOnlyViolationException) + [S3Exception (structure)](#S3Exception) + [ServerShutdownException (structure)](#ServerShutdownException) + [StatisticsNotAvailableException (structure)](#StatisticsNotAvailableException) + [StreamRecordsNotFoundException (structure)](#StreamRecordsNotFoundException) + [ThrottlingException (structure)](#ThrottlingException) + [TimeLimitExceededException (structure)](#TimeLimitExceededException) + [TooManyRequestsException (structure)](#TooManyRequestsException) + [UnsupportedOperationException (structure)](#UnsupportedOperationException) + [UnloadUrlAccessDeniedException (structure)](#UnloadUrlAccessDeniedException) ## AccessDeniedException (structure) Générée en cas d'échec d'authentification ou d'autorisation. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## BadRequestException (structure) Générée lorsqu'une demande est soumise et qu'elle ne peut pas être traitée. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande incorrecte. ## BulkLoadIdNotFoundException (structure) Générée lorsqu'un ID de tâche de chargement en bloc spécifié est introuvable. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de tâche de chargement en bloc introuvable. ## CancelledByUserException (structure) Générée lorsqu'un utilisateur annule une demande. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ClientTimeoutException (structure) Générée lorsqu'une demande a expiré côté client. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ConcurrentModificationException (structure) Générée lorsqu'une demande tente de modifier des données qui sont modifiées simultanément par un autre processus. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ConstraintViolationException (structure) Générée lorsqu'une valeur d'un champ de demande ne satisfaisait pas aux contraintes requises. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ExpiredStreamException (structure) Générée lorsqu'une demande tente d'accéder à un flux expiré. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## FailureByQueryException (structure) Générée lorsqu'une demande échoue. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## IllegalArgumentException (structure) Générée lorsqu'un argument d'une demande n'est pas pris en charge. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## InternalFailureException (structure) Générée lorsque le traitement de la demande a échoué de façon inattendue. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## InvalidArgumentException (structure) Générée lorsqu'un argument d'une demande possède une valeur non valide. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## InvalidNumericDataException (structure) Générée lorsque des données numériques non valides sont détectées lors du traitement d'une demande. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## InvalidParameterException (structure) Générée lorsqu'une valeur de paramètre n'est pas valide. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui inclut un paramètre non valide. ## LoadUrlAccessDeniedException (structure) Générée lorsque l'accès à une URL de chargement spécifiée est refusé. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## MalformedQueryException (structure) Générée lorsqu'une requête soumise est incorrecte du point de vue syntaxique ou lorsqu'elle n'est pas approuvée par une étape de validation supplémentaire. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande de requête mal formée. ## MemoryLimitExceededException (structure) Générée lorsqu'une demande échoue en raison de ressources mémoire insuffisantes. Une nouvelle tentative peut avoir lieu. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui a échoué. ## MethodNotAllowedException (structure) Générée lorsque la méthode HTTP utilisée par une requête n'est pas prise en charge par le point de terminaison utilisé. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## MissingParameterException (structure) Générée lorsqu'un paramètre obligatoire est manquant. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande dans laquelle il manque le paramètre. ## MLResourceNotFoundException (structure) Générée lorsqu'une ressource de machine learning spécifiée est introuvable. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ParsingException (structure) Générée en cas de problème d'analyse. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## PreconditionsFailedException (structure) Générée lorsqu'une condition préalable au traitement d'une demande n'est pas satisfaite. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## QueryLimitExceededException (structure) Générée lorsque le nombre de requêtes actives dépasse ce que le serveur peut traiter. La requête en question pourra faire l'objet d'une nouvelle tentative lorsque le système sera moins occupé. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui a dépassé la limite. ## QueryLimitException (structure) Générée lorsque la taille d'une requête dépasse la limite du système. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui a dépassé la limite. ## QueryTooLargeException (structure) Générée lorsque le corps d'une requête est trop grand. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui est trop grande. ## ReadOnlyViolationException (structure) Générée lorsqu'une demande tente d'écrire des données dans une ressource en lecture seule. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande dans laquelle il manque le paramètre. ## S3Exception (structure) Générée en cas de problème lors de l'accès à Amazon S3. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ServerShutdownException (structure) Générée lorsque le serveur s'arrête pendant le traitement d'une demande. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## StatisticsNotAvailableException (structure) Générée lorsque les statistiques nécessaires pour satisfaire une demande ne sont pas disponibles. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## StreamRecordsNotFoundException (structure) Générée lorsque les enregistrements de flux demandés par une requête sont introuvables. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## ThrottlingException (structure) Générée lorsque la fréquence des demandes dépasse le débit maximum. Les demandes peuvent faire l'objet d'une nouvelle tentative une fois cette exception genérée. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui n'a pas pu être traitée pour cette raison. ## TimeLimitExceededException (structure) Générée lorsque l'opération dépasse le délai imparti pour celle-ci. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui n'a pas pu être traitée pour cette raison. ## TooManyRequestsException (structure) Générée lorsque le nombre de demandes traitées dépasse la limite. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande qui n'a pas pu être traitée pour cette raison. ## UnsupportedOperationException (structure) Générée lorsqu'une demande tente de lancer une opération qui n'est pas prise en charge. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question. ## UnloadUrlAccessDeniedException (structure) Générée lorsque l'accès est refusé à une URL qui est une cible de déchargement. **Champs** + **code** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Codes de statut HTTP renvoyé avec l'exception. + **detailedMessage** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). Message détaillé décrivant le problème. + **requestId** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8). ID de la demande en question.