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

CreateWhatIfForecastExport

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

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

Le composant < ExportTimestamp > est en Java SimpleDateFormat (YYYY-MM-DDTHH-MM-SSZ).

Important

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 »

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 de plus amples informations, veuillez consulter Configuration d'autorisations pour Amazon Forecast.

Pour de plus amples informations, veuillez consulter Génération de prévisions.

Pour obtenir une liste de toutes vos tâches d'exportation de prévisions hypothétiques, utilisez l'ListWhatIfForecastExportsopé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'DescribeWhatIfForecastExportopération.

Syntaxe de la requête

{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportName": "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

Format

Le format des données exportées, CSV ou PARQUET.

Type : String

Contraintes de longueur : longueur maximale de 7.

Modèle : ^CSV|PARQUET$

Obligatoire : non

Tags

Une liste de balises à appliquer aux prévisions hypothétiques.

Type : tableau d’objets Tag

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

Obligatoire : non

WhatIfForecastArns

La liste des prévisions hypothétiques Amazon Resource Names (ARNs) à exporter.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.

Contraintes de longueur : longueur maximale de 300.

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

Obligatoire : oui

WhatIfForecastExportName

Nom de la prévision hypothétique à exporter.

Type : String

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

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

Obligatoire : oui

Syntaxe de la réponse

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

WhatIfForecastExportArn

Le nom de ressource Amazon (ARN) de la prévision hypothétique.

Type : String

Contraintes de longueur : longueur maximale de 300.

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 langages spécifiques AWS SDKs, consultez ce qui suit :