

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

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

Descreve um preditor criado usando a CreateAutoPredictor 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/) 

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

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

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

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

 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) **   <a name="forecast-DescribeAutoPredictor-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
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_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"
   }
}
```

## Elementos de resposta
<a name="API_DescribeAutoPredictor_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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-CreationTime"></a>
O carimbo de data/hora da CreateAutoPredictor solicitação.  
Tipo: Timestamp

 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DataConfig"></a>
A configuração de dados do seu grupo de conjuntos de dados e de quaisquer conjuntos de dados adicionais.  
Tipo: objeto [DataConfig](API_DataConfig.md)

 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DatasetImportJobArns"></a>
Uma matriz dos trabalhos ARNs de importação do conjunto de dados usados para importar dados de treinamento para o preditor.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave. Você pode especificar esse objeto opcional nas solicitações [CreateDataset](API_CreateDataset.md) e [CreatePredictor](API_CreatePredictor.md).  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do preditor.  
Tipo: longo

 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ExplainabilityInfo"></a>
Fornece o status e o ARN da explicabilidade do preditor.  
Tipo: objeto [ExplainabilityInfo](API_ExplainabilityInfo.md)

 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastDimensions"></a>
Uma matriz de nomes de dimensões (campo) que especificam os atributos usados para agrupar as séries temporais.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastFrequency"></a>
A frequência das predições em uma previsão.  
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, “Y” indica todos os anos e “5min” indica a cada 5 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$` 

 ** [ForecastHorizon](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastHorizon"></a>
O número de etapas temporais que o modelo prevê. O horizonte de predição também é chamado de comprimento da predição.  
Tipo: inteiro

 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastTypes"></a>
Os tipos de previsão usados durante o treinamento do preditor. O valor padrão é [“0,1”, “0,5”, “0,9”].  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Restrições de tamanho: o tamanho mínimo é 2. O tamanho máximo é 4.  
Padrão: `(^0?\.\d\d?$|^mean$)` 

 ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-LastModificationTime"></a>
A última vez que o recurso foi modificado. O carimbo de data e hora depende do status do trabalho:  
+  `CREATE_PENDING`: o `CreationTime`.
+  `CREATE_IN_PROGRESS`: o carimbo de data e hora atual.
+  `CREATE_STOPPING`: o carimbo de data e hora atual.
+  `CREATE_STOPPED`: quando o trabalho parou.
+  `ACTIVE` ou `CREATE_FAILED`: quando o trabalho foi concluído ou falhou.
Tipo: Timestamp

 ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
No caso de um erro, uma mensagem detalhando a causa do erro.  
Tipo: string

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
Um objeto [MonitorInfo](API_MonitorInfo.md) com o nome do recurso da Amazon (ARN) e o status do recurso de monitor.  
Tipo: objeto [MonitorInfo](API_MonitorInfo.md)

 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

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

 ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorName"></a>
O nome do preditor.  
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_]*` 

 ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ReferencePredictorSummary"></a>
O ARN e o estado do preditor de referência. Esse parâmetro só é válido para preditores treinados novamente ou atualizados.  
Tipo: objeto [ReferencePredictorSummary](API_ReferencePredictorSummary.md)

 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Status"></a>
O status do preditor. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-TimeAlignmentBoundary"></a>
O limite de tempo que o Forecast usa ao agregar dados.  
Tipo: objeto [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md)

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