Amazon Forecast ya no está disponible para nuevos clientes. Los clientes actuales de Amazon Forecast pueden seguir utilizando el servicio con normalidad. [Más información](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

**nota**  
 Esta operación solo es válida para los predictores heredados creados con CreatePredictor. Si no utiliza un predictor heredado, utilice [DescribeAutoPredictor](API_DescribeAutoPredictor.md).

Describe un predictor creado mediante la operación [CreatePredictor](API_CreatePredictor.md).

**importante**  
Amazon Forecast ya no está disponible para nuevos clientes. Los clientes actuales de Amazon Forecast pueden seguir utilizando el servicio con normalidad. [Más información](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

Además de enumerar las propiedades proporcionadas en la solicitud `CreatePredictor`, esta operación muestra las siguientes propiedades:
+  `DatasetImportJobArns`: los trabajos de importación de conjuntos de datos que se utilizan para importar los datos de entrenamiento.
+  `AutoMLAlgorithmArns`: si se ejecuta AutoML, los algoritmos que se evaluaron.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`: si se produjo un error, la información sobre el error.

## Sintaxis de la solicitud
<a name="API_DescribePredictor_RequestSyntax"></a>

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

## Parámetros de la solicitud
<a name="API_DescribePredictor_RequestParameters"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) **   <a name="forecast-DescribePredictor-request-PredictorArn"></a>
El nombre de recurso de Amazon (ARN) del predictor sobre el que desea información.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obligatorio: sí

## Sintaxis de la respuesta
<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 respuesta
<a name="API_DescribePredictor_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AlgorithmArn"></a>
El nombre de recurso de Amazon (ARN) del algoritmo utilizado para el entrenamiento del modelo.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLAlgorithmArns"></a>
Cuando se especifica `PerformAutoML`, el ARN del algoritmo elegido.  
Tipo: matriz de cadenas  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLOverrideStrategy"></a>
 La estrategia de anulación del AutoML `LatencyOptimized` solo está disponible en la versión beta privada. Póngase en contacto con AWS Support o con el administrador de su cuenta para obtener más información sobre los privilegios de acceso. 
La estrategia de AutoML utilizada para entrenar el predictor. A menos que se especifique `LatencyOptimized`, la estrategia de AutoML optimiza la precisión del predictor.  
Este parámetro solo es válido para los predictores entrenados con AutoML.  
Tipo: cadena  
Valores válidos: `LatencyOptimized | AccuracyOptimized` 

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
Cuando se creó la tarea de entrenamiento del modelo.  
Tipo: marca temporal

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-DatasetImportJobArns"></a>
Conjunto de los trabajos de importación ARNs de conjuntos de datos que se utilizan para importar los datos de entrenamiento para el predictor.  
Tipo: matriz de cadenas  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EncryptionConfig"></a>
Una clave AWS Key Management Service (KMS) y la función AWS Identity and Access Management (IAM) que Amazon Forecast puede asumir para acceder a la clave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EstimatedTimeRemainingInMinutes"></a>
El tiempo estimado que queda en minutos para que finalice el trabajo de entrenamiento del predictor.  
Tipo: largo

 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EvaluationParameters"></a>
Se utiliza para anular los parámetros de evaluación predeterminados del algoritmo especificado. Amazon Forecast evalúa un predictor dividiendo un conjunto de datos en datos de entrenamiento y datos de prueba. Los parámetros de evaluación definen cómo realizar la división y el número de iteraciones.  
Tipo: objeto [EvaluationParameters](API_EvaluationParameters.md)

 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-FeaturizationConfig"></a>
La configuración de caracterización.  
Tipo: objeto [FeaturizationConfig](API_FeaturizationConfig.md)

 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastHorizon"></a>
El número de pasos de tiempo de la previsión. El horizonte de previsión también se denomina longitud de predicción.  
Tipo: entero

 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastTypes"></a>
Los tipos de previsión usados durante el entrenamiento del predictor. El valor predeterminado es `["0.1","0.5","0.9"]`   
Tipo: matriz de cadenas  
Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 20 artículos.  
Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 4 caracteres.  
Patrón: `(^0?\.\d\d?$|^mean$)` 

 ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-HPOConfig"></a>
El hiperparámetro anula valores para el algoritmo.  
Tipo: objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)

 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-InputDataConfig"></a>
Describe el grupo de conjuntos de datos que contiene los datos que se utilizarán para entrenar el predictor.  
Tipo: objeto [InputDataConfig](API_InputDataConfig.md)

 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-IsAutoPredictor"></a>
Si el predictor se creó con [CreateAutoPredictor](API_CreateAutoPredictor.md).  
Tipo: Booleano

 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-LastModificationTime"></a>
La última vez que se modificó el recurso. La marca temporal depende del estado del trabajo:  
+  `CREATE_PENDING`: la `CreationTime`.
+  `CREATE_IN_PROGRESS`: marca temporal actual.
+  `CREATE_STOPPING`: marca temporal actual.
+  `CREATE_STOPPED`: cuándo se detuvo el trabajo.
+  `ACTIVE` o `CREATE_FAILED`: cuando el trabajo terminó o falló.
Tipo: marca temporal

 ** [Message](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Message"></a>
Si se produjo un error, el mensaje informativo sobre el error.  
Tipo: cadena

 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-OptimizationMetric"></a>
La métrica de precisión utilizada para optimizar el predictor.  
Tipo: cadena  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformAutoML"></a>
Si el predictor está configurado para realizar AutoML.  
Tipo: Booleano

 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformHPO"></a>
Si el predictor está configurado para realizar la optimización de hiperparámetros (HPO).  
Tipo: Booleano

 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorArn"></a>
El ARN del predictor.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.  
Patrón: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorExecutionDetails"></a>
Detalles sobre el estado y los resultados de las pruebas de datos realizadas para evaluar la precisión del predictor. Al llamar a la operación [CreatePredictor](API_CreatePredictor.md), debe especificar el número de pruebas de datos que se van a realizar.  
Tipo: objeto [PredictorExecutionDetails](API_PredictorExecutionDetails.md)

 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorName"></a>
El nombre del predictor.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.  
Patrón: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [Status](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Status"></a>
El estado del predictor. Los estados incluyen:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
El `Status` del predictor debe ser `ACTIVE` para poder usarlo para crear una previsión.
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.

 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-TrainingParameters"></a>
Los parámetros de entrenamiento predeterminados o las anulaciones seleccionadas durante el entrenamiento del modelo. Al ejecutar AutoML o elegir HPO con CNN-QR o DeepAR\$1, se devuelven los valores optimizados para los hiperparámetros elegidos. Para obtener más información, consulte [Algoritmos de Amazon Forecast](aws-forecast-choosing-recipes.md).  
Tipo: mapa de cadena a cadena  
Entradas de mapa: número mínimo de 0 artículos. Número máximo de 100 artículos.  
Limitaciones de longitud de clave: longitud máxima de 256.  
Patrón de clave: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`   
Limitaciones de longitud de valor: longitud máxima de 256.  
Patrón de valores: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 

## Errores
<a name="API_DescribePredictor_Errors"></a>

 ** InvalidInputException **   
No podemos procesar la solicitud porque incluye un valor no válido o un valor que supera el rango válido.  
Código de estado HTTP: 400

 ** ResourceNotFoundException **   
No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe el ARN e inténtelo de nuevo.  
Código de estado HTTP: 400

## Véase también
<a name="API_DescribePredictor_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos 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)