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.

# DescribeForecast
<a name="API_DescribeForecast"></a>

Describe una previsión creada mediante la operación [CreateForecast](API_CreateForecast.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 `CreateForecast`, esta operación muestra las siguientes propiedades:
+  `DatasetGroupArn`: el grupo de conjuntos de datos que proporcionó los datos de entrenamiento.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`: si se produjo un error, la información sobre el error.

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

```
{
   "ForecastArn": "string"
}
```

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

La solicitud acepta los siguientes datos en formato JSON.

 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) **   <a name="forecast-DescribeForecast-request-ForecastArn"></a>
El nombre de recurso de Amazon (ARN) de la previsió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_DescribeForecast_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "DatasetGroupArn": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "ForecastName": "string",
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "PredictorArn": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   }
}
```

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

 ** [CreationTime](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-CreationTime"></a>
Cuándo se creó la tarea de creación de previsiones.  
Tipo: marca temporal

 ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-DatasetGroupArn"></a>
El ARN del grupo de conjunto de datos que proporcionó los datos usados para entrenar el predictor.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-EstimatedTimeRemainingInMinutes"></a>
El tiempo estimado que queda en minutos para que finalice el trabajo de previsión.  
Tipo: largo

 ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastArn"></a>
El ARN de previsión especificado en la solicitud.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastName](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastName"></a>
El nombre de la previsión.  
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_]*` 

 ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastTypes"></a>
Los cuantiles en los que se generaron las previsiones probabilísticas.  
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$)` 

 ** [LastModificationTime](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-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_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Message"></a>
Si se produjo un error, el mensaje informativo sobre el error.  
Tipo: cadena

 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-PredictorArn"></a>
El ARN del predictor utilizado para generar la previsión.  
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Status](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Status"></a>
El estado de la previsión. Los estados incluyen:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
El `Status` de la previsión debe ser `ACTIVE` antes de poder consultarla o exportarla.
Tipo: cadena  
Limitaciones de longitud: longitud máxima de 256.  
Patrón: `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-TimeSeriesSelector"></a>
La serie temporal que se va a incluir en la previsión.  
Tipo: objeto [TimeSeriesSelector](API_TimeSeriesSelector.md)

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