View a markdown version of this page

QueryWhatIfForecast - 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.

QueryWhatIfForecast

Récupère une prévision hypothétique.

Syntaxe de la requête

{
   "EndDate": "string",
   "Filters": { 
      "string" : "string" 
   },
   "NextToken": "string",
   "StartDate": "string",
   "WhatIfForecastArn": "string"
}

Paramètres de demande

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

EndDate

Date de fin des prévisions hypothétiques. Spécifiez la date en utilisant le format suivant : aaaa- MM-dd « T » HH:mm:ss (format ISO 8601). Par exemple, 2015-01-01T20:00:00.

Type : chaîne

Obligatoire : non

Filters

Les critères de filtrage à appliquer lors de la récupération de la prévision. Par exemple, pour obtenir les prévisions pour le jeu client_21 de données de consommation d'électricité, spécifiez ce qui suit :

{"item_id" : "client_21"}

Pour obtenir les prévisions hypothétiques complètes, utilisez l'CreateForecastExportJobopération.

Type : mappage chaîne/chaîne

Entrées sur la carte : nombre maximum de 50 éléments.

Contraintes relatives à la longueur des touches : longueur maximale de 256.

Modèle de clé :^[a-zA-Z0-9\_\-]+$

Contraintes de longueur des valeurs : longueur maximale de 256.

Obligatoire : oui

NextToken

Si le résultat de la demande précédente a été tronqué, la réponse inclut un. NextToken Pour récupérer la prochaine série de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.

Obligatoire : non

StartDate

Date de début des prévisions hypothétiques. Spécifiez la date en utilisant le format suivant : aaaa- MM-dd « T » HH:mm:ss (format ISO 8601). Par exemple, 2015-01-01T08:00:00.

Type : chaîne

Obligatoire : non

WhatIfForecastArn

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

Type : Chaîne

Contraintes de longueur : longueur maximale de 300.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "Forecast": { 
      "Predictions": { 
         "string" : [ 
            { 
               "Timestamp": "string",
               "Value": number
            }
         ]
      }
   }
}

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.

Forecast

Fournit des informations sur une prévision. Renvoyé dans le cadre de la QueryForecast réponse.

Type : objet Forecast

Erreurs

InvalidInputException

La valeur n'est pas valide ou est trop longue.

Code d’état HTTP : 400

InvalidNextTokenException

Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.

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

ResourceInUseException

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

Code d’état HTTP : 400

ResourceNotFoundException

Nous ne trouvons pas cette ressource. Vérifiez les informations que vous avez fournies 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 :