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.
QueryForecast
Recupera una previsión de un solo artículo, filtrada por los criterios proporcionados.
El criterio es un par clave-valor. La clave es item_id
(o el campo equivalente sin marca temporal ni destino) del conjunto de datos TARGET_TIME_SERIES
, o una de las dimensiones de previsión especificadas como parte del objeto FeaturizationConfig
.
De forma predeterminada, QueryForecast
devuelve el intervalo de fechas completo de la previsión filtrada. Puede solicitar un intervalo de fechas específico.
Para obtener la previsión completa, utilice la CreateForecastExportJoboperación.
nota
Las previsiones generadas por Amazon Forecast se encuentran en la misma zona horaria que el conjunto de datos que se utilizó para crear el predictor.
Sintaxis de la solicitud
{
"EndDate": "string
",
"Filters": {
"string
" : "string
"
},
"ForecastArn": "string
",
"NextToken": "string
",
"StartDate": "string
"
}
Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- EndDate
-
La fecha de finalización de la previsión. Especifique la fecha con este formato: yyyy-MM-dd 't'HH:MM:ss (formato ISO 8601). Por ejemplo, 2015-01-01T20:00:00.
Tipo: cadena
Requerido: no
- Filters
-
Los criterios de filtrado que se aplicarán al recuperar la previsión. Por ejemplo, para obtener la previsión de
client_21
en el conjunto de datos de consumo de electricidad, especifique lo siguiente:{"item_id" : "client_21"}
Para obtener la previsión completa, utilice la operación. CreateForecastExportJob
Tipo: mapa de cadena a cadena
Entradas de mapa: número máximo de 50 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.
Obligatorio: sí
- ForecastArn
-
El nombre de recurso de Amazon (ARN) de la previsión que consultar.
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):forecast:.*:.*:.+
Obligatorio: sí
- NextToken
-
Si el resultado de la solicitud anterior se truncó, la respuesta incluye un
NextToken
. Para recuperar el siguiente conjunto de resultados, utilice el token en la siguiente solicitud. Los tokens caducan tras 24 horas.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 3000.
Obligatorio: no
- StartDate
-
La fecha de inicio de la previsión. Especifique la fecha con este formato: yyyy-MM-dd 't'HH:MM:ss (formato ISO 8601). Por ejemplo, 2015-01-01T08:00:00.
Tipo: cadena
Requerido: no
Sintaxis de la respuesta
{
"Forecast": {
"Predictions": {
"string" : [
{
"Timestamp": "string",
"Value": number
}
]
}
}
}
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.
Errores
- InvalidInputException
-
El valor no es válido o es demasiado largo.
Código de estado HTTP: 400
- InvalidNextTokenException
-
El token no es válido. Los tokens caducan tras 24 horas.
Código de estado HTTP: 400
- LimitExceededException
-
Se ha excedido el límite en el número de solicitudes por segundo.
Código de estado HTTP: 400
- ResourceInUseException
-
El recurso especificado está en uso.
Código de estado HTTP: 400
- ResourceNotFoundException
-
No podemos encontrar ese recurso. Compruebe la información que ha proporcionado 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, consulta lo siguiente: AWS SDKs