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

DescribeForecast

Décrit une prévision créée à l'aide de l'CreateForecastopé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 CreateForecast demande, cette opération répertorie les propriétés suivantes :

  • DatasetGroupArn- Le groupe de jeux de données qui a fourni les données d'entraînement.

  • CreationTime

  • LastModificationTime

  • Status

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

Syntaxe de la requête

{ "ForecastArn": "string" }

Paramètres de demande

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

ForecastArn

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

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, "DatasetGroupArn": "string", "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "ForecastName": "string", "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "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 la tâche de création des prévisions a été créée.

Type : Timestamp

DatasetGroupArn

Le groupe ARN de jeux de données qui a fourni les données utilisées pour entraîner le prédicteur.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

EstimatedTimeRemainingInMinutes

Le temps restant estimé, en minutes, pour terminer la tâche de prévision.

Type : long

ForecastArn

La prévision ARN telle que spécifiée dans la demande.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

ForecastName

Le nom de la prévision.

Type : String

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

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

ForecastTypes

Quantiles à partir desquels les prévisions probabilistes ont été générées.

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

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

PredictorArn

Le ARN prédicteur utilisé pour générer la prévision.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

Status

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

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Note

La prévision doit Status l'être ACTIVE avant que vous puissiez l'interroger ou l'exporter.

Type : String

Contraintes de longueur : longueur maximale de 256.

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

TimeSeriesSelector

La série chronologique à inclure dans les prévisions.

Type : objet TimeSeriesSelector

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 :