View a markdown version of this page

ListWhatIfAnalyses - Amazon Forecast

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.

ListWhatIfAnalyses

Renvoie une liste des analyses hypothétiques créées à l'aide de l'CreateWhatIfAnalysisopération. Pour chaque analyse hypothétique, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet de propriétés en utilisant l'ARN d'analyse hypothétique associé à l'DescribeWhatIfAnalysisopération.

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

Une gamme de filtres. Pour chaque filtre, vous indiquez une condition et un énoncé de correspondance. La condition est soit IS ouIS_NOT, qui spécifie s'il faut inclure ou exclure les tâches d'analyse hypothétiques qui correspondent à l'instruction de la liste, 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 sont IS et IS_NOT. Pour inclure les tâches d'analyse hypothétiques qui correspondent à l'instruction, spécifiez. IS Pour exclure les tâches d'analyse hypothétiques correspondantes, spécifiez. IS_NOT

  • Key- Le nom du paramètre sur lequel filtrer. Les valeurs valides sont WhatIfAnalysisArn et Status.

  • Value- La valeur à égaler.

Par exemple, pour répertorier toutes les tâches qui exportent une prévision nommée électricité WhatIf, spécifiez le filtre suivant :

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

Type : tableau d’objets Filter

Obligatoire : non

MaxResults

Le nombre d'éléments à 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 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.

Modèle : .+

Obligatoire : non

Syntaxe de la réponse

{ "NextToken": "string", "WhatIfAnalyses": [ { "CreationTime": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "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.

NextToken

Si la réponse est tronquée, Forecast renvoie ce jeton. Pour récupérer la prochaine série de résultats, utilisez le jeton dans la demande suivante.

Type : Chaîne

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

Modèle : .+

WhatIfAnalyses

Tableau d'WhatIfAnalysisSummaryobjets qui décrivent les analyses correspondantes.

Type : tableau d’objets WhatIfAnalysisSummary

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

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 :