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

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

ListWhatIfForecasts

Exibe uma lista de previsões de hipóteses criadas por meio da operação CreateWhatIfForecast. Para cada previsão de hipóteses, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). É possível recuperar o conjunto completo de propriedades usando o ARN da previsão de hipóteses com a operação DescribeWhatIfForecast.

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 dados a seguir no formato JSON.

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 os trabalhos de exportação de previsão de hipóteses correspondentes à declaração devem ser incluídos ou excluídos 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 os trabalhos de exportação de previsão correspondentes à declaração, especifique IS. Para excluir trabalhos de exportação de previsão correspondentes, especifique IS_NOT.

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

  • Value: o valor a ser comparado.

Por exemplo, para listar todos os trabalhos que exportam uma electricityWhatIfprevisão chamada Forecast, especifique o seguinte filtro:

"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]

Tipo: matriz de objetos Filter

Obrigatório: não

MaxResults

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

Tipo: inteiro

Intervalo válido: 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

{
   "NextToken": "string",
   "WhatIfForecasts": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfForecastArn": "string",
         "WhatIfForecastName": "string"
      }
   ]
}

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.

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: .+

WhatIfForecasts

Uma matriz de objetos WhatIfForecasts que descrevem as previsões correspondentes.

Tipo: matriz de objetos WhatIfForecastSummary

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.

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

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: