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](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

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

# QueryWhatIfForecast
<a name="API_forecastquery_QueryWhatIfForecast"></a>

Recupera uma previsão de hipóteses.

## Sintaxe da solicitação
<a name="API_forecastquery_QueryWhatIfForecast_RequestSyntax"></a>

```
{
   "EndDate": "string",
   "Filters": { 
      "string" : "string" 
   },
   "NextToken": "string",
   "StartDate": "string",
   "WhatIfForecastArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_forecastquery_QueryWhatIfForecast_RequestParameters"></a>

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

 ** [EndDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-EndDate"></a>
A data de término da previsão de hipóteses. Especifique a data usando este formato: yyyy-MM-dd 'T'hh:mm:ss (formato ISO 8601). Por exemplo, 2015-01-01T20:00:00.   
Tipo: string  
Obrigatório: não

 ** [Filters](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-Filters"></a>
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 hipotética completa, use a [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html)operaçã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

 ** [NextToken](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-NextToken"></a>
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](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-StartDate"></a>
A data de início da previsão de hipóteses. Especifique a data usando este formato: yyyy-MM-dd 'T'hh:mm:ss (formato ISO 8601). Por exemplo, 2015-01-01T08:00:00.  
Tipo: string  
Obrigatório: não

 ** [WhatIfForecastArn](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-WhatIfForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão de hipóteses a ser consultada.  
Tipo: string  
Comprimentos de tamanho: comprimento máximo de 300.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_forecastquery_QueryWhatIfForecast_ResponseSyntax"></a>

```
{
   "Forecast": { 
      "Predictions": { 
         "string" : [ 
            { 
               "Timestamp": "string",
               "Value": number
            }
         ]
      }
   }
}
```

## Elementos de resposta
<a name="API_forecastquery_QueryWhatIfForecast_ResponseElements"></a>

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.

 ** [Forecast](#API_forecastquery_QueryWhatIfForecast_ResponseSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-response-Forecast"></a>
Fornece informações sobre uma previsão. Exibidos como parte da resposta [QueryForecast](API_forecastquery_QueryForecast.md).  
Tipo: objeto [Forecast](API_forecastquery_Forecast.md)

## Erros
<a name="API_forecastquery_QueryWhatIfForecast_Errors"></a>

 ** 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
<a name="API_forecastquery_QueryWhatIfForecast_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryWhatIfForecast)