ListForecasts - Amazon Forecast
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

ListForecasts

Exibe uma lista de previsões criadas por meio da operação CreateForecast. Para cada previsão, essa operação retorna um resumo de suas propriedades, incluindo seu Amazon Resource Name (ARN). Para recuperar o conjunto completo de propriedades, especifique ARN com a DescribeForecast operação. É possível filtrar a lista usando uma matriz de objetos Filter.

Importante

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

Sintaxe da Solicitação

{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Parâmetros da solicitação

A solicitação aceita os seguintes dados no JSON formato.

Filters

Uma matriz de filtros. Para cada filtro, são fornecidas uma condição e uma declaração de correspondência. A condição é IS ou IS_NOT, que especifica se as previsões correspondentes à declaração devem ser incluídas ou excluídas da lista, respectivamente. A declaração de correspondência consiste em uma chave e um valor.

Propriedades do filtro

  • Condition: a condição a ser aplicada. Os valores válidos são IS e IS_NOT. Para incluir as previsões correspondentes à declaração, especifique IS. Para excluir previsões correspondentes, especifique IS_NOT.

  • Key: o nome do parâmetro a ser filtrado. Os valores válidos são DatasetGroupArn, PredictorArn e Status.

  • Value: o valor a ser comparado.

Por exemplo, para listar todas as previsões cujo status não sejaACTIVE, você especificaria:

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

Tipo: matriz de objetos Filter

Obrigatório: Não

MaxResults

O número de itens a serem exibidos na resposta.

Tipo: número inteiro

Faixa válida: valor mínimo de 1. Valor máximo de 100.

Obrigatório: Não

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.

Padrão: .+

Obrigatório: Não

Sintaxe da Resposta

{
   "Forecasts": [ 
      { 
         "CreatedUsingAutoPredictor": boolean,
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "ForecastArn": "string",
         "ForecastName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

Forecasts

Uma matriz de objetos que resumem as propriedades de cada previsão.

Tipo: matriz de objetos ForecastSummary

NextToken

Se a resposta estiver truncada, o Amazon Forecast vai gerar esse token. Para recuperar o próximo conjunto de resultados, use o token na próxima solicitação.

Tipo: string

Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 3.000.

Padrão: .+

Erros

InvalidInputException

Não podemos processar a solicitação porque ela inclui um valor inválido ou um valor que excede o intervalo válido.

HTTPCódigo de status: 400

InvalidNextTokenException

O token não é válido. Os tokens expiram após 24 horas.

HTTPCódigo de status: 400

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: