O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Descreve um conjunto de dados do Amazon Forecast criado usando a [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação.

**Importante**  
O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

Além de listar os parâmetros especificados na solicitação `CreateDataset`, essa operação inclui as seguintes propriedades do conjunto de dados:
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

## Sintaxe da solicitação
<a name="API_DescribeDataset_RequestSyntax"></a>

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

## Parâmetros da solicitação
<a name="API_DescribeDataset_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="forecast-DescribeDataset-request-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<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"
}
```

## Elementos de resposta
<a name="API_DescribeDataset_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [CreationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-CreationTime"></a>
Quando o conjunto de dados foi criado.  
Tipo: Timestamp

 ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DataFrequency"></a>
A frequência da coleta de dados.  
Os intervalos válidos são Y (Ano), M (Mês), W (Semana), D (Dia), H (Hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) e 1min (1 minuto). Por exemplo, “M” indica todos os meses e “30min” indica a cada 30 minutos.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` 

 ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetName"></a>
O nome do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [DatasetType](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetType"></a>
O tipo de conjunto de dados.  
Tipo: string  
Valores válidos: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 

 ** [Domain](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Domain"></a>
O domínio associado ao conjunto de dados.  
Tipo: string  
Valores válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-EncryptionConfig"></a>
A chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-LastModificationTime"></a>
Ao criar um conjunto de dados, `LastModificationTime` é o mesmo que `CreationTime`. Enquanto os dados estão sendo importados para o conjunto de dados, `LastModificationTime` é a hora atual da chamada `DescribeDataset`. Após a conclusão de uma [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação, `LastModificationTime` é quando o trabalho de importação foi concluído ou falhou.  
Tipo: Timestamp

 ** [Schema](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Schema"></a>
Uma matriz de objetos `SchemaAttribute` que especificam os campos de conjuntos de dados. Cada `SchemaAttribute` especifica o nome e o tipo de dados de um campo.  
Tipo: objeto [Schema](API_Schema.md)

 ** [Status](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Status"></a>
O status do conjunto de dados. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
Os `UPDATE` estados se aplicam enquanto os dados são importados para o conjunto de dados a partir de uma chamada para a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação e refletem o status do trabalho de importação do conjunto de dados. Por exemplo, quando o status do trabalho de importação é `CREATE_IN_PROGRESS`, o status do conjunto de dados é `UPDATE_IN_PROGRESS`.  
O `Status` do conjunto de dados deve ser `ACTIVE` para que seja possível treinar dados.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

## Erros
<a name="API_DescribeDataset_Errors"></a>

 ** InvalidInputException **   
Não podemos processar a solicitação porque ela inclui um valor inválido ou um valor que excede o intervalo válido.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não conseguimos encontrar um recurso com esse nome do recurso da Amazon (ARN). Verifique o ARN e tente novamente.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset)