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.
ListForecasts
Renvoie la liste des prévisions créées à l'aide de l'CreateForecastopération. Pour chaque prévision, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Pour récupérer l'ensemble complet des propriétés, spécifiez l'ARN avec l'DescribeForecastopération. Vous pouvez filtrer la liste à l'aide d'un tableau d'Filterobjets.
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 »
Syntaxe de la requête
{
"Filters": [
{
"Condition": "string",
"Key": "string",
"Value": "string"
}
],
"MaxResults": number,
"NextToken": "string"
}Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
- Filters
-
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit
IS_NOT,ISsoit, qui indique s'il faut inclure ou exclure de la liste les prévisions correspondant à l'énoncé, respectivement. L'instruction match se compose d'une clé et d'une valeur.Propriétés du filtre
-
Condition- La condition à appliquer. Les valeurs valides sontISetIS_NOT. Pour inclure les prévisions correspondant à l'énoncé, spécifiezIS. Pour exclure les prévisions correspondantes, spécifiezIS_NOT. -
Key- Le nom du paramètre à filtrer. Les valeurs valides sontDatasetGroupArn,PredictorArnetStatus. -
Value- La valeur à égaler.
Par exemple, pour répertorier toutes les prévisions dont le statut n'est pas ACTIF, vous devez spécifier :
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]Type : tableau d’objets Filter
Obligatoire : non
-
- MaxResults
-
Le nombre d'articles à renvoyer dans la réponse.
Type : entier
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.
Obligatoire : non
- NextToken
-
Si le résultat de la demande précédente a été tronqué, la réponse inclut un
NextToken. 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 : String
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.
Modèle :
.+Obligatoire : non
Syntaxe de la réponse
{
"Forecasts": [
{
"CreatedUsingAutoPredictor": boolean,
"CreationTime": number,
"DatasetGroupArn": "string",
"ForecastArn": "string",
"ForecastName": "string",
"LastModificationTime": number,
"Message": "string",
"PredictorArn": "string",
"Status": "string"
}
],
"NextToken": "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.
- Forecasts
-
Tableau d'objets qui récapitule les propriétés de chaque prévision.
Type : tableau d’objets ForecastSummary
- NextToken
-
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.
Modèle :
.+
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
- InvalidNextTokenException
-
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.
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 :
