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 d'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 des propriétés en utilisant l'analyse hypothétique associée à l'ARNDescribeWhatIfAnalysisopé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
La demande accepte les données suivantes au JSON format suivant.
- Filters
-
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit
IS_NOT
,IS
soit, qui indique s'il faut inclure ou exclure de la liste les tâches d'analyse hypothétiques correspondant à l'instruction, 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 sontIS
etIS_NOT
. Pour inclure les tâches d'analyse hypothétiques correspondant à l'instruction, spécifiez.IS
Pour exclure les tâches d'analyse hypothétique correspondantes, spécifiez.IS_NOT
-
Key
- Le nom du paramètre à filtrer. Les valeurs valides sontWhatIfAnalysisArn
etStatus
. -
Value
- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches qui exportent une prévision nommée electricityWhatIf, 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'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 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 sous JSON forme formatée par le service.
- NextToken
-
Si la réponse est tronquée, 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 3 000.
Modèle :
.+
- WhatIfAnalyses
-
Tableau d'
WhatIfAnalysisSummary
objets décrivant 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.
HTTPCode de statut : 400
- InvalidNextTokenException
-
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.
HTTPCode de statut : 400
consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :