View a markdown version of this page

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

DescribeWhatIfForecast

Décrit les prévisions hypothétiques créées à l'aide de cette opération. CreateWhatIfForecast

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 »

Outre la liste des propriétés fournies dans la CreateWhatIfForecast demande, cette opération répertorie les propriétés suivantes :

  • CreationTime

  • LastModificationTime

  • Message- En cas d'erreur, informations sur l'erreur.

  • Status

Syntaxe de la requête

{
   "WhatIfForecastArn": "string"
}

Paramètres de demande

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

WhatIfForecastArn

Le nom de ressource Amazon (ARN) de la prévision hypothétique qui vous intéresse.

Type : Chaîne

Contraintes de longueur : longueur maximale de 300.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesReplacementsDataSource": { 
      "Format": "string",
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      },
      "Schema": { 
         "Attributes": [ 
            { 
               "AttributeName": "string",
               "AttributeType": "string"
            }
         ]
      },
      "TimestampFormat": "string"
   },
   "TimeSeriesTransformations": [ 
      { 
         "Action": { 
            "AttributeName": "string",
            "Operation": "string",
            "Value": number
         },
         "TimeSeriesConditions": [ 
            { 
               "AttributeName": "string",
               "AttributeValue": "string",
               "Condition": "string"
            }
         ]
      }
   ],
   "WhatIfAnalysisArn": "string",
   "WhatIfForecastArn": "string",
   "WhatIfForecastName": "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.

CreationTime

Quand la prévision hypothétique a été créée.

Type : Timestamp

EstimatedTimeRemainingInMinutes

Temps approximatif restant pour terminer les prévisions hypothétiques, en minutes.

Type : Long

ForecastTypes

Quantiles auxquels les prévisions probabilistes sont générées. Vous pouvez spécifier jusqu'à cinq quantiles par prévision hypothétique au cours de l'opération. CreateWhatIfForecast Si vous n'avez pas spécifié de quantiles, les valeurs par défaut sont["0.1", "0.5", "0.9"].

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 20 éléments.

Contraintes de longueur : longueur minimale de 2. Longueur maximale de 4.

Modèle : (^0?\.\d\d?$|^mean$)

LastModificationTime

Dernière modification de la ressource. L'horodatage dépend du statut de la tâche :

  • CREATE_PENDING- LeCreationTime.

  • CREATE_IN_PROGRESS- L'horodatage actuel.

  • CREATE_STOPPING- L'horodatage actuel.

  • CREATE_STOPPED- Quand le travail s'est arrêté.

  • ACTIVEou CREATE_FAILED : lorsque la tâche s'est terminée ou a échoué.

Type : Timestamp

Message

Si une erreur s'est produite, un message d'information concernant l'erreur.

Type : Chaîne

Status

État de la prévision hypothétique. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Note

Vous devez Status disposer de la prévision hypothétique pour que vous ACTIVE puissiez accéder à la prévision.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

TimeSeriesReplacementsDataSource

Tableau d'FormatélémentsS3Config,Schema, et décrivant la série chronologique de remplacement.

Type : objet TimeSeriesReplacementsDataSource

TimeSeriesTransformations

Tableau Action et TimeSeriesConditions éléments décrivant les transformations qui ont été appliquées à telle ou telle série chronologique.

Type : tableau d’objets TimeSeriesTransformation

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 30 articles.

WhatIfAnalysisArn

Le nom de ressource Amazon (ARN) de l'analyse hypothétique qui contient cette prévision.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

WhatIfForecastArn

Le nom de ressource Amazon (ARN) de la prévision hypothétique.

Type : Chaîne

Contraintes de longueur : longueur maximale de 300.

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

WhatIfForecastName

Le nom de la prévision hypothétique.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Modèle : ^[a-zA-Z][a-zA-Z0-9_]*

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

ResourceNotFoundException

Nous ne trouvons aucune ressource portant ce nom de ressource Amazon (ARN). Vérifiez l'ARN et réessayez.

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 :