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
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
Describe una previsión creada mediante la operación CreateForecast.
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
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
{
"ForecastArn": "string"
}Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ForecastArn
-
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
{
"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
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- CreationTime
-
Cuándo se creó la tarea de creación de previsiones.
Tipo: marca temporal
- DatasetGroupArn
-
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
-
El tiempo estimado que queda en minutos para que finalice el trabajo de previsión.
Tipo: largo
- ForecastArn
-
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
-
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
-
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
-
La última vez que se modificó el recurso. La marca temporal depende del estado del trabajo:
-
CREATE_PENDING: laCreationTime. -
CREATE_IN_PROGRESS: marca temporal actual. -
CREATE_STOPPING: marca temporal actual. -
CREATE_STOPPED: cuándo se detuvo el trabajo. -
ACTIVEoCREATE_FAILED: cuando el trabajo terminó o falló.
Tipo: marca temporal
-
- Message
-
Si se produjo un error, el mensaje informativo sobre el error.
Tipo: cadena
- PredictorArn
-
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
-
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
nota
El
Statusde la previsión debe serACTIVEantes de poder consultarla o exportarla.Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
^[a-zA-Z0-9\_]+$ -
- TimeSeriesSelector
-
La serie temporal que se va a incluir en la previsión.
Tipo: objeto TimeSeriesSelector
Errores
- 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
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
