ListWhatIfForecastExports - Amazon Forecast
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez 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.

ListWhatIfForecastExports

Renvoie une liste d'exportations de prévisions hypothétiques créées à l'aide de l'CreateWhatIfForecastExportopération. Pour chaque exportation de prévisions hypothétiques, 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'exportation des prévisions hypothétiques ARN avec l'DescribeWhatIfForecastExportopé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 le JSON format des données suivantes.

Filters

Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est l'une IS ou l'autreIS_NOT, qui indique s'il faut inclure ou exclure de la liste les tâches d'exportation prévisionnelles qui correspondent à 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 sont IS et IS_NOT. Pour inclure les tâches d'exportation de prévisions correspondant à l'instruction, spécifiezIS. Pour exclure les tâches d'exportation de prévisions correspondantes, spécifiezIS_NOT.

  • Key- Le nom du paramètre à filtrer. Les valeurs valides sont WhatIfForecastExportArn et Status.

  • Value- La valeur à égaler.

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

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

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 unNextToken. Pour récupérer le prochain ensemble de résultats, utilisez le jeton du prochain demande. 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

{
   "NextToken": "string",
   "WhatIfForecastExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfForecastArns": [ "string" ],
         "WhatIfForecastExportArn": "string",
         "WhatIfForecastExportName": "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 3000.

Modèle : .+

WhatIfForecastExports

Tableau d'WhatIfForecastExportsobjets décrivant les exportations de prévisions correspondantes.

Type : tableau d’objets WhatIfForecastExportSummary

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 :