View a markdown version of this page

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

Amazon Forecast n'est plus disponible pour les nouveaux clients. Les clients existants d'Amazon Forecast peuvent continuer à utiliser le service normalement. En savoir plus »

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.

CreateExplainabilityExport

Exporte une ressource d'explicabilité créée par l'CreateExplainabilityopération. Les fichiers exportés sont exportés vers un compartiment Amazon Simple Storage Service (Amazon S3).

Vous devez spécifier un DataDestination objet qui inclut un compartiment Amazon S3 et un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour de plus amples informations, veuillez consulter Configuration d'autorisations pour Amazon Forecast.

Note

La tâche Status d'exportation doit avoir lieu ACTIVE avant que vous puissiez accéder à l'exportation dans votre compartiment Amazon S3. Pour obtenir le statut, utilisez l'DescribeExplainabilityExportopération.

Syntaxe de la requête

{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ExplainabilityArn": "string",
   "ExplainabilityExportName": "string",
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Paramètres de demande

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

Destination

La destination d'un emploi dans le secteur de l'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) qui permet à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).

Type : objet DataDestination

Obligatoire : oui

ExplainabilityArn

Le nom de la ressource Amazon (ARN) de l'explicabilité à exporter.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

ExplainabilityExportName

Nom unique pour l'export Explainability.

Type : Chaîne

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

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

Obligatoire : oui

Format

Format des données exportées, CSV ou PARQUET.

Type : Chaîne

Contraintes de longueur : longueur maximale de 7.

Modèle : ^CSV|PARQUET$

Obligatoire : non

Tags

Des métadonnées facultatives pour vous aider à classer et à organiser vos ressources. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises font la distinction entre majuscules et minuscules.

Les restrictions suivantes s’appliquent aux balises :

  • Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.

  • Nombre maximum de balises par ressource : 50.

  • Longueur de clé maximale : 128 caractères Unicode. UTF-8

  • Longueur de valeur maximale : 256 caractères Unicode au UTF-8 format.

  • Caractères acceptés : toutes les lettres et tous les chiffres, les espaces peuvent être représentés et + - =. UTF-8 _ :/@. Si votre schéma de balisage est utilisé dans d'autres services et ressources, les restrictions de caractères de ces services s'appliquent également.

  • Les préfixes clés ne peuvent inclure aucune combinaison majuscule ou minuscule de ou. aws: AWS: Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a aws pour préfixe mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et sera prise en compte dans la limite de 50 balises. Les balises dont le seul préfixe clé est ne sont aws pas prises en compte dans vos balises par limite de ressource. Vous ne pouvez ni modifier ni supprimer les clés de tag avec ce préfixe.

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

{
   "ExplainabilityExportArn": "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.

ExplainabilityExportArn

Le nom de ressource Amazon (ARN) de l'exportation.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Erreurs

InvalidInputException

Nous ne pouvons pas traiter la demande car elle contient une valeur non valide ou une valeur qui dépasse la plage valide.

Code d’état HTTP : 400

LimitExceededException

La limite du nombre de ressources par compte a été dépassée.

Code d’état HTTP : 400

ResourceAlreadyExistsException

Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.

Code d’état HTTP : 400

ResourceInUseException

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

Code d’état HTTP : 400

ResourceNotFoundException

Nous ne trouvons aucune ressource portant ce nom de ressource Amazon (ARN). Vérifiez l'ARN et réessayez.

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 :