DescribeWhatIfAnalysis - 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.

DescribeWhatIfAnalysis

Décrit l'analyse hypothétique créée à l'aide de l'CreateWhatIfAnalysisopé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 »

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

  • CreationTime

  • LastModificationTime

  • Message- Si une erreur s'est produite, informations sur l'erreur.

  • Status

Syntaxe de la requête

{
   "WhatIfAnalysisArn": "string"
}

Paramètres de demande

La demande accepte les données suivantes au JSON format suivant.

WhatIfAnalysisArn

Le nom de la ressource Amazon (ARN) de l'analyse hypothétique qui vous intéresse.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "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.

CreationTime

Quand l'analyse hypothétique a été créée.

Type : Timestamp

EstimatedTimeRemainingInMinutes

Temps approximatif restant pour terminer l'analyse hypothétique, en minutes.

Type : long

ForecastArn

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

Type : String

Contraintes de longueur : longueur maximale de 256.

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

LastModificationTime

La dernière fois que la ressource a été modifiée. 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 le travail s'est terminé ou a échoué.

Type : Timestamp

Message

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

Type : String

Status

État de l'analyse 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

L'Statusanalyse hypothétique doit avoir lieu ACTIVE avant que vous puissiez accéder à l'analyse.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

TimeSeriesSelector

Définit l'ensemble des séries chronologiques utilisées pour créer les prévisions dans un TimeSeriesIdentifiers objet.

L'TimeSeriesIdentifiersobjet a besoin des informations suivantes :

  • DataSource

  • Format

  • Schema

Type : objet TimeSeriesSelector

WhatIfAnalysisArn

Le nom de la ressource Amazon (ARN) de l'analyse hypothétique.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

WhatIfAnalysisName

Le nom de l'analyse hypothétique.

Type : String

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.

HTTPCode de statut : 400

ResourceNotFoundException

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

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 :