View a markdown version of this page

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

DescribeAutoPredictor

Décrit un prédicteur créé à l'aide de cette CreateAutoPredictor opé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

{ "PredictorArn": "string" }

Paramètres de demande

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

PredictorArn

Le nom de ressource Amazon (ARN) du prédicteur.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

Syntaxe de la réponse

{ "CreationTime": number, "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "ExplainabilityInfo": { "ExplainabilityArn": "string", "Status": "string" }, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "MonitorInfo": { "MonitorArn": "string", "Status": "string" }, "OptimizationMetric": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string", "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "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

Horodatage de la demande. CreateAutoPredictor

Type : Timestamp

DataConfig

La configuration des données pour votre groupe de jeux de données et tous les jeux de données supplémentaires.

Type : objet DataConfig

DatasetImportJobArns

Tableau des ARN des tâches d'importation de l'ensemble de données utilisées pour importer des données d'entraînement pour le prédicteur.

Type : tableau de chaînes

Contraintes de longueur : longueur maximale de 256.

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

EncryptionConfig

Une clé AWS Key Management Service (KMS) et un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé. Vous pouvez spécifier cet objet facultatif dans les CreatePredictor requêtes CreateDataset et.

Type : objet EncryptionConfig

EstimatedTimeRemainingInMinutes

Temps estimé restant en minutes pour terminer la tâche de formation des prédicteurs.

Type : Long

ExplainabilityInfo

Fournit le statut et l'ARN de l'explicabilité du prédicteur.

Type : objet ExplainabilityInfo

ForecastDimensions

Tableau de noms de dimensions (champs) qui spécifient les attributs utilisés pour regrouper vos séries chronologiques.

Type : tableau de chaînes

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

Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximum de 63.

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

ForecastFrequency

Fréquence des prévisions dans une prévision.

Les intervalles valides sont Y (année), M (mois), W (semaine), D (jour), H (heure), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes) et 1min (1 minute). Par exemple, « Y » indique chaque année et « 5min » indique toutes les cinq minutes.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 5.

Modèle : ^Y|M|W|D|H|30min|15min|10min|5min|1min$

ForecastHorizon

Le nombre de pas temporels que le modèle prédit. L’horizon de prévision est également appelé longueur de prédiction.

Type : Integer

ForecastTypes

Les types de prévisions utilisés lors de l'entraînement des prédicteurs. La valeur par défaut est ["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

En cas d'erreur, un message détaillant la cause de l'erreur.

Type : Chaîne

MonitorInfo

Un MonitorInfo objet avec le nom de ressource Amazon (ARN) et l'état de la ressource de surveillance.

Type : objet MonitorInfo

OptimizationMetric

La métrique de précision utilisée pour optimiser le prédicteur.

Type : Chaîne

Valeurs valides : WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PredictorArn

Le nom de ressource Amazon (ARN) du prédicteur

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

PredictorName

Le nom du prédicteur.

Type : Chaîne

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

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

ReferencePredictorSummary

L'ARN et l'état du prédicteur de référence. Ce paramètre n'est valide que pour les prédicteurs réentraînés ou mis à niveau.

Type : objet ReferencePredictorSummary

Status

État du prédicteur. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

TimeAlignmentBoundary

La limite de temps utilisée par Forecast lors de l'agrégation des données.

Type : objet TimeAlignmentBoundary

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 :