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

# DescribeWhatIfForecast
<a name="API_DescribeWhatIfForecast"></a>

Descreve a previsão de hipóteses por meio da operação [CreateWhatIfForecast](API_CreateWhatIfForecast.md).

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

Além de listar as propriedades fornecidas na solicitação `CreateWhatIfForecast`, essa operação inclui as seguintes propriedades:
+  `CreationTime` 
+  `LastModificationTime` 
+  `Message`: se ocorreu um erro, as informações sobre o erro.
+  `Status` 

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

```
{
   "WhatIfForecastArn": "string"
}
```

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

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

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecast-request-WhatIfForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão de hipóteses de interesse.  
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_DescribeWhatIfForecast_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesReplacementsDataSource": { 
      "Format": "string",
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      },
      "Schema": { 
         "Attributes": [ 
            { 
               "AttributeName": "string",
               "AttributeType": "string"
            }
         ]
      },
      "TimestampFormat": "string"
   },
   "TimeSeriesTransformations": [ 
      { 
         "Action": { 
            "AttributeName": "string",
            "Operation": "string",
            "Value": number
         },
         "TimeSeriesConditions": [ 
            { 
               "AttributeName": "string",
               "AttributeValue": "string",
               "Condition": "string"
            }
         ]
      }
   ],
   "WhatIfAnalysisArn": "string",
   "WhatIfForecastArn": "string",
   "WhatIfForecastName": "string"
}
```

## Elementos de resposta
<a name="API_DescribeWhatIfForecast_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.

 ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-CreationTime"></a>
Quando a previsão de hipóteses foi criada.  
Tipo: Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-EstimatedTimeRemainingInMinutes"></a>
O tempo aproximado restante para concluir a previsão de hipóteses, em minutos.  
Tipo: longo

 ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-ForecastTypes"></a>
Os quantis nos quais as previsões probabilísticas são geradas. É possível especificar até cinco quantis por previsão de hipóteses na operação [CreateWhatIfForecast](API_CreateWhatIfForecast.md). Se você não especificou quantis, os valores padrão serão `["0.1", "0.5", "0.9"]`.   
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Restrições de tamanho: o tamanho mínimo é 2. O tamanho máximo é 4.  
Padrão: `(^0?\.\d\d?$|^mean$)` 

 ** [LastModificationTime](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-LastModificationTime"></a>
A última vez que o recurso foi modificado. O carimbo de data e hora depende do status do trabalho:  
+  `CREATE_PENDING`: o `CreationTime`.
+  `CREATE_IN_PROGRESS`: o carimbo de data e hora atual.
+  `CREATE_STOPPING`: o carimbo de data e hora atual.
+  `CREATE_STOPPED`: quando o trabalho parou.
+  `ACTIVE` ou `CREATE_FAILED`: quando o trabalho foi concluído ou falhou.
Tipo: Timestamp

 ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Status"></a>
O status da previsão de hipóteses. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
O `Status` da previsão de hipóteses deve ser `ACTIVE` antes que você possa acessar a previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesReplacementsDataSource"></a>
Uma matriz de elementos `S3Config`, `Schema` e `Format` que descrevem a série temporal de substituição.  
Tipo: objeto [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md)

 ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesTransformations"></a>
Uma matriz de elementos `Action` e `TimeSeriesConditions` que descrevem quais transformações foram aplicadas a quais séries temporais.  
Tipo: matriz de objetos [TimeSeriesTransformation](API_TimeSeriesTransformation.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 30 itens.

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfAnalysisArn"></a>
O nome do recurso da Amazon (ARN) da análise de hipóteses que contém a previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

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

 ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastName"></a>
O nome da previsão de hipóteses.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*` 

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

 ** 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

 ** ResourceNotFoundException **   
Não conseguimos encontrar um recurso com esse nome do recurso da Amazon (ARN). Verifique o ARN e tente novamente.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeWhatIfForecast_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/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast)