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 »](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

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
<a name="API_DescribeForecast"></a>

Décrit une prévision créée à l'aide de l'[CreateForecast](API_CreateForecast.md)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 »](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

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
<a name="API_DescribeForecast_RequestSyntax"></a>

```
{
   "ForecastArn": "string"
}
```

## Paramètres de demande
<a name="API_DescribeForecast_RequestParameters"></a>

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

 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) **   <a name="forecast-DescribeForecast-request-ForecastArn"></a>
Le nom de ressource Amazon (ARN) de la prévision.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Syntaxe de la réponse
<a name="API_DescribeForecast_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeForecast_ResponseElements"></a>

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](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-CreationTime"></a>
Quand la tâche de création des prévisions a été créée.  
Type : Timestamp

 ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-DatasetGroupArn"></a>
L'ARN du groupe de jeux de données qui a fourni les données utilisées pour entraîner le prédicteur.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-EstimatedTimeRemainingInMinutes"></a>
Le temps restant estimé, en minutes, pour terminer la tâche de prévision.  
Type : Long

 ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastArn"></a>
L'ARN de prévision tel que spécifié dans la demande.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastName](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastName"></a>
Le nom de la prévision.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastTypes"></a>
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](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-LastModificationTime"></a>
La dernière fois que la ressource a été modifiée. L'horodatage dépend du statut de la tâche :  
+  `CREATE_PENDING`- Le`CreationTime`.
+  `CREATE_IN_PROGRESS`- L'horodatage actuel.
+  `CREATE_STOPPING`- L'horodatage actuel.
+  `CREATE_STOPPED`- Quand le travail s'est arrêté.
+  `ACTIVE`ou `CREATE_FAILED` - Lorsque le travail s'est terminé ou a échoué.
Type : Timestamp

 ** [Message](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-PredictorArn"></a>
L'ARN du prédicteur utilisé pour générer la prévision.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Status](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Status"></a>
É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` 
La prévision doit `Status` l'être `ACTIVE` avant que vous puissiez l'interroger ou l'exporter.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-TimeSeriesSelector"></a>
La série chronologique à inclure dans les prévisions.  
Type : objet [TimeSeriesSelector](API_TimeSeriesSelector.md)

## Erreurs
<a name="API_DescribeForecast_Errors"></a>

 ** 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
<a name="API_DescribeForecast_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecast)