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.

# Amazon Forecast Service
<a name="API_Operations_Amazon_Forecast_Service"></a>

Les actions suivantes sont prises en charge par Amazon Forecast Service :
+  [CreateAutoPredictor](API_CreateAutoPredictor.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateExplainability](API_CreateExplainability.md) 
+  [CreateExplainabilityExport](API_CreateExplainabilityExport.md) 
+  [CreateForecast](API_CreateForecast.md) 
+  [CreateForecastExportJob](API_CreateForecastExportJob.md) 
+  [CreateMonitor](API_CreateMonitor.md) 
+  [CreatePredictor](API_CreatePredictor.md) 
+  [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) 
+  [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 
+  [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 
+  [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) 
+  [DeleteExplainability](API_DeleteExplainability.md) 
+  [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) 
+  [DeleteForecast](API_DeleteForecast.md) 
+  [DeleteForecastExportJob](API_DeleteForecastExportJob.md) 
+  [DeleteMonitor](API_DeleteMonitor.md) 
+  [DeletePredictor](API_DeletePredictor.md) 
+  [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) 
+  [DeleteResourceTree](API_DeleteResourceTree.md) 
+  [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) 
+  [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) 
+  [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) 
+  [DescribeAutoPredictor](API_DescribeAutoPredictor.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeExplainability](API_DescribeExplainability.md) 
+  [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) 
+  [DescribeForecast](API_DescribeForecast.md) 
+  [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 
+  [DescribeMonitor](API_DescribeMonitor.md) 
+  [DescribePredictor](API_DescribePredictor.md) 
+  [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) 
+  [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) 
+  [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 
+  [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 
+  [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListExplainabilities](API_ListExplainabilities.md) 
+  [ListExplainabilityExports](API_ListExplainabilityExports.md) 
+  [ListForecastExportJobs](API_ListForecastExportJobs.md) 
+  [ListForecasts](API_ListForecasts.md) 
+  [ListMonitorEvaluations](API_ListMonitorEvaluations.md) 
+  [ListMonitors](API_ListMonitors.md) 
+  [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) 
+  [ListPredictors](API_ListPredictors.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) 
+  [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) 
+  [ListWhatIfForecasts](API_ListWhatIfForecasts.md) 
+  [ResumeResource](API_ResumeResource.md) 
+  [StopResource](API_StopResource.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatasetGroup](API_UpdateDatasetGroup.md) 

# CreateAutoPredictor
<a name="API_CreateAutoPredictor"></a>

Crée un prédicteur Amazon Forecast.

**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/) 

Amazon Forecast crée des prédicteurs avec AutoPredictor, ce qui implique d'appliquer la combinaison optimale d'algorithmes à chaque série chronologique de vos ensembles de données. Vous pouvez les utiliser [CreateAutoPredictor](#API_CreateAutoPredictor) pour créer de nouveaux prédicteurs ou mettre à niveau/réentraîner les prédicteurs existants.

 **Création de nouveaux prédicteurs** 

Les paramètres suivants sont requis lors de la création d'un nouveau prédicteur :
+  `PredictorName`- Un nom unique pour le prédicteur.
+  `DatasetGroupArn`- L'ARN du groupe de données utilisé pour entraîner le prédicteur.
+  `ForecastFrequency`- La granularité de vos prévisions (horaires, quotidiennes, hebdomadaires, etc.).
+  `ForecastHorizon`- Le nombre d'étapes temporelles prédites par le modèle. L’horizon de prévision est également appelé longueur de prédiction.

Lorsque vous créez un nouveau prédicteur, ne spécifiez pas de valeur pour`ReferencePredictorArn`.

 **Mise à niveau et réentraînement des prédicteurs** 

Les paramètres suivants sont requis lors du réentraînement ou de la mise à niveau d'un prédicteur :
+  `PredictorName`- Un nom unique pour le prédicteur.
+  `ReferencePredictorArn`- L'ARN du prédicteur à réentraîner ou à améliorer.

Lors de la mise à niveau ou du réentraînement d'un prédicteur, spécifiez uniquement des valeurs pour le `ReferencePredictorArn` et. `PredictorName` 

## Syntaxe de la requête
<a name="API_CreateAutoPredictor_RequestSyntax"></a>

```
{
   "DataConfig": { 
      "AdditionalDatasets": [ 
         { 
            "Configuration": { 
               "string" : [ "string" ]
            },
            "Name": "string"
         }
      ],
      "AttributeConfigs": [ 
         { 
            "AttributeName": "string",
            "Transformations": { 
               "string" : "string" 
            }
         }
      ],
      "DatasetGroupArn": "string"
   },
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "ExplainPredictor": boolean,
   "ForecastDimensions": [ "string" ],
   "ForecastFrequency": "string",
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "MonitorConfig": { 
      "MonitorName": "string"
   },
   "OptimizationMetric": "string",
   "PredictorName": "string",
   "ReferencePredictorArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeAlignmentBoundary": { 
      "DayOfMonth": number,
      "DayOfWeek": "string",
      "Hour": number,
      "Month": "string"
   }
}
```

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

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

 ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-DataConfig"></a>
La configuration des données de votre groupe de jeux de données et de tous les ensembles de données supplémentaires.  
Type : objet [DataConfig](API_DataConfig.md)  
Obligatoire : non

 ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-EncryptionConfig"></a>
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](API_CreatePredictor.md) demandes [CreateDataset](API_CreateDataset.md) et.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)  
Obligatoire : non

 ** [ExplainPredictor](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ExplainPredictor"></a>
Créez une ressource d'explicabilité pour le prédicteur.  
Type : booléen  
Obligatoire : non

 ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastDimensions"></a>
Tableau de noms de dimensions (champs) indiquant comment regrouper les prévisions générées.  
Par exemple, si vous générez des prévisions pour les ventes d'articles dans tous vos magasins et que votre jeu de données contient un `store_id` champ, vous devez le spécifier `store_id` comme dimension pour regrouper les prévisions de ventes pour chaque boutique.  
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_]*`   
Obligatoire : non

 ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastFrequency"></a>
Fréquence des prédictions contenues dans une prévision.  
Les intervalles valides sont un nombre entier suivi de Y (année), M (mois), W (semaine), D (jour), H (heure) et min (minute). Par exemple, « 1D » indique tous les jours et « 15min » indique toutes les 15 minutes. Vous ne pouvez pas spécifier une valeur qui chevaucherait la fréquence supérieure suivante. Cela signifie, par exemple, que vous ne pouvez pas spécifier une fréquence de 60 minutes, car cela équivaut à 1 heure. Les valeurs valides pour chaque fréquence sont les suivantes :  
+ Minute : 1 à 59
+ Heure : 1 à 23
+ Jour : 1 à 6
+ Semaine : 1 à 4
+ Mois : 1 à 11
+ Année : 1
Ainsi, si vous souhaitez des prévisions toutes les deux semaines, spécifiez « 2W ». Ou, si vous souhaitez des prévisions trimestrielles, spécifiez « 3M ».  
La fréquence doit être supérieure ou égale à la fréquence du jeu de données TARGET\$1TIME\$1SERIES.  
Lorsqu'un jeu de données RELATED\$1TIME\$1SERIES est fourni, la fréquence doit être égale à la fréquence du jeu de données RELATED\$1TIME\$1SERIES.  
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$`   
Obligatoire : non

 ** [ForecastHorizon](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastHorizon"></a>
Nombre d'étapes temporelles prédites par le modèle. L’horizon de prévision est également appelé longueur de prédiction.  
L'horizon de prévision maximal est le moins élevé des valeurs suivantes : 500 pas temporels ou 1/4 de la longueur du jeu de données TARGET\$1TIME\$1SERIES. Si vous réentraînez un objet existant AutoPredictor, l'horizon de prévision maximal est le moins élevé des deux montants suivants : 500 pas temporels ou 1/3 de la longueur du jeu de données TARGET\$1TIME\$1SERIES.  
Si vous effectuez une mise à niveau AutoPredictor ou que vous reformez un existant AutoPredictor, vous ne pouvez pas mettre à jour le paramètre de l'horizon de prévision. Vous pouvez répondre à cette exigence en fournissant des séries chronologiques plus longues dans le jeu de données.  
Type : Integer  
Obligatoire : non

 ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastTypes"></a>
Les types de prévisions utilisés pour entraîner un prédicteur. Vous pouvez spécifier jusqu'à cinq types de prévisions. Les types de prévisions peuvent être des quantiles compris entre 0,01 et 0,99, par incréments de 0,01 ou plus. Vous pouvez également spécifier la prévision moyenne avec`mean`.  
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$)`   
Obligatoire : non

 ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-MonitorConfig"></a>
Détails de configuration pour la surveillance des prédicteurs. Donnez un nom à la ressource de surveillance afin d'activer la surveillance des prédicteurs.  
La surveillance des prédicteurs vous permet de voir comment les performances de votre prédicteur évoluent au fil du temps. Pour plus d'informations, consultez [Predictor Monitoring](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html).  
Type : objet [MonitorConfig](API_MonitorConfig.md)  
Obligatoire : non

 ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-OptimizationMetric"></a>
Mesure de précision utilisée pour optimiser le prédicteur.  
Type : Chaîne  
Valeurs valides : `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
Obligatoire : non

 ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-PredictorName"></a>
Nom unique pour le 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_]*`   
Obligatoire : oui

 ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ReferencePredictorArn"></a>
L'ARN du prédicteur à réentraîner ou à améliorer. Ce paramètre est uniquement utilisé lors du réentraînement ou de la mise à niveau d'un prédicteur. Lorsque vous créez un nouveau prédicteur, ne spécifiez pas de valeur pour ce paramètre.  
Lors de la mise à niveau ou du réentraînement d'un prédicteur, spécifiez uniquement des valeurs pour le `ReferencePredictorArn` et. `PredictorName` La valeur de `PredictorName` doit être un nom de prédicteur unique.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : non

 ** [Tags](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-Tags"></a>
Des métadonnées facultatives pour vous aider à classer et à organiser vos prédicteurs. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises distinguent les majuscules et minuscules.  
Les restrictions suivantes s’appliquent aux balises :  
+ Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.
+ Nombre maximum de balises par ressource : 50.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Caractères acceptés : toutes les lettres et tous les chiffres, les espaces représentables en UTF-8, et \$1 - =. \$1 :/@. Si votre schéma de balisage est utilisé pour d'autres services et ressources, les restrictions relatives aux caractères de ces services s'appliquent également. 
+ Les préfixes clés ne peuvent inclure aucune combinaison majuscules ou minuscules de ou. `aws:` `AWS:` Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ». Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe.
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-TimeAlignmentBoundary"></a>
La limite temporelle utilisée par Forecast pour aligner et agréger les données qui ne correspondent pas à la fréquence de vos prévisions. Indiquez l'unité de temps et la limite de temps sous forme de paire clé-valeur. Pour plus d'informations sur la définition d'une limite de temps, consultez la section [Spécification d'une limite de temps](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). Si vous ne fournissez pas de limite de temps, Forecast utilise un ensemble de [limites temporelles par défaut](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries).  
Type : objet [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md)  
Obligatoire : non

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

```
{
   "PredictorArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateAutoPredictor_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.

 ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) **   <a name="forecast-CreateAutoPredictor-response-PredictorArn"></a>
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:.*:.*:.+` 

## Erreurs
<a name="API_CreateAutoPredictor_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateAutoPredictor_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/CreateAutoPredictor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateAutoPredictor) 

# CreateDataset
<a name="API_CreateDataset"></a>

Crée un jeu de données Amazon Forecast. 

**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/) 

Les informations relatives au jeu de données de données que vous fournissez aident Forecast à comprendre comment utiliser les données pour l'entraînement de modèle. Cela inclut les éléments suivants :
+  * `DataFrequency` * : la fréquence à laquelle vos données de séries temporelles historiques sont collectées.
+  * `Domain` * et * `DatasetType` * : chaque jeu de données possède un domaine de jeu de données associé et un type au sein du domaine. Amazon Forecast fournit une liste de domaines et de types prédéfinis au sein de chaque domaine. Pour chaque domaine et type de jeu de données unique au sein du domaine, Amazon Forecast nécessite que vos données incluent un ensemble minimal de champs prédéfinis.
+  * `Schema` * : un schéma spécifie les champs du jeu de données, y compris le nom du champ et le type de données.

Après avoir créé un jeu de données, vous y importez vos données d'entraînement et ajoutez le jeu de données à un groupe de jeux de données. Vous utilisez le groupe de jeux de données pour créer un prédicteur. Pour plus d'informations, veuillez consulter la rubrique [Importation de jeux de données](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

Pour obtenir la liste de tous vos ensembles de données, utilisez l'[ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)opération.

Par exemple, les ensembles de données Forecast, consultez le [ GitHubréférentiel Amazon Forecast Sample](https://github.com/aws-samples/amazon-forecast-samples).

**Note**  
Le paramètre `Status` d'un ensemble de données doit avoir la valeur `ACTIVE` pour rendre possible l'importation de données de formation. Utilisez l'opération [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) pour obtenir le statut.

## Syntaxe de la requête
<a name="API_CreateDataset_RequestSyntax"></a>

```
{
   "DataFrequency": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DataFrequency](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DataFrequency"></a>
La fréquence de collecte des données. Ce paramètre est obligatoire pour les jeux de données RELATED\$1TIME\$1SERIES.  
Les intervalles valides sont un nombre entier suivi de Y (année), M (mois), W (semaine), D (jour), H (heure) et min (minute). Par exemple, « 1D » indique tous les jours et « 15min » indique toutes les 15 minutes. Vous ne pouvez pas spécifier une valeur qui chevaucherait la fréquence supérieure suivante. Cela signifie, par exemple, que vous ne pouvez pas spécifier une fréquence de 60 minutes, car cela équivaut à 1 heure. Les valeurs valides pour chaque fréquence sont les suivantes :  
+ Minute : 1 à 59
+ Heure : 1 à 23
+ Jour : 1 à 6
+ Semaine : 1 à 4
+ Mois : 1 à 11
+ Année : 1
Ainsi, si vous souhaitez des prévisions toutes les deux semaines, spécifiez « 2W ». Ou, si vous souhaitez des prévisions trimestrielles, spécifiez « 3M ».  
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$`   
Obligatoire : non

 ** [DatasetName](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetName"></a>
Nom de l'ensemble de données.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [DatasetType](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetType"></a>
Le type de jeu de données. Les valeurs valides dépendent de la valeur choisie`Domain`.  
Type : Chaîne  
Valeurs valides : `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
Obligatoire : oui

 ** [Domain](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Domain"></a>
Le domaine associé au jeu de données. Lorsque vous ajoutez un ensemble de données à un groupe de jeux de données, cette valeur et celle spécifiée pour le `Domain` paramètre de l'[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)opération doivent correspondre.  
Les `Domain` et `DatasetType` que vous choisissez déterminent les champs qui doivent être présents dans les données d'entraînement que vous importez dans le jeu de données. Par exemple, si vous choisissez le `RETAIL` domaine et `TARGET_TIME_SERIES` comme tels`DatasetType`, Amazon Forecast exige `item_id``timestamp`, et `demand` les champs devant figurer dans vos données. Pour plus d'informations, veuillez consulter la rubrique [Importation de jeux de données](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).  
Type : Chaîne  
Valeurs valides : `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Obligatoire : oui

 ** [EncryptionConfig](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-EncryptionConfig"></a>
Une clé AWS Key Management Service (KMS) et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)  
Obligatoire : non

 ** [Schema](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Schema"></a>
Le schéma du jeu de données. Les attributs du schéma et leur ordre doivent correspondre aux champs de vos données. Les jeux de données `Domain` et `DatasetType` que vous choisissez déterminent les champs obligatoires minimaux dans vos données d'entraînement. Pour plus d'informations sur les champs obligatoires pour un domaine et un type de jeu de données spécifiques, veuillez consulter la rubrique [Domaines de jeux de données et types de jeux de données](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).  
Type : objet [Schema](API_Schema.md)  
Obligatoire : oui

 ** [Tags](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Tags"></a>
Les métadonnées facultatives que vous appliquez à l'ensemble de données pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "DatasetArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateDataset_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.

 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="forecast-CreateDataset-response-DatasetArn"></a>
L'Amazon Resource Name (ARN) du jeu de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateDataset_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_CreateDataset_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/CreateDataset) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDataset) 

# CreateDatasetGroup
<a name="API_CreateDatasetGroup"></a>

Crée un groupe de jeux de données qui contient une collection de jeux de données connexes. Vous pouvez ajouter des ensembles de données au groupe de jeux de données lorsque vous créez le groupe de jeux de données, ou ultérieurement en utilisant l'[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)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/) 

Après avoir créé un groupe de jeux de données et y avoir ajouté des jeux de données, vous utilisez le groupe de jeux de données lorsque vous créez un prédicteur. Pour plus d'informations, veuillez consulter la rubrique [Groupe de jeux de données](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

Pour obtenir la liste de tous vos groupes de jeux de données, utilisez l'[ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)opération.

**Note**  
Le `Status` d'un groupe de jeux de données doit être `ACTIVE` avant de pouvoir l'utiliser pour créer un prédicteur. Pour obtenir le statut, utilisez l'[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)opération.

## Syntaxe de la requête
<a name="API_CreateDatasetGroup_RequestSyntax"></a>

```
{
   "DatasetArns": [ "string" ],
   "DatasetGroupName": "string",
   "Domain": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetArns"></a>
Tableau des Amazon Resource Names (ARNs) des ensembles de données que vous souhaitez inclure dans le groupe de jeux de données.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : non

 ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetGroupName"></a>
Nom du groupe de jeux de données.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [Domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Domain"></a>
Le domaine associé au groupe de jeux de données. Lorsque vous ajoutez un ensemble de données à un groupe de jeux de données, cette valeur et celle spécifiée pour le `Domain` paramètre de l'[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)opération doivent correspondre.  
Le `Domain` et le `DatasetType` que vous choisissez déterminent les champs qui doivent être présents dans les données d'entraînement que vous importez dans un jeu de données. Par exemple, si vous choisissez le domaine `RETAIL` et `TARGET_TIME_SERIES` en tant que `DatasetType`, Amazon Forecast exige que les champs `item_id`, `timestamp` et `demand` soient présents dans vos données. Pour plus d'informations, veuillez consulter la rubrique [Groupe de jeux de données](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).  
Type : Chaîne  
Valeurs valides : `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Obligatoire : oui

 ** [Tags](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Tags"></a>
Les métadonnées facultatives que vous appliquez au groupe de jeux de données pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "DatasetGroupArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateDatasetGroup_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.

 ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="forecast-CreateDatasetGroup-response-DatasetGroupArn"></a>
L'Amazon Resource Name (ARN) du groupe de jeux de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateDatasetGroup_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateDatasetGroup_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/CreateDatasetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup) 

# CreateDatasetImportJob
<a name="API_CreateDatasetImportJob"></a>

Importe vos données d'entraînement dans un ensemble de données Amazon Forecast. Vous indiquez l'emplacement de vos données d'entraînement dans un bucket Amazon Simple Storage Service (Amazon S3) ainsi que le nom de ressource Amazon (ARN) de l'ensemble de données dans lequel vous souhaitez importer les données.

**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/) 

Vous devez spécifier un [DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html)objet qui inclut un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder aux données, car Amazon Forecast crée une copie de vos données et les traite dans un AWS système interne. Pour plus d'informations, consultez la section [Configurer les autorisations](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html).

Les données d'entraînement doivent être au format CSV ou Parquet. Le délimiteur doit être une virgule (,).

Vous pouvez spécifier le chemin d'accès à un fichier spécifique, au compartiment S3 ou à un dossier du compartiment S3. Dans les deux derniers cas, Amazon Forecast importe tous les fichiers dans la limite de 10 000 fichiers.

Comme les importations de jeux de données ne sont pas agrégées, votre importation de jeu de données la plus récente est celle qui est utilisée lors de l'entraînement d'un prédicteur ou de la génération d'une prévision. Assurez-vous que votre dernier jeu de données importé contient toutes les données à partir desquelles vous souhaitez modéliser, et pas uniquement les nouvelles données collectées depuis l'importation précédente.

Pour obtenir une liste de toutes vos tâches d'importation de jeux de données, filtrées selon des critères spécifiques, utilisez l'[ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)opération.

## Syntaxe de la requête
<a name="API_CreateDatasetImportJob_RequestSyntax"></a>

```
{
   "DatasetArn": "string",
   "DatasetImportJobName": "string",
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "GeolocationFormat": "string",
   "ImportMode": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimestampFormat": "string",
   "TimeZone": "string",
   "UseGeolocationForTimeZone": boolean
}
```

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

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

 ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetArn"></a>
Le nom de ressource Amazon (ARN) du jeu de données Amazon Forecast dans lequel vous souhaitez importer des données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetImportJobName"></a>
Nom de la tâche d'importation de l'ensemble de données. Nous recommandons d'inclure l'horodatage actuel dans le nom, par exemple,. `20190721DatasetImport` Cela peut vous aider à éviter une `ResourceAlreadyExistsException` exception.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DataSource"></a>
L'emplacement des données d'entraînement à importer et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder aux données. Les données d'entraînement doivent être stockées dans un compartiment Amazon S3.  
Si le chiffrement est utilisé, `DataSource` il doit inclure une clé AWS Key Management Service (KMS) et le rôle IAM doit autoriser Amazon Forecast à accéder à la clé. La clé KMS et le rôle IAM doivent correspondre à ceux spécifiés dans le `EncryptionConfig` paramètre de l'[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)opération.  
Type : objet [DataSource](API_DataSource.md)  
Obligatoire : oui

 ** [Format](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Format"></a>
Le format des données importées, CSV ou PARQUET. La valeur par défaut est CSV.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$`   
Obligatoire : non

 ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-GeolocationFormat"></a>
Format de l'attribut de géolocalisation. L'attribut de géolocalisation peut être formaté de deux manières différentes :  
+  `LAT_LONG`- la latitude et la longitude au format décimal (exemple : 47.61\$1-122.33).
+  `CC_POSTALCODE`(États-Unis uniquement) : le code du pays (États-Unis), suivi du code postal à 5 chiffres (exemple : US\$198121).
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9_]+$`   
Obligatoire : non

 ** [ImportMode](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-ImportMode"></a>
Spécifie si la tâche d'importation de l'ensemble de données est une tâche `FULL` ou une `INCREMENTAL` importation. L'importation d'un `FULL` jeu de données remplace toutes les données existantes par les données nouvellement importées. Une `INCREMENTAL` importation ajoute les données importées aux données existantes.  
Type : Chaîne  
Valeurs valides : `FULL | INCREMENTAL`   
Obligatoire : non

 ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Tags"></a>
Les métadonnées facultatives que vous appliquez à la tâche d'importation du jeu de données pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TimestampFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimestampFormat"></a>
Format des horodatages dans le jeu de données. Le format que vous spécifiez dépend du moment où le `DataFrequency` jeu de données a été créé. Les formats suivants sont pris en charge  
+ « YYYY-MM-DD »

  Pour les fréquences de données suivantes : Y, M, W et D
+ « yyyy-MM-dd  HH : MM : SS »

  Pour les fréquences de données suivantes : H, 30 min, 15 min et 1 min ; et éventuellement, pour : Y, M, W et D
Si le format n'est pas spécifié, Amazon Forecast s'attend à ce que le format soit « yyyy-MM-DD HH:MM:ss ».  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\-\:\.\,\'\s]+$`   
Obligatoire : non

 ** [TimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimeZone"></a>
Un seul fuseau horaire pour chaque élément de votre jeu de données. Cette option est idéale pour les ensembles de données dont tous les horodatages se situent dans un même fuseau horaire, ou si tous les horodatages sont normalisés sur un seul fuseau horaire.   
Reportez-vous à l'[API Joda-Time](http://joda-time.sourceforge.net/timezones.html) pour obtenir la liste complète des noms de fuseaux horaires valides.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\/\+\-\_]+$`   
Obligatoire : non

 ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-UseGeolocationForTimeZone"></a>
Dérivez automatiquement les informations de fuseau horaire à partir de l'attribut de géolocalisation. Cette option est idéale pour les ensembles de données contenant des horodatages dans plusieurs fuseaux horaires et ces horodatages sont exprimés en heure locale.  
Type : booléen  
Obligatoire : non

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

```
{
   "DatasetImportJobArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateDatasetImportJob_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.

 ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="forecast-CreateDatasetImportJob-response-DatasetImportJobArn"></a>
Le nom de ressource Amazon (ARN) de la tâche d'importation de l'ensemble de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateDatasetImportJob_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateDatasetImportJob_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/CreateDatasetImportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) 

# CreateExplainability
<a name="API_CreateExplainability"></a>

**Note**  
L'explicabilité n'est disponible que pour les prévisions et les prédicteurs générés à partir d'un () AutoPredictor [CreateAutoPredictor](API_CreateAutoPredictor.md)

Crée une explication Amazon Forecast.

**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/) 

L'explicabilité vous aide à mieux comprendre l'impact des attributs de vos ensembles de données sur les prévisions. Amazon Forecast utilise une métrique appelée score d'impact pour quantifier l'impact relatif de chaque attribut et déterminer s'il augmente ou diminue les valeurs de prévision.

Pour activer Forecast Explainability, votre prédicteur doit inclure au moins l'un des éléments suivants : des séries chronologiques associées, des métadonnées d'éléments ou des ensembles de données supplémentaires tels que Holidays et l'indice météo.

**Note**  
Les modèles ARIMA (AutoRegressive Integrated Moving Average), ETS (Exponential Smoothing State Space Model) et NPTS (Non-Parametric Time Series) n'intègrent pas de données de séries chronologiques externes. Par conséquent, ces modèles ne créent pas de rapport d'explicabilité, même si vous incluez les ensembles de données supplémentaires.

CreateExplainability accepte soit un Predictor ARN, soit un Forecast ARN. Pour recevoir des scores d'impact agrégés pour toutes les séries chronologiques et tous les points temporels de vos ensembles de données, fournissez un ARN prédictif. Pour recevoir les scores d'impact pour des séries chronologiques et des points temporels spécifiques, fournissez un Forecast ARN.

 **CreateExplainability avec un ARN prédictif** 

**Note**  
Vous ne pouvez disposer que d'une seule ressource d'explicabilité par prédicteur. Si vous l'avez déjà activé `ExplainPredictor`[CreateAutoPredictor](API_CreateAutoPredictor.md), ce prédicteur dispose déjà d'une ressource d'explicabilité.

Les paramètres suivants sont requis lors de la fourniture d'un ARN prédicteur :
+  `ExplainabilityName`- Un nom unique pour l'explicabilité.
+  `ResourceArn`- L'Arn du prédicteur.
+  `TimePointGranularity`- Doit être réglé sur « TOUS ».
+  `TimeSeriesGranularity`- Doit être réglé sur « TOUS ».

Ne spécifiez pas de valeur pour les paramètres suivants :
+  `DataSource`- Valable uniquement lorsque « SPÉCIFIQUE » TimeSeriesGranularity est indiqué.
+  `Schema`- Valable uniquement lorsque « SPÉCIFIQUE » TimeSeriesGranularity est indiqué.
+  `StartDateTime`- Valable uniquement lorsque « SPÉCIFIQUE » TimePointGranularity est indiqué.
+  `EndDateTime`- Valable uniquement lorsque « SPÉCIFIQUE » TimePointGranularity est indiqué.

 **CreateExplainability avec un Forecast ARN** 

**Note**  
Vous pouvez spécifier un maximum de 50 séries chronologiques et 500 points temporels.

Les paramètres suivants sont requis lors de la fourniture d'un ARN prédicteur :
+  `ExplainabilityName`- Un nom unique pour l'explicabilité.
+  `ResourceArn`- L'Arn des prévisions.
+  `TimePointGranularity`- « TOUT » ou « SPÉCIFIQUE ».
+  `TimeSeriesGranularity`- « TOUT » ou « SPÉCIFIQUE ».

Si vous réglez TimeSeriesGranularity sur « SPÉCIFIQUE », vous devez également fournir les informations suivantes :
+  `DataSource`- L'emplacement S3 du fichier CSV spécifiant votre série chronologique.
+  `Schema`- Le schéma définit les attributs et les types d'attributs répertoriés dans la source de données.

Si vous réglez TimePointGranularity sur « SPÉCIFIQUE », vous devez également fournir les informations suivantes :
+  `StartDateTime`- Le premier horodatage de la plage de points temporels.
+  `EndDateTime`- Le dernier horodatage de la plage de points temporels.

## Syntaxe de la requête
<a name="API_CreateExplainability_RequestSyntax"></a>

```
{
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DataSource](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-DataSource"></a>
La source de vos données, un rôle Gestion des identités et des accès AWS (IAM) qui permet à Amazon Forecast d'accéder aux données et, éventuellement, une clé AWS Key Management Service (KMS).  
Type : objet [DataSource](API_DataSource.md)  
Obligatoire : non

 ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EnableVisualization"></a>
Créez une visualisation de l'explicabilité consultable dans la console. AWS   
Type : booléen  
Obligatoire : non

 ** [EndDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EndDateTime"></a>
S'il `TimePointGranularity` est défini sur`SPECIFIC`, définissez le dernier point temporel de l'explicabilité.  
Utilisez le format d'horodatage suivant ::mm:ss yyyy-MM-ddTHH (exemple : 2015-01-01T 20:00:00)  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 19.  
Modèle : `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`   
Obligatoire : non

 ** [ExplainabilityConfig](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityConfig"></a>
Les paramètres de configuration qui définissent la granularité des séries chronologiques et des points temporels pour l'explicabilité.  
Type : objet [ExplainabilityConfig](API_ExplainabilityConfig.md)  
Obligatoire : oui

 ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityName"></a>
Un nom unique pour l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [ResourceArn](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ResourceArn"></a>
L'Amazon Resource Name (ARN) du Predictor ou Forecast utilisé pour créer l'Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [Schema](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Schema"></a>
Définit les champs d'un jeu de données.  
Type : objet [Schema](API_Schema.md)  
Obligatoire : non

 ** [StartDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-StartDateTime"></a>
S'il `TimePointGranularity` est défini sur`SPECIFIC`, définissez le premier point de l'explicabilité.  
Utilisez le format d'horodatage suivant ::mm:ss yyyy-MM-ddTHH (exemple : 2015-01-01T 20:00:00)  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 19.  
Modèle : `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`   
Obligatoire : non

 ** [Tags](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Tags"></a>
Des métadonnées facultatives pour vous aider à classer et à organiser vos ressources. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises distinguent les majuscules et minuscules.  
Les restrictions suivantes s’appliquent aux balises :  
+ Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.
+ Nombre maximum de balises par ressource : 50.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Caractères acceptés : toutes les lettres et tous les chiffres, les espaces représentables en UTF-8, et \$1 - =. \$1 :/@. Si votre schéma de balisage est utilisé pour d'autres services et ressources, les restrictions relatives aux caractères de ces services s'appliquent également. 
+ Les préfixes clés ne peuvent inclure aucune combinaison majuscules ou minuscules de ou. `aws:` `AWS:` Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ». Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe.
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "ExplainabilityArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateExplainability_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.

 ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) **   <a name="forecast-CreateExplainability-response-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateExplainability_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateExplainability_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/CreateExplainability) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) 

# CreateExplainabilityExport
<a name="API_CreateExplainabilityExport"></a>

Exporte une ressource d'explicabilité créée par l'[CreateExplainability](API_CreateExplainability.md)opération. Les fichiers exportés sont exportés vers un compartiment Amazon Simple Storage Service (Amazon S3).

Vous devez spécifier un [DataDestination](API_DataDestination.md) objet qui inclut un compartiment Amazon S3 et un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour de plus amples informations, veuillez consulter [Configuration d'autorisations pour Amazon Forecast](aws-forecast-iam-roles.md).

**Note**  
La tâche `Status` d'exportation doit avoir lieu `ACTIVE` avant que vous puissiez accéder à l'exportation dans votre compartiment Amazon S3. Pour obtenir le statut, utilisez l'[DescribeExplainabilityExport](API_DescribeExplainabilityExport.md)opération.

## Syntaxe de la requête
<a name="API_CreateExplainabilityExport_RequestSyntax"></a>

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ExplainabilityArn": "string",
   "ExplainabilityExportName": "string",
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Destination"></a>
Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).   
Type : objet [DataDestination](API_DataDestination.md)  
Obligatoire : oui

 ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de l'explicabilité à exporter.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityExportName"></a>
Nom unique pour l'exportation Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [Format](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$`   
Obligatoire : non

 ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Tags"></a>
Des métadonnées facultatives pour vous aider à classer et à organiser vos ressources. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises distinguent les majuscules et minuscules.  
Les restrictions suivantes s’appliquent aux balises :  
+ Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.
+ Nombre maximum de balises par ressource : 50.
+ Longueur maximale de la clé : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Caractères acceptés : toutes les lettres et tous les chiffres, les espaces représentables en UTF-8, et \$1 - =. \$1 :/@. Si votre schéma de balisage est utilisé pour d'autres services et ressources, les restrictions relatives aux caractères de ces services s'appliquent également. 
+ Les préfixes clés ne peuvent inclure aucune combinaison majuscules ou minuscules de ou. `aws:` `AWS:` Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ». Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe.
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "ExplainabilityExportArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateExplainabilityExport_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.

 ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) **   <a name="forecast-CreateExplainabilityExport-response-ExplainabilityExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateExplainabilityExport_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateExplainabilityExport_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/CreateExplainabilityExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainabilityExport) 

# CreateForecast
<a name="API_CreateForecast"></a>

Crée une prévision pour chaque élément de l'`TARGET_TIME_SERIES`ensemble de données qui a été utilisé pour entraîner le prédicteur. C'est ce que l'on appelle l'inférence. Pour récupérer les prévisions pour un seul élément avec une faible latence, utilisez l'[QueryForecast](API_forecastquery_QueryForecast.md)opération. Pour exporter les prévisions complètes dans votre compartiment Amazon Simple Storage Service (Amazon S3), utilisez l'[CreateForecastExportJob](API_CreateForecastExportJob.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/) 

La plage des prévisions est déterminée par la `ForecastHorizon` valeur que vous spécifiez dans la [CreatePredictor](API_CreatePredictor.md) demande. Lorsque vous recherchez une prévision, vous pouvez demander une plage de dates spécifique dans la prévision.

Pour obtenir la liste de toutes vos prévisions, utilisez l'[ListForecasts](API_ListForecasts.md)opération.

**Note**  
Les prévisions générées par Amazon Forecast se situent dans le même fuseau horaire que le jeu de données utilisé pour créer le prédicteur.

Pour de plus amples informations, veuillez consulter [Génération de prévisions](howitworks-forecast.md).

**Note**  
La prévision doit `Status` l'être `ACTIVE` avant que vous puissiez l'interroger ou l'exporter. Utilisez l'opération [DescribeForecast](API_DescribeForecast.md) pour obtenir le statut.

Par défaut, une prévision inclut des prédictions pour chaque élément (`item_id`) du groupe de jeux de données qui a été utilisé pour entraîner le prédicteur. Vous pouvez toutefois utiliser l'`TimeSeriesSelector`objet pour générer une prévision sur un sous-ensemble de séries chronologiques. La création de prévisions est ignorée pour toutes les séries chronologiques que vous spécifiez et qui ne figurent pas dans le jeu de données en entrée. Le fichier d'exportation des prévisions ne contiendra pas ces séries chronologiques ni leurs valeurs prévisionnelles.

## Syntaxe de la requête
<a name="API_CreateForecast_RequestSyntax"></a>

```
{
   "ForecastName": "string",
   "ForecastTypes": [ "string" ],
   "PredictorArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   }
}
```

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

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

 ** [ForecastName](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastName"></a>
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_]*`   
Obligatoire : oui

 ** [ForecastTypes](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastTypes"></a>
Quantiles à partir desquels les prévisions probabilistes sont générées. **Vous pouvez actuellement spécifier jusqu'à 5 quantiles par prévision.** Les valeurs acceptées incluent `0.01 to 0.99` (incréments de 0,01 uniquement) et. `mean` La prévision moyenne est différente de la médiane (0,50) lorsque la distribution n'est pas symétrique (par exemple, binomial bêta et négatif).   
Les quantiles par défaut sont ceux que vous avez spécifiés lors de la création du prédicteur. 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$)`   
Obligatoire : non

 ** [PredictorArn](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-PredictorArn"></a>
Nom de ressource Amazon (ARN) du prédicteur à utiliser pour générer les prévisions.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [Tags](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-Tags"></a>
Les métadonnées facultatives que vous appliquez aux prévisions pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TimeSeriesSelector](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-TimeSeriesSelector"></a>
Définit l'ensemble des séries chronologiques utilisées pour créer les prévisions dans un `TimeSeriesIdentifiers` objet.  
L'`TimeSeriesIdentifiers`objet a besoin des informations suivantes :  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Type : objet [TimeSeriesSelector](API_TimeSeriesSelector.md)  
Obligatoire : non

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

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

## Eléments de réponse
<a name="API_CreateForecast_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.

 ** [ForecastArn](#API_CreateForecast_ResponseSyntax) **   <a name="forecast-CreateForecast-response-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:.*:.*:.+` 

## Erreurs
<a name="API_CreateForecast_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateForecast_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/CreateForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast) 

# CreateForecastExportJob
<a name="API_CreateForecastExportJob"></a>

Exporte une prévision créée par l'[CreateForecast](API_CreateForecast.md)opération vers votre bucket Amazon Simple Storage Service (Amazon S3). Le nom du fichier de prévisions respectera les conventions suivantes :

<ForecastExportJobName>\$1<ExportTimestamp>\$1<PartNumber>

où le composant < ExportTimestamp > est en Java SimpleDateFormat (yyyy-MM-DDTHH-MM-SSZ).

**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/) 

Vous devez spécifier un [DataDestination](API_DataDestination.md) objet qui inclut un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour de plus amples informations, veuillez consulter [Configuration d'autorisations pour Amazon Forecast](aws-forecast-iam-roles.md).

Pour de plus amples informations, veuillez consulter [Génération de prévisions](howitworks-forecast.md).

Pour obtenir une liste de toutes vos tâches d'exportation de prévisions, utilisez l'[ListForecastExportJobs](API_ListForecastExportJobs.md)opération.

**Note**  
La tâche `Status` d'exportation des prévisions doit avoir lieu `ACTIVE` avant que vous puissiez accéder aux prévisions dans votre compartiment Amazon S3. Pour obtenir le statut, utilisez l'[DescribeForecastExportJob](API_DescribeForecastExportJob.md)opération.

## Syntaxe de la requête
<a name="API_CreateForecastExportJob_RequestSyntax"></a>

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ForecastArn": "string",
   "ForecastExportJobName": "string",
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Destination"></a>
L'emplacement où vous souhaitez enregistrer les prévisions et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à l'emplacement. Les prévisions doivent être exportées vers un compartiment Amazon S3.  
Si le chiffrement est utilisé, `Destination` il doit inclure une clé AWS Key Management Service (KMS). Le rôle IAM doit autoriser Amazon Forecast à accéder à la clé.  
Type : objet [DataDestination](API_DataDestination.md)  
Obligatoire : oui

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

 ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastExportJobName"></a>
Nom de la tâche d'exportation des prévisions.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [Format](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Format"></a>
Le format des données exportées, CSV ou PARQUET. La valeur par défaut est CSV.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$`   
Obligatoire : non

 ** [Tags](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Tags"></a>
Les métadonnées facultatives que vous appliquez à la tâche d'exportation des prévisions pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "ForecastExportJobArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateForecastExportJob_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.

 ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) **   <a name="forecast-CreateForecastExportJob-response-ForecastExportJobArn"></a>
Le nom de ressource Amazon (ARN) de la tâche d'exportation.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateForecastExportJob_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateForecastExportJob_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/CreateForecastExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) 

# CreateMonitor
<a name="API_CreateMonitor"></a>

Crée une ressource de surveillance des prédicteurs pour un prédicteur automatique existant. La surveillance des prédicteurs vous permet de voir comment les performances de votre prédicteur évoluent au fil du temps. Pour plus d'informations, consultez [Predictor Monitoring](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). 

**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/) 

## Syntaxe de la requête
<a name="API_CreateMonitor_RequestSyntax"></a>

```
{
   "MonitorName": "string",
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [MonitorName](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-MonitorName"></a>
Nom de la ressource du moniteur.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [ResourceArn](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-ResourceArn"></a>
Nom de ressource Amazon (ARN) du prédicteur à surveiller.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [Tags](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-Tags"></a>
Liste de [balises](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) à appliquer à la ressource du moniteur.  
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "MonitorArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateMonitor_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.

 ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) **   <a name="forecast-CreateMonitor-response-MonitorArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateMonitor_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateMonitor_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/CreateMonitor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateMonitor) 

# CreatePredictor
<a name="API_CreatePredictor"></a>

**Note**  
 Cette opération crée un prédicteur existant qui n'inclut pas toutes les fonctionnalités de prédicteur fournies par Amazon Forecast. Pour créer un prédicteur compatible avec tous les aspects de Forecast, utilisez[CreateAutoPredictor](API_CreateAutoPredictor.md).

Crée un prédicteur Amazon Forecast.

**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/) 

Dans la demande, indiquez un groupe de jeux de données et spécifiez un algorithme ou laissez Amazon Forecast choisir un algorithme pour vous à l'aide d'AutoML. Si vous spécifiez un algorithme, vous pouvez également remplacer les hyperparamètres spécifiques à l'algorithme.

Amazon Forecast utilise l'algorithme pour entraîner un prédicteur à l'aide de la dernière version des ensembles de données du groupe de jeux de données spécifié. Vous pouvez ensuite générer une prévision à l'aide de cette [CreateForecast](API_CreateForecast.md) opération.

 Pour consulter les métriques d'évaluation, utilisez l'opération [GetAccuracyMetrics](API_GetAccuracyMetrics.md). 

Vous pouvez spécifier une configuration de fonctionnalités pour remplir et agréger les champs de données du `TARGET_TIME_SERIES` jeu de données afin d'améliorer l'apprentissage du modèle. Pour de plus amples informations, veuillez consulter [FeaturizationConfig](API_FeaturizationConfig.md).

Pour les ensembles de données RELATED\$1TIME\$1SERIES, `CreatePredictor` vérifie que le moment `DataFrequency` spécifié lors de la création du jeu de données correspond au. `ForecastFrequency` Les ensembles de données TARGET\$1TIME\$1SERIES ne sont pas soumis à cette restriction. Amazon Forecast vérifie également le délimiteur et le format d'horodatage. Pour de plus amples informations, veuillez consulter [Importation de jeux de données](howitworks-datasets-groups.md).

Par défaut, les prédicteurs sont entraînés et évalués aux quantiles de 0,1 (P10), 0,5 (P50) et 0,9 (P90). Vous pouvez choisir des types de prévisions personnalisés pour entraîner et évaluer votre prédicteur en définissant le`ForecastTypes`. 

 **AutoML** 

Si vous souhaitez qu'Amazon Forecast évalue chaque algorithme et choisisse celui qui le minimise`objective function`, définissez sur`PerformAutoML`. `true` Le `objective function` est défini comme la moyenne des pertes pondérées par rapport aux types de prévisions. Par défaut, il s'agit des pertes quantiles p10, p50 et p90. Pour de plus amples informations, veuillez consulter [EvaluationResult](API_EvaluationResult.md).

Lorsque AutoML est activé, les propriétés suivantes ne sont pas autorisées :
+  `AlgorithmArn` 
+  `HPOConfig` 
+  `PerformHPO` 
+  `TrainingParameters` 

Pour obtenir la liste de tous vos prédicteurs, utilisez l'[ListPredictors](API_ListPredictors.md)opération.

**Note**  
Avant de pouvoir utiliser le prédicteur pour créer une prévision, le prédicteur doit être « `Status` de »`ACTIVE`, ce qui signifie que l'entraînement est terminé. Pour obtenir le statut, utilisez l'[DescribePredictor](API_DescribePredictor.md)opération.

## Syntaxe de la requête
<a name="API_CreatePredictor_RequestSyntax"></a>

```
{
   "AlgorithmArn": "string",
   "AutoMLOverrideStrategy": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrainingParameters": { 
      "string" : "string" 
   }
}
```

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

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

 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AlgorithmArn"></a>
Nom de ressource Amazon (ARN) de l'algorithme à utiliser pour l'entraînement des modèles. Obligatoire s'`PerformAutoML`il n'est pas défini sur`true`.  

**Algorithmes compatibles :**
+  `arn:aws:forecast:::algorithm/ARIMA` 
+  `arn:aws:forecast:::algorithm/CNN-QR` 
+  `arn:aws:forecast:::algorithm/Deep_AR_Plus` 
+  `arn:aws:forecast:::algorithm/ETS` 
+  `arn:aws:forecast:::algorithm/NPTS` 
+  `arn:aws:forecast:::algorithm/Prophet` 
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : non

 ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AutoMLOverrideStrategy"></a>
 La stratégie de `LatencyOptimized` remplacement AutoML n'est disponible qu'en version bêta privée. Contactez AWS le Support ou votre responsable de compte pour en savoir plus sur les privilèges d'accès. 
Utilisé pour remplacer la stratégie AutoML par défaut, qui vise à optimiser la précision des prédicteurs. Pour appliquer une stratégie AutoML qui minimise le temps de formation, utilisez. `LatencyOptimized`  
Ce paramètre n'est valide que pour les prédicteurs entraînés à l'aide d'AutoML.  
Type : Chaîne  
Valeurs valides : `LatencyOptimized | AccuracyOptimized`   
Obligatoire : non

 ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EncryptionConfig"></a>
Une clé AWS Key Management Service (KMS) et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)  
Obligatoire : non

 ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EvaluationParameters"></a>
Utilisé pour remplacer les paramètres d'évaluation par défaut de l'algorithme spécifié. Amazon Forecast évalue un prédicteur en divisant un ensemble de données en données d'entraînement et en données de test. Les paramètres d'évaluation définissent la manière d'effectuer le fractionnement et le nombre d'itérations.  
Type : objet [EvaluationParameters](API_EvaluationParameters.md)  
Obligatoire : non

 ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-FeaturizationConfig"></a>
La configuration des fonctionnalités.  
Type : objet [FeaturizationConfig](API_FeaturizationConfig.md)  
Obligatoire : oui

 ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastHorizon"></a>
Spécifie le nombre d'étapes temporelles que le modèle est entraîné à prévoir. L’horizon de prévision est également appelé longueur de prédiction.  
Par exemple, si vous configurez un jeu de données pour la collecte quotidienne de données (à l'aide du `DataFrequency` paramètre de l'[CreateDataset](API_CreateDataset.md)opération) et que vous définissez l'horizon de prévision sur 10, le modèle renvoie des prévisions pour 10 jours.  
L'horizon de prévision maximal est le moins élevé des valeurs suivantes : 500 pas temporels ou 1/3 de la longueur du jeu de données TARGET\$1TIME\$1SERIES.  
Type : Integer  
Obligatoire : oui

 ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastTypes"></a>
Spécifie les types de prévisions utilisés pour entraîner un prédicteur. Vous pouvez spécifier jusqu'à cinq types de prévisions. Les types de prévisions peuvent être des quantiles compris entre 0,01 et 0,99, par incréments de 0,01 ou plus. Vous pouvez également spécifier la prévision moyenne avec`mean`.   
La valeur par défaut est `["0.10", "0.50", "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$)`   
Obligatoire : non

 ** [HPOConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-HPOConfig"></a>
Fournit des valeurs de remplacement d'hyperparamètres pour l'algorithme. Si vous ne fournissez pas ce paramètre, Amazon Forecast utilise les valeurs par défaut. Les algorithmes individuels spécifient quels hyperparamètres prennent en charge l'optimisation des hyperparamètres (HPO). Pour de plus amples informations, veuillez consulter [Algorithmes d'Amazon Forecast](aws-forecast-choosing-recipes.md).  
Si vous avez inclus l'`HPOConfig`objet, vous devez le `PerformHPO` définir sur true.  
Type : objet [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)  
Obligatoire : non

 ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-InputDataConfig"></a>
Décrit le groupe de jeux de données qui contient les données à utiliser pour entraîner le prédicteur.  
Type : objet [InputDataConfig](API_InputDataConfig.md)  
Obligatoire : oui

 ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-OptimizationMetric"></a>
Mesure de précision utilisée pour optimiser le prédicteur. La valeur par défaut est `AverageWeightedQuantileLoss`.  
Type : Chaîne  
Valeurs valides : `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
Obligatoire : non

 ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformAutoML"></a>
S'il faut exécuter AutoML. Lorsqu'Amazon Forecast exécute AutoML, il évalue les algorithmes qu'il fournit et choisit le meilleur algorithme et la meilleure configuration pour votre ensemble de données d'entraînement.  
La valeur par défaut est `false`. Dans ce cas, vous devez spécifier un algorithme.  
Configurez `PerformAutoML` `true` pour qu'Amazon Forecast exécute AutoML. C'est une bonne option si vous ne savez pas quel algorithme convient à vos données d'entraînement. Dans ce cas, elle `PerformHPO` doit être fausse.  
Type : booléen  
Obligatoire : non

 ** [PerformHPO](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformHPO"></a>
S'il faut effectuer l'optimisation des hyperparamètres (HPO). HPO trouve les valeurs d'hyperparamètres optimales pour vos données d'entraînement. Le processus d'exécution du HPO est connu sous le nom d'exécution d'une tâche de réglage d'hyperparamètres.  
La valeur par défaut est `false`. Dans ce cas, Amazon Forecast utilise les valeurs d'hyperparamètres par défaut issues de l'algorithme choisi.  
Pour remplacer les valeurs par défaut, définissez `PerformHPO` l'[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)objet `true` et, éventuellement, fournissez-le. La tâche de réglage spécifie une métrique à optimiser, les hyperparamètres participant au réglage et la plage valide pour chaque hyperparamètre réglable. Dans ce cas, vous devez spécifier un algorithme qui `PerformAutoML` doit être faux.  
Les algorithmes suivants prennent en charge le HPO :  
+ DeepAR\$1
+ CNN-QR
Type : booléen  
Obligatoire : non

 ** [PredictorName](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PredictorName"></a>
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_]*`   
Obligatoire : oui

 ** [Tags](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-Tags"></a>
Les métadonnées facultatives que vous appliquez au prédicteur pour vous aider à les classer et à les organiser. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-TrainingParameters"></a>
Les hyperparamètres à remplacer pour l'entraînement du modèle. Les hyperparamètres que vous pouvez modifier sont répertoriés dans les algorithmes individuels. Pour la liste des algorithmes pris en charge, consultez[Algorithmes d'Amazon Forecast](aws-forecast-choosing-recipes.md).  
Type : mappage chaîne/chaîne  
Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 100 éléments.  
Contraintes relatives à la longueur des clés : longueur maximale de 256.  
Modèle de clé :`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`   
Contraintes de longueur de valeur : longueur maximale de 256.  
Modèle de valeur : `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`   
Obligatoire : non

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

```
{
   "PredictorArn": "string"
}
```

## Eléments de réponse
<a name="API_CreatePredictor_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.

 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) **   <a name="forecast-CreatePredictor-response-PredictorArn"></a>
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:.*:.*:.+` 

## Erreurs
<a name="API_CreatePredictor_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreatePredictor_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/CreatePredictor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor) 

# CreatePredictorBacktestExportJob
<a name="API_CreatePredictorBacktestExportJob"></a>

Exporte les prévisions de backtest et les mesures de précision générées par les [CreatePredictor](API_CreatePredictor.md) opérations du système [CreateAutoPredictor](API_CreateAutoPredictor.md) d'exploitation. Deux dossiers contenant des fichiers CSV ou Parquet sont exportés vers le compartiment S3 que vous avez spécifié.

**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/) 

 Les noms des fichiers d'exportation respecteront les conventions suivantes :

 `<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv` 

Le composant < ExportTimestamp > est au SimpleDate format Java (YYYY-MM-DDTHH-MM-SSZ).

Vous devez spécifier un [DataDestination](API_DataDestination.md) objet qui inclut un compartiment Amazon S3 et un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour de plus amples informations, veuillez consulter [Configuration d'autorisations pour Amazon Forecast](aws-forecast-iam-roles.md).

**Note**  
La tâche `Status` d'exportation doit avoir lieu `ACTIVE` avant que vous puissiez accéder à l'exportation dans votre compartiment Amazon S3. Pour obtenir le statut, utilisez l'[DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md)opération.

## Syntaxe de la requête
<a name="API_CreatePredictorBacktestExportJob_RequestSyntax"></a>

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "PredictorArn": "string",
   "PredictorBacktestExportJobName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Destination"></a>
Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).   
Type : objet [DataDestination](API_DataDestination.md)  
Obligatoire : oui

 ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Format"></a>
Le format des données exportées, CSV ou PARQUET. La valeur par défaut est CSV.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$`   
Obligatoire : non

 ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorArn"></a>
Le nom de ressource Amazon (ARN) du prédicteur que vous souhaitez exporter.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorBacktestExportJobName"></a>
Nom de la tâche d'exportation du backtest.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

 ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Tags"></a>
Des métadonnées facultatives pour vous aider à classer et à organiser vos backtests. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises distinguent les majuscules et minuscules.  
Les restrictions suivantes s’appliquent aux balises :  
+ Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.
+ Nombre maximum de balises par ressource : 50.
+ Longueur maximale de la clé : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Caractères acceptés : toutes les lettres et tous les chiffres, les espaces représentables en UTF-8, et \$1 - =. \$1 :/@. Si votre schéma de balisage est utilisé pour d'autres services et ressources, les restrictions relatives aux caractères de ces services s'appliquent également. 
+ Les préfixes clés ne peuvent inclure aucune combinaison majuscules ou minuscules de ou. `aws:` `AWS:` Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ». Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe.
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

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

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

## Eléments de réponse
<a name="API_CreatePredictorBacktestExportJob_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.

 ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation du backtest prédictif que vous souhaitez exporter.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreatePredictorBacktestExportJob_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreatePredictorBacktestExportJob_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/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 

# CreateWhatIfAnalysis
<a name="API_CreateWhatIfAnalysis"></a>

L'analyse hypothétique est une technique de modélisation de scénarios dans laquelle vous apportez une modification hypothétique à une série chronologique et comparez les prévisions générées par ces modifications à la série chronologique de référence inchangée. Il est important de se rappeler que le but d'une analyse hypothétique est de comprendre comment une prévision peut changer en fonction des différentes modifications apportées à la série chronologique de référence.

**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/) 

Par exemple, imaginez que vous êtes un détaillant de vêtements qui envisage une vente de fin de saison pour libérer de l'espace pour de nouveaux styles. Après avoir créé une prévision de référence, vous pouvez utiliser une analyse hypothétique pour déterminer comment les différentes tactiques de vente peuvent affecter vos objectifs.

Vous pourriez créer un scénario où tout reçoit une réduction de 25 %, et un autre où tout reçoit une réduction fixe en dollars. Vous pouvez créer un scénario dans lequel la vente dure une semaine et un autre dans lequel la vente dure un mois. Grâce à une analyse hypothétique, vous pouvez comparer de nombreux scénarios différents les uns par rapport aux autres.

Notez qu'une analyse hypothétique est destinée à montrer ce que le modèle de prévision a appris et comment il se comportera dans les scénarios que vous évaluez. N'utilisez pas aveuglément les résultats de l'analyse hypothétique pour prendre des décisions commerciales. Par exemple, les prévisions peuvent ne pas être exactes pour les nouveaux scénarios dans lesquels aucune référence n'est disponible pour déterminer si une prévision est bonne.

L'[TimeSeriesSelector](API_TimeSeriesSelector.md)objet définit les éléments que vous souhaitez inclure dans l'analyse hypothétique.

**Note**  
Vos données doivent être au format CSV (valeurs séparées par des virgules) pour créer une analyse hypothétique.

## Syntaxe de la requête
<a name="API_CreateWhatIfAnalysis_RequestSyntax"></a>

```
{
   "ForecastArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   },
   "WhatIfAnalysisName": "string"
}
```

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

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

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

 ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-Tags"></a>
Une liste de [balises](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) à appliquer aux prévisions hypothétiques.  
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-TimeSeriesSelector"></a>
Définit l'ensemble des séries chronologiques utilisées dans l'analyse hypothétique d'un `TimeSeriesIdentifiers` objet. Les analyses hypothétiques sont effectuées uniquement pour les séries chronologiques de cet objet.  
L'`TimeSeriesIdentifiers`objet a besoin des informations suivantes :  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Type : objet [TimeSeriesSelector](API_TimeSeriesSelector.md)  
Obligatoire : non

 ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-WhatIfAnalysisName"></a>
Nom de l'analyse hypothétique. Chaque nom doit être unique.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

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

```
{
   "WhatIfAnalysisArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateWhatIfAnalysis_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.

 ** [WhatIfAnalysisArn](#API_CreateWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-CreateWhatIfAnalysis-response-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erreurs
<a name="API_CreateWhatIfAnalysis_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateWhatIfAnalysis_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/CreateWhatIfAnalysis) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) 

# CreateWhatIfForecast
<a name="API_CreateWhatIfForecast"></a>

Une prévision hypothétique est une prévision créée à partir d'une version modifiée de la prévision de base. Chaque prévision hypothétique intègre soit un jeu de données de remplacement, soit un ensemble de transformations du jeu de données d'origine. 

**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/) 

## Syntaxe de la requête
<a name="API_CreateWhatIfForecast_RequestSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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",
   "WhatIfForecastName": "string"
}
```

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

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

 ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-Tags"></a>
Une liste de [balises](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) à appliquer aux prévisions hypothétiques.  
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesReplacementsDataSource"></a>
Le jeu de données de série chronologique de remplacement, qui contient les lignes que vous souhaitez modifier dans le jeu de données de séries chronologiques associé. Il n'est pas nécessaire qu'une série chronologique de remplacement contienne toutes les lignes de la série chronologique associée à la référence. N'incluez que les lignes (combinaisons de mesures et de dimensions) que vous souhaitez inclure dans les prévisions hypothétiques.  
Ce jeu de données est fusionné avec la série chronologique d'origine pour créer un ensemble de données transformé qui est utilisé pour l'analyse hypothétique.  
Cet ensemble de données doit contenir les éléments à modifier (tels que item\$1id ou workforce\$1type), toutes les dimensions pertinentes, la colonne d'horodatage et au moins l'une des colonnes de séries chronologiques associées. Ce fichier ne doit pas contenir d'horodatages dupliqués pour la même série chronologique. Ce fichier doit être au format CSV.  
Les horodatages et les item\$1ids non inclus dans cet ensemble de données ne sont pas inclus dans l'analyse hypothétique.   
Type : objet [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md)  
Obligatoire : non

 ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesTransformations"></a>
Les transformations appliquées à la série chronologique de référence. Chaque transformation contient une action et un ensemble de conditions. Une action n'est appliquée que lorsque toutes les conditions sont remplies. Si aucune condition n'est spécifiée, l'action est appliquée à tous les éléments.  
Type : tableau d’objets [TimeSeriesTransformation](API_TimeSeriesTransformation.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 30 articles.  
Obligatoire : non

 ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfForecastName"></a>
Le nom de la prévision hypothétique. Les noms doivent être uniques dans chaque analyse 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_]*`   
Obligatoire : oui

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

```
{
   "WhatIfForecastArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateWhatIfForecast_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.

 ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecast-response-WhatIfForecastArn"></a>
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:.*:.*:.+` 

## Erreurs
<a name="API_CreateWhatIfForecast_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateWhatIfForecast_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/CreateWhatIfForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecast) 

# CreateWhatIfForecastExport
<a name="API_CreateWhatIfForecastExport"></a>

Exporte une prévision créée par l'[CreateWhatIfForecast](API_CreateWhatIfForecast.md)opération vers votre bucket Amazon Simple Storage Service (Amazon S3). Le nom du fichier de prévisions respectera les conventions suivantes :

 `≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>` 

Le composant < ExportTimestamp > est en Java SimpleDateFormat (YYYY-MM-DDTHH-MM-SSZ).

**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/) 

Vous devez spécifier un [DataDestination](API_DataDestination.md) objet qui inclut un rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder au compartiment Amazon S3. Pour de plus amples informations, veuillez consulter [Configuration d'autorisations pour Amazon Forecast](aws-forecast-iam-roles.md).

Pour de plus amples informations, veuillez consulter [Génération de prévisions](howitworks-forecast.md).

Pour obtenir une liste de toutes vos tâches d'exportation de prévisions hypothétiques, utilisez l'[ListWhatIfForecastExports](API_ListWhatIfForecastExports.md)opération.

**Note**  
La tâche `Status` d'exportation des prévisions doit avoir lieu `ACTIVE` avant que vous puissiez accéder aux prévisions dans votre compartiment Amazon S3. Pour obtenir le statut, utilisez l'[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)opération.

## Syntaxe de la requête
<a name="API_CreateWhatIfForecastExport_RequestSyntax"></a>

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportName": "string"
}
```

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

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

 ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Destination"></a>
L'emplacement où vous souhaitez enregistrer les prévisions et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à l'emplacement. Les prévisions doivent être exportées vers un compartiment Amazon S3.  
Si le chiffrement est utilisé, `Destination` il doit inclure une clé AWS Key Management Service (KMS). Le rôle IAM doit autoriser Amazon Forecast à accéder à la clé.  
Type : objet [DataDestination](API_DataDestination.md)  
Obligatoire : oui

 ** [Format](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$`   
Obligatoire : non

 ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Tags"></a>
Une liste de [balises](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) à appliquer aux prévisions hypothétiques.  
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : non

 ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastArns"></a>
La liste des prévisions hypothétiques Amazon Resource Names (ARNs) à exporter.  
Type : tableau de chaînes  
Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.  
Contraintes de longueur : longueur maximale de 300.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastExportName"></a>
Nom de la prévision hypothétique à exporter.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*`   
Obligatoire : oui

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

```
{
   "WhatIfForecastExportArn": "string"
}
```

## Eléments de réponse
<a name="API_CreateWhatIfForecastExport_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.

 ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecastExport-response-WhatIfForecastExportArn"></a>
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:.*:.*:.+` 

## Erreurs
<a name="API_CreateWhatIfForecastExport_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceAlreadyExistsException **   
Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_CreateWhatIfForecastExport_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/CreateWhatIfForecastExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecastExport) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

Supprime un ensemble de données Amazon Forecast créé à l'aide de cette [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)opération. Vous ne pouvez supprimer que les ensembles de données dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)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/) 

**Note**  
Forecast ne met pas automatiquement à jour les groupes de jeux de données contenant le jeu de données supprimé. Pour mettre à jour le groupe de jeux de données, utilisez l'[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)opération en omettant l'ARN du jeu de données supprimé.

## Syntaxe de la requête
<a name="API_DeleteDataset_RequestSyntax"></a>

```
{
   "DatasetArn": "string"
}
```

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

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

 ** [DatasetArn](#API_DeleteDataset_RequestSyntax) **   <a name="forecast-DeleteDataset-request-DatasetArn"></a>
Nom de ressource Amazon (ARN) de l'ensemble de données à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteDataset_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteDataset_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteDataset_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/DeleteDataset) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset) 

# DeleteDatasetGroup
<a name="API_DeleteDatasetGroup"></a>

Supprime un groupe de jeux de données créé à l'aide de l'[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)opération. Vous ne pouvez supprimer que les groupes de jeux de données dont le statut est `ACTIVE``CREATE_FAILED`, ou`UPDATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)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/) 

Cette opération supprime uniquement le groupe de jeux de données, pas les ensembles de données du groupe.

## Syntaxe de la requête
<a name="API_DeleteDatasetGroup_RequestSyntax"></a>

```
{
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **   <a name="forecast-DeleteDatasetGroup-request-DatasetGroupArn"></a>
Nom de ressource Amazon (ARN) du groupe de données à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteDatasetGroup_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteDatasetGroup_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteDatasetGroup_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/DeleteDatasetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup) 

# DeleteDatasetImportJob
<a name="API_DeleteDatasetImportJob"></a>

Supprime une tâche d'importation de jeu de données créée à l'aide de cette [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)opération. Vous ne pouvez supprimer que les tâches d'importation de jeux de données dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)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/) 

## Syntaxe de la requête
<a name="API_DeleteDatasetImportJob_RequestSyntax"></a>

```
{
   "DatasetImportJobArn": "string"
}
```

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

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

 ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) **   <a name="forecast-DeleteDatasetImportJob-request-DatasetImportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'importation de l'ensemble de données à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteDatasetImportJob_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteDatasetImportJob_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteDatasetImportJob_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/DeleteDatasetImportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) 

# DeleteExplainability
<a name="API_DeleteExplainability"></a>

Supprime une ressource d'explicabilité.

**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/) 

Vous ne pouvez supprimer que les prédicteurs dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeExplainability](API_DescribeExplainability.md)opération.

## Syntaxe de la requête
<a name="API_DeleteExplainability_RequestSyntax"></a>

```
{
   "ExplainabilityArn": "string"
}
```

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

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

 ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) **   <a name="forecast-DeleteExplainability-request-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de la ressource Explainability à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteExplainability_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteExplainability_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteExplainability_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/DeleteExplainability) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) 

# DeleteExplainabilityExport
<a name="API_DeleteExplainabilityExport"></a>

Supprime une exportation d'explicabilité.

## Syntaxe de la requête
<a name="API_DeleteExplainabilityExport_RequestSyntax"></a>

```
{
   "ExplainabilityExportArn": "string"
}
```

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

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

 ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) **   <a name="forecast-DeleteExplainabilityExport-request-ExplainabilityExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation Explainability à supprimer.   
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteExplainabilityExport_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteExplainabilityExport_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteExplainabilityExport_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/DeleteExplainabilityExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainabilityExport) 

# DeleteForecast
<a name="API_DeleteForecast"></a>

Supprime une prévision créée à l'aide de l'[CreateForecast](API_CreateForecast.md)opération. Vous ne pouvez supprimer que les prévisions dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeForecast](API_DescribeForecast.md)opération.

Vous ne pouvez pas supprimer une prévision pendant son exportation. Après la suppression d'une prévision, vous ne pouvez plus interroger la prévision.

**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/) 

## Syntaxe de la requête
<a name="API_DeleteForecast_RequestSyntax"></a>

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

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

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

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

## Éléments de réponse
<a name="API_DeleteForecast_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteForecast_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteForecast_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/DeleteForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast) 

# DeleteForecastExportJob
<a name="API_DeleteForecastExportJob"></a>

Supprime une tâche d'exportation de prévisions créée à l'aide de cette [CreateForecastExportJob](API_CreateForecastExportJob.md) opération. Vous ne pouvez supprimer que les tâches d'exportation dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribeForecastExportJob](API_DescribeForecastExportJob.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/) 

## Syntaxe de la requête
<a name="API_DeleteForecastExportJob_RequestSyntax"></a>

```
{
   "ForecastExportJobArn": "string"
}
```

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

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

 ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) **   <a name="forecast-DeleteForecastExportJob-request-ForecastExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation des prévisions à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteForecastExportJob_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteForecastExportJob_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteForecastExportJob_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/DeleteForecastExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) 

# DeleteMonitor
<a name="API_DeleteMonitor"></a>

Supprime une ressource de surveillance. Vous ne pouvez supprimer qu'une ressource de surveillance dont le statut est `ACTIVE``ACTIVE_STOPPED`,`CREATE_FAILED`, ou`CREATE_STOPPED`.

**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/) 

## Syntaxe de la requête
<a name="API_DeleteMonitor_RequestSyntax"></a>

```
{
   "MonitorArn": "string"
}
```

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

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

 ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) **   <a name="forecast-DeleteMonitor-request-MonitorArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteMonitor_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteMonitor_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteMonitor_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/DeleteMonitor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteMonitor) 

# DeletePredictor
<a name="API_DeletePredictor"></a>

Supprime un prédicteur créé à l'aide des opérations [DescribePredictor](API_DescribePredictor.md) or[CreatePredictor](API_CreatePredictor.md). Vous ne pouvez supprimer que les prédicteurs dont le statut est `ACTIVE` ou`CREATE_FAILED`. Pour obtenir le statut, utilisez l'[DescribePredictor](API_DescribePredictor.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/) 

## Syntaxe de la requête
<a name="API_DeletePredictor_RequestSyntax"></a>

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DeletePredictor_RequestSyntax) **   <a name="forecast-DeletePredictor-request-PredictorArn"></a>
Nom de ressource Amazon (ARN) du prédicteur à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeletePredictor_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeletePredictor_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeletePredictor_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/DeletePredictor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor) 

# DeletePredictorBacktestExportJob
<a name="API_DeletePredictorBacktestExportJob"></a>

Supprime une tâche d'exportation de backtest prédictif.

**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/) 

## Syntaxe de la requête
<a name="API_DeletePredictorBacktestExportJob_RequestSyntax"></a>

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

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

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

 ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DeletePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation du backtest prédicteur à supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeletePredictorBacktestExportJob_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeletePredictorBacktestExportJob_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeletePredictorBacktestExportJob_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/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 

# DeleteResourceTree
<a name="API_DeleteResourceTree"></a>

Supprime une arborescence de ressources complète. Cette opération supprimera la ressource parent et ses ressources enfants.

**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/) 

Les ressources pour enfants sont des ressources créées à partir d'une autre ressource. Par exemple, lorsqu'une prévision est générée à partir d'un prédicteur, la prévision est la ressource enfant et le prédicteur est la ressource parent.

Les ressources Amazon Forecast possèdent les hiérarchies de ressources parent-enfant suivantes :
+  **Ensemble de données** : tâches d'importation de jeux de données
+  **Groupe de données** : prédicteurs, tâches d'exportation rétrotests de prédicteurs, prévisions, tâches d'exportation de prévisions
+  **Prédicteur** : analyse rétrospective des tâches d'exportation, prévisions, prévisions des emplois d'exportation
+  **Forecast : prévisions** d'emplois dans le secteur de l'exportation

**Note**  
 `DeleteResourceTree`supprimera uniquement les ressources Amazon Forecast et ne supprimera pas les ensembles de données ni les fichiers exportés stockés dans Amazon S3. 

## Syntaxe de la requête
<a name="API_DeleteResourceTree_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) **   <a name="forecast-DeleteResourceTree-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) de la ressource parent à supprimer. Toutes les ressources enfants de la ressource parent seront également supprimées.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteResourceTree_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteResourceTree_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteResourceTree_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/DeleteResourceTree) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) 

# DeleteWhatIfAnalysis
<a name="API_DeleteWhatIfAnalysis"></a>

Supprime une analyse hypothétique créée à l'aide de l'opération. [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) Vous ne pouvez supprimer que les analyses hypothétiques dont le statut est ou. `ACTIVE` `CREATE_FAILED` Pour obtenir le statut, utilisez l'[DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md)opération. 

Vous ne pouvez pas supprimer une analyse hypothétique pendant que l'une de ses prévisions est exportée.

**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/) 

## Syntaxe de la requête
<a name="API_DeleteWhatIfAnalysis_RequestSyntax"></a>

```
{
   "WhatIfAnalysisArn": "string"
}
```

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

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

 ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) **   <a name="forecast-DeleteWhatIfAnalysis-request-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique que vous souhaitez supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteWhatIfAnalysis_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteWhatIfAnalysis_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteWhatIfAnalysis_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/DeleteWhatIfAnalysis) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 

# DeleteWhatIfForecast
<a name="API_DeleteWhatIfForecast"></a>

Supprime une prévision hypothétique créée à l'aide de cette opération. [CreateWhatIfForecast](API_CreateWhatIfForecast.md) Vous ne pouvez supprimer que les prévisions hypothétiques dont le statut est ou. `ACTIVE` `CREATE_FAILED` Pour obtenir le statut, utilisez l'[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md)opération. 

Vous ne pouvez pas supprimer une prévision hypothétique pendant son exportation. Une fois qu'une prévision hypothétique est supprimée, vous ne pouvez plus interroger l'analyse hypothétique.

## Syntaxe de la requête
<a name="API_DeleteWhatIfForecast_RequestSyntax"></a>

```
{
   "WhatIfForecastArn": "string"
}
```

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

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

 ** [WhatIfForecastArn](#API_DeleteWhatIfForecast_RequestSyntax) **   <a name="forecast-DeleteWhatIfForecast-request-WhatIfForecastArn"></a>
Le nom de ressource Amazon (ARN) de la prévision hypothétique que vous souhaitez supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 300.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteWhatIfForecast_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteWhatIfForecast_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteWhatIfForecast_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/DeleteWhatIfForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) 

# DeleteWhatIfForecastExport
<a name="API_DeleteWhatIfForecastExport"></a>

Supprime une exportation de prévisions hypothétiques créée à l'aide de cette opération. [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) Vous ne pouvez supprimer que les exportations de prévisions hypothétiques dont le statut est ou. `ACTIVE` `CREATE_FAILED` Pour obtenir le statut, utilisez l'[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)opération. 

## Syntaxe de la requête
<a name="API_DeleteWhatIfForecastExport_RequestSyntax"></a>

```
{
   "WhatIfForecastExportArn": "string"
}
```

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

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

 ** [WhatIfForecastExportArn](#API_DeleteWhatIfForecastExport_RequestSyntax) **   <a name="forecast-DeleteWhatIfForecastExport-request-WhatIfForecastExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation de prévisions hypothétiques que vous souhaitez supprimer.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 300.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_DeleteWhatIfForecastExport_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_DeleteWhatIfForecastExport_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_DeleteWhatIfForecastExport_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/DeleteWhatIfForecastExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 

# DescribeAutoPredictor
<a name="API_DescribeAutoPredictor"></a>

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

## Syntaxe de la requête
<a name="API_DescribeAutoPredictor_RequestSyntax"></a>

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) **   <a name="forecast-DescribeAutoPredictor-request-PredictorArn"></a>
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
<a name="API_DescribeAutoPredictor_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeAutoPredictor_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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-CreationTime"></a>
Horodatage de la CreateAutoPredictor demande.  
Type : Timestamp

 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DataConfig"></a>
La configuration des données de votre groupe de jeux de données et de tous les ensembles de données supplémentaires.  
Type : objet [DataConfig](API_DataConfig.md)

 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DatasetImportJobArns"></a>
Tableau des tâches d'importation ARNs de jeux de données utilisées pour importer les données d'apprentissage pour le prédicteur.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EncryptionConfig"></a>
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](API_CreatePredictor.md) demandes [CreateDataset](API_CreateDataset.md) et.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)

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

 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ExplainabilityInfo"></a>
Fournit le statut et l'ARN de l'explicabilité du prédicteur.  
Type : objet [ExplainabilityInfo](API_ExplainabilityInfo.md)

 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastDimensions"></a>
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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastFrequency"></a>
Fréquence des prédictions contenues 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 « 5 minutes » 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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastHorizon"></a>
Nombre d'étapes temporelles prédites par le modèle. L’horizon de prévision est également appelé longueur de prédiction.  
Type : Integer

 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastTypes"></a>
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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
En cas d'erreur, un message détaillant la cause de l'erreur.  
Type : Chaîne

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
Un [MonitorInfo](API_MonitorInfo.md) objet portant le nom de ressource Amazon (ARN) et le statut de la ressource de surveillance.  
Type : objet [MonitorInfo](API_MonitorInfo.md)

 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-OptimizationMetric"></a>
Mesure de précision utilisée pour optimiser le prédicteur.  
Type : Chaîne  
Valeurs valides : `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorArn"></a>
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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorName"></a>
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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ReferencePredictorSummary"></a>
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 améliorés.  
Type : objet [ReferencePredictorSummary](API_ReferencePredictorSummary.md)

 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Status"></a>
É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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-TimeAlignmentBoundary"></a>
La limite de temps utilisée par Forecast lors de l'agrégation des données.  
Type : objet [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md)

## Erreurs
<a name="API_DescribeAutoPredictor_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_DescribeAutoPredictor_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/DescribeAutoPredictor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeAutoPredictor) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

Décrit un jeu de données Amazon Forecast créé à l'aide de [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)cette 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 paramètres spécifiés dans la `CreateDataset` demande, cette opération inclut les propriétés de jeu de données suivantes :
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

## Syntaxe de la requête
<a name="API_DescribeDataset_RequestSyntax"></a>

```
{
   "DatasetArn": "string"
}
```

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

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

 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="forecast-DescribeDataset-request-DatasetArn"></a>
L'Amazon Resource Name (ARN) du jeu de données.  
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_DescribeDataset_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "DataFrequency": "string",
   "DatasetArn": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "LastModificationTime": number,
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeDataset_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_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-CreationTime"></a>
Quand le jeu de données a été créé.  
Type : Timestamp

 ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DataFrequency"></a>
La fréquence de collecte des données.  
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, « M » indique tous les mois et « 30 minutes » indique toutes les 30 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$` 

 ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetArn"></a>
L'Amazon Resource Name (ARN) du jeu de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetName"></a>
Nom de l'ensemble de données.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [DatasetType](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetType"></a>
Le type de jeu de données.  
Type : Chaîne  
Valeurs valides : `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 

 ** [Domain](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Domain"></a>
Le domaine associé au jeu de données.  
Type : Chaîne  
Valeurs valides : `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-EncryptionConfig"></a>
La clé AWS Key Management Service (KMS) et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)

 ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-LastModificationTime"></a>
Lorsque vous créez un jeu de données, `LastModificationTime` c'est la même chose que`CreationTime`. Pendant l'importation des données dans l'ensemble de données, `LastModificationTime` c'est l'heure actuelle de l'`DescribeDataset`appel. Une fois qu'une [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)opération est terminée, `LastModificationTime` c'est lorsque le travail d'importation s'est terminé ou a échoué.  
Type : Timestamp

 ** [Schema](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Schema"></a>
Tableau d'`SchemaAttribute`objets qui spécifient les champs du jeu de données. Chacun `SchemaAttribute` indique le nom et le type de données d'un champ.  
Type : objet [Schema](API_Schema.md)

 ** [Status](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Status"></a>
État de l'ensemble de données. Les États incluent :  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
Les `UPDATE` états s'appliquent lorsque les données sont importées dans l'ensemble de données à la suite d'un appel à l'[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)opération et reflètent le statut de la tâche d'importation de l'ensemble de données. Par exemple, lorsque le statut de la tâche d'importation est`CREATE_IN_PROGRESS`, le statut de l'ensemble de données est`UPDATE_IN_PROGRESS`.  
Le jeu `Status` de données doit l'être pour `ACTIVE` que vous puissiez importer des données d'entraînement.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

## Erreurs
<a name="API_DescribeDataset_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_DescribeDataset_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/DescribeDataset) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset) 

# DescribeDatasetGroup
<a name="API_DescribeDatasetGroup"></a>

Décrit un groupe de jeux de données créé à l'aide de l'[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)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 paramètres fournis dans la `CreateDatasetGroup` demande, cette opération inclut les propriétés suivantes :
+  `DatasetArns`- Les ensembles de données appartenant au groupe.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

## Syntaxe de la requête
<a name="API_DescribeDatasetGroup_RequestSyntax"></a>

```
{
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **   <a name="forecast-DescribeDatasetGroup-request-DatasetGroupArn"></a>
L'Amazon Resource Name (ARN) du groupe de jeux de données.  
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_DescribeDatasetGroup_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "DatasetArns": [ "string" ],
   "DatasetGroupArn": "string",
   "DatasetGroupName": "string",
   "Domain": "string",
   "LastModificationTime": number,
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeDatasetGroup_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_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-CreationTime"></a>
Quand le groupe de jeux de données a été créé.  
Type : Timestamp

 ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetArns"></a>
Un tableau des Amazon Resource Names (ARNs) des ensembles de données contenus dans le groupe de jeux de données.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupArn"></a>
L'ARN du groupe de jeux de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupName"></a>
Le nom du groupe de jeux de données.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Domain"></a>
Le domaine associé au groupe de jeux de données.  
Type : Chaîne  
Valeurs valides : `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-LastModificationTime"></a>
Date de création ou de dernière mise à jour du groupe de jeux de données suite à un appel à l'[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)opération. Pendant la mise à jour du groupe de jeux de données, `LastModificationTime` c'est l'heure actuelle de l'`DescribeDatasetGroup`appel.  
Type : Timestamp

 ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Status"></a>
État du groupe de jeux de données. Les États incluent :  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
Les `UPDATE` états s'appliquent lorsque vous appelez l'[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)opération.  
Le groupe `Status` de jeux de données doit être celui du groupe de `ACTIVE` données pour que vous puissiez utiliser le groupe de jeux de données pour créer un prédicteur.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

## Erreurs
<a name="API_DescribeDatasetGroup_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_DescribeDatasetGroup_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/DescribeDatasetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetGroup) 

# DescribeDatasetImportJob
<a name="API_DescribeDatasetImportJob"></a>

Décrit une tâche d'importation de jeu de données créée à l'aide de [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)cette 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 paramètres fournis dans la `CreateDatasetImportJob` demande, cette opération inclut les propriétés suivantes :
+  `CreationTime` 
+  `LastModificationTime` 
+  `DataSize` 
+  `FieldStatistics` 
+  `Status` 
+  `Message`- Si une erreur s'est produite, informations sur l'erreur.

## Syntaxe de la requête
<a name="API_DescribeDatasetImportJob_RequestSyntax"></a>

```
{
   "DatasetImportJobArn": "string"
}
```

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

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

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **   <a name="forecast-DescribeDatasetImportJob-request-DatasetImportJobArn"></a>
Le nom de ressource Amazon (ARN) de la tâche d'importation de l'ensemble de données.  
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_DescribeDatasetImportJob_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "DatasetArn": "string",
   "DatasetImportJobArn": "string",
   "DatasetImportJobName": "string",
   "DataSize": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EstimatedTimeRemainingInMinutes": number,
   "FieldStatistics": { 
      "string" : { 
         "Avg": number,
         "Count": number,
         "CountDistinct": number,
         "CountDistinctLong": number,
         "CountLong": number,
         "CountNan": number,
         "CountNanLong": number,
         "CountNull": number,
         "CountNullLong": number,
         "Max": "string",
         "Min": "string",
         "Stddev": number
      }
   },
   "Format": "string",
   "GeolocationFormat": "string",
   "ImportMode": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimestampFormat": "string",
   "TimeZone": "string",
   "UseGeolocationForTimeZone": boolean
}
```

## Eléments de réponse
<a name="API_DescribeDatasetImportJob_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_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-CreationTime"></a>
Date de création de la tâche d'importation de l'ensemble de données.  
Type : Timestamp

 ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetArn"></a>
Le nom de ressource Amazon (ARN) de l'ensemble de données dans lequel les données d'entraînement ont été importées.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobArn"></a>
L'ARN de la tâche d'importation du jeu de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobName"></a>
Nom de la tâche d'importation de l'ensemble de données.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSize"></a>
Taille du jeu de données en gigaoctets (Go) une fois le travail d'importation terminé.  
Type : double

 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSource"></a>
L'emplacement des données d'entraînement à importer et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder aux données.  
Si le chiffrement est utilisé, `DataSource` inclut une clé AWS Key Management Service (KMS).  
Type : objet [DataSource](API_DataSource.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-EstimatedTimeRemainingInMinutes"></a>
Durée estimée restant, en minutes, pour terminer la tâche d'importation du jeu de données.  
Type : Long

 ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-FieldStatistics"></a>
Informations statistiques sur chaque champ des données d'entrée.  
Type : mappage entre chaîne et [Statistics](API_Statistics.md) objet  
Contraintes relatives à la longueur des clés : longueur maximale de 256.  
Modèle de clé :`^[a-zA-Z0-9\_]+$` 

 ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Format"></a>
Le format des données importées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$` 

 ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-GeolocationFormat"></a>
Format de l'attribut de géolocalisation. Valeurs valides : `"LAT_LONG"` et `"CC_POSTALCODE"`.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9_]+$` 

 ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-ImportMode"></a>
Mode d'importation de la tâche d'importation de l'ensemble de données, FULL ou INCREMENTAL.  
Type : Chaîne  
Valeurs valides : `FULL | INCREMENTAL` 

 ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-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_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Status"></a>
État de la tâche d'importation de l'ensemble de données. Les États incluent :  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

 ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimestampFormat"></a>
Format des horodatages dans le jeu de données. Le format que vous spécifiez dépend du moment où le `DataFrequency` jeu de données a été créé. Les formats suivants sont pris en charge  
+ « YYYY-MM-DD »

  Pour les fréquences de données suivantes : Y, M, W et D
+ « yyyy-MM-dd  HH : MM : SS »

  Pour les fréquences de données suivantes : H, 30 min, 15 min et 1 min ; et éventuellement, pour : Y, M, W et D
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\-\:\.\,\'\s]+$` 

 ** [TimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimeZone"></a>
Le fuseau horaire unique appliqué à chaque élément du jeu de données  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\/\+\-\_]+$` 

 ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-UseGeolocationForTimeZone"></a>
S'il `TimeZone` est automatiquement dérivé de l'attribut de géolocalisation.  
Type : Boolean

## Erreurs
<a name="API_DescribeDatasetImportJob_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_DescribeDatasetImportJob_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/DescribeDatasetImportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob) 

# DescribeExplainability
<a name="API_DescribeExplainability"></a>

Décrit une ressource d'explicabilité créée à l'aide de l'[CreateExplainability](API_CreateExplainability.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/) 

## Syntaxe de la requête
<a name="API_DescribeExplainability_RequestSyntax"></a>

```
{
   "ExplainabilityArn": "string"
}
```

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

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

 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) **   <a name="forecast-DescribeExplainability-request-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de l'explicabilité à décrire.  
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_DescribeExplainability_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityArn": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "LastModificationTime": number,
   "Message": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeExplainability_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_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-CreationTime"></a>
Date de création de la ressource Explainability.  
Type : Timestamp

 ** [DataSource](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-DataSource"></a>
La source de vos données, un rôle Gestion des identités et des accès AWS (IAM) qui permet à Amazon Forecast d'accéder aux données et, éventuellement, une clé AWS Key Management Service (KMS).  
Type : objet [DataSource](API_DataSource.md)

 ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EnableVisualization"></a>
Si la visualisation a été activée pour la ressource Explainability.  
Type : Boolean

 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EndDateTime"></a>
Il `TimePointGranularity` est défini sur`SPECIFIC`, le dernier point temporel de l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 19.  
Modèle : `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EstimatedTimeRemainingInMinutes"></a>
Le temps restant estimé, en minutes, pour terminer le [CreateExplainability](API_CreateExplainability.md) travail.  
Type : Long

 ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityConfig"></a>
Les paramètres de configuration qui définissent la granularité des séries chronologiques et des points temporels pour l'explicabilité.  
Type : objet [ExplainabilityConfig](API_ExplainabilityConfig.md)

 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityName"></a>
Le nom de l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-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_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Message"></a>
Si une erreur s'est produite, un message la concernant.  
Type : Chaîne

 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ResourceArn"></a>
Le nom de ressource Amazon (ARN) du Predictor ou Forecast utilisé pour créer la ressource Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Schema](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Schema"></a>
Définit les champs d'un jeu de données.  
Type : objet [Schema](API_Schema.md)

 ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-StartDateTime"></a>
Il `TimePointGranularity` est défini sur`SPECIFIC`, le premier point temporel de l'explicabilité.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 19.  
Modèle : `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [Status](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Status"></a>
État de la ressource Explainability. 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.

## Erreurs
<a name="API_DescribeExplainability_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_DescribeExplainability_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/DescribeExplainability) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability) 

# DescribeExplainabilityExport
<a name="API_DescribeExplainabilityExport"></a>

Décrit une exportation d'explicabilité créée à l'aide de l'[CreateExplainabilityExport](API_CreateExplainabilityExport.md)opération.

## Syntaxe de la requête
<a name="API_DescribeExplainabilityExport_RequestSyntax"></a>

```
{
   "ExplainabilityExportArn": "string"
}
```

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

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

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) **   <a name="forecast-DescribeExplainabilityExport-request-ExplainabilityExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation Explainability.  
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_DescribeExplainabilityExport_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ExplainabilityArn": "string",
   "ExplainabilityExportArn": "string",
   "ExplainabilityExportName": "string",
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeExplainabilityExport_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_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-CreationTime"></a>
Quand l'export Explainability a été créé.  
Type : Timestamp

 ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Destination"></a>
Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).   
Type : objet [DataDestination](API_DataDestination.md)

 ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportName"></a>
Nom de l'exportation Explainability.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-LastModificationTime"></a>
Dernière modification de la ressource. 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_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Message"></a>
Informations sur les erreurs survenues lors de l'exportation.  
Type : Chaîne

 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Status"></a>
État de l'exportation de l'explicabilité. 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.

## Erreurs
<a name="API_DescribeExplainabilityExport_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_DescribeExplainabilityExport_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/DescribeExplainabilityExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainabilityExport) 

# 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) 

# DescribeForecastExportJob
<a name="API_DescribeForecastExportJob"></a>

Décrit une tâche d'exportation de prévisions créée à l'aide de [CreateForecastExportJob](API_CreateForecastExportJob.md) cette opération.

Outre la liste des propriétés fournies par l'utilisateur dans la `CreateForecastExportJob` demande, cette opération répertorie les propriétés suivantes :
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`- En cas d'erreur, informations sur l'erreur.

## Syntaxe de la requête
<a name="API_DescribeForecastExportJob_RequestSyntax"></a>

```
{
   "ForecastExportJobArn": "string"
}
```

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

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

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) **   <a name="forecast-DescribeForecastExportJob-request-ForecastExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation des prévisions.  
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_DescribeForecastExportJob_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ForecastArn": "string",
   "ForecastExportJobArn": "string",
   "ForecastExportJobName": "string",
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeForecastExportJob_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_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-CreationTime"></a>
Date de création de la tâche d'exportation des prévisions.  
Type : Timestamp

 ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Destination"></a>
Le chemin d'accès au compartiment Amazon Simple Storage Service (Amazon S3) dans lequel les prévisions sont exportées.  
Type : objet [DataDestination](API_DataDestination.md)

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

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobArn"></a>
L'ARN de la tâche d'exportation des prévisions.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobName"></a>
Nom de la tâche d'exportation des prévisions.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-LastModificationTime"></a>
Dernière modification de la ressource. 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_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Status"></a>
État de la tâche d'exportation des prévisions. Les États incluent :  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
La tâche `Status` d'exportation des prévisions doit avoir lieu `ACTIVE` avant que vous puissiez accéder aux prévisions dans votre compartiment S3.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

## Erreurs
<a name="API_DescribeForecastExportJob_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_DescribeForecastExportJob_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/DescribeForecastExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecastExportJob) 

# DescribeMonitor
<a name="API_DescribeMonitor"></a>

Décrit une ressource de surveillance. Outre la liste des propriétés fournies dans la [CreateMonitor](API_CreateMonitor.md) demande, cette opération répertorie les propriétés suivantes :
+  `Baseline` 
+  `CreationTime` 
+  `LastEvaluationTime` 
+  `LastEvaluationState` 
+  `LastModificationTime` 
+  `Message` 
+  `Status` 

**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/) 

## Syntaxe de la requête
<a name="API_DescribeMonitor_RequestSyntax"></a>

```
{
   "MonitorArn": "string"
}
```

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

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

 ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) **   <a name="forecast-DescribeMonitor-request-MonitorArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance à décrire.  
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_DescribeMonitor_ResponseSyntax"></a>

```
{
   "Baseline": { 
      "PredictorBaseline": { 
         "BaselineMetrics": [ 
            { 
               "Name": "string",
               "Value": number
            }
         ]
      }
   },
   "CreationTime": number,
   "EstimatedEvaluationTimeRemainingInMinutes": number,
   "LastEvaluationState": "string",
   "LastEvaluationTime": number,
   "LastModificationTime": number,
   "Message": "string",
   "MonitorArn": "string",
   "MonitorName": "string",
   "ResourceArn": "string",
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribeMonitor_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.

 ** [Baseline](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Baseline"></a>
Des mesures que vous pouvez utiliser comme base de référence à des fins de comparaison. Utilisez ces valeurs pour interpréter les résultats de surveillance pour un autoprédicteur.  
Type : objet [Baseline](API_Baseline.md)

 ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-CreationTime"></a>
Horodatage de la création de la ressource de surveillance.  
Type : Timestamp

 ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-EstimatedEvaluationTimeRemainingInMinutes"></a>
Nombre estimé de minutes restantes avant que la ressource de surveillance ne termine son évaluation en cours.  
Type : Long

 ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationState"></a>
État de la dernière évaluation du moniteur.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

 ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationTime"></a>
Horodatage de la dernière évaluation effectuée par le moniteur.  
Type : Timestamp

 ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastModificationTime"></a>
Horodatage de la dernière modification apportée au moniteur.  
Type : Timestamp

 ** [Message](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Message"></a>
Un message d'erreur, le cas échéant, pour le moniteur.  
Type : Chaîne

 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance décrite.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorName"></a>
Nom du moniteur.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-ResourceArn"></a>
Le nom de ressource Amazon (ARN) de l'autoprédicteur surveillé.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Status](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Status"></a>
État de la ressource du moniteur.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

## Erreurs
<a name="API_DescribeMonitor_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_DescribeMonitor_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/DescribeMonitor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeMonitor) 

# DescribePredictor
<a name="API_DescribePredictor"></a>

**Note**  
 Cette opération n'est valide que pour les anciens prédicteurs créés avec CreatePredictor. Si vous n'utilisez pas d'ancien prédicteur, utilisez[DescribeAutoPredictor](API_DescribeAutoPredictor.md).

Décrit un prédicteur créé à l'aide de l'[CreatePredictor](API_CreatePredictor.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 `CreatePredictor` demande, cette opération répertorie les propriétés suivantes :
+  `DatasetImportJobArns`- Les tâches d'importation de jeux de données utilisées pour importer les données d'entraînement.
+  `AutoMLAlgorithmArns`- Si AutoML est exécuté, les algorithmes qui ont été évalués.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`- Si une erreur s'est produite, informations sur l'erreur.

## Syntaxe de la requête
<a name="API_DescribePredictor_RequestSyntax"></a>

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) **   <a name="forecast-DescribePredictor-request-PredictorArn"></a>
Le nom de ressource Amazon (ARN) du prédicteur sur lequel vous souhaitez obtenir des informations.  
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_DescribePredictor_ResponseSyntax"></a>

```
{
   "AlgorithmArn": "string",
   "AutoMLAlgorithmArns": [ "string" ],
   "AutoMLOverrideStrategy": "string",
   "CreationTime": number,
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "IsAutoPredictor": boolean,
   "LastModificationTime": number,
   "Message": "string",
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorArn": "string",
   "PredictorExecutionDetails": { 
      "PredictorExecutions": [ 
         { 
            "AlgorithmArn": "string",
            "TestWindows": [ 
               { 
                  "Message": "string",
                  "Status": "string",
                  "TestWindowEnd": number,
                  "TestWindowStart": number
               }
            ]
         }
      ]
   },
   "PredictorName": "string",
   "Status": "string",
   "TrainingParameters": { 
      "string" : "string" 
   }
}
```

## Eléments de réponse
<a name="API_DescribePredictor_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.

 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AlgorithmArn"></a>
Amazon Resource Name (ARN) de l'algorithme utilisé pour l'entraînement des modèles.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLAlgorithmArns"></a>
Quand `PerformAutoML` est spécifié, l'ARN de l'algorithme choisi.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLOverrideStrategy"></a>
 La stratégie de `LatencyOptimized` remplacement AutoML n'est disponible qu'en version bêta privée. Contactez AWS le Support ou votre responsable de compte pour en savoir plus sur les privilèges d'accès. 
Stratégie AutoML utilisée pour entraîner le prédicteur. Sauf indication contraire`LatencyOptimized`, la stratégie AutoML optimise la précision des prédicteurs.  
Ce paramètre n'est valide que pour les prédicteurs entraînés à l'aide d'AutoML.  
Type : Chaîne  
Valeurs valides : `LatencyOptimized | AccuracyOptimized` 

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
Date de création de la tâche d'entraînement du modèle.  
Type : Timestamp

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-DatasetImportJobArns"></a>
Tableau des tâches d'importation ARNs de jeux de données utilisées pour importer les données d'apprentissage pour le prédicteur.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EncryptionConfig"></a>
Une clé AWS Key Management Service (KMS) et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé.  
Type : objet [EncryptionConfig](API_EncryptionConfig.md)

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

 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EvaluationParameters"></a>
Utilisé pour remplacer les paramètres d'évaluation par défaut de l'algorithme spécifié. Amazon Forecast évalue un prédicteur en divisant un ensemble de données en données d'entraînement et en données de test. Les paramètres d'évaluation définissent la manière d'effectuer le fractionnement et le nombre d'itérations.  
Type : objet [EvaluationParameters](API_EvaluationParameters.md)

 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-FeaturizationConfig"></a>
La configuration des fonctionnalités.  
Type : objet [FeaturizationConfig](API_FeaturizationConfig.md)

 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastHorizon"></a>
Le nombre d'étapes temporelles de la prévision. L’horizon de prévision est également appelé longueur de prédiction.  
Type : Integer

 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastTypes"></a>
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$)` 

 ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-HPOConfig"></a>
L'hyperparamètre remplace les valeurs de l'algorithme.  
Type : objet [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)

 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-InputDataConfig"></a>
Décrit le groupe de jeux de données qui contient les données à utiliser pour entraîner le prédicteur.  
Type : objet [InputDataConfig](API_InputDataConfig.md)

 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-IsAutoPredictor"></a>
Si le prédicteur a été créé avec[CreateAutoPredictor](API_CreateAutoPredictor.md).  
Type : Boolean

 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-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_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-OptimizationMetric"></a>
Mesure de précision utilisée pour optimiser le prédicteur.  
Type : Chaîne  
Valeurs valides : `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformAutoML"></a>
Si le prédicteur est configuré pour exécuter AutoML.  
Type : Boolean

 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformHPO"></a>
Si le prédicteur est configuré pour effectuer une optimisation des hyperparamètres (HPO).  
Type : Boolean

 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorArn"></a>
L'ARN 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_]*` 

 ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorExecutionDetails"></a>
Détails sur l'état et les résultats des backtests effectués pour évaluer la précision du prédicteur. Vous spécifiez le nombre de backtests à effectuer lorsque vous appelez l'[CreatePredictor](API_CreatePredictor.md)opération.  
Type : objet [PredictorExecutionDetails](API_PredictorExecutionDetails.md)

 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorName"></a>
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_]*` 

 ** [Status](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Status"></a>
État du prédicteur. Les États incluent :  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
Le `Status` prédicteur doit être défini `ACTIVE` avant que vous puissiez utiliser le prédicteur pour créer une prévision.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-TrainingParameters"></a>
Les paramètres d'entraînement par défaut ou les remplacements sélectionnés lors de l'entraînement du modèle. Lorsque vous exécutez AutoML ou que vous choisissez HPO avec CNN-QR ou DeepAr\$1, les valeurs optimisées pour les hyperparamètres choisis sont renvoyées. Pour de plus amples informations, veuillez consulter [Algorithmes d'Amazon Forecast](aws-forecast-choosing-recipes.md).  
Type : mappage chaîne/chaîne  
Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 100 éléments.  
Contraintes relatives à la longueur des clés : longueur maximale de 256.  
Modèle de clé :`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`   
Contraintes de longueur de valeur : longueur maximale de 256.  
Modèle de valeur : `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 

## Erreurs
<a name="API_DescribePredictor_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_DescribePredictor_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/DescribePredictor) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor) 

# DescribePredictorBacktestExportJob
<a name="API_DescribePredictorBacktestExportJob"></a>

Décrit une tâche d'exportation de backtest prédictif créée à l'aide de l'[CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.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 par l'utilisateur dans la `CreatePredictorBacktestExportJob` demande, cette opération répertorie les propriétés suivantes :
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`(en cas d'erreur)

## Syntaxe de la requête
<a name="API_DescribePredictorBacktestExportJob_RequestSyntax"></a>

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

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

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

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation du backtest 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
<a name="API_DescribePredictorBacktestExportJob_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "PredictorArn": "string",
   "PredictorBacktestExportJobArn": "string",
   "PredictorBacktestExportJobName": "string",
   "Status": "string"
}
```

## Eléments de réponse
<a name="API_DescribePredictorBacktestExportJob_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_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-CreationTime"></a>
Lorsque la tâche d'exportation du backtest du prédicteur a été créée.  
Type : Timestamp

 ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Destination"></a>
Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).   
Type : objet [DataDestination](API_DataDestination.md)

 ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-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_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Message"></a>
Informations sur les erreurs qui ont pu se produire lors de l'exportation du backtest.  
Type : Chaîne

 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorArn"></a>
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:.*:.*:.+` 

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
Nom de ressource Amazon (ARN) de la tâche d'exportation du backtest du prédicteur.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobName"></a>
Nom de la tâche d'exportation du backtest 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_]*` 

 ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Status"></a>
État de la tâche d'exportation du backtest 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.

## Erreurs
<a name="API_DescribePredictorBacktestExportJob_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_DescribePredictorBacktestExportJob_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/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 

# DescribeWhatIfAnalysis
<a name="API_DescribeWhatIfAnalysis"></a>

Décrit l'analyse hypothétique créée à l'aide de l'[CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.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 `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
<a name="API_DescribeWhatIfAnalysis_RequestSyntax"></a>

```
{
   "WhatIfAnalysisArn": "string"
}
```

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

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

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_RequestSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-request-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique qui vous intéresse.  
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_DescribeWhatIfAnalysis_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeWhatIfAnalysis_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_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-CreationTime"></a>
Quand l'analyse hypothétique a été créée.  
Type : Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-EstimatedTimeRemainingInMinutes"></a>
Temps approximatif restant pour terminer l'analyse hypothétique, en minutes.  
Type : Long

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

 ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-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_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Status"></a>
É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` 
L'`Status`analyse hypothétique doit avoir lieu `ACTIVE` avant que vous puissiez accéder à l'analyse.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesSelector](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-TimeSeriesSelector"></a>
Définit l'ensemble des séries chronologiques utilisées pour créer les prévisions dans un `TimeSeriesIdentifiers` objet.  
L'`TimeSeriesIdentifiers`objet a besoin des informations suivantes :  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Type : objet [TimeSeriesSelector](API_TimeSeriesSelector.md)

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisName"></a>
Le nom de l'analyse 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
<a name="API_DescribeWhatIfAnalysis_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_DescribeWhatIfAnalysis_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/DescribeWhatIfAnalysis) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 

# DescribeWhatIfForecast
<a name="API_DescribeWhatIfForecast"></a>

Décrit la prévision hypothétique créée à l'aide de l'[CreateWhatIfForecast](API_CreateWhatIfForecast.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 `CreateWhatIfForecast` 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
<a name="API_DescribeWhatIfForecast_RequestSyntax"></a>

```
{
   "WhatIfForecastArn": "string"
}
```

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

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

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecast-request-WhatIfForecastArn"></a>
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
<a name="API_DescribeWhatIfForecast_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeWhatIfForecast_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_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-CreationTime"></a>
Quand la prévision hypothétique a été créée.  
Type : Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-EstimatedTimeRemainingInMinutes"></a>
Le temps approximatif restant pour terminer les prévisions hypothétiques, en minutes.  
Type : Long

 ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-ForecastTypes"></a>
Quantiles à partir desquels les prévisions probabilistes sont générées. Vous pouvez spécifier jusqu'à cinq quantiles par prévision hypothétique dans le cadre de l'opération. [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 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](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-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_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Status"></a>
É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` 
La prévision `Status` hypothétique doit être `ACTIVE` antérieure à ce que vous puissiez accéder à la prévision.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesReplacementsDataSource"></a>
Tableau d'`Format`éléments `S3Config``Schema`, et décrivant la série chronologique de remplacement.  
Type : objet [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md)

 ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesTransformations"></a>
Un ensemble `Action` d'`TimeSeriesConditions`éléments décrivant quelles transformations ont été appliquées à telle ou telle série chronologique.  
Type : tableau d’objets [TimeSeriesTransformation](API_TimeSeriesTransformation.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 30 articles.

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfAnalysisArn"></a>
Le nom de ressource Amazon (ARN) de l'analyse hypothétique contenant cette prévision.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastArn"></a>
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](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastName"></a>
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
<a name="API_DescribeWhatIfForecast_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_DescribeWhatIfForecast_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/DescribeWhatIfForecast) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast) 

# DescribeWhatIfForecastExport
<a name="API_DescribeWhatIfForecastExport"></a>

Décrit l'exportation de prévisions hypothétiques créée à l'aide de cette opération. [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md)

**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 `CreateWhatIfForecastExport` 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
<a name="API_DescribeWhatIfForecastExport_RequestSyntax"></a>

```
{
   "WhatIfForecastExportArn": "string"
}
```

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

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

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-request-WhatIfForecastExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation de prévisions hypothétiques 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
<a name="API_DescribeWhatIfForecastExport_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EstimatedTimeRemainingInMinutes": number,
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportArn": "string",
   "WhatIfForecastExportName": "string"
}
```

## Eléments de réponse
<a name="API_DescribeWhatIfForecastExport_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_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-CreationTime"></a>
Quand l'exportation des prévisions hypothétiques a été créée.  
Type : Timestamp

 ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Destination"></a>
Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle Gestion des identités et des accès AWS (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).   
Type : objet [DataDestination](API_DataDestination.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-EstimatedTimeRemainingInMinutes"></a>
Temps approximatif restant pour terminer l'exportation des prévisions hypothétiques, en minutes.  
Type : Long

 ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Format"></a>
Le format des données exportées, CSV ou PARQUET.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 7.  
Modèle : `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-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_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Message"></a>
Si une erreur s'est produite, un message d'information la concernant.  
Type : Chaîne

 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Status"></a>
É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` 
L'exportation `Status` des prévisions hypothétiques doit être effectuée `ACTIVE` avant que vous puissiez accéder à l'exportation des prévisions.
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.

 ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastArns"></a>
Un tableau de noms de ressources Amazon (ARNs) qui représente toutes les prévisions hypothétiques exportées dans cette ressource.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 300.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportArn"></a>
Le nom de ressource Amazon (ARN) de l'exportation des prévisions hypothétiques.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 300.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportName"></a>
Nom de l'exportation de prévisions hypothétiques.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.  
Modèle : `^[a-zA-Z][a-zA-Z0-9_]*` 

## Erreurs
<a name="API_DescribeWhatIfForecastExport_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_DescribeWhatIfForecastExport_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/DescribeWhatIfForecastExport) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 

# GetAccuracyMetrics
<a name="API_GetAccuracyMetrics"></a>

Fournit des mesures relatives à la précision des modèles entraînés par l'[CreatePredictor](API_CreatePredictor.md)opération. Utilisez des métriques pour évaluer les performances du modèle et pour décider s'il convient d'utiliser le prédicteur pour générer une prévision. Pour plus d'informations, consultez [Predictor Metrics](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html).

**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/) 

Cette opération génère des métriques pour chaque fenêtre de backtest évaluée. Le nombre de fenêtres de backtest (`NumberOfBacktestWindows`) est spécifié à l'aide de l'[EvaluationParameters](API_EvaluationParameters.md)objet, qui est éventuellement inclus dans la `CreatePredictor` demande. S'il `NumberOfBacktestWindows` n'est pas spécifié, le nombre par défaut est un.

Les paramètres de la `filling` méthode déterminent quels éléments contribuent aux métriques. Si vous souhaitez que tous les éléments contribuent, spécifiez`zero`. Si vous souhaitez que seuls les éléments dont les données sont complètes dans la plage en cours d'évaluation contribuent, spécifiez`nan`. Pour de plus amples informations, veuillez consulter [FeaturizationMethod](API_FeaturizationMethod.md).

**Note**  
Avant de pouvoir obtenir des mesures `Status` de précision, le prédicteur doit l'être`ACTIVE`, ce qui signifie que l'entraînement est terminé. Pour obtenir le statut, utilisez l'[DescribePredictor](API_DescribePredictor.md)opération.

## Syntaxe de la requête
<a name="API_GetAccuracyMetrics_RequestSyntax"></a>

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) **   <a name="forecast-GetAccuracyMetrics-request-PredictorArn"></a>
Le nom de ressource Amazon (ARN) du prédicteur pour lequel vous souhaitez obtenir des métriques.  
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_GetAccuracyMetrics_ResponseSyntax"></a>

```
{
   "AutoMLOverrideStrategy": "string",
   "IsAutoPredictor": boolean,
   "OptimizationMetric": "string",
   "PredictorEvaluationResults": [ 
      { 
         "AlgorithmArn": "string",
         "TestWindows": [ 
            { 
               "EvaluationType": "string",
               "ItemCount": number,
               "Metrics": { 
                  "AverageWeightedQuantileLoss": number,
                  "ErrorMetrics": [ 
                     { 
                        "ForecastType": "string",
                        "MAPE": number,
                        "MASE": number,
                        "RMSE": number,
                        "WAPE": number
                     }
                  ],
                  "RMSE": number,
                  "WeightedQuantileLosses": [ 
                     { 
                        "LossValue": number,
                        "Quantile": number
                     }
                  ]
               },
               "TestWindowEnd": number,
               "TestWindowStart": number
            }
         ]
      }
   ]
}
```

## Eléments de réponse
<a name="API_GetAccuracyMetrics_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.

 ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-AutoMLOverrideStrategy"></a>
 La stratégie de `LatencyOptimized` remplacement AutoML n'est disponible qu'en version bêta privée. Contactez AWS le Support ou votre responsable de compte pour en savoir plus sur les privilèges d'accès. 
La stratégie AutoML utilisée pour entraîner le prédicteur. Sauf indication contraire`LatencyOptimized`, la stratégie AutoML optimise la précision des prédicteurs.  
Ce paramètre n'est valide que pour les prédicteurs entraînés à l'aide d'AutoML.  
Type : Chaîne  
Valeurs valides : `LatencyOptimized | AccuracyOptimized` 

 ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-IsAutoPredictor"></a>
Si le prédicteur a été créé avec[CreateAutoPredictor](API_CreateAutoPredictor.md).  
Type : Boolean

 ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-OptimizationMetric"></a>
Mesure de précision utilisée pour optimiser le prédicteur.  
Type : Chaîne  
Valeurs valides : `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-PredictorEvaluationResults"></a>
Tableau de résultats issus de l'évaluation du prédicteur.  
Type : tableau d’objets [EvaluationResult](API_EvaluationResult.md)

## Erreurs
<a name="API_GetAccuracyMetrics_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_GetAccuracyMetrics_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/GetAccuracyMetrics) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics) 

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

Renvoie la liste des groupes de jeux de données créés à l'aide de l'[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)opération. Pour chaque groupe de jeux de données, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN du groupe de jeux de données avec l'[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)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/) 

## Syntaxe de la requête
<a name="API_ListDatasetGroups_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "DatasetGroups": [ 
      { 
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "DatasetGroupName": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListDatasetGroups_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.

 ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-DatasetGroups"></a>
Tableau d'objets qui récapitule les propriétés de chaque groupe de jeux de données.  
Type : tableau d’objets [DatasetGroupSummary](API_DatasetGroupSummary.md)

 ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListDatasetGroups_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/ListDatasetGroups) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetGroups) 

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

Renvoie une liste des tâches d'importation de jeux de données créées à l'aide de l'[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)opération. Pour chaque tâche d'importation, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN avec l'[DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)opération. Vous pouvez filtrer la liste en fournissant un tableau d'objets [Filter](https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html).

## Syntaxe de la requête
<a name="API_ListDatasetImportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les ensembles de données correspondant à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les ensembles de données correspondant à l'instruction, spécifiez`IS`. Pour exclure les ensembles de données correspondants, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `DatasetArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches d'importation de jeux de données dont le statut est ACTIF, vous devez spécifier le filtre suivant :  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "DatasetImportJobs": [ 
      { 
         "CreationTime": number,
         "DatasetImportJobArn": "string",
         "DatasetImportJobName": "string",
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ImportMode": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListDatasetImportJobs_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.

 ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-DatasetImportJobs"></a>
Tableau d'objets qui récapitule les propriétés de chaque tâche d'importation de jeu de données.  
Type : tableau d’objets [DatasetImportJobSummary](API_DatasetImportJobSummary.md)

 ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.  
Modèle : `.+` 

## Erreurs
<a name="API_ListDatasetImportJobs_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListDatasetImportJobs_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/ListDatasetImportJobs) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetImportJobs) 

# ListDatasets
<a name="API_ListDatasets"></a>

Renvoie une liste des ensembles de données créés à l'aide de l'[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)opération. Pour chaque ensemble de données, un résumé de ses propriétés, y compris son Amazon Resource Name (ARN), est renvoyé. Pour récupérer l'ensemble complet des propriétés, utilisez l'ARN avec l'[DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)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/) 

## Syntaxe de la requête
<a name="API_ListDatasets_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "Datasets": [ 
      { 
         "CreationTime": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "DatasetType": "string",
         "Domain": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListDatasets_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.

 ** [Datasets](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-Datasets"></a>
Tableau d'objets qui récapitule les propriétés de chaque ensemble de données.  
Type : tableau d’objets [DatasetSummary](API_DatasetSummary.md)

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+` 

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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListDatasets_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/ListDatasets) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets) 

# ListExplainabilities
<a name="API_ListExplainabilities"></a>

Renvoie une liste de ressources d'explicabilité créées à l'aide de l'[CreateExplainability](API_CreateExplainability.md)opération. Cette opération renvoie un résumé pour chaque explicabilité. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

**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/) 

Pour récupérer l'ensemble complet des propriétés d'une ressource d'explicabilité particulière, utilisez l'ARN avec l'[DescribeExplainability](API_DescribeExplainability.md)opération.

## Syntaxe de la requête
<a name="API_ListExplainabilities_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, indiquez une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les ressources correspondant à l'instruction. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`.
+  `Key`- Le nom du paramètre sur lequel filtrer. Les valeurs valides sont `ResourceArn` et `Status`.
+  `Value`- La valeur à égaler.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-MaxResults"></a>
Le nombre d'articles renvoyés dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un NextToken. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "Explainabilities": [ 
      { 
         "CreationTime": number,
         "ExplainabilityArn": "string",
         "ExplainabilityConfig": { 
            "TimePointGranularity": "string",
            "TimeSeriesGranularity": "string"
         },
         "ExplainabilityName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListExplainabilities_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.

 ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-Explainabilities"></a>
Un tableau d'objets qui récapitule les propriétés de chaque ressource d'explicabilité.  
Type : tableau d’objets [ExplainabilitySummary](API_ExplainabilitySummary.md)

 ** [NextToken](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-NextToken"></a>
Renvoie ce jeton si la réponse est tronquée. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+` 

## Erreurs
<a name="API_ListExplainabilities_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListExplainabilities_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/ListExplainabilities) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilities) 

# ListExplainabilityExports
<a name="API_ListExplainabilityExports"></a>

Renvoie une liste des exportations d'explicabilité créées à l'aide de l'[CreateExplainabilityExport](API_CreateExplainabilityExport.md)opération. Cette opération renvoie un résumé pour chaque exportation d'Explainability. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

**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/) 

Pour récupérer l'ensemble complet des propriétés d'une exportation d'explicabilité particulière, utilisez l'ARN avec l'[DescribeExplainability](API_DescribeExplainability.md)opération.

## Syntaxe de la requête
<a name="API_ListExplainabilityExports_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, indiquez une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les ressources correspondant à l'instruction. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `ResourceArn` et `Status`.
+  `Value`- La valeur à égaler.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un NextToken. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "ExplainabilityExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ExplainabilityExportArn": "string",
         "ExplainabilityExportName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListExplainabilityExports_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.

 ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-ExplainabilityExports"></a>
Un tableau d'objets qui récapitule les propriétés de chaque exportation d'Explainability.  
Type : tableau d’objets [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md)

 ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-NextToken"></a>
Renvoie ce jeton si la réponse est tronquée. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

## Erreurs
<a name="API_ListExplainabilityExports_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListExplainabilityExports_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/ListExplainabilityExports) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilityExports) 

# ListForecastExportJobs
<a name="API_ListForecastExportJobs"></a>

Renvoie une liste des tâches d'exportation de prévisions créées à l'aide de l'[CreateForecastExportJob](API_CreateForecastExportJob.md)opération. Pour chaque tâche d'exportation de prévisions, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Pour récupérer l'ensemble complet des propriétés, utilisez l'ARN avec l'[DescribeForecastExportJob](API_DescribeForecastExportJob.md)opération. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

**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/) 

## Syntaxe de la requête
<a name="API_ListForecastExportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les tâches d'exportation de prévisions correspondant à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les tâches d'exportation de prévisions correspondant à l'instruction, spécifiez`IS`. Pour exclure les tâches d'exportation de prévisions correspondantes, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `ForecastArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches qui exportent une prévision nommée *electricityforecast*, spécifiez le filtre suivant :  
 `"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "ForecastExportJobs": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ForecastExportJobArn": "string",
         "ForecastExportJobName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListForecastExportJobs_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.

 ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-ForecastExportJobs"></a>
Tableau d'objets qui récapitule les propriétés de chaque tâche d'exportation.  
Type : tableau d’objets [ForecastExportJobSummary](API_ForecastExportJobSummary.md)

 ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

## Erreurs
<a name="API_ListForecastExportJobs_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListForecastExportJobs_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/ListForecastExportJobs) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs) 

# ListForecasts
<a name="API_ListForecasts"></a>

Renvoie la liste des prévisions créées à l'aide de l'[CreateForecast](API_CreateForecast.md)opération. Pour chaque prévision, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Pour récupérer l'ensemble complet des propriétés, spécifiez l'ARN avec l'[DescribeForecast](API_DescribeForecast.md)opération. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

**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/) 

## Syntaxe de la requête
<a name="API_ListForecasts_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les prévisions correspondant à l'énoncé, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les prévisions qui correspondent à l'énoncé, spécifiez`IS`. Pour exclure les prévisions correspondantes, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `DatasetGroupArn`, `PredictorArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les prévisions dont le statut n'est pas ACTIF, vous devez spécifier :  
 `"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "Forecasts": [ 
      { 
         "CreatedUsingAutoPredictor": boolean,
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "ForecastArn": "string",
         "ForecastName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListForecasts_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.

 ** [Forecasts](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-Forecasts"></a>
Tableau d'objets qui récapitule les propriétés de chaque prévision.  
Type : tableau d’objets [ForecastSummary](API_ForecastSummary.md)

 ** [NextToken](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

## Erreurs
<a name="API_ListForecasts_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListForecasts_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/ListForecasts) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecasts) 

# ListMonitorEvaluations
<a name="API_ListMonitorEvaluations"></a>

Renvoie une liste des résultats de l'évaluation du suivi et des événements prédictifs collectés par la ressource du moniteur au cours de différentes fenêtres temporelles.

**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/) 

Pour plus d'informations sur la surveillance, voir[Surveillance des prédicteurs](predictor-monitoring.md). Pour plus d'informations sur la récupération des résultats de surveillance, voir [Affichage des résultats de surveillance](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).

## Syntaxe de la requête
<a name="API_ListMonitorEvaluations_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "MonitorArn": "string",
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, indiquez une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les ressources correspondant à l'instruction. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. La seule valeur valide est `EvaluationState`.
+  `Value`- La valeur à égaler. Les valeurs valides sont uniquement `SUCCESS` ou`FAILURE`.
Par exemple, pour répertorier uniquement les évaluations de monitoring réussies, vous devez spécifier :  
 `"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MaxResults"></a>
Le nombre maximum de résultats de surveillance à renvoyer.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MonitorArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance à partir de laquelle obtenir les résultats.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "PredictorMonitorEvaluations": [ 
      { 
         "EvaluationState": "string",
         "EvaluationTime": number,
         "Message": "string",
         "MetricResults": [ 
            { 
               "MetricName": "string",
               "MetricValue": number
            }
         ],
         "MonitorArn": "string",
         "MonitorDataSource": { 
            "DatasetImportJobArn": "string",
            "ForecastArn": "string",
            "PredictorArn": "string"
         },
         "NumItemsEvaluated": number,
         "PredictorEvent": { 
            "Datetime": number,
            "Detail": "string"
         },
         "ResourceArn": "string",
         "WindowEndDatetime": number,
         "WindowStartDatetime": number
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListMonitorEvaluations_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.

 ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

 ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-PredictorMonitorEvaluations"></a>
Les résultats de surveillance et les événements prédictifs collectés par la ressource de surveillance au cours de différentes fenêtres temporelles.  
Pour plus d'informations sur la surveillance, voir [Affichage des résultats de surveillance](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). Pour plus d'informations sur la récupération des résultats de surveillance, voir [Affichage des résultats de surveillance](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).  
Type : tableau d’objets [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md)

## Erreurs
<a name="API_ListMonitorEvaluations_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
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_ListMonitorEvaluations_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/ListMonitorEvaluations) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitorEvaluations) 

# ListMonitors
<a name="API_ListMonitors"></a>

Renvoie la liste des moniteurs créés avec l'[CreateMonitor](API_CreateMonitor.md)opération et [CreateAutoPredictor](API_CreateAutoPredictor.md) l'opération. Pour chaque ressource de surveillance, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer un ensemble complet de propriétés d'une ressource de moniteur en spécifiant l'ARN du moniteur dans l'[DescribeMonitor](API_DescribeMonitor.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/) 

## Syntaxe de la requête
<a name="API_ListMonitors_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, indiquez une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les ressources correspondant à l'instruction. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. La seule valeur valide est `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier tous les moniteurs dont le statut est ACTIF, vous devez spécifier :  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-MaxResults"></a>
Le nombre maximum de moniteurs à inclure dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "Monitors": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "MonitorArn": "string",
         "MonitorName": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Eléments de réponse
<a name="API_ListMonitors_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.

 ** [Monitors](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-Monitors"></a>
Tableau d'objets qui récapitule les propriétés de chaque moniteur.  
Type : tableau d’objets [MonitorSummary](API_MonitorSummary.md)

 ** [NextToken](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

## Erreurs
<a name="API_ListMonitors_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListMonitors_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/ListMonitors) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitors) 

# ListPredictorBacktestExportJobs
<a name="API_ListPredictorBacktestExportJobs"></a>

Renvoie une liste de tâches d'exportation basées sur le backtest prédictif créées à l'aide de l'[CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md)opération. Cette opération renvoie un résumé pour chaque tâche d'exportation de backtest. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

**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/) 

Pour récupérer l'ensemble complet des propriétés d'une tâche d'exportation de backtest spécifique, utilisez l'ARN avec l'[DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md)opération.

## Syntaxe de la requête
<a name="API_ListPredictorBacktestExportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, indiquez une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, ce qui indique s'il faut inclure ou exclure de la liste les tâches d'exportation du backtest prédictif qui correspondent à l'instruction. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les tâches d'exportation du backtest prédictif qui correspondent à l'instruction, spécifiez. `IS` Pour exclure les tâches d'exportation du backtest prédictif correspondant, spécifiez. `IS_NOT`
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `PredictorArn` et `Status`.
+  `Value`- La valeur à égaler.
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un NextToken. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "PredictorBacktestExportJobs": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "PredictorBacktestExportJobArn": "string",
         "PredictorBacktestExportJobName": "string",
         "Status": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListPredictorBacktestExportJobs_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.

 ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-NextToken"></a>
Renvoie ce jeton si la réponse est tronquée. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

 ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-PredictorBacktestExportJobs"></a>
Tableau d'objets qui récapitule les propriétés de chaque tâche d'exportation du backtest prédictif.  
Type : tableau d’objets [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md)

## Erreurs
<a name="API_ListPredictorBacktestExportJobs_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListPredictorBacktestExportJobs_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/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 

# ListPredictors
<a name="API_ListPredictors"></a>

Renvoie une liste de prédicteurs créés à l'aide des [CreatePredictor](API_CreatePredictor.md) opérations [CreateAutoPredictor](API_CreateAutoPredictor.md) or. Pour chaque prédicteur, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). 

**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/) 

Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN avec les [DescribePredictor](API_DescribePredictor.md) opérations [DescribeAutoPredictor](API_DescribeAutoPredictor.md) et. Vous pouvez filtrer la liste à l'aide d'un tableau d'[Filter](API_Filter.md)objets.

## Syntaxe de la requête
<a name="API_ListPredictors_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les prédicteurs correspondant à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les prédicteurs correspondant à l'instruction, spécifiez`IS`. Pour exclure les prédicteurs correspondants, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `DatasetGroupArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier tous les prédicteurs dont le statut est ACTIF, vous devez spécifier :  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "Predictors": [ 
      { 
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "IsAutoPredictor": boolean,
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "PredictorName": "string",
         "ReferencePredictorSummary": { 
            "Arn": "string",
            "State": "string"
         },
         "Status": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListPredictors_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.

 ** [NextToken](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-NextToken"></a>
Si la réponse est tronquée, Amazon Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

 ** [Predictors](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-Predictors"></a>
Tableau d'objets qui récapitule les propriétés de chaque prédicteur.  
Type : tableau d’objets [PredictorSummary](API_PredictorSummary.md)

## Erreurs
<a name="API_ListPredictors_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListPredictors_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/ListPredictors) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictors) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Répertorie les balises d'une ressource Amazon Forecast.

**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/) 

## Syntaxe de la requête
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="forecast-ListTagsForResource-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) qui identifie la ressource pour laquelle répertorier les balises.   
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_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListTagsForResource_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.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="forecast-ListTagsForResource-response-Tags"></a>
Balises de la ressource.  
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.

## Erreurs
<a name="API_ListTagsForResource_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_ListTagsForResource_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/ListTagsForResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource) 

# ListWhatIfAnalyses
<a name="API_ListWhatIfAnalyses"></a>

Renvoie une liste d'analyses hypothétiques créées à l'aide de l'[CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md)opération. Pour chaque analyse hypothétique, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN d'analyse hypothétique associé à l'[DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.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/) 

## Syntaxe de la requête
<a name="API_ListWhatIfAnalyses_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est soit`IS_NOT`, `IS` soit, qui indique s'il faut inclure ou exclure de la liste les tâches d'analyse hypothétiques correspondant à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les tâches d'analyse hypothétiques correspondant à l'instruction, spécifiez. `IS` Pour exclure les tâches d'analyse hypothétique correspondantes, spécifiez. `IS_NOT`
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `WhatIfAnalysisArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches qui exportent une prévision nommée *electricityWhatIf*, spécifiez le filtre suivant :  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "WhatIfAnalyses": [ 
      { 
         "CreationTime": number,
         "ForecastArn": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfAnalysisName": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListWhatIfAnalyses_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.

 ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-NextToken"></a>
Si la réponse est tronquée, Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3000.  
Modèle : `.+` 

 ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-WhatIfAnalyses"></a>
Tableau d'`WhatIfAnalysisSummary`objets décrivant les analyses correspondantes.  
Type : tableau d’objets [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md)

## Erreurs
<a name="API_ListWhatIfAnalyses_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListWhatIfAnalyses_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/ListWhatIfAnalyses) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfAnalyses) 

# ListWhatIfForecastExports
<a name="API_ListWhatIfForecastExports"></a>

Renvoie une liste d'exportations de prévisions hypothétiques créées à l'aide de l'[CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md)opération. Pour chaque exportation de prévisions hypothétiques, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN d'exportation des prévisions hypothétiques avec l'[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.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/) 

## Syntaxe de la requête
<a name="API_ListWhatIfForecastExports_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est l'une `IS` ou l'autre`IS_NOT`, qui indique s'il faut inclure ou exclure de la liste les tâches d'exportation prévisionnelles qui correspondent à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les tâches d'exportation de prévisions qui correspondent à l'instruction, spécifiez`IS`. Pour exclure les tâches d'exportation de prévisions correspondantes, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre sur lequel filtrer. Les valeurs valides sont `WhatIfForecastExportArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches qui exportent une prévision nommée *électricité WIFExport*, spécifiez le filtre suivant :  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer la série de résultats suivante, utilisez le jeton dans la prochaine demande. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "WhatIfForecastExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfForecastArns": [ "string" ],
         "WhatIfForecastExportArn": "string",
         "WhatIfForecastExportName": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListWhatIfForecastExports_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.

 ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-NextToken"></a>
Si la réponse est tronquée, Forecast renvoie ce jeton. Pour récupérer le prochain ensemble de résultats, utilisez le jeton dans la demande suivante.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000  
Modèle : `.+` 

 ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-WhatIfForecastExports"></a>
Tableau d'`WhatIfForecastExports`objets décrivant les exportations de prévisions correspondantes.  
Type : tableau d’objets [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md)

## Erreurs
<a name="API_ListWhatIfForecastExports_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListWhatIfForecastExports_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/ListWhatIfForecastExports) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecastExports) 

# ListWhatIfForecasts
<a name="API_ListWhatIfForecasts"></a>

Renvoie une liste de prévisions hypothétiques créées à l'aide de l'[CreateWhatIfForecast](API_CreateWhatIfForecast.md)opération. Pour chaque prévision hypothétique, cette opération renvoie un résumé de ses propriétés, y compris son Amazon Resource Name (ARN). Vous pouvez récupérer l'ensemble complet des propriétés en utilisant l'ARN de prévision hypothétique associé à l'[DescribeWhatIfForecast](API_DescribeWhatIfForecast.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/) 

## Syntaxe de la requête
<a name="API_ListWhatIfForecasts_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-Filters"></a>
Un ensemble de filtres. Pour chaque filtre, vous devez fournir une condition et un énoncé de correspondance. La condition est l'une `IS` ou l'autre`IS_NOT`, qui indique s'il faut inclure ou exclure de la liste les tâches d'exportation prévisionnelles qui correspondent à l'instruction, respectivement. L'instruction match se compose d'une clé et d'une valeur.  
 **Propriétés du filtre**   
+  `Condition`- La condition à appliquer. Les valeurs valides sont `IS` et `IS_NOT`. Pour inclure les tâches d'exportation de prévisions qui correspondent à l'instruction, spécifiez`IS`. Pour exclure les tâches d'exportation de prévisions correspondantes, spécifiez`IS_NOT`.
+  `Key`- Le nom du paramètre à filtrer. Les valeurs valides sont `WhatIfForecastArn` et `Status`.
+  `Value`- La valeur à égaler.
Par exemple, pour répertorier toutes les tâches qui exportent une *electricityWhatIfprévision nommée Forecast*, spécifiez le filtre suivant :  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]`   
Type : tableau d’objets [Filter](API_Filter.md)  
Obligatoire : non

 ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-MaxResults"></a>
Le nombre d'articles à renvoyer dans la réponse.  
Type : entier  
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.  
Obligatoire : non

 ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer la série de résultats suivante, utilisez le jeton dans la prochaine demande. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+`   
Obligatoire : non

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

```
{
   "NextToken": "string",
   "WhatIfForecasts": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfForecastArn": "string",
         "WhatIfForecastName": "string"
      }
   ]
}
```

## Eléments de réponse
<a name="API_ListWhatIfForecasts_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.

 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-NextToken"></a>
Si le résultat de la demande précédente a été tronqué, la réponse inclut un`NextToken`. Pour récupérer la série de résultats suivante, utilisez le jeton dans la prochaine demande. Les jetons expirent au bout de 24 heures.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 3 000.  
Modèle : `.+` 

 ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-WhatIfForecasts"></a>
Tableau d'`WhatIfForecasts`objets décrivant les prévisions correspondantes.  
Type : tableau d’objets [WhatIfForecastSummary](API_WhatIfForecastSummary.md)

## Erreurs
<a name="API_ListWhatIfForecasts_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

 ** InvalidNextTokenException **   
Le jeton n'est pas valide. Les jetons expirent au bout de 24 heures.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_ListWhatIfForecasts_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/ListWhatIfForecasts) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecasts) 

# ResumeResource
<a name="API_ResumeResource"></a>

Reprend une ressource de surveillance arrêtée.

**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/) 

## Syntaxe de la requête
<a name="API_ResumeResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_ResumeResource_RequestSyntax) **   <a name="forecast-ResumeResource-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) de la ressource de surveillance à reprendre.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_ResumeResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_ResumeResource_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
Code d’état HTTP : 400

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_ResumeResource_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/ResumeResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ResumeResource) 

# StopResource
<a name="API_StopResource"></a>

Arrête une ressource.

**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/) 

La ressource est soumise aux états suivants : `CREATE_STOPPING` et`CREATE_STOPPED`. Vous ne pouvez pas reprendre une ressource une fois qu'elle a été arrêtée.

Cette opération peut être appliquée aux ressources suivantes (et aux ressources enfants correspondantes) :
+ Job d'importation de jeux de données
+ Job de Predictor
+ Forecast Job
+ Forecast Export Job
+ Job d'exportation de Predictor Backtest
+ Job d'explicabilité
+ Job d'exportation d'explicabilité

## Syntaxe de la requête
<a name="API_StopResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_StopResource_RequestSyntax) **   <a name="forecast-StopResource-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) qui identifie la ressource à arrêter. ARNsLes options prises en charge sont `DatasetImportJobArn` `PredictorArn``PredictorBacktestExportJobArn`,`ForecastArn`,`ForecastExportJobArn`,`ExplainabilityArn`, et`ExplainabilityExportArn`.   
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_StopResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_StopResource_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
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_StopResource_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/StopResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/StopResource) 

# TagResource
<a name="API_TagResource"></a>

Associe les balises spécifiées à une ressource avec la balise spécifiée`resourceArn`. Si les balises existantes d'une ressource ne sont pas spécifiées dans les paramètres de demande, elles ne sont pas modifiées. Lorsqu'une ressource est supprimée, les balises associées à cette ressource sont également supprimées.

**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/) 

## Syntaxe de la requête
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) qui identifie la ressource pour laquelle répertorier les balises.   
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-Tags"></a>
Les balises à ajouter à la ressource. Une balise est un tableau de paires clé-valeur.  
Les restrictions de base suivantes s’appliquent aux balises :  
+ Nombre maximum de balises par ressource : 50.
+ Pour chaque ressource, chaque clé d'identification doit être unique, et chaque clé d'identification peut avoir une seule valeur.
+ Longueur de clé maximale : 128 caractères Unicode en UTF-8.
+ Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.
+ Si votre schéma d'identification est utilisé pour plusieurs services et ressources, n'oubliez pas que d'autres services peuvent avoir des restrictions concernant les caractères autorisés. Les caractères généralement autorisés sont les lettres, les chiffres et les espaces représentables en UTF-8, ainsi que les caractères suivants : \$1 - =. \$1 :/@.
+ Les clés et les valeurs des balises distinguent les majuscules et minuscules.
+ N'utilisez pas `aws:``AWS:`, ni aucune combinaison majuscules ou minuscules, comme un préfixe pour les clés, car il est réservé à l'usage. AWS Vous ne pouvez pas modifier ou supprimer les clés de balise avec ce préfixe. Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a `aws` pour préfixe, mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans `aws` le calcul de vos balises par limite de ressources ».
Type : tableau d’objets [Tag](API_Tag.md)  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Obligatoire : oui

## Éléments de réponse
<a name="API_TagResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_TagResource_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

 ** LimitExceededException **   
La limite du nombre de ressources par compte a été dépassée.  
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_TagResource_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/TagResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Supprime les balises spécifiées d'une ressource.

**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/) 

## Syntaxe de la requête
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

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

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

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-ResourceArn"></a>
Le nom de ressource Amazon (ARN) qui identifie la ressource pour laquelle répertorier les balises.   
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-TagKeys"></a>
Les clés des tags à supprimer.  
Type : tableau de chaînes  
Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.  
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 128.  
Modèle : `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Obligatoire : oui

## Éléments de réponse
<a name="API_UntagResource_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_UntagResource_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_UntagResource_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/UntagResource) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UntagResource) 

# UpdateDatasetGroup
<a name="API_UpdateDatasetGroup"></a>

Remplace les ensembles de données d'un groupe de jeux de données par les ensembles de données spécifiés.

**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/) 

**Note**  
Le groupe `Status` de jeux de données doit être celui du groupe de `ACTIVE` données pour que vous puissiez utiliser le groupe de jeux de données pour créer un prédicteur. Utilisez l'opération [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) pour obtenir le statut.

## Syntaxe de la requête
<a name="API_UpdateDatasetGroup_RequestSyntax"></a>

```
{
   "DatasetArns": [ "string" ],
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetArns"></a>
Tableau des Amazon Resource Names (ARNs) des ensembles de données à ajouter au groupe de jeux de données.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

 ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetGroupArn"></a>
L'ARN du groupe de jeux de données.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatoire : oui

## Éléments de réponse
<a name="API_UpdateDatasetGroup_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_UpdateDatasetGroup_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

 ** ResourceInUseException **   
La ressource spécifiée est en cours d'utilisation.  
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_UpdateDatasetGroup_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/UpdateDatasetGroup) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup)