View a markdown version of this page

CreateDatasetExportJob - Amazon Personalize
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

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.

CreateDatasetExportJob

Crée une tâche qui exporte les données de votre ensemble de données vers un compartiment Amazon S3. Pour autoriser Amazon Personalize à exporter les données de formation, vous devez spécifier un rôle IAM lié à un service qui donne à Amazon Personalize PutObject des autorisations pour votre compartiment Amazon S3. Pour plus d'informations, consultez la section Exporter un ensemble de données dans le guide du développeur Amazon Personalize.

Statut

Une tâche d'exportation de jeu de données peut se présenter dans l'un des états suivants :

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -ou- CREATE FAILED

Pour connaître l'état de la tâche d'exportation DescribeDatasetExportJob, appelez et spécifiez le nom de ressource Amazon (ARN) de la tâche d'exportation de l'ensemble de données. L'exportation de l'ensemble de données est terminée lorsque le statut est indiqué comme ACTIF. Si l'état indique CREATE FAILED, la réponse inclut une failureReason clé qui décrit pourquoi la tâche a échoué.

Syntaxe de la requête

{
   "datasetArn": "string",
   "ingestionMode": "string",
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

datasetArn

Le nom de ressource Amazon (ARN) du jeu de données qui contient les données à exporter.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : oui

ingestionMode

Les données à exporter, en fonction de la manière dont vous les avez importées. Vous pouvez choisir d'exporter uniquement les BULK données que vous avez importées à l'aide d'une tâche d'importation de jeux de données, uniquement les PUT données que vous avez importées de manière incrémentielle (à l'aide de la console PutUsers et PutItems des opérations), ou ALL pour les deux types. PutEvents La valeur par défaut est PUT.

Type : Chaîne

Valeurs valides : BULK | PUT | ALL

Obligatoire : non

jobName

Le nom de la tâche d'exportation de l'ensemble de données.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Modèle : ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Obligatoire : oui

jobOutput

Le chemin d'accès au compartiment Amazon S3 dans lequel la sortie de la tâche est stockée.

Type : objet DatasetExportJobOutput

Obligatoire : oui

roleArn

Le nom de ressource Amazon (ARN) du rôle de service IAM autorisé à ajouter des données à votre compartiment Amazon S3 de sortie.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Obligatoire : oui

tags

Liste des balises à appliquer à la tâche d'exportation de l'ensemble de données.

Type : tableau d’objets Tag

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.

Obligatoire : non

Syntaxe de la réponse

{
   "datasetExportJobArn": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

datasetExportJobArn

Le nom de ressource Amazon (ARN) de la tâche d'exportation de l'ensemble de données.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Erreurs

InvalidInputException

Fournissez une valeur valide pour le champ ou le paramètre.

Code d’état HTTP : 400

LimitExceededException

La limite du nombre de requêtes par seconde a été dépassée.

Code d’état HTTP : 400

ResourceAlreadyExistsException

La ressource spécifiée existe déjà.

Code d’état HTTP : 400

ResourceInUseException

La ressource spécifiée est en cours d'utilisation.

Code d’état HTTP : 400

ResourceNotFoundException

Impossible de trouver la ressource spécifiée.

Code d’état HTTP : 400

TooManyTagsException

Vous avez dépassé le nombre maximum de balises que vous pouvez appliquer à cette ressource.

Code d’état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :