

 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.

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