CreateForecastExportJob - Amazon Forecast
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez 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.

CreateForecastExportJob

Exporte une prévision créée par l'CreateForecastopération vers votre bucket Amazon Simple Storage Service (Amazon S3). Le nom du fichier de prévisions respectera les conventions suivantes :

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

où le composant < ExportTimestamp > est en Java SimpleDateFormat (yyyy-MM-DDTHH-MM-SSZ).

Vous devez spécifier un DataDestination objet qui inclut un rôle AWS Identity and Access Management (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour plus d’informations, consultez Configuration d'autorisations pour Amazon Forecast.

Pour plus d’informations, consultez Génération de prévisions.

Pour obtenir une liste de toutes vos tâches d'exportation de prévisions, utilisez l'ListForecastExportJobsopération.

Note

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

Syntaxe de la requête

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

Paramètres de demande

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

Destination

L'emplacement où vous souhaitez enregistrer les prévisions et le rôle AWS Identity and Access Management (IAM) qu'Amazon Forecast peut assumer pour accéder à l'emplacement. Les prévisions doivent être exportées vers un compartiment Amazon S3.

Si le chiffrement est utilisé, Destination il doit inclure une clé AWS Key Management Service (KMS). Le rôle IAM doit autoriser Amazon Forecast à accéder à la clé.

Type : objet DataDestination

Obligatoire : oui

ForecastArn

Le nom de ressource Amazon (ARN) de la prévision que vous souhaitez exporter.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

ForecastExportJobName

Nom de la tâche d'exportation des prévisions.

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

Le format des données exportées, CSV ou PARQUET. La valeur par défaut est CSV.

Type : chaîne

Contraintes de longueur : longueur maximale de 7.

Modèle : ^CSV|PARQUET$

Obligatoire : non

Tags

Les métadonnées facultatives que vous appliquez à la tâche d'exportation des prévisions pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.

Les restrictions de base suivantes s’appliquent aux balises :

  • Nombre maximum de balises par ressource : 50.

  • Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.

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

  • Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.

  • Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : + - = . _ : / @.

  • Les clés et valeurs de balise sont sensibles à la casse.

  • N'utilisez pas aws:AWS:, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. 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 compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans aws le calcul de vos balises par limite de ressources ».

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

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

ForecastExportJobArn

Le nom de ressource Amazon (ARN) de la tâche d'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

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :