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

QueryForecast

Récupère une prévision pour un seul article, filtrée selon les critères fournis.

Le critère est une paire clé-valeur. La clé provient soit de l'ensemble de TARGET_TIME_SERIES données item_id (ou du champ équivalent non horodatage, non cible), soit de l'une des dimensions de prévision spécifiées dans l'objet. FeaturizationConfig

Par défaut, QueryForecast renvoie la plage de dates complète pour la prévision filtrée. Vous pouvez demander une plage de dates spécifique.

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

Note

Les prévisions générées par Amazon Forecast se situent dans le même fuseau horaire que le jeu de données utilisé pour créer le prédicteur.

Syntaxe de la requête

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

Paramètres de demande

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

EndDate

Date de fin de la prévision. Spécifiez la date au format suivant : YYYY-MM-DD'T'HH:MM:SS (format ISO 8601). Par exemple, 2015-01-01T 20:00:00.

Type : chaîne

Obligatoire : non

Filters

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

{"item_id" : "client_21"}

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

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre maximum de 50 éléments.

Contraintes relatives à la longueur des clés : longueur maximale de 256.

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

Contraintes de longueur de valeur : longueur maximale de 256.

Obligatoire : oui

ForecastArn

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

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

NextToken

Si le résultat de la demande précédente a été tronqué, la réponse inclut unNextToken. Pour récupérer le prochain ensemble 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 de la prévision. Spécifiez la date au format suivant : YYYY-MM-DD'T'HH:MM:SS (format ISO 8601). Par exemple, 2015-01-01T 08:00:00.

Type : chaîne

Obligatoire : non

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

Les prévisions.

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 demandes 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

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 :