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

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

**nota**  
 Essa operação só é válida para preditores legados criados com CreatePredictor. Se você não estiver usando um preditor antigo, use [DescribeAutoPredictor](API_DescribeAutoPredictor.md).

Descreve um preditor criado por meio da operação [CreatePredictor](API_CreatePredictor.md).

**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 as propriedades fornecidas na solicitação `CreatePredictor`, essa operação inclui as seguintes propriedades:
+  `DatasetImportJobArns`: os trabalhos de importação do conjunto de dados usados para importar dados de treinamento.
+  `AutoMLAlgorithmArns`: se o AutoML for executado, os algoritmos avaliados.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`: se ocorreu um erro, as informações sobre o erro.

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

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

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

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

 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) **   <a name="forecast-DescribePredictor-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor a sobre o qual você deseja obter informações.  
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_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" 
   }
}
```

## Elementos de resposta
<a name="API_DescribePredictor_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.

 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AlgorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo usado no treinamento do modelo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLAlgorithmArns"></a>
Quando `PerformAutoML` é especificado, o ARN do algoritmo selecionado.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLOverrideStrategy"></a>
 A estratégia de substituição `LatencyOptimized` do AutoML só está disponível na versão beta privada. Entre em contato com o AWS Support ou com seu gerente de conta para saber mais sobre os privilégios de acesso. 
A estratégia do AutoML usada para treinar o preditor. A menos que `LatencyOptimized` seja especificada, a estratégia do AutoML otimiza a precisão do preditor.  
Esse parâmetro só é válido para preditores treinados por meio do AutoML.  
Tipo: string  
Valores válidos: `LatencyOptimized | AccuracyOptimized` 

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
Quando a tarefa de treinamento do modelo foi criada.  
Tipo: Timestamp

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-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_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EncryptionConfig"></a>
Uma 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)

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

 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EvaluationParameters"></a>
Usado para substituir os parâmetros de avaliação padrão do algoritmo especificado. O Amazon Forecast avalia um preditor dividindo um conjunto de dados em dados de treinamento e dados de teste. Os parâmetros de avaliação definem como realizar a divisão e o número de iterações.  
Tipo: objeto [EvaluationParameters](API_EvaluationParameters.md)

 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-FeaturizationConfig"></a>
A configuração de caracterização.  
Tipo: objeto [FeaturizationConfig](API_FeaturizationConfig.md)

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

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

 ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-HPOConfig"></a>
Os valores de substituição de hiperparâmetros do algoritmo.  
Tipo: objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)

 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-InputDataConfig"></a>
Descreve o grupo de conjuntos de dados que contém os dados a serem usados para treinar o preditor.  
Tipo: objeto [InputDataConfig](API_InputDataConfig.md)

 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-IsAutoPredictor"></a>
Se o preditor foi ou não criado com [CreateAutoPredictor](API_CreateAutoPredictor.md).  
Tipo: booliano

 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-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_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

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

 ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformAutoML"></a>
Se o preditor está configurado para executar o AutoML.  
Tipo: booliano

 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformHPO"></a>
Se o preditor estiver definido para realizar a otimização de hiperparâmetros (HPO).  
Tipo: booliano

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

 ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorExecutionDetails"></a>
Detalhes sobre o status e os resultados dos backtests realizados para avaliar a precisão do preditor. Você vai especificar o número de backtests a serem executados ao chamar a operação [CreatePredictor](API_CreatePredictor.md).  
Tipo: objeto [PredictorExecutionDetails](API_PredictorExecutionDetails.md)

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

 ** [Status](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Status"></a>
O status do preditor. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
O `Status` do preditor deve ser `ACTIVE` para que seja possível usar o preditor na criação de uma previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-TrainingParameters"></a>
Os parâmetros ou as substituições de treinamento padrão selecionados durante o treinamento do modelo. Ao executar o AutoML ou escolher o HPO com CNN-QR ou DeepAR\$1, os valores otimizados para os hiperparâmetros selecionados são exibidos. Para obter mais informações, consulte [Algoritmos do Amazon Forecast](aws-forecast-choosing-recipes.md).  
Tipo: mapa de string para string  
Entradas do mapa: número mínimo de 0 itens. Número máximo de 100 itens.  
Restrições de tamanho de chave: o tamanho máximo é 256.  
Padrão da chave: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`   
Restrições de tamanho de valor: o tamanho máximo é 256.  
Padrão de valor: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 

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