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
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á.
QueryForecast
Recupera uma previsão para um único item, filtrada pelos critérios fornecidos.
O critério é um par de chave-valor. A chave é item_id
(ou o campo sem carimbo de data e hora e sem destino equivalente) do conjunto de dados TARGET_TIME_SERIES
ou uma das dimensões de previsão especificadas como parte do objeto FeaturizationConfig
.
Por padrão, QueryForecast
exibe o intervalo de datas completo para a previsão filtrada. É possível solicitar um intervalo de datas específico.
Para obter a previsão completa, use a CreateForecastExportJoboperação.
nota
As previsões geradas pelo Amazon Forecast estão no mesmo fuso horário do conjunto de dados usado para criar o preditor.
Sintaxe da Solicitação
{
"EndDate": "string
",
"Filters": {
"string
" : "string
"
},
"ForecastArn": "string
",
"NextToken": "string
",
"StartDate": "string
"
}
Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- EndDate
-
A data de término da previsão. Especifique a data usando este formato: aaaa-MM-dd'T'HH:mm:ss (formato ISO 8601). Por exemplo, 2015-01-01T20:00:00.
Tipo: string
Obrigatório: não
- Filters
-
Os critérios de filtragem a serem aplicados ao recuperar a previsão. Por exemplo, para obter a previsão para
client_21
no conjunto de dados de uso de eletricidade, especifique o seguinte:{"item_id" : "client_21"}
Para obter a previsão completa, use a CreateForecastExportJoboperação.
Tipo: mapa de string para string
Entradas do mapa: número máximo de 50 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.
Obrigatório: Sim
- ForecastArn
-
O nome do recurso da Amazon (ARN) da previsão a ser consultada.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+
Exigido: Sim
- NextToken
-
Se o resultado da solicitação anterior estava truncado, a resposta incluirá um
NextToken
. Para recuperar o próximo conjunto de resultados, use o token na próxima solicitação. Os tokens expiram após 24 horas.Tipo: string
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 3.000.
Obrigatório: não
- StartDate
-
A data de início da previsão. Especifique a data usando este formato: aaaa-MM-dd'T'HH:mm:ss (formato ISO 8601). Por exemplo, 2015-01-01T08:00:00.
Tipo: string
Obrigatório: não
Sintaxe da Resposta
{
"Forecast": {
"Predictions": {
"string" : [
{
"Timestamp": "string",
"Value": number
}
]
}
}
}
Elementos de Resposta
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.
Erros
- InvalidInputException
-
O valor é inválido ou é muito longo.
Código de Status HTTP: 400
- InvalidNextTokenException
-
O token não é válido. Os tokens expiram após 24 horas.
Código de Status HTTP: 400
- LimitExceededException
-
O limite de número de solicitações por segundo foi excedido.
Código de Status HTTP: 400
- ResourceInUseException
-
O recurso especificado está em uso.
Código de Status HTTP: 400
- ResourceNotFoundException
-
Não conseguimos encontrar esse recurso. Confira as informações que você forneceu e tente novamente.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: