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

# Referência da API
<a name="api-reference"></a>

Esta seção fornece a documentação das operações de API do Amazon Forecast.

**Topics**
+ [Ações](API_Operations.md)
+ [Tipos de dados](API_Types.md)
+ [Erros comuns](CommonErrors.md)
+ [Parâmetros gerais](CommonParameters.md)

# Ações
<a name="API_Operations"></a>

As ações a seguir são compatíveis com o Amazon Forecast Service:
+  [CreateAutoPredictor](API_CreateAutoPredictor.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateExplainability](API_CreateExplainability.md) 
+  [CreateExplainabilityExport](API_CreateExplainabilityExport.md) 
+  [CreateForecast](API_CreateForecast.md) 
+  [CreateForecastExportJob](API_CreateForecastExportJob.md) 
+  [CreateMonitor](API_CreateMonitor.md) 
+  [CreatePredictor](API_CreatePredictor.md) 
+  [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) 
+  [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 
+  [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 
+  [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) 
+  [DeleteExplainability](API_DeleteExplainability.md) 
+  [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) 
+  [DeleteForecast](API_DeleteForecast.md) 
+  [DeleteForecastExportJob](API_DeleteForecastExportJob.md) 
+  [DeleteMonitor](API_DeleteMonitor.md) 
+  [DeletePredictor](API_DeletePredictor.md) 
+  [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) 
+  [DeleteResourceTree](API_DeleteResourceTree.md) 
+  [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) 
+  [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) 
+  [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) 
+  [DescribeAutoPredictor](API_DescribeAutoPredictor.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeExplainability](API_DescribeExplainability.md) 
+  [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) 
+  [DescribeForecast](API_DescribeForecast.md) 
+  [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 
+  [DescribeMonitor](API_DescribeMonitor.md) 
+  [DescribePredictor](API_DescribePredictor.md) 
+  [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) 
+  [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) 
+  [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 
+  [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 
+  [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListExplainabilities](API_ListExplainabilities.md) 
+  [ListExplainabilityExports](API_ListExplainabilityExports.md) 
+  [ListForecastExportJobs](API_ListForecastExportJobs.md) 
+  [ListForecasts](API_ListForecasts.md) 
+  [ListMonitorEvaluations](API_ListMonitorEvaluations.md) 
+  [ListMonitors](API_ListMonitors.md) 
+  [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) 
+  [ListPredictors](API_ListPredictors.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) 
+  [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) 
+  [ListWhatIfForecasts](API_ListWhatIfForecasts.md) 
+  [ResumeResource](API_ResumeResource.md) 
+  [StopResource](API_StopResource.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatasetGroup](API_UpdateDatasetGroup.md) 

As ações a seguir são compatíveis com o Amazon Forecast Query Service:
+  [QueryForecast](API_forecastquery_QueryForecast.md) 
+  [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) 

# Amazon Forecast Service
<a name="API_Operations_Amazon_Forecast_Service"></a>

As ações a seguir são compatíveis com o Amazon Forecast Service:
+  [CreateAutoPredictor](API_CreateAutoPredictor.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateExplainability](API_CreateExplainability.md) 
+  [CreateExplainabilityExport](API_CreateExplainabilityExport.md) 
+  [CreateForecast](API_CreateForecast.md) 
+  [CreateForecastExportJob](API_CreateForecastExportJob.md) 
+  [CreateMonitor](API_CreateMonitor.md) 
+  [CreatePredictor](API_CreatePredictor.md) 
+  [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) 
+  [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 
+  [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 
+  [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) 
+  [DeleteExplainability](API_DeleteExplainability.md) 
+  [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) 
+  [DeleteForecast](API_DeleteForecast.md) 
+  [DeleteForecastExportJob](API_DeleteForecastExportJob.md) 
+  [DeleteMonitor](API_DeleteMonitor.md) 
+  [DeletePredictor](API_DeletePredictor.md) 
+  [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) 
+  [DeleteResourceTree](API_DeleteResourceTree.md) 
+  [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) 
+  [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) 
+  [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) 
+  [DescribeAutoPredictor](API_DescribeAutoPredictor.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeExplainability](API_DescribeExplainability.md) 
+  [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) 
+  [DescribeForecast](API_DescribeForecast.md) 
+  [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 
+  [DescribeMonitor](API_DescribeMonitor.md) 
+  [DescribePredictor](API_DescribePredictor.md) 
+  [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) 
+  [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) 
+  [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 
+  [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 
+  [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListExplainabilities](API_ListExplainabilities.md) 
+  [ListExplainabilityExports](API_ListExplainabilityExports.md) 
+  [ListForecastExportJobs](API_ListForecastExportJobs.md) 
+  [ListForecasts](API_ListForecasts.md) 
+  [ListMonitorEvaluations](API_ListMonitorEvaluations.md) 
+  [ListMonitors](API_ListMonitors.md) 
+  [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) 
+  [ListPredictors](API_ListPredictors.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) 
+  [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) 
+  [ListWhatIfForecasts](API_ListWhatIfForecasts.md) 
+  [ResumeResource](API_ResumeResource.md) 
+  [StopResource](API_StopResource.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatasetGroup](API_UpdateDatasetGroup.md) 

# CreateAutoPredictor
<a name="API_CreateAutoPredictor"></a>

Cria um preditor do Amazon Forecast.

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

O Amazon Forecast cria preditores com AutoPredictor, o que envolve a aplicação da combinação ideal de algoritmos a cada série temporal em seus conjuntos de dados. Você pode usar [CreateAutoPredictor](#API_CreateAutoPredictor) para criar novos preditores ou fazer upgrade/retreinar preditores existentes.

 **Criação de preditores** 

Os seguintes parâmetros são obrigatórios ao criar um novo preditor:
+  `PredictorName` - Um nome exclusivo para o preditor.
+  `DatasetGroupArn` - O ARN do grupo de conjuntos de dados usado para treinar o preditor.
+  `ForecastFrequency` - A granularidade de suas previsões (por hora, diariamente, semanalmente etc.).
+  `ForecastHorizon` - O número de etapas temporais que o modelo prevê. O horizonte de predição também é chamado de comprimento da predição.

Ao criar um novo preditor, não especifique um valor para `ReferencePredictorArn`.

 **Como fazer upgrade de preditores e treiná-los novamente** 

Os seguintes parâmetros são obrigatórios para fazer upgrade de um preditor ou treiná-lo novamente.
+  `PredictorName` - Um nome exclusivo para o preditor.
+  `ReferencePredictorArn` - O ARN do preditor a ser submetido a upgrade ou a um novo treinamento.

Ao fazer upgrade de um preditor ou treiná-lo novamente, especifique apenas valores para `ReferencePredictorArn` e `PredictorName`. 

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

```
{
   "DataConfig": { 
      "AdditionalDatasets": [ 
         { 
            "Configuration": { 
               "string" : [ "string" ]
            },
            "Name": "string"
         }
      ],
      "AttributeConfigs": [ 
         { 
            "AttributeName": "string",
            "Transformations": { 
               "string" : "string" 
            }
         }
      ],
      "DatasetGroupArn": "string"
   },
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "ExplainPredictor": boolean,
   "ForecastDimensions": [ "string" ],
   "ForecastFrequency": "string",
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "MonitorConfig": { 
      "MonitorName": "string"
   },
   "OptimizationMetric": "string",
   "PredictorName": "string",
   "ReferencePredictorArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeAlignmentBoundary": { 
      "DayOfMonth": number,
      "DayOfWeek": "string",
      "Hour": number,
      "Month": "string"
   }
}
```

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

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

 ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-DataConfig"></a>
A configuração de dados do seu grupo de conjuntos de dados e de quaisquer conjuntos de dados adicionais.  
Tipo: objeto [DataConfig](API_DataConfig.md)  
Obrigatório: não

 ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave. Você pode especificar esse objeto opcional nas solicitações [CreateDataset](API_CreateDataset.md) e [CreatePredictor](API_CreatePredictor.md).  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)  
Obrigatório: não

 ** [ExplainPredictor](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ExplainPredictor"></a>
Crie um recurso de explicabilidade para o preditor.  
Tipo: booliano  
Obrigatório: não

 ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastDimensions"></a>
Uma matriz de nomes de dimensão (campo) que especificam como agrupar a previsão gerada.  
Por exemplo, se você estiver gerando previsões de vendas de itens em todas as suas lojas e seu conjunto de dados contiver um campo `store_id`, você especificaria `store_id` como uma dimensão para agrupar as previsões de vendas de cada loja.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*`   
Obrigatório: não

 ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastFrequency"></a>
A frequência das previsões em uma previsão.  
Os intervalos válidos são um número inteiro seguido de Y (ano), M (mês), W (semana), D (dia), H (hora) e min (minuto). Por exemplo, "1D" indica todos os dias e "15min" indica a cada 15 minutos. Você não pode especificar um valor que se sobreporia à próxima frequência maior. Isso significa, por exemplo, que você não pode especificar uma frequência de 60 minutos, porque isso equivale a 1 hora. Os valores válidos para cada frequência são os seguintes:  
+ Minuto: 1 a 59
+ Hora: 1 a 23
+ Dia: 1 a 6
+ Semana: 1 a 4
+ Mês: 1 a 11
+ Year (Ano): 1
Assim, se você quiser previsões a cada duas semanas, especifique "2W". Ou, se quiser previsões trimestrais, especifique "3M".  
A frequência deve ser maior ou igual à frequência de conjunto de dados TARGET\$1TIME\$1SERIES.  
Quando um conjunto de dados RELATED\$1TIME\$1SERIES é fornecido, a frequência deve ser igual à frequência de conjunto de dados RELATED\$1TIME\$1SERIES.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$`   
Obrigatório: não

 ** [ForecastHorizon](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastHorizon"></a>
O número de etapas temporais que o modelo prevê. O horizonte de predição também é chamado de comprimento da predição.  
O horizonte máximo de previsão é o menor entre 500 etapas temporais ou 1/4 do tamanho do conjunto de dados TARGET\$1TIME\$1SERIES. Se você estiver treinando novamente um existente AutoPredictor, o horizonte máximo de previsão será o menor de 500 intervalos de tempo ou 1/3 do tamanho do conjunto de dados TARGET\$1TIME\$1SERIES.  
Se você estiver atualizando AutoPredictor ou retreinando um existente AutoPredictor, não poderá atualizar o parâmetro do horizonte de previsão. Você pode atender a esse requisito fornecendo séries temporais mais longas no conjunto de dados.  
Tipo: inteiro  
Obrigatório: não

 ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastTypes"></a>
Os tipos de previsão usados para treinar um preditor. Você pode especificar até cinco tipos de previsão. Os tipos de previsão podem ser quantis de 0,01 a 0,99, em incrementos de 0,01 ou mais. Você também pode especificar a previsão média com `mean`.  
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$)`   
Obrigatório: não

 ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-MonitorConfig"></a>
Os detalhes da configuração do monitoramento de preditores. Forneça um nome exclusivo para o recurso de monitor a fim de habilitar o monitoramento do preditor.  
O monitoramento de preditores permite que você veja como o desempenho do seu preditor muda ao longo do tempo. Para obter mais informações, consulte [Monitoramento de preditores](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html).  
Tipo: objeto [MonitorConfig](API_MonitorConfig.md)  
Obrigatório: não

 ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
Obrigatório: não

 ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-PredictorName"></a>
Um nome exclusivo para o preditor  
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_]*`   
Obrigatório: Sim

 ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ReferencePredictorArn"></a>
O ARN do preditor a ser submetido a upgrade ou a um novo treinamento. Este parâmetro só é usado quando um preditor é submetido a upgrade ou a um novo treinamento. Ao criar um novo preditor, não especifique um valor para este parâmetro.  
Ao fazer upgrade de um preditor ou treiná-lo novamente, especifique apenas valores para `ReferencePredictorArn` e `PredictorName`. O valor de `PredictorName` deve ser um nome de preditor exclusivo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** [Tags](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-Tags"></a>
Os metadados opcionais que ajudam você a categorizar e organizar seus preditores. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. As chaves e valores das tags diferenciam maiúsculas de minúsculas.  
As restrições a seguir se aplicam às tags:  
+ Em todos os recursos, cada chave de tag deve ser exclusiva e ter apenas um valor.
+ Número máximo de tags por recurso: 50.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caracteres aceitos: todas as letras, números e espaços representáveis em UTF-8 e os símbolos \$1 - = . \$1 : / @. Se seu esquema de tags for usado em outros serviços e recursos, as restrições de caracteres desses serviços também serão aplicáveis. 
+ Os prefixos de teclas não podem incluir nenhuma combinação de letras maiúsculas ou minúsculas de `aws:` ou `AWS:`. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso. Você não pode editar nem excluir chaves de tag com esse prefixo.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-TimeAlignmentBoundary"></a>
O limite de tempo que o Forecast usa para alinhar e agregar quaisquer dados que não estejam alinhados à sua frequência de previsão. Forneça a unidade de tempo e o limite de tempo como um par chave-valor. Para obter mais informações sobre como especificar um limite de tempo, consulte [Como especificar um limite de tempo](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). Se você não fornecer um limite de tempo, o Forecast usará um conjunto de [Limites de tempo padrão](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries).  
Tipo: objeto [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md)  
Obrigatório: não

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

```
{
   "PredictorArn": "string"
}
```

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

 ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) **   <a name="forecast-CreateAutoPredictor-response-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateAutoPredictor_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateAutoPredictor_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/CreateAutoPredictor) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateAutoPredictor) 

# CreateDataset
<a name="API_CreateDataset"></a>

Cria um conjunto de dados do Amazon Forecast. 

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

As informações fornecidas sobre o conjunto de dados ajudam o Forecast a entender como consumir os dados para treinamento de modelos. Essa transmissão inclui o seguinte:
+  * `DataFrequency` *: a frequência com a qual seus dados de séries temporais históricos são coletados.
+  * `Domain` * e * `DatasetType` *: cada conjunto de dados tem um domínio de conjunto de dados associado e um tipo dentro do domínio. O Amazon Forecast fornece uma lista de domínios e tipos predefinidos dentro de cada domínio. Para cada domínio e tipo de conjunto de dados exclusivos, o Amazon Forecast exige que os dados de entrada incluam um conjunto mínimo de campos predefinidos.
+  * `Schema` *: um esquema especifica os campos do conjunto de dados, incluindo o nome do campo e o tipo de dados.

Depois de criar um conjunto de dados, você importa os dados de treinamento nele e o adiciona a um grupo de conjuntos de dados. Você utiliza esse grupo de conjuntos de dados para criar um agente de previsão. Para obter mais informações, consulte [Importar conjuntos de dados](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

Para obter uma lista de todos os seus conjuntos de dados, use a [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)operação.

Por exemplo, conjuntos de dados do Forecast, consulte o [ GitHubrepositório Amazon Forecast Sample](https://github.com/aws-samples/amazon-forecast-samples).

**nota**  
O `Status` de um conjunto de dados deve ser `ACTIVE` antes que você possa importar dados de treinamento. Use a operação [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) para obter o status.

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

```
{
   "DataFrequency": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DataFrequency](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DataFrequency"></a>
A frequência da coleta de dados. Esse parâmetro é obrigatório para conjuntos de dados RELATED\$1TIME\$1SERIES.  
Os intervalos válidos são um número inteiro seguido de Y (ano), M (mês), W (semana), D (dia), H (hora) e min (minuto). Por exemplo, "1D" indica todos os dias e "15min" indica a cada 15 minutos. Você não pode especificar um valor que se sobreporia à próxima frequência maior. Isso significa, por exemplo, que você não pode especificar uma frequência de 60 minutos, porque isso equivale a 1 hora. Os valores válidos para cada frequência são os seguintes:  
+ Minuto: 1 a 59
+ Hora: 1 a 23
+ Dia: 1 a 6
+ Semana: 1 a 4
+ Mês: 1 a 11
+ Year (Ano): 1
Assim, se você quiser previsões a cada duas semanas, especifique "2W". Ou, se quiser previsões trimestrais, especifique "3M".  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$`   
Obrigatório: não

 ** [DatasetName](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetName"></a>
Um nome para o conjunto de dados.  
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_]*`   
Obrigatório: Sim

 ** [DatasetType](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetType"></a>
O tipo de conjunto de dados. Os valores válidos dependem do `Domain` escolhido.  
Tipo: string  
Valores válidos: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
Obrigatório: Sim

 ** [Domain](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Domain"></a>
O domínio associado ao conjunto de dados. Quando você adiciona um conjunto de dados a um grupo de conjuntos de dados, esse valor e o valor especificado para o `Domain` parâmetro da [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)operação devem corresponder.  
O `Domain` e o `DatasetType` que você escolhe para determinar os campos que devem estar presentes nos dados de treinamento importados para um conjunto de dados. Por exemplo, se você escolher o domínio `RETAIL` e `TARGET_TIME_SERIES` como `DatasetType`, o Amazon Forecast exigirá que os campos `item_id`, `timestamp` e `demand` estejam presentes nos seus dados. Para obter mais informações, consulte [Importar conjuntos de dados](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).  
Tipo: string  
Valores válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Obrigatório: Sim

 ** [EncryptionConfig](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)  
Obrigatório: não

 ** [Schema](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Schema"></a>
O esquema do conjunto de dados. Os atributos do esquema e sua ordem devem corresponder aos campos nos seus dados. O conjunto de dados `Domain` e `DatasetType` que você escolher para determinar os campos mínimos obrigatórios nos seus dados de treinamento. Para saber mais sobre os campos obrigatórios de um domínio e tipo de conjunto de dados específicos, consulte [Domínios e tipos de conjunto de dados](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).  
Tipo: objeto [Schema](API_Schema.md)  
Obrigatório: Sim

 ** [Tags](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Tags"></a>
Os metadados opcionais que você aplica ao conjunto de dados para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "DatasetArn": "string"
}
```

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

 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="forecast-CreateDataset-response-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateDataset_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de Status HTTP: 400

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

# CreateDatasetGroup
<a name="API_CreateDatasetGroup"></a>

Cria um grupo de conjuntos de dados que mantém uma coleção de conjuntos de dados relacionados. Você pode adicionar conjuntos de dados ao grupo de conjuntos de dados ao criar o grupo de conjuntos de dados ou posteriormente usando a operação. [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)

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

Depois de criar um grupo de conjuntos de dados e adicionar conjuntos de dados, use esse grupo ao criar um preditor. Para obter mais informações, consulte [Grupos de conjuntos de dados](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

Para obter uma lista de todos os seus grupos de conjuntos de dados, use a [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)operação.

**nota**  
O `Status` de um grupo de conjuntos de dados deve ser `ACTIVE` antes de utilizar esse grupo para criar um preditor. Para obter o status, use a operação [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html).

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

```
{
   "DatasetArns": [ "string" ],
   "DatasetGroupName": "string",
   "Domain": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetArns"></a>
Uma matriz de nomes de recursos da Amazon (ARNs) dos conjuntos de dados que você deseja incluir no grupo de conjuntos de dados.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetGroupName"></a>
Um nome para o grupo de conjuntos de dados.  
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_]*`   
Obrigatório: Sim

 ** [Domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Domain"></a>
O domínio associado ao grupo de conjuntos de dados. Quando você adiciona um conjunto de dados a um grupo de conjuntos de dados, esse valor e o valor especificado para o `Domain` parâmetro da [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação devem corresponder.  
O `Domain` e o `DatasetType` que você escolhe para determinar os campos que devem estar presentes nos dados de treinamento importados para um conjunto de dados. Por exemplo, se você escolher o domínio `RETAIL` e `TARGET_TIME_SERIES` como `DatasetType`, o Amazon Forecast exigirá que os campos `item_id`, `timestamp` e `demand` estejam presentes nos seus dados. Para obter mais informações, consulte [Grupos de conjuntos de dados](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).  
Tipo: string  
Valores válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Obrigatório: Sim

 ** [Tags](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Tags"></a>
Os metadados opcionais que você aplica ao grupo de conjuntos de dados para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "DatasetGroupArn": "string"
}
```

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

 ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="forecast-CreateDatasetGroup-response-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateDatasetGroup_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateDatasetGroup_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/CreateDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup) 

# CreateDatasetImportJob
<a name="API_CreateDatasetImportJob"></a>

Importa os dados do treinamento para um conjunto de dados do Amazon Forecast. Você fornece o local dos dados de treinamento em um bucket do Amazon Simple Storage Service (Amazon S3) e o nome do recurso da Amazon (ARN) do conjunto de dados para o qual os dados serão importados.

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

Você deve especificar um [DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html)objeto que inclua uma função AWS Identity and Access Management (IAM) que o Amazon Forecast possa assumir para acessar os dados, pois o Amazon Forecast faz uma cópia dos seus dados e os processa em um AWS sistema interno. Para obter mais informações, consulte [Configurar permissões](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html).

Os dados do treinamento devem estar no formato CSV ou Parquet. O delimitador deve ser uma vírgula (,).

Você pode especificar um caminho para um arquivo específico, para o bucket do S3 ou para uma pasta no bucket do S3. Nos dois últimos casos, o Amazon Forecast importa todos os arquivos até o limite de 10.000 arquivos.

Como as importações de conjuntos de dados não são agregadas, sua importação mais recente de conjuntos de dados é a utilizada ao treinar um preditor ou gerar uma previsão. Certifique-se de que sua importação mais recente de conjuntos de dados contém todos os dados dos quais você deseja modelar, e não apenas os novos dados coletados desde a importação anterior.

Para obter uma lista de todos os seus trabalhos de importação de conjuntos de dados, filtrados por critérios especificados, use a [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)operação.

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

```
{
   "DatasetArn": "string",
   "DatasetImportJobName": "string",
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "GeolocationFormat": "string",
   "ImportMode": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimestampFormat": "string",
   "TimeZone": "string",
   "UseGeolocationForTimeZone": boolean
}
```

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

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

 ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados do Amazon Forecast para o qual você deseja importar os dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetImportJobName"></a>
O nome do trabalho de importação do conjunto de dados. Recomendamos incluir o carimbo de data e hora atual no nome, por exemplo, `20190721DatasetImport`. Isso pode ajudar você a evitar a exceção `ResourceAlreadyExistsException`.  
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_]*`   
Obrigatório: Sim

 ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DataSource"></a>
A localização dos dados de treinamento a serem importados e uma função AWS Identity and Access Management (IAM) que a Amazon Forecast pode assumir para acessar os dados. Os dados de treinamento devem ser armazenados em um bucket do Amazon S3.  
Se a criptografia for usada, `DataSource` deverá incluir uma chave AWS Key Management Service (KMS) e a função do IAM deve permitir que a Amazon Forecast acesse a chave. A chave KMS e a função do IAM devem corresponder às especificadas no `EncryptionConfig` parâmetro da [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação.  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: Sim

 ** [Format](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Format"></a>
O formato dos dados importados: CSV ou PARQUET. O valor padrão é CSV.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-GeolocationFormat"></a>
O formato do atributo de geolocalização. O atributo de geolocalização pode ser formatado de duas maneiras:  
+  `LAT_LONG` - a latitude e a longitude em formato decimal (Exemplo: 47,61\$1-122,33).
+  `CC_POSTALCODE` (Somente nos EUA) - o código do país (EUA), seguido pelo código postal de 5 dígitos (exemplo: US\$198121).
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9_]+$`   
Obrigatório: não

 ** [ImportMode](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-ImportMode"></a>
Especifica se o trabalho de importação de conjunto de dados é uma importação `FULL` ou `INCREMENTAL`. A importação de conjunto de dados `FULL` substitui todos os dados existentes pelos dados recém-importados. Uma importação `INCREMENTAL` anexa os dados importados aos dados existentes.  
Tipo: string  
Valores válidos: `FULL | INCREMENTAL`   
Obrigatório: não

 ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Tags"></a>
Os metadados opcionais que você aplica ao trabalho de importação de conjunto de dados para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TimestampFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimestampFormat"></a>
O formato dos carimbos de data/hora no conjunto de dados. O formato que você especifica depende da `DataFrequency` especificada quando o conjunto de dados foi criado. Os formatos a seguir são compatíveis.  
+ “aaaa-MM-dd”

  Para as seguintes frequências de dados: A, M, S e D
+ “yyyy-MM-dd HH: MM: SS”

  Para as seguintes frequências de dados: H, 30 min, 15 min e 1 min; e opcionalmente, para: A, M, S e D
Se o formato não for especificado, o Amazon Forecast espera que o formato seja “aaaa-MM-dd HH:mm:ss”.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\-\:\.\,\'\s]+$`   
Obrigatório: não

 ** [TimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimeZone"></a>
Um único fuso horário de cada item em seu conjunto de dados. Essa opção é ideal para conjuntos de dados com todos os carimbos de data/hora em um único fuso horário ou se todos os carimbos de data/hora estiverem normalizados para um único fuso horário.   
Consulte a [API Joda-Time](http://joda-time.sourceforge.net/timezones.html) para obter uma lista completa dos nomes de fuso horário válidos.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\/\+\-\_]+$`   
Obrigatório: não

 ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-UseGeolocationForTimeZone"></a>
Derive automaticamente as informações de fuso horário do atributo de geolocalização. Essa opção é ideal para conjuntos de dados que contêm carimbos de data/hora em vários fusos horários, esses carimbos de data/hora são expressos no horário local.  
Tipo: booliano  
Obrigatório: não

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

```
{
   "DatasetImportJobArn": "string"
}
```

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

 ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="forecast-CreateDatasetImportJob-response-DatasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação de conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateDatasetImportJob_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateDatasetImportJob_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/CreateDatasetImportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) 

# CreateExplainability
<a name="API_CreateExplainability"></a>

**nota**  
A explicabilidade só está disponível para previsões e preditores gerados a partir de um () AutoPredictor [CreateAutoPredictor](API_CreateAutoPredictor.md)

Cria uma explicabilidade do Amazon Forecast.

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

A explicabilidade ajuda você a entender melhor como os atributos em seus conjuntos de dados afetam a previsão. O Amazon Forecast usa uma métrica chamada Impact scores para quantificar o impacto relativo de cada atributo e determinar se eles aumentam ou diminuem os valores da previsão.

Para habilitar a explicabilidade da previsão, seu preditor deve incluir pelo menos um dos seguintes elementos: séries temporais relacionadas, metadados de itens ou conjuntos de dados adicionais, como Holidays, e o Weather Index.

**nota**  
Os modelos ARIMA (AutoRegressive Integrated Moving Average), ETS (Exponential Smoothing State Space Model) e NPTS (Non-Parametric Time Series) não incorporam dados externos de séries temporais. Portanto, esses modelos não criam um relatório de explicabilidade, mesmo se você incluir os conjuntos de dados adicionais.

CreateExplainability aceita um ARN do Predictor ou do Forecast ARN. Para receber pontuações de impacto agregadas para todas as séries temporais e pontos no tempo em seus conjuntos de dados, forneça o ARN de um preditor. Para receber pontuações de impacto para séries temporais e pontos no tempo específicos, forneça o ARN de uma previsão.

 **CreateExplainability com um ARN do Predictor** 

**nota**  
Você só pode ter um recurso de explicabilidade por preditor. Se você já habilitou `ExplainPredictor` em [CreateAutoPredictor](API_CreateAutoPredictor.md), esse preditor já tem um recurso de explicabilidade.

Os seguintes parâmetros são obrigatórios ao fornecer o ARN de um preditor:
+  `ExplainabilityName` - Um nome exclusivo para a explicabilidade.
+  `ResourceArn` - O ARN do preditor.
+  `TimePointGranularity` - Deve ser definido como “ALL”.
+  `TimeSeriesGranularity` - Deve ser definido como “ALL”.

Não especifique um valor para os seguintes parâmetros:
+  `DataSource`- Só é válido quando TimeSeriesGranularity é “ESPECÍFICO”.
+  `Schema`- Só é válido quando TimeSeriesGranularity é “ESPECÍFICO”.
+  `StartDateTime`- Só é válido quando TimePointGranularity é “ESPECÍFICO”.
+  `EndDateTime`- Só é válido quando TimePointGranularity é “ESPECÍFICO”.

 **CreateExplainability com um Forecast ARN** 

**nota**  
Você pode especificar um máximo de 50 séries temporais e 500 pontos no tempo.

Os seguintes parâmetros são obrigatórios ao fornecer o ARN de um preditor:
+  `ExplainabilityName` - Um nome exclusivo para a explicabilidade.
+  `ResourceArn` - O Arn da previsão.
+  `TimePointGranularity` - “ALL” ou “SPECIFIC”.
+  `TimeSeriesGranularity` - “ALL” ou “SPECIFIC”.

Se você TimeSeriesGranularity definir como “ESPECÍFICO”, também deverá fornecer o seguinte:
+  `DataSource` - O local do S3 do arquivo CSV que especifica sua série temporal.
+  `Schema` - O esquema define os atributos e os tipos de atributo listados na fonte de dados.

Se você TimePointGranularity definir como “ESPECÍFICO”, também deverá fornecer o seguinte:
+  `StartDateTime` - O primeiro carimbo de data e hora na faixa de pontos no tempo.
+  `EndDateTime` - O último carimbo de data e hora na faixa de pontos no tempo.

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

```
{
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [DataSource](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-DataSource"></a>
A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite ao Amazon Forecast acessar os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: não

 ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EnableVisualization"></a>
Crie uma visualização de explicabilidade que possa ser visualizada no console. AWS   
Tipo: booliano  
Obrigatório: não

 ** [EndDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EndDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, defina o último ponto no tempo para a explicabilidade.  
Use o seguinte formato de timestamp ::mm:ss (exemplo: 2015-01-01T 20:00:00) yyyy-MM-ddTHH  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`   
Obrigatório: não

 ** [ExplainabilityConfig](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityConfig"></a>
As configurações que definem a granularidade das séries temporais e dos pontos no tempo para a explicabilidade.  
Tipo: objeto [ExplainabilityConfig](API_ExplainabilityConfig.md)  
Obrigatório: Sim

 ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityName"></a>
Um nome exclusivo para a explicabilidade.  
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_]*`   
Obrigatório: Sim

 ** [ResourceArn](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor ou da previsão usado para criar a explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [Schema](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Schema"></a>
Define os campos de um conjunto de dados.  
Tipo: objeto [Schema](API_Schema.md)  
Obrigatório: não

 ** [StartDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-StartDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, defina o primeiro ponto para a explicabilidade.  
Use o seguinte formato de timestamp ::mm:ss (exemplo: 2015-01-01T 20:00:00) yyyy-MM-ddTHH  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`   
Obrigatório: não

 ** [Tags](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Tags"></a>
Metadados opcionais que ajudam você a categorizar e organizar seus recursos. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. As chaves e valores das tags diferenciam maiúsculas de minúsculas.  
As restrições a seguir se aplicam às tags:  
+ Em todos os recursos, cada chave de tag deve ser exclusiva e ter apenas um valor.
+ Número máximo de tags por recurso: 50.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caracteres aceitos: todas as letras, números e espaços representáveis em UTF-8 e os símbolos \$1 - = . \$1 : / @. Se seu esquema de tags for usado em outros serviços e recursos, as restrições de caracteres desses serviços também serão aplicáveis. 
+ Os prefixos de teclas não podem incluir nenhuma combinação de letras maiúsculas ou minúsculas de `aws:` ou `AWS:`. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso. Você não pode editar nem excluir chaves de tag com esse prefixo.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "ExplainabilityArn": "string"
}
```

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

 ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) **   <a name="forecast-CreateExplainability-response-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateExplainability_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateExplainability_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/CreateExplainability) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) 

# CreateExplainabilityExport
<a name="API_CreateExplainabilityExport"></a>

Exporta um recurso de explicabilidade criado pela operação [CreateExplainability](API_CreateExplainability.md). Os arquivos exportados são exportados para um bucket do Amazon Simple Storage Service (Amazon S3).

Você deve especificar um [DataDestination](API_DataDestination.md) objeto que inclua um bucket do Amazon S3 e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast possa assumir para acessar o bucket do Amazon S3. Para obter mais informações, consulte [Configurar permissões para o Amazon Forecast](aws-forecast-iam-roles.md).

**nota**  
O `Status` do trabalho de exportação deve ser `ACTIVE` para que você possa acessar a exportação no bucket do Amazon S3. Para obter o status, use a operação [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md).

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

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ExplainabilityArn": "string",
   "ExplainabilityExportName": "string",
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: Sim

 ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade a ser exportada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityExportName"></a>
Um nome exclusivo para a exportação da explicabilidade.  
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_]*`   
Obrigatório: Sim

 ** [Format](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Format"></a>
O formato dos dados exportados: CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Tags"></a>
Metadados opcionais que ajudam você a categorizar e organizar seus recursos. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. As chaves e valores das tags diferenciam maiúsculas de minúsculas.  
As restrições a seguir se aplicam às tags:  
+ Em todos os recursos, cada chave de tag deve ser exclusiva e ter apenas um valor.
+ Número máximo de tags por recurso: 50.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caracteres aceitos: todas as letras, números e espaços representáveis em UTF-8 e os símbolos \$1 - = . \$1 : / @. Se seu esquema de tags for usado em outros serviços e recursos, as restrições de caracteres desses serviços também serão aplicáveis. 
+ Os prefixos de teclas não podem incluir nenhuma combinação de letras maiúsculas ou minúsculas de `aws:` ou `AWS:`. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso. Você não pode editar nem excluir chaves de tag com esse prefixo.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "ExplainabilityExportArn": "string"
}
```

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

 ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) **   <a name="forecast-CreateExplainabilityExport-response-ExplainabilityExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateExplainabilityExport_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateExplainabilityExport_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/CreateExplainabilityExport) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainabilityExport) 

# CreateForecast
<a name="API_CreateForecast"></a>

Cria uma previsão para cada item no conjunto de dados `TARGET_TIME_SERIES` usado para treinar o preditor. Isso é conhecido como inferência. Para recuperar a previsão de um único item com baixa latência, use a operação [QueryForecast](API_forecastquery_QueryForecast.md). Para exportar a previsão completa para o bucket do Amazon Simple Storage Service (Amazon S3), use a operação [CreateForecastExportJob](API_CreateForecastExportJob.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/) 

O intervalo da previsão é determinado pelo valor `ForecastHorizon`, que você especifica na solicitação [CreatePredictor](API_CreatePredictor.md). Ao consultar uma previsão, você pode solicitar um intervalo de datas específico na previsão.

Para obter uma lista de todas as suas previsões, use a operação [ListForecasts](API_ListForecasts.md).

**nota**  
As previsões geradas pelo Amazon Forecast estão no mesmo fuso horário do conjunto de dados usado para criar o preditor.

Para obter mais informações, consulte [Geração de previsões](howitworks-forecast.md).

**nota**  
O `Status` da previsão deve ser `ACTIVE` para que você possa consultar ou exportar a previsão. Use a operação [DescribeForecast](API_DescribeForecast.md) para obter o status.

Por padrão, uma previsão inclui previsões para cada item (`item_id`) no grupo de conjuntos de dados usado para treinar o preditor. No entanto, você pode usar o objeto `TimeSeriesSelector` para gerar uma previsão em um subconjunto de séries temporais. A criação de previsões é ignorada em qualquer série temporal especificada que não esteja no conjunto de dados de entrada. O arquivo de exportação de previsão não conterá essas séries temporais ou seus valores previstos.

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

```
{
   "ForecastName": "string",
   "ForecastTypes": [ "string" ],
   "PredictorArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   }
}
```

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

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

 ** [ForecastName](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastName"></a>
Um nome para a previsão.  
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_]*`   
Obrigatório: Sim

 ** [ForecastTypes](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastTypes"></a>
Os quantis nos quais as previsões probabilísticas são geradas. **Atualmente, você pode especificar até cinco quantis por previsão**. Os valores aceitos incluem `0.01 to 0.99` (somente incrementos de 0,01) e `mean`. A previsão média é diferente da mediana (0,50) quando a distribuição não é simétrica (por exemplo, beta e binominal negativa).   
Os quantis padrão são aqueles que você especificou durante a criação do preditor. 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$)`   
Obrigatório: não

 ** [PredictorArn](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor a ser usado para gerar a previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [Tags](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-Tags"></a>
Os metadados opcionais que você aplica à previsão para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TimeSeriesSelector](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-TimeSeriesSelector"></a>
Define o conjunto de séries temporais usadas para criar as previsões em um objeto `TimeSeriesIdentifiers`.  
O objeto `TimeSeriesIdentifiers` deve ter as seguintes informações:  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Tipo: objeto [TimeSeriesSelector](API_TimeSeriesSelector.md)  
Obrigatório: não

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

```
{
   "ForecastArn": "string"
}
```

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

 ** [ForecastArn](#API_CreateForecast_ResponseSyntax) **   <a name="forecast-CreateForecast-response-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateForecast_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateForecast_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/CreateForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast) 

# CreateForecastExportJob
<a name="API_CreateForecastExportJob"></a>

Exporta uma previsão criada pela operação [CreateForecast](API_CreateForecast.md) para seu bucket do Amazon Simple Storage Service (Amazon S3). O nome do arquivo de previsão corresponderá às seguintes convenções:

<ForecastExportJobName>\$1<ExportTimestamp>\$1<PartNumber>

onde o componente < ExportTimestamp > está em Java SimpleDateFormat (YYYY-MM-DDTHH-MM-ssz).

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

Você deve especificar um objeto [DataDestination](API_DataDestination.md) que inclua um perfil do AWS Identity and Access Management (IAM) que o Amazon Forecast possa assumir para acessar o bucket do Amazon S3. Para obter mais informações, consulte [Configurar permissões para o Amazon Forecast](aws-forecast-iam-roles.md).

Para obter mais informações, consulte [Geração de previsões](howitworks-forecast.md).

Para obter uma lista de todos os trabalhos de exportação de previsão, use a operação [ListForecastExportJobs](API_ListForecastExportJobs.md).

**nota**  
O `Status` do trabalho de exportação de previsão deve ser `ACTIVE` para que você possa acessar a exportação no bucket do Amazon S3. Para obter o status, use a operação [DescribeForecastExportJob](API_DescribeForecastExportJob.md).

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

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ForecastArn": "string",
   "ForecastExportJobName": "string",
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Destination"></a>
O local em que você deseja salvar a previsão e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar o local. A previsão deve ser exportada para um bucket do Amazon S3.  
Se a criptografia for usada, `Destination` deverá incluir uma chave AWS Key Management Service (KMS). O perfil do IAM deve permitir que o Amazon Forecast acesse a chave.  
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: Sim

 ** [ForecastArn](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão que você deseja excluir.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastExportJobName"></a>
O nome do trabalho de exportação da previsão.  
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_]*`   
Obrigatório: Sim

 ** [Format](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Format"></a>
O formato dos dados exportados: CSV ou PARQUET. O valor padrão é CSV.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** [Tags](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Tags"></a>
Os metadados opcionais que você aplica ao trabalho de exportação de previsão para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "ForecastExportJobArn": "string"
}
```

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

 ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) **   <a name="forecast-CreateForecastExportJob-response-ForecastExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateForecastExportJob_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateForecastExportJob_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/CreateForecastExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) 

# CreateMonitor
<a name="API_CreateMonitor"></a>

Cria um recurso de monitor de preditor para um preditor automático existente. O monitoramento de preditores permite que você veja como o desempenho do seu preditor muda ao longo do tempo. Para obter mais informações, consulte [Monitoramento de preditores](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). 

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

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

```
{
   "MonitorName": "string",
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [MonitorName](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-MonitorName"></a>
O nome do recurso de monitor.  
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_]*`   
Obrigatório: Sim

 ** [ResourceArn](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor a ser monitorado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [Tags](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-Tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) a serem aplicadas ao recurso de monitor.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "MonitorArn": "string"
}
```

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

 ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) **   <a name="forecast-CreateMonitor-response-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreateMonitor_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateMonitor_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/CreateMonitor) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateMonitor) 

# CreatePredictor
<a name="API_CreatePredictor"></a>

**nota**  
 Esta operação cria um preditor antigo que não inclui todas as funcionalidades do preditor fornecidas pelo Amazon Forecast. Para criar um preditor compatível com todos os aspectos do Forecast, use [CreateAutoPredictor](API_CreateAutoPredictor.md).

Cria um preditor do Amazon Forecast.

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

Na solicitação, forneça um grupo de conjuntos de dados e especifique um algoritmo ou deixe o Amazon Forecast escolher um algoritmo para você usando o AutoML. Se você especificar um algoritmo, também poderá substituir os hiperparâmetros específicos do algoritmo.

O Amazon Forecast usa o algoritmo para treinar um preditor usando a versão mais recente dos conjuntos de dados no grupo de conjuntos de dados especificado. Em seguida, você pode gerar uma previsão usando a operação [CreateForecast](API_CreateForecast.md).

 Para ver as métricas de avaliação, use a operação [GetAccuracyMetrics](API_GetAccuracyMetrics.md). 

Você pode especificar uma configuração de caracterização a ser preenchida e agregar os campos de dados no conjunto de dados `TARGET_TIME_SERIES` para melhorar o treinamento do modelo. Para obter mais informações, consulte [FeaturizationConfig](API_FeaturizationConfig.md).

Para conjuntos de dados RELATED\$1TIME\$1SERIES, `CreatePredictor` verifica se a `DataFrequency` especificada quando o conjunto de dados foi criado corresponde à `ForecastFrequency`. Os conjuntos de dados TARGET\$1TIME\$1SERIES não têm essa restrição. O Amazon Forecast também verifica o formato do delimitador e do carimbo de data/hora. Para obter mais informações, consulte [Importação de conjuntos de dados](howitworks-datasets-groups.md).

Por padrão, os preditores são treinados e avaliados nos quantis 0,1 (P10), 0,5 (P50) e 0,9 (P90). Você pode escolher tipos de previsão personalizados para treinar e avaliar seu preditor definindo os `ForecastTypes`. 

 **AutoML** 

Se você quiser que o Amazon Forecast avalie cada algoritmo e escolha aquele que minimiza a `objective function`, defina `PerformAutoML` como `true`. A `objective function` é definida como a média de perdas ponderadas sobre os tipos de previsão. Por padrão, essas são as perdas de quanti p10, p50 e p90. Para obter mais informações, consulte [EvaluationResult](API_EvaluationResult.md).

Quando o AutoML é habilitado, as seguintes propriedades não são permitidas:
+  `AlgorithmArn` 
+  `HPOConfig` 
+  `PerformHPO` 
+  `TrainingParameters` 

Para obter uma lista de todos os preditores, use a operação [ListPredictors](API_ListPredictors.md).

**nota**  
Para que você possa usar o preditor para criar uma previsão, o `Status` do preditor deve ser `ACTIVE`, o que significa que o treinamento foi concluído. Para obter o status, use a operação [DescribePredictor](API_DescribePredictor.md).

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

```
{
   "AlgorithmArn": "string",
   "AutoMLOverrideStrategy": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrainingParameters": { 
      "string" : "string" 
   }
}
```

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

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

 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AlgorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo a ser usado no treinamento do modelo. Obrigatório se `PerformAutoML` não for definido como `true`.  

**Algoritmos compatíveis:**
+  `arn:aws:forecast:::algorithm/ARIMA` 
+  `arn:aws:forecast:::algorithm/CNN-QR` 
+  `arn:aws:forecast:::algorithm/Deep_AR_Plus` 
+  `arn:aws:forecast:::algorithm/ETS` 
+  `arn:aws:forecast:::algorithm/NPTS` 
+  `arn:aws:forecast:::algorithm/Prophet` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AutoMLOverrideStrategy"></a>
 A estratégia de substituição `LatencyOptimized` do AutoML só está disponível na versão beta privada. Entre em contato com o AWS Support ou com seu gerente de conta para saber mais sobre os privilégios de acesso. 
Usado para substituir a estratégia padrão do AutoML, que é otimizar a precisão do preditor. Para aplicar uma estratégia do AutoML que minimize o tempo de treinamento, use `LatencyOptimized`.  
Esse parâmetro só é válido para preditores treinados por meio do AutoML.  
Tipo: string  
Valores válidos: `LatencyOptimized | AccuracyOptimized`   
Obrigatório: não

 ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)  
Obrigatório: não

 ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EvaluationParameters"></a>
Usado para substituir os parâmetros de avaliação padrão do algoritmo especificado. O Amazon Forecast avalia um preditor dividindo um conjunto de dados em dados de treinamento e dados de teste. Os parâmetros de avaliação definem como realizar a divisão e o número de iterações.  
Tipo: objeto [EvaluationParameters](API_EvaluationParameters.md)  
Obrigatório: não

 ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-FeaturizationConfig"></a>
A configuração de caracterização.  
Tipo: objeto [FeaturizationConfig](API_FeaturizationConfig.md)  
Obrigatório: Sim

 ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastHorizon"></a>
Especifica o número de etapas temporais que o modelo é treinado a prever. O horizonte de predição também é chamado de comprimento da predição.  
Por exemplo, se você configurar um conjunto de dados para coleta diária de dados (usando o parâmetro `DataFrequency` da operação [CreateDataset](API_CreateDataset.md)) e definir o horizonte de previsão como 10, o modelo retornará as previsões de 10 dias.  
O horizonte máximo de previsão é o menor entre 500 etapas temporais ou 1/3 do tamanho de conjunto de dados TARGET\$1TIME\$1SERIES.  
Tipo: inteiro  
Obrigatório: Sim

 ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastTypes"></a>
Especifica os tipos de previsão usados para treinar um preditor. Você pode especificar até cinco tipos de previsão. Os tipos de previsão podem ser quantis de 0,01 a 0,99, em incrementos de 0,01 ou mais. Você também pode especificar a previsão média com `mean`.   
O valor padrão é `["0.10", "0.50", "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$)`   
Obrigatório: não

 ** [HPOConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-HPOConfig"></a>
Fornece valores de substituição de hiperparâmetros para o algoritmo. Se você não fornecer este parâmetro, o Amazon Forecast usará os valores padrão. Os algoritmos individuais especificam quais hiperparâmetros são compatíveis com a otimização de hiperparâmetros (HPO). Para obter mais informações, consulte [Algoritmos do Amazon Forecast](aws-forecast-choosing-recipes.md).  
Se você incluiu o objeto `HPOConfig`, defina `PerformHPO` como true.  
Tipo: objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)  
Obrigatório: não

 ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-InputDataConfig"></a>
Descreve o grupo de conjuntos de dados que contém os dados a serem usados para treinar o preditor.  
Tipo: objeto [InputDataConfig](API_InputDataConfig.md)  
Obrigatório: Sim

 ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor. O valor padrão é `AverageWeightedQuantileLoss`.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
Obrigatório: não

 ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformAutoML"></a>
Se deve executar o AutoML. Quando o Amazon Forecast executa o AutoML, ele avalia os algoritmos fornecidos e escolhe o melhor algoritmo e configuração para seu conjunto de dados de treinamento.  
O valor padrão é `false`. Nesse caso, você deve especificar um algoritmo.  
Defina `PerformAutoML` como `true` para que o Amazon Forecast execute o AutoML. Essa é uma boa opção se você não tiver certeza de qual algoritmo é adequado para seus dados de treinamento. Nesse caso, `PerformHPO` deve ser false.  
Tipo: booliano  
Obrigatório: não

 ** [PerformHPO](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformHPO"></a>
Se a otimização de hiperparâmetros (HPO) deve ser executada. A HPO localiza os valores de hiperparâmetros ideais para seus dados de treinamento. O processo de execução de HPO é conhecido como a execução de um trabalho de ajuste de hiperparâmetros.  
O valor padrão é `false`. Nesse caso, o Amazon Forecast usa valores de hiperparâmetros padrão do algoritmo escolhido.  
Para substituir os valores padrão, defina `PerformHPO` como `true` e, opcionalmente, forneça o objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md). O trabalho de ajuste especifica uma métrica a ser otimizada, quais hiperparâmetros participam do ajuste e o intervalo válido para cada hiperparâmetro ajustável. Nesse caso, você é solicitado a especificar um algoritmo e `PerformAutoML` deve ser false.  
Os seguintes algoritmos são compatíveis com a HPO:  
+ DeepAR\$1
+ CNN-QR
Tipo: booliano  
Obrigatório: não

 ** [PredictorName](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PredictorName"></a>
Um nome para o preditor.  
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_]*`   
Obrigatório: Sim

 ** [Tags](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-Tags"></a>
Os metadados opcionais que você aplica ao preditor para categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-TrainingParameters"></a>
Os hiperparâmetros a serem substituídos para o treinamento do modelo. Os hiperparâmetros que você pode substituir estão listados nos algoritmos individuais. Para ver uma lista dos algoritmos compatíveis, consulte [Algoritmos do Amazon Forecast](aws-forecast-choosing-recipes.md).  
Tipo: mapa de string para string  
Entradas do mapa: número mínimo de 0 itens. Número máximo de 100 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.  
Padrão de valor: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`   
Obrigatório: não

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

```
{
   "PredictorArn": "string"
}
```

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

 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) **   <a name="forecast-CreatePredictor-response-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreatePredictor_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreatePredictor_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/CreatePredictor) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor) 

# CreatePredictorBacktestExportJob
<a name="API_CreatePredictorBacktestExportJob"></a>

Exporta previsões de backtest e métricas de precisão geradas pelas operações [CreateAutoPredictor](API_CreateAutoPredictor.md) ou [CreatePredictor](API_CreatePredictor.md). Duas pastas contendo arquivos CSV ou Parquet são exportadas para o bucket do S3 especificado.

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

 Os nomes de arquivo de exportação corresponderão às seguintes convenções:

 `<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv` 

O componente < ExportTimestamp > está no SimpleDate formato Java (YYYY-MM-DDTHH-MM-ssz).

Você deve especificar um [DataDestination](API_DataDestination.md) objeto que inclua um bucket do Amazon S3 e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast possa assumir para acessar o bucket do Amazon S3. Para obter mais informações, consulte [Configurar permissões para o Amazon Forecast](aws-forecast-iam-roles.md).

**nota**  
O `Status` do trabalho de exportação deve ser `ACTIVE` para que você possa acessar a exportação no bucket do Amazon S3. Para obter o status, use a operação [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md).

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

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "PredictorArn": "string",
   "PredictorBacktestExportJobName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: Sim

 ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Format"></a>
O formato dos dados exportados: CSV ou PARQUET. O valor padrão é CSV.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor que você deseja exportar.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorBacktestExportJobName"></a>
O nome do trabalho de exportação de backtest.  
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_]*`   
Obrigatório: Sim

 ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Tags"></a>
Metadados opcionais que ajudam você a categorizar e organizar seus backtests. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. As chaves e valores das tags diferenciam maiúsculas de minúsculas.  
As restrições a seguir se aplicam às tags:  
+ Em todos os recursos, cada chave de tag deve ser exclusiva e ter apenas um valor.
+ Número máximo de tags por recurso: 50.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caracteres aceitos: todas as letras, números e espaços representáveis em UTF-8 e os símbolos \$1 - = . \$1 : / @. Se seu esquema de tags for usado em outros serviços e recursos, as restrições de caracteres desses serviços também serão aplicáveis. 
+ Os prefixos de teclas não podem incluir nenhuma combinação de letras maiúsculas ou minúsculas de `aws:` ou `AWS:`. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso. Você não pode editar nem excluir chaves de tag com esse prefixo.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

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

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

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

 ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de backtest de preditor que você deseja exportar.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

## Erros
<a name="API_CreatePredictorBacktestExportJob_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreatePredictorBacktestExportJob_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/CreatePredictorBacktestExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 

# CreateWhatIfAnalysis
<a name="API_CreateWhatIfAnalysis"></a>

A análise de hipóteses é uma técnica de modelagem de cenários em que você faz uma alteração hipotética em uma série temporal e compara as previsões geradas por essas alterações com a série temporal inalterada de linha de base. É importante lembrar que o objetivo de uma análise de hipóteses é entender como uma previsão pode mudar devido às diferentes modificações na série temporal de linha de base.

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

Por exemplo, imagine que você é um varejista de roupas que está considerando uma promoção de final de temporada para abrir espaço para novos estilos. Após criar uma previsão básica, você pode usar uma análise de hipóteses para investigar como diferentes táticas de vendas podem afetar suas metas.

Você pode criar um cenário em que tudo receba uma redução de 25% e outro em que tudo receba uma redução fixa em dólar. Você pode criar um cenário em que a venda dure uma semana e outro em que a venda dure um mês. Com uma análise de hipóteses, você pode comparar vários cenários diferentes entre si.

Observe que uma análise de hipóteses serve para mostrar o que o modelo de previsão aprendeu e como ele se comportará nos cenários que você está avaliando. Não use cegamente os resultados da análise de hipóteses para tomar decisões de negócios. Por exemplo, as previsões podem não ser precisas nos novos cenários em que não há referência disponível para determinar se uma previsão é boa.

O objeto [TimeSeriesSelector](API_TimeSeriesSelector.md) define os itens que você deseja na análise de hipóteses.

**nota**  
Para criar uma análise de hipóteses, seus dados devem estar no formato CSV (valores separados por vírgula).

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

```
{
   "ForecastArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   },
   "WhatIfAnalysisName": "string"
}
```

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

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

 ** [ForecastArn](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão de linha de base.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-Tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) a ser aplicada à previsão de hipóteses.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-TimeSeriesSelector"></a>
Define o conjunto de séries temporais usadas na análise de hipóteses com um objeto `TimeSeriesIdentifiers`. As análises de hipóteses são realizadas somente para as séries temporais desse objeto.  
O objeto `TimeSeriesIdentifiers` deve ter as seguintes informações:  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Tipo: objeto [TimeSeriesSelector](API_TimeSeriesSelector.md)  
Obrigatório: não

 ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-WhatIfAnalysisName"></a>
O nome da análise de hipóteses. Cada nome deve ser exclusivo.  
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_]*`   
Obrigatório: sim

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

```
{
   "WhatIfAnalysisArn": "string"
}
```

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

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

## Erros
<a name="API_CreateWhatIfAnalysis_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateWhatIfAnalysis_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/CreateWhatIfAnalysis) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) 

# CreateWhatIfForecast
<a name="API_CreateWhatIfForecast"></a>

Uma previsão de hipóteses é uma previsão criada a partir de uma versão modificada da previsão de linha de base. Cada previsão de hipóteses incorpora um conjunto de dados substituto ou um conjunto de transformações no conjunto de dados original. 

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

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

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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",
   "WhatIfForecastName": "string"
}
```

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

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

 ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-Tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) a ser aplicada à previsão de hipóteses.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesReplacementsDataSource"></a>
O conjunto de dados de séries temporais de substituição, que contém as linhas que você deseja alterar no conjunto de dados de séries temporais relacionadas. Uma série temporal de substituição não precisa conter todas as linhas que estão na série temporal relacionada de linha de base. Inclua somente as linhas (combinações de medidas e dimensões) que você deseja incluir na previsão de hipóteses.  
Este conjunto de dados é mesclado com a série temporal original para criar um conjunto de dados transformado usado na análise de hipóteses.  
Este conjunto de dados deve conter os itens a serem modificados (como item\$1id ou workforce\$1type), todas as dimensões relevantes, a coluna de carimbo de data e hora e pelo menos uma das colunas de série temporal relacionada. Este arquivo não deve conter carimbos de data/hora duplicados para a mesma série temporal. Este arquivo deve estar no formato CSV.  
Os carimbos de data/hora e item\$1ids não incluídos nesse conjunto de dados não estão incluídos na análise de hipóteses.   
Tipo: objeto [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md)  
Obrigatório: não

 ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesTransformations"></a>
As transformações aplicadas à série temporal de linha de base. Cada transformação contém uma ação e um conjunto de condições. Uma ação é aplicada somente quando todas as condições são atendidas. Se nenhuma condição for fornecida, a ação será aplicada a todos os itens.  
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.  
Obrigatório: não

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

 ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfForecastName"></a>
O nome da previsão de hipóteses. Os nomes devem ser exclusivos em cada análise 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_]*`   
Obrigatório: sim

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

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

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

 ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecast-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:.*:.*:.+` 

## Erros
<a name="API_CreateWhatIfForecast_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateWhatIfForecast_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/CreateWhatIfForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecast) 

# CreateWhatIfForecastExport
<a name="API_CreateWhatIfForecastExport"></a>

Exporta uma previsão criada pela operação [CreateWhatIfForecast](API_CreateWhatIfForecast.md) para seu bucket do Amazon Simple Storage Service (Amazon S3). O nome do arquivo de previsão corresponderá às seguintes convenções:

 `≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>` 

O componente < ExportTimestamp > está em Java SimpleDateFormat (YYYY-MM-DDTHH-MM-ssz).

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

Você deve especificar um objeto [DataDestination](API_DataDestination.md) que inclua um perfil do AWS Identity and Access Management (IAM) que o Amazon Forecast possa assumir para acessar o bucket do Amazon S3. Para obter mais informações, consulte [Configurar permissões para o Amazon Forecast](aws-forecast-iam-roles.md).

Para obter mais informações, consulte [Geração de previsões](howitworks-forecast.md).

Para obter uma lista de todos os seus trabalhos de exportação de previsão de hipóteses, use a operação [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md).

**nota**  
O `Status` do trabalho de exportação de previsão deve ser `ACTIVE` para que você possa acessar a exportação no bucket do Amazon S3. Para obter o status, use a operação [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md).

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

```
{
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportName": "string"
}
```

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

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

 ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Destination"></a>
O local em que você deseja salvar a previsão e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar o local. A previsão deve ser exportada para um bucket do Amazon S3.  
Se a criptografia for usada, `Destination` deverá incluir uma chave AWS Key Management Service (KMS). O perfil do IAM deve permitir que o Amazon Forecast acesse a chave.  
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: Sim

 ** [Format](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Format"></a>
O formato dos dados exportados: CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Tags"></a>
Uma lista de [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) a ser aplicada à previsão de hipóteses.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: não

 ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastArns"></a>
A lista de previsões hipotéticas do Amazon Resource Names (ARNs) a serem exportadas.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 50 itens.  
Restrições de tamanho: o tamanho máximo é 300.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastExportName"></a>
O nome da previsão de hipóteses a ser exportada.  
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_]*`   
Obrigatório: sim

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

```
{
   "WhatIfForecastExportArn": "string"
}
```

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

 ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecastExport-response-WhatIfForecastExportArn"></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:.*:.*:.+` 

## Erros
<a name="API_CreateWhatIfForecastExport_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
Código de status HTTP: 400

 ** ResourceAlreadyExistsException **   
Já existe um recurso com esse nome. Tente novamente com outro nome.  
Código de status HTTP: 400

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_CreateWhatIfForecastExport_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/CreateWhatIfForecastExport) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecastExport) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

Exclui um conjunto de dados do Amazon Forecast que foi criado usando a [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação. Você pode excluir somente conjuntos de dados que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)operação.

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

**nota**  
O Forecast não atualiza automaticamente nenhum grupo de conjuntos de dados que contenha o conjunto de dados excluído. Para atualizar o grupo de conjuntos de dados, use a [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)operação, omitindo o ARN do conjunto de dados excluído.

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

```
{
   "DatasetArn": "string"
}
```

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

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

 ** [DatasetArn](#API_DeleteDataset_RequestSyntax) **   <a name="forecast-DeleteDataset-request-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteDataset_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteDataset_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/DeleteDataset) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset) 

# DeleteDatasetGroup
<a name="API_DeleteDatasetGroup"></a>

Exclui um grupo de conjuntos de dados criado usando a [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)operação. Você pode excluir somente grupos de conjuntos de dados que tenham o status `ACTIVE`, `CREATE_FAILED` ou `UPDATE_FAILED`. Para obter o status, use a operação [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html).

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

Esta operação exclui somente o grupo de conjuntos de dados, e não os conjuntos de dados do grupo.

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

```
{
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **   <a name="forecast-DeleteDatasetGroup-request-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteDatasetGroup_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteDatasetGroup_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/DeleteDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup) 

# DeleteDatasetImportJob
<a name="API_DeleteDatasetImportJob"></a>

Exclui um trabalho de importação de conjunto de dados criado usando a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação. Você pode excluir somente trabalhos de importação de conjunto de dados que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html).

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

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

```
{
   "DatasetImportJobArn": "string"
}
```

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

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

 ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) **   <a name="forecast-DeleteDatasetImportJob-request-DatasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação de conjunto de dados a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteDatasetImportJob_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteDatasetImportJob_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/DeleteDatasetImportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) 

# DeleteExplainability
<a name="API_DeleteExplainability"></a>

Exclui um recurso de explicabilidade.

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

Você pode excluir somente preditores que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeExplainability](API_DescribeExplainability.md).

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

```
{
   "ExplainabilityArn": "string"
}
```

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

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

 ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) **   <a name="forecast-DeleteExplainability-request-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) do recurso de explicabilidade a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteExplainability_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteExplainability_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/DeleteExplainability) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) 

# DeleteExplainabilityExport
<a name="API_DeleteExplainabilityExport"></a>

Exclui uma exportação de explicabilidade.

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

```
{
   "ExplainabilityExportArn": "string"
}
```

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

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

 ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) **   <a name="forecast-DeleteExplainabilityExport-request-ExplainabilityExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de explicabilidade a ser excluída.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteExplainabilityExport_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteExplainabilityExport_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/DeleteExplainabilityExport) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainabilityExport) 

# DeleteForecast
<a name="API_DeleteForecast"></a>

Exclui uma previsão criada por meio da operação [CreateForecast](API_CreateForecast.md). Você pode excluir somente previsões que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeForecast](API_DescribeForecast.md).

Não é possível excluir uma previsão enquanto ela está sendo exportada. Depois que uma previsão é excluída, você não poderá mais consultá-la.

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

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

```
{
   "ForecastArn": "string"
}
```

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

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

 ** [ForecastArn](#API_DeleteForecast_RequestSyntax) **   <a name="forecast-DeleteForecast-request-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão a ser excluída.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteForecast_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteForecast_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/DeleteForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast) 

# DeleteForecastExportJob
<a name="API_DeleteForecastExportJob"></a>

Exclui um trabalho de exportação de previsão criado por meio da operação [CreateForecastExportJob](API_CreateForecastExportJob.md). Você pode excluir somente trabalhos de exportação que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeForecastExportJob](API_DescribeForecastExportJob.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/) 

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

```
{
   "ForecastExportJobArn": "string"
}
```

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

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

 ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) **   <a name="forecast-DeleteForecastExportJob-request-ForecastExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de previsão a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteForecastExportJob_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteForecastExportJob_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/DeleteForecastExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) 

# DeleteMonitor
<a name="API_DeleteMonitor"></a>

Exclui um recurso de monitor. Você só pode excluir um recurso de monitor que tenha o status `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED` ou `CREATE_STOPPED`.

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

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

```
{
   "MonitorArn": "string"
}
```

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

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

 ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) **   <a name="forecast-DeleteMonitor-request-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteMonitor_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteMonitor_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/DeleteMonitor) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteMonitor) 

# DeletePredictor
<a name="API_DeletePredictor"></a>

Exclui um preditor criado por meio das operações [DescribePredictor](API_DescribePredictor.md) ou [CreatePredictor](API_CreatePredictor.md). Você pode excluir somente preditores que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribePredictor](API_DescribePredictor.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/) 

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

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DeletePredictor_RequestSyntax) **   <a name="forecast-DeletePredictor-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeletePredictor_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeletePredictor_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/DeletePredictor) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor) 

# DeletePredictorBacktestExportJob
<a name="API_DeletePredictorBacktestExportJob"></a>

Exclui um trabalho de exportação de backtest de preditor.

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

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

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

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

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

 ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DeletePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de backtest de preditor a ser excluído.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeletePredictorBacktestExportJob_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeletePredictorBacktestExportJob_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/DeletePredictorBacktestExportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 

# DeleteResourceTree
<a name="API_DeleteResourceTree"></a>

Exclui uma árvore de recursos inteira. Esta operação excluirá o recursos pai e seu recursos filho.

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

Recursos filho são recursos criados a partir de outro recurso. Por exemplo, quando uma previsão é gerada a partir de um preditor, a previsão é o recurso filho e o preditor é o recurso pai.

Os recursos do Amazon Forecast possuem as seguintes hierarquias de recursos pai-filho:
+  **Conjunto de dados:** trabalhos de importação de conjuntos de dados
+  **Grupo de conjuntos de dados:** preditores, trabalhos de exportação de backtest de preditor, previsões, trabalhos de exportação de previsão
+  **Preditor:** trabalhos de exportação de backtest de preditor, previsões, trabalhos de exportação de previsão
+  **Previsão**: trabalhos de exportação de previsão

**nota**  
 `DeleteResourceTree` excluirá somente os recursos do Amazon Forecast;ele não excluirá conjuntos de dados ou arquivos exportados armazenados no Amazon S3. 

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

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) **   <a name="forecast-DeleteResourceTree-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso pai a ser excluído. Todos os recursos filho do recurso pai também serão excluídos.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteResourceTree_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteResourceTree_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/DeleteResourceTree) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) 

# DeleteWhatIfAnalysis
<a name="API_DeleteWhatIfAnalysis"></a>

Exclui uma análise de hipóteses criada por meio da operação [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md). Você pode excluir somente análises de hipóteses que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md). 

Não é possível excluir uma análise de hipóteses durante a exportação de qualquer uma de suas previsões.

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

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

```
{
   "WhatIfAnalysisArn": "string"
}
```

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

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

 ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) **   <a name="forecast-DeleteWhatIfAnalysis-request-WhatIfAnalysisArn"></a>
O nome do recurso da Amazon (ARN) da análise de hipóteses que você deseja excluir.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteWhatIfAnalysis_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteWhatIfAnalysis_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/DeleteWhatIfAnalysis) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 

# DeleteWhatIfForecast
<a name="API_DeleteWhatIfForecast"></a>

Exclui uma previsão de hipóteses criada por meio da operação [CreateWhatIfForecast](API_CreateWhatIfForecast.md). Você pode excluir somente previsões de hipóteses que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md). 

Não é possível excluir uma previsão de hipóteses enquanto ela está sendo exportada. Depois que uma previsão de hipóteses for excluída, você não poderá mais consultar a análise de hipóteses.

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

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

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

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

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

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteWhatIfForecast_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteWhatIfForecast_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/DeleteWhatIfForecast) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) 

# DeleteWhatIfForecastExport
<a name="API_DeleteWhatIfForecastExport"></a>

Exclui uma exportação de previsão de hipóteses criada por meio da operação [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md). É possível excluir somente exportações de previsões de hipóteses que tenham o status `ACTIVE` ou `CREATE_FAILED`. Para obter o status, use a operação [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md). 

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

```
{
   "WhatIfForecastExportArn": "string"
}
```

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

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

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

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_DeleteWhatIfForecastExport_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_DeleteWhatIfForecastExport_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/DeleteWhatIfForecastExport) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 

# DescribeAutoPredictor
<a name="API_DescribeAutoPredictor"></a>

Descreve um preditor criado usando a CreateAutoPredictor operação.

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

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

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) **   <a name="forecast-DescribeAutoPredictor-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DataConfig": { 
      "AdditionalDatasets": [ 
         { 
            "Configuration": { 
               "string" : [ "string" ]
            },
            "Name": "string"
         }
      ],
      "AttributeConfigs": [ 
         { 
            "AttributeName": "string",
            "Transformations": { 
               "string" : "string" 
            }
         }
      ],
      "DatasetGroupArn": "string"
   },
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityInfo": { 
      "ExplainabilityArn": "string",
      "Status": "string"
   },
   "ForecastDimensions": [ "string" ],
   "ForecastFrequency": "string",
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "MonitorInfo": { 
      "MonitorArn": "string",
      "Status": "string"
   },
   "OptimizationMetric": "string",
   "PredictorArn": "string",
   "PredictorName": "string",
   "ReferencePredictorSummary": { 
      "Arn": "string",
      "State": "string"
   },
   "Status": "string",
   "TimeAlignmentBoundary": { 
      "DayOfMonth": number,
      "DayOfWeek": "string",
      "Hour": number,
      "Month": "string"
   }
}
```

## Elementos de resposta
<a name="API_DescribeAutoPredictor_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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-CreationTime"></a>
O carimbo de data/hora da CreateAutoPredictor solicitação.  
Tipo: Timestamp

 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DataConfig"></a>
A configuração de dados do seu grupo de conjuntos de dados e de quaisquer conjuntos de dados adicionais.  
Tipo: objeto [DataConfig](API_DataConfig.md)

 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DatasetImportJobArns"></a>
Uma matriz dos trabalhos ARNs de importação do conjunto de dados usados para importar dados de treinamento para o preditor.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave. Você pode especificar esse objeto opcional nas solicitações [CreateDataset](API_CreateDataset.md) e [CreatePredictor](API_CreatePredictor.md).  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do preditor.  
Tipo: longo

 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ExplainabilityInfo"></a>
Fornece o status e o ARN da explicabilidade do preditor.  
Tipo: objeto [ExplainabilityInfo](API_ExplainabilityInfo.md)

 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastDimensions"></a>
Uma matriz de nomes de dimensões (campo) que especificam os atributos usados para agrupar as séries temporais.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastFrequency"></a>
A frequência das predições em uma previsão.  
Os intervalos válidos são Y (Ano), M (Mês), W (Semana), D (Dia), H (Hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) e 1min (1 minuto). Por exemplo, “Y” indica todos os anos e “5min” indica a cada 5 minutos.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` 

 ** [ForecastHorizon](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastHorizon"></a>
O número de etapas temporais que o modelo prevê. O horizonte de predição também é chamado de comprimento da predição.  
Tipo: inteiro

 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastTypes"></a>
Os tipos de previsão usados durante o treinamento do preditor. O valor padrã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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-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_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
No caso de um erro, uma mensagem detalhando a causa do erro.  
Tipo: string

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
Um objeto [MonitorInfo](API_MonitorInfo.md) com o nome do recurso da Amazon (ARN) e o status do recurso de monitor.  
Tipo: objeto [MonitorInfo](API_MonitorInfo.md)

 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorName"></a>
O nome do preditor.  
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_]*` 

 ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ReferencePredictorSummary"></a>
O ARN e o estado do preditor de referência. Esse parâmetro só é válido para preditores treinados novamente ou atualizados.  
Tipo: objeto [ReferencePredictorSummary](API_ReferencePredictorSummary.md)

 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Status"></a>
O status do preditor. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-TimeAlignmentBoundary"></a>
O limite de tempo que o Forecast usa ao agregar dados.  
Tipo: objeto [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md)

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

# DescribeDataset
<a name="API_DescribeDataset"></a>

Descreve um conjunto de dados do Amazon Forecast criado usando a [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação.

**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 os parâmetros especificados na solicitação `CreateDataset`, essa operação inclui as seguintes propriedades do conjunto de dados:
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

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

```
{
   "DatasetArn": "string"
}
```

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

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

 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="forecast-DescribeDataset-request-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DataFrequency": "string",
   "DatasetArn": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "LastModificationTime": number,
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribeDataset_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_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-CreationTime"></a>
Quando o conjunto de dados foi criado.  
Tipo: Timestamp

 ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DataFrequency"></a>
A frequência da coleta de dados.  
Os intervalos válidos são Y (Ano), M (Mês), W (Semana), D (Dia), H (Hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) e 1min (1 minuto). Por exemplo, “M” indica todos os meses e “30min” indica a cada 30 minutos.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` 

 ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetName"></a>
O nome do conjunto de dados.  
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_]*` 

 ** [DatasetType](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetType"></a>
O tipo de conjunto de dados.  
Tipo: string  
Valores válidos: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 

 ** [Domain](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Domain"></a>
O domínio associado ao conjunto de dados.  
Tipo: string  
Valores válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-EncryptionConfig"></a>
A chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-LastModificationTime"></a>
Ao criar um conjunto de dados, `LastModificationTime` é o mesmo que `CreationTime`. Enquanto os dados estão sendo importados para o conjunto de dados, `LastModificationTime` é a hora atual da chamada `DescribeDataset`. Após a conclusão de uma [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação, `LastModificationTime` é quando o trabalho de importação foi concluído ou falhou.  
Tipo: Timestamp

 ** [Schema](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Schema"></a>
Uma matriz de objetos `SchemaAttribute` que especificam os campos de conjuntos de dados. Cada `SchemaAttribute` especifica o nome e o tipo de dados de um campo.  
Tipo: objeto [Schema](API_Schema.md)

 ** [Status](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Status"></a>
O status do conjunto de dados. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
Os `UPDATE` estados se aplicam enquanto os dados são importados para o conjunto de dados a partir de uma chamada para a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação e refletem o status do trabalho de importação do conjunto de dados. Por exemplo, quando o status do trabalho de importação é `CREATE_IN_PROGRESS`, o status do conjunto de dados é `UPDATE_IN_PROGRESS`.  
O `Status` do conjunto de dados deve ser `ACTIVE` para que seja possível treinar dados.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeDatasetGroup
<a name="API_DescribeDatasetGroup"></a>

Descreve um grupo de conjuntos de dados criado usando a [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)operação.

**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 os parâmetros fornecidos na solicitação `CreateDatasetGroup`, essa operação inclui as seguintes propriedades:
+  `DatasetArns`: os conjuntos de dados pertencentes ao grupo.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

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

```
{
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **   <a name="forecast-DescribeDatasetGroup-request-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DatasetArns": [ "string" ],
   "DatasetGroupArn": "string",
   "DatasetGroupName": "string",
   "Domain": "string",
   "LastModificationTime": number,
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribeDatasetGroup_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_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-CreationTime"></a>
Quando o grupo de conjuntos de dados foi criado.  
Tipo: Timestamp

 ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetArns"></a>
Uma matriz de nomes de recursos da Amazon (ARNs) dos conjuntos de dados contidos no grupo de conjuntos de dados.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupArn"></a>
O ARN do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupName"></a>
O nome do grupo de conjuntos de dados.  
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_]*` 

 ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Domain"></a>
O domínio associado ao grupo de conjuntos de dados.  
Tipo: string  
Valores válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-LastModificationTime"></a>
Quando o grupo de conjuntos de dados foi criado ou atualizado pela última vez a partir de uma chamada para a [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)operação. Enquanto o grupo de conjuntos de dados está sendo atualizado, `LastModificationTime` é a hora atual da chamada `DescribeDatasetGroup`.  
Tipo: Timestamp

 ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Status"></a>
O status do grupo do conjunto de dados. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
Os `UPDATE` estados se aplicam quando você chama a [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)operação.  
O `Status` do grupo de conjuntos de dados deve ser `ACTIVE` para que seja possível utilizar esse grupo na criação de um preditor.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeDatasetImportJob
<a name="API_DescribeDatasetImportJob"></a>

Descreve um trabalho de importação de conjunto de dados criado usando a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação.

**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 os parâmetros fornecidos na solicitação `CreateDatasetImportJob`, essa operação inclui as seguintes propriedades:
+  `CreationTime` 
+  `LastModificationTime` 
+  `DataSize` 
+  `FieldStatistics` 
+  `Status` 
+  `Message`: se ocorreu um erro, as informações sobre o erro.

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

```
{
   "DatasetImportJobArn": "string"
}
```

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

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

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **   <a name="forecast-DescribeDatasetImportJob-request-DatasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação de conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DatasetArn": "string",
   "DatasetImportJobArn": "string",
   "DatasetImportJobName": "string",
   "DataSize": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EstimatedTimeRemainingInMinutes": number,
   "FieldStatistics": { 
      "string" : { 
         "Avg": number,
         "Count": number,
         "CountDistinct": number,
         "CountDistinctLong": number,
         "CountLong": number,
         "CountNan": number,
         "CountNanLong": number,
         "CountNull": number,
         "CountNullLong": number,
         "Max": "string",
         "Min": "string",
         "Stddev": number
      }
   },
   "Format": "string",
   "GeolocationFormat": "string",
   "ImportMode": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimestampFormat": "string",
   "TimeZone": "string",
   "UseGeolocationForTimeZone": boolean
}
```

## Elementos de resposta
<a name="API_DescribeDatasetImportJob_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_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-CreationTime"></a>
Quando o trabalho de importação de conjunto de dados foi criado.  
Tipo: Timestamp

 ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados para o qual os dados de treinamento foram importados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobArn"></a>
O ARN do trabalho de importação do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobName"></a>
O nome do trabalho de importação do conjunto de dados.  
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_]*` 

 ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSize"></a>
O tamanho do conjunto de dados em gigabytes (GB) após a conclusão do trabalho de importação.  
Tipo: duplo

 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSource"></a>
A localização dos dados de treinamento a serem importados e uma função AWS Identity and Access Management (IAM) que a Amazon Forecast pode assumir para acessar os dados.  
Se a criptografia for usada, `DataSource` inclua uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do conjunto de dados.  
Tipo: longo

 ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-FieldStatistics"></a>
Informações estatísticas sobre cada campo nos dados de entrada.  
Tipo: string para o mapa de objeto [Statistics](API_Statistics.md).  
Restrições de tamanho de chave: o tamanho máximo é 256.  
Padrão da chave: `^[a-zA-Z0-9\_]+$` 

 ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Format"></a>
O formato dos dados importados: CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$` 

 ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-GeolocationFormat"></a>
O formato do atributo de geolocalização. Valores válidos: `"LAT_LONG"` e `"CC_POSTALCODE"`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9_]+$` 

 ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-ImportMode"></a>
O modo de importação do trabalho de importação do conjunto de dados, COMPLETO ou INCREMENTAL.  
Tipo: string  
Valores válidos: `FULL | INCREMENTAL` 

 ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-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_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Status"></a>
O status do trabalho de importação do conjunto de dados. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimestampFormat"></a>
O formato dos carimbos de data/hora no conjunto de dados. O formato que você especifica depende da `DataFrequency` especificada quando o conjunto de dados foi criado. Os formatos a seguir são compatíveis.  
+ “aaaa-MM-dd”

  Para as seguintes frequências de dados: A, M, S e D
+ “yyyy-MM-dd HH: MM: SS”

  Para as seguintes frequências de dados: H, 30 min, 15 min e 1 min; e opcionalmente, para: A, M, S e D
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\-\:\.\,\'\s]+$` 

 ** [TimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimeZone"></a>
O único fuso horário aplicado a cada item no conjunto de dados  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\/\+\-\_]+$` 

 ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-UseGeolocationForTimeZone"></a>
Se `TimeZone` é derivado automaticamente do atributo de geolocalização.  
Tipo: booliano

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

# DescribeExplainability
<a name="API_DescribeExplainability"></a>

Descreve um recurso de explicabilidade criado por meio da operação [CreateExplainability](API_CreateExplainability.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/) 

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

```
{
   "ExplainabilityArn": "string"
}
```

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

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

 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) **   <a name="forecast-DescribeExplainability-request-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade a ser descrita.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityArn": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "LastModificationTime": number,
   "Message": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribeExplainability_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_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-CreationTime"></a>
Quando o recurso de explicabilidade foi criado.  
Tipo: Timestamp

 ** [DataSource](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-DataSource"></a>
A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)

 ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EnableVisualization"></a>
Se a visualização foi ou não habilitada para o recurso de explicabilidade.  
Tipo: booliano

 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EndDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, o último ponto no tempo na explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho [CreateExplainability](API_CreateExplainability.md).  
Tipo: longo

 ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityConfig"></a>
As configurações que definem a granularidade das séries temporais e dos pontos no tempo para a explicabilidade.  
Tipo: objeto [ExplainabilityConfig](API_ExplainabilityConfig.md)

 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityName"></a>
O nome da explicabilidade.  
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_]*` 

 ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-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_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Message"></a>
Se ocorreu um erro, uma mensagem sobre o erro.  
Tipo: string

 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor ou do Forecast usado para criar o recurso de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Schema](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Schema"></a>
Define os campos de um conjunto de dados.  
Tipo: objeto [Schema](API_Schema.md)

 ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-StartDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, o primeiro ponto no tempo na explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [Status](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Status"></a>
O status do recurso de explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeExplainabilityExport
<a name="API_DescribeExplainabilityExport"></a>

Descreve uma exportação de explicabilidade criada por meio da operação [CreateExplainabilityExport](API_CreateExplainabilityExport.md).

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

```
{
   "ExplainabilityExportArn": "string"
}
```

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

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

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) **   <a name="forecast-DescribeExplainabilityExport-request-ExplainabilityExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ExplainabilityArn": "string",
   "ExplainabilityExportArn": "string",
   "ExplainabilityExportName": "string",
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribeExplainabilityExport_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_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-CreationTime"></a>
Quando a exportação de explicabilidade foi criada.  
Tipo: Timestamp

 ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)

 ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da exportação de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportName"></a>
O nome da exportação de explicabilidade.  
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_]*` 

 ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Format"></a>
O formato dos dados exportados, CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-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_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Message"></a>
Informações sobre todos os erros ocorridos durante a exportação.  
Tipo: string

 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Status"></a>
O status da exportação de explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeForecast
<a name="API_DescribeForecast"></a>

Descreve uma previsão criada por meio da operação [CreateForecast](API_CreateForecast.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 `CreateForecast`, essa operação inclui as seguintes propriedades:
+  `DatasetGroupArn`: o grupo de conjuntos de dados que forneceu os dados de treinamento.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`: se ocorreu um erro, as informações sobre o erro.

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

```
{
   "ForecastArn": "string"
}
```

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

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

 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) **   <a name="forecast-DescribeForecast-request-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "DatasetGroupArn": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "ForecastName": "string",
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "PredictorArn": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   }
}
```

## Elementos de resposta
<a name="API_DescribeForecast_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_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-CreationTime"></a>
Quando a tarefa de criação da previsão foi criada.  
Tipo: Timestamp

 ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-DatasetGroupArn"></a>
O ARN do grupo de conjuntos de dados que forneceu os dados utilizados para treinar o preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho de previsão.  
Tipo: longo

 ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastArn"></a>
O ARN da previsão conforme especificado na solicitação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastName](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastName"></a>
O nome da previsão.  
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_]*` 

 ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastTypes"></a>
Os quantis nos quais as previsões probabilísticas foram geradas.  
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_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-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_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-PredictorArn"></a>
O ARN do preditor usado para gerar a previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Status](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Status"></a>
O status da previsão. 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 deve ser `ACTIVE` para que você possa consultar ou exportar a previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-TimeSeriesSelector"></a>
A série temporal a ser incluída na previsão.  
Tipo: objeto [TimeSeriesSelector](API_TimeSeriesSelector.md)

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

# DescribeForecastExportJob
<a name="API_DescribeForecastExportJob"></a>

Descreve um trabalho de exportação de previsão criado por meio da operação [CreateForecastExportJob](API_CreateForecastExportJob.md).

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

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

```
{
   "ForecastExportJobArn": "string"
}
```

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

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

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) **   <a name="forecast-DescribeForecastExportJob-request-ForecastExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "ForecastArn": "string",
   "ForecastExportJobArn": "string",
   "ForecastExportJobName": "string",
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribeForecastExportJob_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_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-CreationTime"></a>
Quando o trabalho de exportação de previsão foi criado.  
Tipo: Timestamp

 ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Destination"></a>
O caminho para o bucket do Amazon Simple Storage Service (Amazon S3) para o qual a previsão é exportada.  
Tipo: objeto [DataDestination](API_DataDestination.md)

 ** [ForecastArn](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão exportada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobArn"></a>
O ARN do trabalho de exportação de previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobName"></a>
O nome do trabalho de exportação de previsão.  
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_]*` 

 ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Format"></a>
O formato dos dados exportados, CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-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_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Status"></a>
O status do trabalho de exportação de previsão. 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` do trabalho de exportação de previsão deve ser `ACTIVE` para que seja possível acessar a previsão no bucket do S3.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeMonitor
<a name="API_DescribeMonitor"></a>

Descreve um recurso de monitor. Além de listar as propriedades fornecidas na solicitação [CreateMonitor](API_CreateMonitor.md), essa operação inclui as seguintes propriedades:
+  `Baseline` 
+  `CreationTime` 
+  `LastEvaluationTime` 
+  `LastEvaluationState` 
+  `LastModificationTime` 
+  `Message` 
+  `Status` 

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

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

```
{
   "MonitorArn": "string"
}
```

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

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

 ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) **   <a name="forecast-DescribeMonitor-request-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "Baseline": { 
      "PredictorBaseline": { 
         "BaselineMetrics": [ 
            { 
               "Name": "string",
               "Value": number
            }
         ]
      }
   },
   "CreationTime": number,
   "EstimatedEvaluationTimeRemainingInMinutes": number,
   "LastEvaluationState": "string",
   "LastEvaluationTime": number,
   "LastModificationTime": number,
   "Message": "string",
   "MonitorArn": "string",
   "MonitorName": "string",
   "ResourceArn": "string",
   "Status": "string"
}
```

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

 ** [Baseline](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Baseline"></a>
Métricas que você pode usar como base para fins de comparação. Use esses valores para interpretar os resultados do monitoramento de um preditor automático.  
Tipo: objeto [Baseline](API_Baseline.md)

 ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-CreationTime"></a>
O carimbo de data e hora de quando o recurso de monitor foi criado.  
Tipo: Timestamp

 ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-EstimatedEvaluationTimeRemainingInMinutes"></a>
O número estimado de minutos restantes antes que o recurso de monitor conclua a avaliação atual.  
Tipo: longo

 ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationState"></a>
O estado da avaliação mais recente do monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationTime"></a>
O carimbo de data e hora da avaliação mais recente concluída pelo monitor.  
Tipo: Timestamp

 ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastModificationTime"></a>
O carimbo de data e hora da modificação mais recente no monitor.  
Tipo: Timestamp

 ** [Message](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Message"></a>
Uma mensagem de erro, se houver, para o monitor.  
Tipo: string

 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor a ser descrito.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorName"></a>
O nome do monitor.  
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_]*` 

 ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor que está sendo monitorado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Status](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Status"></a>
O status do recurso de monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribePredictor
<a name="API_DescribePredictor"></a>

**nota**  
 Essa operação só é válida para preditores legados criados com CreatePredictor. Se você não estiver usando um preditor antigo, use [DescribeAutoPredictor](API_DescribeAutoPredictor.md).

Descreve um preditor criado por meio da operação [CreatePredictor](API_CreatePredictor.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 `CreatePredictor`, essa operação inclui as seguintes propriedades:
+  `DatasetImportJobArns`: os trabalhos de importação do conjunto de dados usados para importar dados de treinamento.
+  `AutoMLAlgorithmArns`: se o AutoML for executado, os algoritmos avaliados.
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message`: se ocorreu um erro, as informações sobre o erro.

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

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) **   <a name="forecast-DescribePredictor-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor a sobre o qual você deseja obter informações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "AlgorithmArn": "string",
   "AutoMLAlgorithmArns": [ "string" ],
   "AutoMLOverrideStrategy": "string",
   "CreationTime": number,
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "IsAutoPredictor": boolean,
   "LastModificationTime": number,
   "Message": "string",
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorArn": "string",
   "PredictorExecutionDetails": { 
      "PredictorExecutions": [ 
         { 
            "AlgorithmArn": "string",
            "TestWindows": [ 
               { 
                  "Message": "string",
                  "Status": "string",
                  "TestWindowEnd": number,
                  "TestWindowStart": number
               }
            ]
         }
      ]
   },
   "PredictorName": "string",
   "Status": "string",
   "TrainingParameters": { 
      "string" : "string" 
   }
}
```

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

 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AlgorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo usado no treinamento do modelo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLAlgorithmArns"></a>
Quando `PerformAutoML` é especificado, o ARN do algoritmo selecionado.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLOverrideStrategy"></a>
 A estratégia de substituição `LatencyOptimized` do AutoML só está disponível na versão beta privada. Entre em contato com o AWS Support ou com seu gerente de conta para saber mais sobre os privilégios de acesso. 
A estratégia do AutoML usada para treinar o preditor. A menos que `LatencyOptimized` seja especificada, a estratégia do AutoML otimiza a precisão do preditor.  
Esse parâmetro só é válido para preditores treinados por meio do AutoML.  
Tipo: string  
Valores válidos: `LatencyOptimized | AccuracyOptimized` 

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
Quando a tarefa de treinamento do modelo foi criada.  
Tipo: Timestamp

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-DatasetImportJobArns"></a>
Uma matriz dos trabalhos ARNs de importação do conjunto de dados usados para importar dados de treinamento para o preditor.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EncryptionConfig"></a>
Uma chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.  
Tipo: objeto [EncryptionConfig](API_EncryptionConfig.md)

 ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do preditor.  
Tipo: longo

 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EvaluationParameters"></a>
Usado para substituir os parâmetros de avaliação padrão do algoritmo especificado. O Amazon Forecast avalia um preditor dividindo um conjunto de dados em dados de treinamento e dados de teste. Os parâmetros de avaliação definem como realizar a divisão e o número de iterações.  
Tipo: objeto [EvaluationParameters](API_EvaluationParameters.md)

 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-FeaturizationConfig"></a>
A configuração de caracterização.  
Tipo: objeto [FeaturizationConfig](API_FeaturizationConfig.md)

 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastHorizon"></a>
O número de etapas temporais da previsão. O horizonte de predição também é chamado de comprimento da predição.  
Tipo: inteiro

 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastTypes"></a>
Os tipos de previsão usados durante o treinamento do preditor. O valor padrã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$)` 

 ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-HPOConfig"></a>
Os valores de substituição de hiperparâmetros do algoritmo.  
Tipo: objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md)

 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-InputDataConfig"></a>
Descreve o grupo de conjuntos de dados que contém os dados a serem usados para treinar o preditor.  
Tipo: objeto [InputDataConfig](API_InputDataConfig.md)

 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-IsAutoPredictor"></a>
Se o preditor foi ou não criado com [CreateAutoPredictor](API_CreateAutoPredictor.md).  
Tipo: booliano

 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-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_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformAutoML"></a>
Se o preditor está configurado para executar o AutoML.  
Tipo: booliano

 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformHPO"></a>
Se o preditor estiver definido para realizar a otimização de hiperparâmetros (HPO).  
Tipo: booliano

 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorArn"></a>
O ARN do preditor.  
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_]*` 

 ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorExecutionDetails"></a>
Detalhes sobre o status e os resultados dos backtests realizados para avaliar a precisão do preditor. Você vai especificar o número de backtests a serem executados ao chamar a operação [CreatePredictor](API_CreatePredictor.md).  
Tipo: objeto [PredictorExecutionDetails](API_PredictorExecutionDetails.md)

 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorName"></a>
O nome do preditor.  
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_]*` 

 ** [Status](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Status"></a>
O status do preditor. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
O `Status` do preditor deve ser `ACTIVE` para que seja possível usar o preditor na criação de uma previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-TrainingParameters"></a>
Os parâmetros ou as substituições de treinamento padrão selecionados durante o treinamento do modelo. Ao executar o AutoML ou escolher o HPO com CNN-QR ou DeepAR\$1, os valores otimizados para os hiperparâmetros selecionados são exibidos. Para obter mais informações, consulte [Algoritmos do Amazon Forecast](aws-forecast-choosing-recipes.md).  
Tipo: mapa de string para string  
Entradas do mapa: número mínimo de 0 itens. Número máximo de 100 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.  
Padrão de valor: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 

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

# DescribePredictorBacktestExportJob
<a name="API_DescribePredictorBacktestExportJob"></a>

Descreve um trabalho de exportação de backtests do preditor criada por meio da operação [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.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 pelo usuário na solicitação `CreatePredictorBacktestExportJob`, essa operação indica as seguintes propriedades:
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message` (se ocorreu um erro).

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

```
{
   "PredictorBacktestExportJobArn": "string"
}
```

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

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

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de backtests do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "PredictorArn": "string",
   "PredictorBacktestExportJobArn": "string",
   "PredictorBacktestExportJobName": "string",
   "Status": "string"
}
```

## Elementos de resposta
<a name="API_DescribePredictorBacktestExportJob_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_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-CreationTime"></a>
Quando o trabalho de exportação de backtests do preditor foi criado.  
Tipo: Timestamp

 ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)

 ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Format"></a>
O formato dos dados exportados, CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-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_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Message"></a>
Informações sobre todos os erros ocorridos durante a exportação de backtests.  
Tipo: string

 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de backtests do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobName"></a>
O nome do trabalho de exportação de backtests do preditor.  
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_]*` 

 ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Status"></a>
O status do trabalho de exportação de backtests do preditor. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

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

# DescribeWhatIfAnalysis
<a name="API_DescribeWhatIfAnalysis"></a>

Descreve uma análise de hipóteses criada por meio da operação [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.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 `CreateWhatIfAnalysis`, 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_DescribeWhatIfAnalysis_RequestSyntax"></a>

```
{
   "WhatIfAnalysisArn": "string"
}
```

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

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

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

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

```
{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   },
   "WhatIfAnalysisArn": "string",
   "WhatIfAnalysisName": "string"
}
```

## Elementos de resposta
<a name="API_DescribeWhatIfAnalysis_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_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-CreationTime"></a>
Quando a análise de hipóteses foi criada.  
Tipo: Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-EstimatedTimeRemainingInMinutes"></a>
O tempo aproximado restante para concluir a análise de hipóteses, em minutos.  
Tipo: longo

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

 ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-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_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Status"></a>
O status da análise 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 análise de hipóteses deve ser `ACTIVE` para que seja possível acessar a análise.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesSelector](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-TimeSeriesSelector"></a>
Define o conjunto de séries temporais usadas para criar as previsões em um objeto `TimeSeriesIdentifiers`.  
O objeto `TimeSeriesIdentifiers` deve ter as seguintes informações:  
+  `DataSource` 
+  `Format` 
+  `Schema` 
Tipo: objeto [TimeSeriesSelector](API_TimeSeriesSelector.md)

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

 ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisName"></a>
O nome da análise 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_DescribeWhatIfAnalysis_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_DescribeWhatIfAnalysis_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/DescribeWhatIfAnalysis) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 

# 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) 

# DescribeWhatIfForecastExport
<a name="API_DescribeWhatIfForecastExport"></a>

Descreve a exportação de previsão de hipóteses por meio da operação [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.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 `CreateWhatIfForecastExport`, 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_DescribeWhatIfForecastExport_RequestSyntax"></a>

```
{
   "WhatIfForecastExportArn": "string"
}
```

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

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

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-request-WhatIfForecastExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de previsão de hipóteses na qual você está interessado.  
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_DescribeWhatIfForecastExport_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EstimatedTimeRemainingInMinutes": number,
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportArn": "string",
   "WhatIfForecastExportName": "string"
}
```

## Elementos de resposta
<a name="API_DescribeWhatIfForecastExport_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_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-CreationTime"></a>
Quando a exportação de previsão de hipóteses foi criada.  
Tipo: Timestamp

 ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)

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

 ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Format"></a>
O formato dos dados exportados, CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$` 

 ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-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_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string

 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-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 exportação de previsão de hipóteses deve ser `ACTIVE` para que seja possível acessar a exportação de previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

 ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastArns"></a>
Uma matriz de nomes de recursos da Amazon (ARNs) que representam todas as previsões hipotéticas exportadas nesse recurso.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 300.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

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

 ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportName"></a>
O nome da exportação de previsão de hipóteses a ser exportada.  
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_DescribeWhatIfForecastExport_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_DescribeWhatIfForecastExport_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/DescribeWhatIfForecastExport) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 

# GetAccuracyMetrics
<a name="API_GetAccuracyMetrics"></a>

Fornece métricas sobre a precisão dos modelos que foram treinados pela operação [CreatePredictor](API_CreatePredictor.md). Use métricas para ver a performance do modelo e decidir se o preditor deve ser usado para gerar uma previsão. Para obter mais informações, consulte [Predictor Metrics](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html).

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

Essa operação gera métricas para cada janela de backtest avaliada. O número de janelas de backtest (`NumberOfBacktestWindows`) é especificado usando o objeto [EvaluationParameters](API_EvaluationParameters.md), que é opcionalmente incluído na solicitação `CreatePredictor`. Se `NumberOfBacktestWindows` não for especificado, o número padrão será um.

Os parâmetros do método `filling` determinam quais itens contribuem com as métricas. Se você quiser que todos os itens contribuam, especifique `zero`. Se você quiser que somente os itens com dados completos no intervalo que estiver sendo avaliado contribuam, especifique `nan`. Para obter mais informações, consulte [FeaturizationMethod](API_FeaturizationMethod.md).

**nota**  
Para que seja possível obter métricas de precisão, o `Status` do preditor deve ser `ACTIVE`, o que significa que o treinamento foi concluído. Para obter o status, use a operação [DescribePredictor](API_DescribePredictor.md).

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

```
{
   "PredictorArn": "string"
}
```

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

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

 ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) **   <a name="forecast-GetAccuracyMetrics-request-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do preditor cujas métricas deseja obter.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "AutoMLOverrideStrategy": "string",
   "IsAutoPredictor": boolean,
   "OptimizationMetric": "string",
   "PredictorEvaluationResults": [ 
      { 
         "AlgorithmArn": "string",
         "TestWindows": [ 
            { 
               "EvaluationType": "string",
               "ItemCount": number,
               "Metrics": { 
                  "AverageWeightedQuantileLoss": number,
                  "ErrorMetrics": [ 
                     { 
                        "ForecastType": "string",
                        "MAPE": number,
                        "MASE": number,
                        "RMSE": number,
                        "WAPE": number
                     }
                  ],
                  "RMSE": number,
                  "WeightedQuantileLosses": [ 
                     { 
                        "LossValue": number,
                        "Quantile": number
                     }
                  ]
               },
               "TestWindowEnd": number,
               "TestWindowStart": number
            }
         ]
      }
   ]
}
```

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

 ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-AutoMLOverrideStrategy"></a>
 A estratégia de substituição `LatencyOptimized` do AutoML só está disponível na versão beta privada. Entre em contato com o AWS Support ou com seu gerente de conta para saber mais sobre os privilégios de acesso. 
A estratégia do AutoML usada para treinar o preditor. A menos que `LatencyOptimized` seja especificada, a estratégia do AutoML otimiza a precisão do preditor.  
Esse parâmetro só é válido para preditores treinados por meio do AutoML.  
Tipo: string  
Valores válidos: `LatencyOptimized | AccuracyOptimized` 

 ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-IsAutoPredictor"></a>
Se o preditor foi ou não criado com [CreateAutoPredictor](API_CreateAutoPredictor.md).  
Tipo: booliano

 ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-OptimizationMetric"></a>
A métrica de precisão usada para otimizar o preditor.  
Tipo: string  
Valores válidos: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-PredictorEvaluationResults"></a>
Uma matriz de resultados da avaliação do preditor.  
Tipo: matriz de objetos [EvaluationResult](API_EvaluationResult.md)

## Erros
<a name="API_GetAccuracyMetrics_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_GetAccuracyMetrics_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/GetAccuracyMetrics) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics) 

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

Retorna uma lista de grupos de conjuntos de dados criados usando a [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)operação. Para cada grupo de conjuntos de dados, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). Você pode recuperar o conjunto completo de propriedades usando o grupo de conjuntos de dados ARN com a operação. [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)

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

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

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "DatasetGroups": [ 
      { 
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "DatasetGroupName": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

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

 ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-DatasetGroups"></a>
Uma matriz de objetos que resumem as propriedades de cada grupo de conjuntos de dados.  
Tipo: matriz de objetos [DatasetGroupSummary](API_DatasetGroupSummary.md)

 ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-NextToken"></a>
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
<a name="API_ListDatasetGroups_Errors"></a>

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

Retorna uma lista de trabalhos de importação de conjuntos de dados criados usando a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação. Para cada trabalho de importação, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). Você pode recuperar o conjunto completo de propriedades usando o ARN com [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)a operação. É possível filtrar a lista fornecendo uma matriz de objetos de [filtro](https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html).

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

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

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

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

 ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-Filters"></a>
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 conjuntos de dados 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 conjuntos de dados correspondentes à declaração, especifique `IS`. Para excluir conjuntos de dados correspondentes, especifique `IS_NOT`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `DatasetArn` e `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os trabalhos de importação de conjuntos de dados cujo status é ATIVO, você vai especificar o seguinte filtro:  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "DatasetImportJobs": [ 
      { 
         "CreationTime": number,
         "DatasetImportJobArn": "string",
         "DatasetImportJobName": "string",
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ImportMode": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-DatasetImportJobs"></a>
Uma matriz de objetos que resumem as propriedades de cada trabalho de importação de conjuntos de dados.  
Tipo: matriz de objetos [DatasetImportJobSummary](API_DatasetImportJobSummary.md)

 ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-NextToken"></a>
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
<a name="API_ListDatasetImportJobs_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListDatasets
<a name="API_ListDatasets"></a>

Retorna uma lista de conjuntos de dados criados usando a [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)operação. Para cada conjunto de dados, é exibido um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). Para recuperar o conjunto completo de propriedades, use o ARN com a operação [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html).

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

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

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "Datasets": [ 
      { 
         "CreationTime": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "DatasetType": "string",
         "Domain": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

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

 ** [Datasets](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-Datasets"></a>
Uma matriz de objetos que resumem as propriedades de cada conjunto de dados.  
Tipo: matriz de objetos [DatasetSummary](API_DatasetSummary.md)

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-NextToken"></a>
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
<a name="API_ListDatasets_Errors"></a>

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListExplainabilities
<a name="API_ListExplainabilities"></a>

Exibe uma lista de recursos de explicabilidade criados por meio da operação [CreateExplainability](API_CreateExplainability.md). Essa operação exibe um resumo de cada explicabilidade. É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.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/) 

Para recuperar o conjunto completo de propriedades de um recurso de explicabilidade específico, use o ARN com a operação [DescribeExplainability](API_DescribeExplainability.md).

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

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

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

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

 ** [Filters](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-Filters"></a>
Uma matriz de filtros. Para cada filtro, forneça uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se os recursos correspondentes à declaração devem ser incluídos ou excluídos da lista. 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`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `ResourceArn` e `Status`.
+  `Value`: o valor a ser comparado.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "Explainabilities": [ 
      { 
         "CreationTime": number,
         "ExplainabilityArn": "string",
         "ExplainabilityConfig": { 
            "TimePointGranularity": "string",
            "TimeSeriesGranularity": "string"
         },
         "ExplainabilityName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-Explainabilities"></a>
Uma matriz de objetos que resumem as propriedades de cada recurso de explicabilidade.  
Tipo: matriz de objetos [ExplainabilitySummary](API_ExplainabilitySummary.md)

 ** [NextToken](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-NextToken"></a>
Exibirá esse token se a resposta estiver truncada. 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
<a name="API_ListExplainabilities_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListExplainabilityExports
<a name="API_ListExplainabilityExports"></a>

Exibe uma lista de exportações de explicabilidade criadas por meio da operação [CreateExplainabilityExport](API_CreateExplainabilityExport.md). Essa operação exibe um resumo de cada exportação de explicabilidade. É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.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/) 

Para recuperar o conjunto completo de propriedades de uma exportação de explicabilidade específica, use o ARN com a operação [DescribeExplainability](API_DescribeExplainability.md).

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

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

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

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

 ** [Filters](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-Filters"></a>
Uma matriz de filtros. Para cada filtro, forneça uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se os recursos correspondentes à declaração devem ser incluídos ou excluídos da lista. 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`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `ResourceArn` e `Status`.
+  `Value`: o valor a ser comparado.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "ExplainabilityExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ExplainabilityExportArn": "string",
         "ExplainabilityExportName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-ExplainabilityExports"></a>
Uma matriz de objetos que resumem as propriedades de cada exportação de explicabilidade.  
Tipo: matriz de objetos [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md)

 ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-NextToken"></a>
Exibirá esse token se a resposta estiver truncada. 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
<a name="API_ListExplainabilityExports_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListForecastExportJobs
<a name="API_ListForecastExportJobs"></a>

Exibe uma lista de trabalhos de exportação de previsão criados por meio da operação [CreateForecastExportJob](API_CreateForecastExportJob.md). Para cada trabalho de exportação de previsão, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). Para recuperar o conjunto completo de propriedades, use o ARN com a operação [DescribeForecastExportJob](API_DescribeForecastExportJob.md). É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.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/) 

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

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

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

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

 ** [Filters](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-Filters"></a>
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 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 `ForecastArn` e `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os trabalhos que exportam uma previsão chamada *electricityforecast*, especifique o seguinte filtro:  
 `"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "ForecastExportJobs": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "ForecastExportJobArn": "string",
         "ForecastExportJobName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-ForecastExportJobs"></a>
Uma matriz de objetos que resumem as propriedades de cada trabalho de exportação.  
Tipo: matriz de objetos [ForecastExportJobSummary](API_ForecastExportJobSummary.md)

 ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-NextToken"></a>
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
<a name="API_ListForecastExportJobs_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListForecasts
<a name="API_ListForecasts"></a>

Exibe uma lista de previsões criadas por meio da operação [CreateForecast](API_CreateForecast.md). Para cada previsão, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). Para recuperar o conjunto completo de propriedades, especifique o ARN com a operação [DescribeForecast](API_DescribeForecast.md). É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.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/) 

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

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

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

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

 ** [Filters](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-Filters"></a>
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 seja ATIVO, especifique:  
 `"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-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.  
Padrão: `.+`   
Obrigatório: Não

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

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

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

 ** [Forecasts](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-Forecasts"></a>
Uma matriz de objetos que resumem as propriedades de cada previsão.  
Tipo: matriz de objetos [ForecastSummary](API_ForecastSummary.md)

 ** [NextToken](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-NextToken"></a>
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
<a name="API_ListForecasts_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListMonitorEvaluations
<a name="API_ListMonitorEvaluations"></a>

Exibe uma lista dos resultados da avaliação do monitoramento e dos eventos de preditores coletados pelo recurso de monitor durante diferentes janelas de tempo.

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

Para obter mais informações sobre monitoramento, consulte [Monitoramento de preditores](predictor-monitoring.md). Para obter mais informações sobre como recuperar os resultados do monitoramento, consulte [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).

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

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

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

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

 ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-Filters"></a>
Uma matriz de filtros. Para cada filtro, forneça uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se os recursos correspondentes à declaração devem ser incluídos ou excluídos da lista. 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`.
+  `Key`: o nome do parâmetro a ser filtrado. O único valor válido é `EvaluationState`.
+  `Value`: o valor a ser comparado. Os valores válidos são `SUCCESS` ou `FAILURE`.
Por exemplo, para listar somente avaliações de monitor bem-sucedidas, especifique:  
 `"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MaxResults"></a>
O número máximo de resultados de monitoramento a serem exibidos.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor do qual obter resultados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "PredictorMonitorEvaluations": [ 
      { 
         "EvaluationState": "string",
         "EvaluationTime": number,
         "Message": "string",
         "MetricResults": [ 
            { 
               "MetricName": "string",
               "MetricValue": number
            }
         ],
         "MonitorArn": "string",
         "MonitorDataSource": { 
            "DatasetImportJobArn": "string",
            "ForecastArn": "string",
            "PredictorArn": "string"
         },
         "NumItemsEvaluated": number,
         "PredictorEvent": { 
            "Datetime": number,
            "Detail": "string"
         },
         "ResourceArn": "string",
         "WindowEndDatetime": number,
         "WindowStartDatetime": number
      }
   ]
}
```

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

 ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-NextToken"></a>
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. 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: `.+` 

 ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-PredictorMonitorEvaluations"></a>
Os resultados de monitoramento e os eventos de preditores coletados pelo recurso de monitor durante diferentes janelas de tempo.  
Para obter informações sobre monitoramento, consulte [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). Para obter mais informações sobre como recuperar os resultados do monitoramento, consulte [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).  
Tipo: matriz de objetos [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md)

## Erros
<a name="API_ListMonitorEvaluations_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
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_ListMonitorEvaluations_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/ListMonitorEvaluations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitorEvaluations) 

# ListMonitors
<a name="API_ListMonitors"></a>

Exibe uma lista de monitores criados com as operações [CreateMonitor](API_CreateMonitor.md) e [CreateAutoPredictor](API_CreateAutoPredictor.md). Para cada recurso de monitor, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). É possível recuperar um conjunto completo de propriedades de um recurso de monitor especificando o ARN do monitor na operação [DescribeMonitor](API_DescribeMonitor.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/) 

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

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

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

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

 ** [Filters](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-Filters"></a>
Uma matriz de filtros. Para cada filtro, forneça uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se os recursos correspondentes à declaração devem ser incluídos ou excluídos da lista. 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`.
+  `Key`: o nome do parâmetro a ser filtrado. O único valor válido é `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os monitores cujo status seja ATIVO, especifique:  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-MaxResults"></a>
O número máximo de monitores a serem incluídos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "Monitors": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "MonitorArn": "string",
         "MonitorName": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [Monitors](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-Monitors"></a>
Uma matriz de objetos que resume as propriedades de cada monitor.  
Tipo: matriz de objetos [MonitorSummary](API_MonitorSummary.md)

 ** [NextToken](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-NextToken"></a>
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
<a name="API_ListMonitors_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListPredictorBacktestExportJobs
<a name="API_ListPredictorBacktestExportJobs"></a>

Exibe uma lista de trabalhos de exportação de backtest do preditor criados usando a operação [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md). Essa operação exibe um resumo de cada trabalho de exportação de backtests. É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.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/) 

Para recuperar o conjunto completo de propriedades de um determinado trabalho de exportação de backtest, use o ARN com a operação [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md).

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

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

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

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

 ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-Filters"></a>
Uma matriz de filtros. Para cada filtro, forneça uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se devem ser incluídos ou excluídos os trabalhos de exportação do backtest do preditor que correspondem à instrução da lista. 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 do backtest do preditor correspondentes à declaração, especifique `IS`. Para excluir os trabalhos de exportação de backtests do preditor correspondentes, especifique `IS_NOT`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `PredictorArn` e `Status`.
+  `Value`: o valor a ser comparado.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "PredictorBacktestExportJobs": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "PredictorBacktestExportJobArn": "string",
         "PredictorBacktestExportJobName": "string",
         "Status": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-NextToken"></a>
Gera esse token se a resposta estiver truncada. 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: `.+` 

 ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-PredictorBacktestExportJobs"></a>
Uma matriz de objetos que resumem as propriedades de cada trabalho de exportação de backtest do preditor.  
Tipo: matriz de objetos [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md)

## Erros
<a name="API_ListPredictorBacktestExportJobs_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListPredictors
<a name="API_ListPredictors"></a>

Exibe uma lista de preditores criados por meio das operações [CreateAutoPredictor](API_CreateAutoPredictor.md) ou [CreatePredictor](API_CreatePredictor.md). Para cada preditor, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN). 

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

É possível recuperar o conjunto completo de propriedades usando o ARN com as operações [DescribeAutoPredictor](API_DescribeAutoPredictor.md) e [DescribePredictor](API_DescribePredictor.md). É possível filtrar a lista usando uma matriz de objetos [Filter](API_Filter.md).

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

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

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

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

 ** [Filters](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-Filters"></a>
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 preditores 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 preditores correspondentes à declaração, especifique `IS`. Para excluir preditores correspondentes, especifique `IS_NOT`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `DatasetGroupArn` e `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os preditores cujo status seja ATIVO, especifique:  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "Predictors": [ 
      { 
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "IsAutoPredictor": boolean,
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "PredictorName": "string",
         "ReferencePredictorSummary": { 
            "Arn": "string",
            "State": "string"
         },
         "Status": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-NextToken"></a>
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: `.+` 

 ** [Predictors](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-Predictors"></a>
Uma matriz de objetos que resumem as propriedades de cada preditor.  
Tipo: matriz de objetos [PredictorSummary](API_PredictorSummary.md)

## Erros
<a name="API_ListPredictors_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lista as tags de um recurso do Amazon Forecast.

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

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

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="forecast-ListTagsForResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) que identifica o recurso para o qual listar as tags.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="forecast-ListTagsForResource-response-Tags"></a>
As tags para o recurso.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.

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

# ListWhatIfAnalyses
<a name="API_ListWhatIfAnalyses"></a>

Exibe uma lista de análises de hipóteses criadas por meio da operação [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md). Para cada análise 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 análise de hipóteses com a operação [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.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/) 

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

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

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

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

 ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-Filters"></a>
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 análise 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 análise de hipóteses correspondentes à declaração, especifique `IS`. Para excluir trabalhos de análise de hipóteses correspondentes, especifique `IS_NOT`.
+  `Key`: o nome do parâmetro a ser filtrado. Os valores válidos são `WhatIfAnalysisArn` e `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os trabalhos que exportam uma previsão chamada *electricityWhatIf*, especifique o seguinte filtro:  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "WhatIfAnalyses": [ 
      { 
         "CreationTime": number,
         "ForecastArn": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfAnalysisName": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-NextToken"></a>
Se a resposta estiver truncada, o 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: `.+` 

 ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-WhatIfAnalyses"></a>
Uma matriz de objetos `WhatIfAnalysisSummary` que descrevem as análises correspondentes.  
Tipo: matriz de objetos [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md)

## Erros
<a name="API_ListWhatIfAnalyses_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListWhatIfForecastExports
<a name="API_ListWhatIfForecastExports"></a>

Exibe uma lista de exportações de previsão de hipóteses criadas por meio da operação [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md). Para cada exportação de 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 exportação de previsão de hipóteses com a operação [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.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/) 

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

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

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

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

 ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-Filters"></a>
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 `WhatIfForecastExportArn` e `Status`.
+  `Value`: o valor a ser comparado.
Por exemplo, para listar todos os trabalhos que exportam uma previsão chamada *eletricidade WIFExport*, especifique o seguinte filtro:  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]`   
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-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.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "WhatIfForecastExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfForecastArns": [ "string" ],
         "WhatIfForecastExportArn": "string",
         "WhatIfForecastExportName": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-NextToken"></a>
Se a resposta estiver truncada, o 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: `.+` 

 ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-WhatIfForecastExports"></a>
Uma matriz de objetos `WhatIfForecastExports` que descrevem as exportações de previsão correspondentes.  
Tipo: matriz de objetos [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md)

## Erros
<a name="API_ListWhatIfForecastExports_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ListWhatIfForecasts
<a name="API_ListWhatIfForecasts"></a>

Exibe uma lista de previsões de hipóteses criadas por meio da operação [CreateWhatIfForecast](API_CreateWhatIfForecast.md). 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](API_DescribeWhatIfForecast.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/) 

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

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

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

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

 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-Filters"></a>
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](API_Filter.md)  
Obrigatório: não

 ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-MaxResults"></a>
O número de itens a serem exibidos na resposta.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 100.  
Obrigatório: não

 ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-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.  
Padrão: `.+`   
Obrigatório: Não

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

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

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

 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-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.  
Padrão: `.+` 

 ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-WhatIfForecasts"></a>
Uma matriz de objetos `WhatIfForecasts` que descrevem as previsões correspondentes.  
Tipo: matriz de objetos [WhatIfForecastSummary](API_WhatIfForecastSummary.md)

## Erros
<a name="API_ListWhatIfForecasts_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

 ** InvalidNextTokenException **   
O token não é válido. Os tokens expiram após 24 horas.  
Código de Status HTTP: 400

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

# ResumeResource
<a name="API_ResumeResource"></a>

Retoma um recurso de monitor parado.

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

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

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_ResumeResource_RequestSyntax) **   <a name="forecast-ResumeResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor a ser retomado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_ResumeResource_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

 ** LimitExceededException **   
O limite do número de recursos por conta 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 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_ResumeResource_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/ResumeResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ResumeResource) 

# StopResource
<a name="API_StopResource"></a>

Interrompe um recurso.

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

O recurso passa pelos seguintes estados: `CREATE_STOPPING` e `CREATE_STOPPED`. Não é possível retomar um recurso depois de interrompê-lo.

Essa operação pode ser aplicada aos seguintes recursos (e aos respectivos recursos secundários):
+ Trabalho de importação de conjuntos de dados
+ Trabalho de preditor
+ Trabalho de previsão
+ Trabalho de exportação de previsão
+ Trabalho de exportação de backtest do preditor
+ Trabalho de explicabilidade
+ Trabalho de exportação de explicabilidade

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

```
{
   "ResourceArn": "string"
}
```

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

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

 ** [ResourceArn](#API_StopResource_RequestSyntax) **   <a name="forecast-StopResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) que identifica exclusivamente o recurso de localização de dados. Os suportados ARNs são `DatasetImportJobArn``PredictorArn`,`PredictorBacktestExportJobArn`,`ForecastArn`, `ForecastExportJobArn``ExplainabilityArn`,, `ExplainabilityExportArn` e.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_StopResource_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
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_StopResource_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/StopResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/StopResource) 

# TagResource
<a name="API_TagResource"></a>

Associa as tags especificadas a um recurso com o `resourceArn` especificado. As tags existentes em um recurso não serão alteradas se não forem especificadas nos parâmetros da solicitação. Quando você exclui um recurso, as tags associadas também são excluídas.

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

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

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) que identifica o recurso para o qual listar as tags.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-Tags"></a>
As tags para adicionar ao recurso. Uma etiqueta é um array de pares de chave/valor.  
As restrições básicas a seguir se aplicam a tags:  
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos da , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Os caracteres geralmente permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - =. \$1:/@.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. As tags que têm apenas o prefixo de chave `aws` não são contabilizadas entre suas tags por limite de recurso.
Tipo: matriz de objetos [Tag](API_Tag.md)  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_TagResource_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

 ** LimitExceededException **   
O limite do número de recursos por conta foi excedido.  
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_TagResource_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/TagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Exclui as tags especificadas de um recurso.

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

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

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

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

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

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-ResourceArn"></a>
O nome do recurso da Amazon (ARN) que identifica o recurso para o qual listar as tags.   
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-TagKeys"></a>
As chaves das tags a serem removidas.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 0 itens. Número máximo de 200 itens.  
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.  
Padrão: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

# UpdateDatasetGroup
<a name="API_UpdateDatasetGroup"></a>

Substitui os conjuntos de dados em um grupo pelos conjuntos de dados especificados.

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

**nota**  
O `Status` do grupo de conjuntos de dados deve ser `ACTIVE` para que seja possível utilizar esse grupo na criação de um preditor. Use a operação [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) para obter o status.

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

```
{
   "DatasetArns": [ "string" ],
   "DatasetGroupArn": "string"
}
```

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

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

 ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetArns"></a>
Uma matriz dos Amazon Resource Names (ARNs) dos conjuntos de dados a serem adicionados ao grupo de conjuntos de dados.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Sim

 ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetGroupArn"></a>
O ARN do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

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

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UpdateDatasetGroup_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

 ** ResourceInUseException **   
O recurso especificado está em uso.  
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_UpdateDatasetGroup_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/UpdateDatasetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup) 

# Amazon Forecast Query Service
<a name="API_Operations_Amazon_Forecast_Query_Service"></a>

As ações a seguir são compatíveis com o Amazon Forecast Query Service:
+  [QueryForecast](API_forecastquery_QueryForecast.md) 
+  [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) 

# QueryForecast
<a name="API_forecastquery_QueryForecast"></a>

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 [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html)operaçã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
<a name="API_forecastquery_QueryForecast_RequestSyntax"></a>

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

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

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

 ** [EndDate](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-EndDate"></a>
A data de término da previsão. 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_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-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 completa, use a [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.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

 ** [ForecastArn](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-ForecastArn"></a>
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:.*:.*:.+`   
Obrigatório: Sim

 ** [NextToken](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-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_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-StartDate"></a>
A data de início da previsão. 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

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

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

## Elementos de resposta
<a name="API_forecastquery_QueryForecast_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_QueryForecast_ResponseSyntax) **   <a name="forecast-forecastquery_QueryForecast-response-Forecast"></a>
A previsão.  
Tipo: objeto [Forecast](API_forecastquery_Forecast.md)

## Erros
<a name="API_forecastquery_QueryForecast_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_QueryForecast_SeeAlso"></a>

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

# 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) 

# Tipos de dados
<a name="API_Types"></a>

Os tipos de dados a seguir são compatíveis com o Amazon Forecast Service:
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

Os tipos de dados a seguir são compatíveis com o Amazon Forecast Query Service:
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

# Amazon Forecast Service
<a name="API_Types_Amazon_Forecast_Service"></a>

Os tipos de dados a seguir são compatíveis com o Amazon Forecast Service:
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

# Action
<a name="API_Action"></a>

Define as modificações que você está fazendo em um atributo de uma previsão de hipóteses. Por exemplo, você pode usar essa operação para criar uma previsão de hipóteses que investigue 10% de desconto na venda em todos os sapatos. Para fazer isso, você especifica `"AttributeName": "shoes"`, `"Operation": "MULTIPLY"` e `"Value": "0.90"`. Combine essa operação com a [TimeSeriesCondition](API_TimeSeriesCondition.md) operação dentro da TimeSeriesTransformations operação [CreateWhatIfForecast:](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) para definir um subconjunto de itens de atributos que são modificados.

## Conteúdo
<a name="API_Action_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Action-AttributeName"></a>
A série temporal relacionada que você está modificando. Esse valor não diferencia maiúsculas de minúsculas.  
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_]*`   
Exigido: Sim

 ** Operation **   <a name="forecast-Type-Action-Operation"></a>
A operação que é aplicada ao atributo fornecido. As operações incluem:  
+  `ADD` adiciona `Value` a todas as linhas de `AttributeName`.
+  `SUBTRACT` subtrai `Value` de todas as linhas de `AttributeName`.
+  `MULTIPLY` multiplica todas as linhas de `AttributeName` por `Value`.
+  `DIVIDE` divide todas as linhas de `AttributeName` por `Value`.
Tipo: string  
Valores Válidos: `ADD | SUBTRACT | MULTIPLY | DIVIDE`   
Obrigatório: sim

 ** Value **   <a name="forecast-Type-Action-Value"></a>
O valor que é aplicado à `Operation` escolhida.  
Tipo: duplo  
Obrigatório: sim

## Consulte também
<a name="API_Action_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Action) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Action) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Action) 

# AdditionalDataset
<a name="API_AdditionalDataset"></a>

Descreve um conjunto de dados adicional. Esse objeto faz parte do objeto [DataConfig](API_DataConfig.md). O Forecast é compatível com os conjuntos de dados adicionais do Weather Index e Holidays.

 **Weather Index** 

O Weather Index do Amazon Forecast é um conjunto de dados integrado que incorpora informações meteorológicas passadas e projetadas em seu modelo. O Weather Index complementa seus conjuntos de dados com mais de dois anos de dados meteorológicos passados e até 14 dias de dados meteorológicos projetados. Para obter mais informações, consulte [Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

 **Holidays** 

Holidays é uma caracterização integrada que incorpora um conjunto de dados projetado por recursos de informações de feriados nacionais em seu modelo. Ele fornece suporte nativo para os calendários de feriados de mais de 250 países. O Amazon Forecast incorpora a [biblioteca de APIs Holiday](https://holidayapi.com/countries) e a [API Jollyday](https://jollyday.sourceforge.net/data.html) para gerar calendários de feriados. Para obter mais informações, consulte [Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

## Conteúdo
<a name="API_AdditionalDataset_Contents"></a>

 ** Name **   <a name="forecast-Type-AdditionalDataset-Name"></a>
O nome do conjunto de dados adicional. Nomes válidos: `"holiday"` e `"weather"`.  
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_]*`   
Exigido: Sim

 ** Configuration **   <a name="forecast-Type-AdditionalDataset-Configuration"></a>
 **Weather Index**   
Para ativar o Weather Index, não especifique um valor para `Configuration`.  
 **Holidays**   
 **Holidays**   
Para habilitar o Holidays, defina `CountryCode` com um dos seguintes códigos de país de duas letras:  
+  Afeganistão — AF 
+  Ilhas Åland — AX 
+  Albânia — AL 
+  Argélia — DZ 
+  Samoa Americana — AS 
+  Andorra — AD 
+  Angola — AO 
+  Anguila — AI 
+  Antártica — AQ 
+  Antígua e Barbuda — AG 
+  Argentina — AR 
+  Armênia — AM 
+  Aruba — AW 
+  Austrália — AU 
+  Áustria — AT 
+  Azerbaijão — AZ 
+  Bahamas — BS 
+  Bahrein — BH 
+  Bangladesh — BD 
+  Barbados — BB 
+  Bielorrússia — BY 
+  Bélgica — BE 
+  Belize — BZ 
+  Benin — BJ 
+  Bermudas — BM 
+  Butão — BT 
+  Bolívia — BO 
+  Bósnia e Herzegovina — BA 
+  Botsuana — BW 
+  Ilha Bouvet — BV 
+  Brasil — BR 
+  Território Britânico do Oceano Índico — IO 
+  Ilhas Virgens Britânicas — VG 
+  Brunei Darussalam — BN 
+  Bulgária — BG 
+  Burkina Faso —BF 
+  Burundi — BI 
+  Camboja — KH 
+  Camarões — CM 
+  Canadá — CA 
+  Cabo Verde — CV 
+  Holanda Caribenha — BQ 
+  Ilhas Cayman — KY 
+  República Centro-Africana — CF 
+  Chade — TD 
+  Chile — CL 
+  China — CN 
+  Christmas Island — CX 
+  Ilhas Cocos (Ilhas Keeling) — CC 
+  Colômbia — CO 
+  Comores — KM 
+  Ilhas Cook — CK 
+  Costa Rica — CR 
+  Croácia — HR 
+  Cuba — CU 
+  Curaçao — CW 
+  Chipre — CY 
+  Tchéquia — CZ 
+  República Democrática do Congo — CD 
+  Dinamarca — DK 
+  Djibuti — DJ 
+  Dominica — DM 
+  República Dominicana — DO 
+  Equador — EC 
+  Egito — EG 
+  El Salvador — SV 
+  Guiné Equatorial — GQ 
+  Eritreia — ER 
+  Estônia — EE 
+  Essuatíni — SZ 
+  Etiópia — ET 
+  Ilhas Falkland — FK 
+  Ilhas Faroe — FO 
+  Fiji — FJ 
+  Finlândia — FI 
+  França — FR 
+  Guiana Francesa — GF 
+  Polinésia Francesa — PF 
+  Territórios Franceses do Sul — TF 
+  Gabão — GA 
+  Gâmbia — GM 
+  Geórgia — GE 
+  Alemanha — DE 
+  Gana — GH 
+  Gibraltar — GI 
+  Grécia — GR 
+  Groenlândia — GL 
+  Granada — GD 
+  Guadalupe — GP 
+  Guam — GU 
+  Guatemala — GT 
+  Guernsey — GG 
+  Guiné — GN 
+  Guiné-Bissau — GW 
+  Guiana — GY 
+  Haiti — HT 
+  Ilha e McDonald Ilhas Heard - HM 
+  Honduras — HN 
+  Hong Kong — HK 
+  Hungria — HU 
+  Islândia — IS 
+  Índia — IN 
+  Indonésia — ID 
+  Irã — IR 
+  Iraque — IQ 
+  Irlanda — IE 
+  Ilha de Man — IM 
+  Israel — IL 
+  Itália — IT 
+  Costa do Marfim — CI 
+  Jamaica — JM 
+  Japão — JP 
+  Jersey — JE 
+  Jordânia — JO 
+  Cazaquistão — KZ 
+  Quênia — KE 
+  Kiribati — KI 
+  Kosovo — XK 
+  Kuwait — KW 
+  Quirguistão — KG 
+  Laos — LA 
+  Letônia — LV 
+  Líbano — LB 
+  Lesoto — LS 
+  Libéria — LR 
+  Líbia — LY 
+  Liechtenstein — LI 
+  Lituânia — LT 
+  Luxemburgo — LU 
+  Macau — MO 
+  Madagáscar — MG 
+  Malawi — MW 
+  Malásia — MY 
+  Maldivas — MV 
+  Mali — ML 
+  Malta — MT 
+  Ilhas Marshall — MH 
+  Martinica — MQ 
+  Mauritânia — MR 
+  Maurício — MU 
+  Mayotte — YT 
+  México — MX 
+  Micronésia — FM 
+  Moldávia — MD 
+  Mônaco — MC 
+  Mongólia — MN 
+  Montenegro — ME 
+  Montserrat — MS 
+  Marrocos — MA 
+  Moçambique — MZ 
+  Mianmar — MM 
+  Namíbia — NA 
+  Nauru — NR 
+  Nepal — NP 
+  Países Baixos — NL 
+  Nova Caledônia — NC 
+  Nova Zelândia — NZ 
+  Nicarágua — NI 
+  Níger — NE 
+  Nigéria — NG 
+  Niue — NU 
+  Ilha Norfolk — NF 
+  Coreia do Norte — KP 
+  Macedônia do Norte — MK 
+  Ilhas Marianas do Norte — MP 
+  Noruega — NO 
+  Omã — OM 
+  Paquistão — PK 
+  Palau — PW 
+  Palestina — PS 
+  Panamá — PA 
+  Papua Nova Guiné — PG 
+  Paraguai — PY 
+  Peru — PE 
+  Filipinas — PH 
+  Ilhas Pitcairn — PN 
+  Polônia — PL 
+  Portugal — PT 
+  Porto Rico — PR 
+  Catar — QA 
+  República do Congo — CG 
+  Reunião — RE 
+  Romênia — RO 
+  Federação Russa — RU 
+  Ruanda — RW 
+  São Bartolomeu — BL 
+  “Santa Helena, Ascensão e Tristão da Cunha” — SH 
+  São Cristóvão e Nevis — KN 
+  Santa Lúcia — LC 
+  São Martinho — MF 
+  Saint Pierre e Miquelon — PM 
+  São Vicente e Granadinas — VC 
+  Samoa — WS 
+  São Marinho — SM 
+  São Tomé e Príncipe — ST 
+  Arábia Saudita — SA 
+  Senegal — SN 
+  Sérvia — RS 
+  Seychelles — SC 
+  Serra Leoa — SL 
+  Singapura — SG 
+  São Martinho — SX 
+  Eslováquia — SK 
+  Eslovênia — SI 
+  Ilhas Salomão — SB 
+  Somália — SO 
+  África do Sul — ZA 
+  Ilhas Geórgia do Sul e Sandwich do Sul — GS 
+  Coreia do Sul — KR 
+  Sudão do Sul — SS 
+  Espanha — ES 
+  Sri Lanka — LK 
+  Sudão — SD 
+  Suriname — SR 
+  Svalbard e Jan Mayen — SJ 
+  Suécia — SE 
+  Suíça — CH 
+  República Árabe da Síria — SY 
+  Taiwan — TW 
+  Tajiquistão — TJ 
+  Tanzânia — TZ 
+  Tailândia — TH 
+  Timor-Leste — TL 
+  Togo — TV 
+  Tokelau — TK 
+  Tonga — TO 
+  Trinidad e Tobago — TT 
+  Tunísia — TN 
+  Turquia — TR 
+  Turcomenistão — TM 
+  Ilhas Turcas e Caicos — TC 
+  Tuvalu — TV 
+  Uganda — UG 
+  Ucrânia — UA 
+  Emirados Árabes Unidos — AE 
+  Reino Unido — GB 
+  Nações Unidas — UN 
+  Estados Unidos — US 
+  Ilhas Menores Distantes dos Estados Unidos — UM 
+  Ilhas Virgens dos Estados Unidos — VI 
+  Uruguai — UY 
+  Uzbequistão — UZ 
+  Vanuatu — VU 
+  Cidade do Vaticano — VA 
+  Venezuela — VE 
+  Vietnã — VN 
+  Wallis e Futuna — WF 
+  Saara Ocidental — EH 
+  Iêmen — YE 
+  Zâmbia — ZM 
+  Zimbábue — ZW 
Tipo: string para a matriz do mapa de strings  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O tamanho máximo é 63.  
Padrão da chave: `^[a-zA-Z][a-zA-Z0-9_]*`   
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_\-]+$`   
Obrigatório: Não

## Consulte também
<a name="API_AdditionalDataset_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AdditionalDataset) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AdditionalDataset) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AdditionalDataset) 

# AttributeConfig
<a name="API_AttributeConfig"></a>

Fornece informações sobre o método usado para transformar atributos.

Veja um exemplo de como usar o domínio RETAIL:

 `{` 

 `"AttributeName": "demand",` 

 `"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## Conteúdo
<a name="API_AttributeConfig_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-AttributeConfig-AttributeName"></a>
O nome do atributo conforme especificado no esquema. O Amazon Forecast é compatível com o campo de destino da série temporal alvo e os conjuntos de dados relacionados da série temporal. Por exemplo, para o domínio RETAIL, o destino é `demand`.  
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_]*`   
Exigido: Sim

 ** Transformations **   <a name="forecast-Type-AttributeConfig-Transformations"></a>
Os parâmetros do método (pares de valores-chave), que são um mapa dos parâmetros de substituição. Especifique esses parâmetros para substituir os valores padrão. Os atributos de séries temporais relacionados não aceitam parâmetros de agregação.  
A lista a seguir mostra os parâmetros e seus valores válidos para o método de caracterização de “preenchimento” de um conjunto de dados **Target Time Series**. Os valores padrão estão em negrito.  
+  `aggregation`: **soma**, `avg`, `first`, `min`, `max` 
+  `frontfill`: **nenhum** 
+  `middlefill`: **zero**, `nan` (não é um número), `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`, `max` 
A lista abaixo mostra os parâmetros e seus valores válidos para um método de caracterização de **Related Time Series** (não há padrões):  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
Para definir um método de preenchimento para um valor específico, defina o parâmetro de preenchimento como `value` e defina o valor em um parâmetro `_value` correspondente. Por exemplo, para definir o preenchimento com um valor de 2, inclua `"backfill": "value"` e `"backfill_value":"2"`.   
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 20 itens.  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O tamanho máximo é 63.  
Padrão da chave: `^[a-zA-Z][a-zA-Z0-9_]*`   
Restrições de tamanho de valor: o tamanho máximo é 256.  
Padrão de valor: `^[a-zA-Z0-9\_\-]+$`   
Obrigatório: sim

## Consulte também
<a name="API_AttributeConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AttributeConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AttributeConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AttributeConfig) 

# Baseline
<a name="API_Baseline"></a>

Métricas que você pode usar como base para fins de comparação. Use essas métricas ao interpretar os resultados do monitoramento de um preditor automático.

## Conteúdo
<a name="API_Baseline_Contents"></a>

 ** PredictorBaseline **   <a name="forecast-Type-Baseline-PredictorBaseline"></a>
As [métricas iniciais de precisão](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) do preditor que você está monitorando. Use essas métricas como base para fins de comparação à medida que você usa seu preditor e as métricas mudam.  
Tipo: objeto [PredictorBaseline](API_PredictorBaseline.md)  
Obrigatório: Não

## Consulte também
<a name="API_Baseline_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Baseline) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Baseline) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Baseline) 

# BaselineMetric
<a name="API_BaselineMetric"></a>

Uma métrica individual que você pode usar para comparação ao avaliar seus resultados de monitoramento.

## Conteúdo
<a name="API_BaselineMetric_Contents"></a>

 ** Name **   <a name="forecast-Type-BaselineMetric-Name"></a>
O nome da métrica.  
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_]*`   
Obrigatório: não

 ** Value **   <a name="forecast-Type-BaselineMetric-Value"></a>
O valor para a métrica.  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_BaselineMetric_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/BaselineMetric) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/BaselineMetric) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/BaselineMetric) 

# CategoricalParameterRange
<a name="API_CategoricalParameterRange"></a>

Especifica um hiperparâmetro categórico e sua faixa de valores ajustáveis. Esse objeto faz parte do objeto [ParameterRanges](API_ParameterRanges.md).

## Conteúdo
<a name="API_CategoricalParameterRange_Contents"></a>

 ** Name **   <a name="forecast-Type-CategoricalParameterRange-Name"></a>
O nome do hiperparâmetro categórico a ser ajustado.  
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_]*`   
Exigido: Sim

 ** Values **   <a name="forecast-Type-CategoricalParameterRange-Values"></a>
Uma lista das categorias do hiperparâmetro.  
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áximo é 256.  
Padrão: `^[a-zA-Z0-9\_\-]+$`   
Exigido: Sim

## Consulte também
<a name="API_CategoricalParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CategoricalParameterRange) 

# ContinuousParameterRange
<a name="API_ContinuousParameterRange"></a>

Especifica um hiperparâmetro contínuo e sua faixa de valores ajustáveis. Esse objeto faz parte do objeto [ParameterRanges](API_ParameterRanges.md).

## Conteúdo
<a name="API_ContinuousParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-ContinuousParameterRange-MaxValue"></a>
O valor máximo ajustável do hiperparâmetro.  
Tipo: duplo  
Obrigatório: sim

 ** MinValue **   <a name="forecast-Type-ContinuousParameterRange-MinValue"></a>
O valor mínimo ajustável do hiperparâmetro.  
Tipo: duplo  
Obrigatório: sim

 ** Name **   <a name="forecast-Type-ContinuousParameterRange-Name"></a>
O nome do hiperparâmetro a ser ajustado.  
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_]*`   
Exigido: Sim

 ** ScalingType **   <a name="forecast-Type-ContinuousParameterRange-ScalingType"></a>
A escala que o ajuste de hiperparâmetros usa para pesquisar a faixa de hiperparâmetros. Valores válidos:    
Auto  
O ajuste de hiperparâmetros do Amazon Forecast escolhe a melhor escala para o hiperparâmetro.  
Linear  
O ajuste de hiperparâmetros pesquisa os valores no intervalo de hiperparâmetros usando uma escala linear.  
Logarítmica  
O ajuste de hiperparâmetros pesquisa os valores no intervalo de hiperparâmetros usando uma escala logarítmica.  
A escalabilidade logarítmica funciona apenas para intervalos que têm valores maiores que 0.  
ReverseLogarithmic  
O ajuste de hiperparâmetros pesquisa os valores no intervalo de hiperparâmetros usando uma escala logarítmica.  
A escalabilidade logarítmica inversa funciona apenas para intervalos que estão inteiramente dentro do intervalo 0 <= x < 1,0.
Para obter informações sobre como escolher uma escala de hiperparâmetros, consulte [Hyperparameter Scaling](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). Um dos seguintes valores:  
Tipo: string  
Valores Válidos: `Auto | Linear | Logarithmic | ReverseLogarithmic`   
Obrigatório: Não

## Consulte também
<a name="API_ContinuousParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ContinuousParameterRange) 

# DataConfig
<a name="API_DataConfig"></a>

A configuração de dados do seu grupo de conjuntos de dados e de quaisquer conjuntos de dados adicionais.

## Conteúdo
<a name="API_DataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-DataConfig-DatasetGroupArn"></a>
O ARN do grupo de conjuntos de dados usado para treinar o preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Exigido: Sim

 ** AdditionalDatasets **   <a name="forecast-Type-DataConfig-AdditionalDatasets"></a>
Conjuntos de dados adicionais integrados, como Holidays e o Weather Index.  
Tipo: Matriz de objetos [AdditionalDataset](API_AdditionalDataset.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 2 itens.  
Obrigatório: não

 ** AttributeConfigs **   <a name="forecast-Type-DataConfig-AttributeConfigs"></a>
Opções de agregação e preenchimento para atributos em seu grupo de conjuntos de dados.  
Tipo: Matriz de objetos [AttributeConfig](API_AttributeConfig.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 50 itens.  
Obrigatório: Não

## Consulte também
<a name="API_DataConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataConfig) 

# DataDestination
<a name="API_DataDestination"></a>

O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional). 

## Conteúdo
<a name="API_DataDestination_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataDestination-S3Config"></a>
O caminho para um bucket do Amazon Simple Storage Service (Amazon S3), juntamente com as credenciais para acessar o bucket.  
Tipo: objeto [S3Config](API_S3Config.md)  
Obrigatório: sim

## Consulte também
<a name="API_DataDestination_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataDestination) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataDestination) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataDestination) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

Fornece um resumo das propriedades do grupo de conjuntos de dados usadas na [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)operação. Para obter o conjunto completo de propriedades, chame a [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)operação e forneça `DatasetGroupArn` o.

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

## Conteúdo
<a name="API_DatasetGroupSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetGroupSummary-CreationTime"></a>
Quando o grupo de conjuntos de dados foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** DatasetGroupArn **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** DatasetGroupName **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupName"></a>
O nome do grupo de conjuntos de dados.  
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_]*`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-DatasetGroupSummary-LastModificationTime"></a>
Quando o grupo de conjuntos de dados foi criado ou atualizado pela última vez a partir de uma chamada para a [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)operação. Enquanto o grupo de conjuntos de dados está sendo atualizado, `LastModificationTime` é a hora atual da chamada `ListDatasetGroups`.  
Tipo: carimbo de data/hora  
Obrigatório: Não

## Consulte também
<a name="API_DatasetGroupSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetGroupSummary) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

Fornece um resumo das propriedades da tarefa de importação do conjunto de dados usadas na [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)operação. Para obter o conjunto completo de propriedades, chame a [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)operação e forneça `DatasetImportJobArn` o.

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

## Conteúdo
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetImportJobSummary-CreationTime"></a>
Quando o trabalho de importação do conjunto de dados foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** DatasetImportJobArn **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação de conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** DatasetImportJobName **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobName"></a>
O nome do trabalho de importação do conjunto de dados.  
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_]*`   
Obrigatório: não

 ** DataSource **   <a name="forecast-Type-DatasetImportJobSummary-DataSource"></a>
A localização dos dados de treinamento a serem importados e uma função AWS Identity and Access Management (IAM) que a Amazon Forecast pode assumir para acessar os dados. Os dados de treinamento devem ser armazenados em um bucket do Amazon S3.  
Se a criptografia for usada, `DataSource` inclua uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: não

 ** ImportMode **   <a name="forecast-Type-DatasetImportJobSummary-ImportMode"></a>
O modo de importação do trabalho de importação do conjunto de dados, COMPLETO ou INCREMENTAL.  
Tipo: string  
Valores Válidos: `FULL | INCREMENTAL`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-DatasetImportJobSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-DatasetImportJobSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-DatasetImportJobSummary-Status"></a>
O status do trabalho de importação do conjunto de dados. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetImportJobSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

Fornece um resumo das propriedades do conjunto de dados usadas na [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)operação. Para obter o conjunto completo de propriedades, chame a [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)operação e forneça `DatasetArn` o.

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

## Conteúdo
<a name="API_DatasetSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetSummary-CreationTime"></a>
Quando o conjunto de dados foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** DatasetArn **   <a name="forecast-Type-DatasetSummary-DatasetArn"></a>
O nome do recurso da Amazon (ARN) do conjunto de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** DatasetName **   <a name="forecast-Type-DatasetSummary-DatasetName"></a>
O nome do conjunto de dados.  
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_]*`   
Obrigatório: não

 ** DatasetType **   <a name="forecast-Type-DatasetSummary-DatasetType"></a>
O tipo de conjunto de dados.  
Tipo: string  
Valores Válidos: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
Obrigatório: não

 ** Domain **   <a name="forecast-Type-DatasetSummary-Domain"></a>
O domínio associado ao conjunto de dados.  
Tipo: string  
Valores Válidos: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-DatasetSummary-LastModificationTime"></a>
Ao criar um conjunto de dados, `LastModificationTime` é o mesmo que `CreationTime`. Enquanto os dados estão sendo importados para o conjunto de dados, `LastModificationTime` é a hora atual da chamada `ListDatasets`. Após a conclusão de uma [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação, `LastModificationTime` é quando o trabalho de importação foi concluído ou falhou.  
Tipo: carimbo de data/hora  
Obrigatório: Não

## Consulte também
<a name="API_DatasetSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetSummary) 

# DataSource
<a name="API_DataSource"></a>

A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite ao Amazon Forecast acessar os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).

## Conteúdo
<a name="API_DataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataSource-S3Config"></a>
O caminho para os dados armazenados em um bucket do Amazon Simple Storage Service (Amazon S3), juntamente com as credenciais para acessar os dados.  
Tipo: objeto [S3Config](API_S3Config.md)  
Obrigatório: sim

## Consulte também
<a name="API_DataSource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataSource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataSource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataSource) 

# EncryptionConfig
<a name="API_EncryptionConfig"></a>

Uma chave AWS Key Management Service (KMS) e uma função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave. Você pode especificar esse objeto opcional nas solicitações [CreateDataset](API_CreateDataset.md) e [CreatePredictor](API_CreatePredictor.md).

## Conteúdo
<a name="API_EncryptionConfig_Contents"></a>

 ** KMSKeyArn **   <a name="forecast-Type-EncryptionConfig-KMSKeyArn"></a>
O nome do recurso da Amazon (ARN) da chave do KMS.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:aws:kms:.*:key/.*`   
Exigido: Sim

 ** RoleArn **   <a name="forecast-Type-EncryptionConfig-RoleArn"></a>
O ARN da função do IAM que o Amazon Forecast pode assumir para acessar a AWS KMS chave.  
Não é permitido transmitir uma função entre AWS contas. Se você passar um perfil que não esteja na sua conta, você receberá um erro `InvalidInputException`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Exigido: Sim

## Consulte também
<a name="API_EncryptionConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EncryptionConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EncryptionConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EncryptionConfig) 

# ErrorMetric
<a name="API_ErrorMetric"></a>

 Fornece métricas de erro detalhadas para avaliar o desempenho de um preditor. Esse objeto faz parte do objeto [Metrics](API_Metrics.md). 

## Conteúdo
<a name="API_ErrorMetric_Contents"></a>

 ** ForecastType **   <a name="forecast-Type-ErrorMetric-ForecastType"></a>
 O tipo de previsão usado para calcular WAPE, MAPE, MAPE e RMSE.   
Tipo: string  
Restrições de tamanho: tamanho mínimo 2. O tamanho máximo é 4.  
Padrão: `(^0?\.\d\d?$|^mean$)`   
Obrigatório: não

 ** MAPE **   <a name="forecast-Type-ErrorMetric-MAPE"></a>
Mean Absolute Percentage Error (MAPE).  
Tipo: duplo  
Obrigatório: não

 ** MASE **   <a name="forecast-Type-ErrorMetric-MASE"></a>
Mean Absolute Scaled Error (MASE).  
Tipo: duplo  
Obrigatório: não

 ** RMSE **   <a name="forecast-Type-ErrorMetric-RMSE"></a>
 O root-mean-square erro (RMSE).   
Tipo: duplo  
Obrigatório: não

 ** WAPE **   <a name="forecast-Type-ErrorMetric-WAPE"></a>
 Weighted Absolute Percentage Error (WAPE).   
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_ErrorMetric_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ErrorMetric) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ErrorMetric) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ErrorMetric) 

# EvaluationParameters
<a name="API_EvaluationParameters"></a>

Parâmetros que definem como dividir um conjunto de dados em dados de treinamento e dados de teste e o número de iterações a serem realizadas. Esses parâmetros são especificados nos algoritmos predefinidos, mas você pode substituí-los na solicitação [CreatePredictor](API_CreatePredictor.md).

## Conteúdo
<a name="API_EvaluationParameters_Contents"></a>

 ** BackTestWindowOffset **   <a name="forecast-Type-EvaluationParameters-BackTestWindowOffset"></a>
O ponto a partir do final do conjunto de dados em que você deseja dividir os dados para treinamento e teste do modelo (avaliação). Especifique o valor como o número de pontos de dados. O padrão é o valor do horizonte de previsão. `BackTestWindowOffset` pode ser usado para imitar a data de início de uma previsão virtual anterior. O valor deve ser maior ou igual ao horizonte de previsão e menor que a metade do tamanho do conjunto de dados TARGET\$1TIME\$1SERIES.  
 `ForecastHorizon` <= `BackTestWindowOffset` < 1/2 \$1 Tamanho do conjunto de dados TARGET\$1TIME\$1SERIES  
Tipo: número inteiro  
Obrigatório: não

 ** NumberOfBacktestWindows **   <a name="forecast-Type-EvaluationParameters-NumberOfBacktestWindows"></a>
O número de vezes que os dados de entrada devem ser divididos. O padrão é um. Os valores válidos são de 1 a 5.  
Tipo: número inteiro  
Obrigatório: Não

## Consulte também
<a name="API_EvaluationParameters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationParameters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationParameters) 

# EvaluationResult
<a name="API_EvaluationResult"></a>

Os resultados da avaliação de um algoritmo. Exibidos como parte da resposta [GetAccuracyMetrics](API_GetAccuracyMetrics.md).

## Conteúdo
<a name="API_EvaluationResult_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-EvaluationResult-AlgorithmArn"></a>
O nome do recurso da Amazon (ARN) do algoritmo que foi avaliado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** TestWindows **   <a name="forecast-Type-EvaluationResult-TestWindows"></a>
A matriz de janelas de teste usadas para avaliar o algoritmo. O `NumberOfBacktestWindows` do objeto [EvaluationParameters](API_EvaluationParameters.md) determina o número de janelas na matriz.  
Tipo: matriz de objetos [WindowSummary](API_WindowSummary.md)  
Obrigatório: Não

## Consulte também
<a name="API_EvaluationResult_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationResult) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationResult) 

# ExplainabilityConfig
<a name="API_ExplainabilityConfig"></a>

O tipo de ExplainabilityConfig dados define o número de séries temporais e pontos temporais incluídos em[CreateExplainability](API_CreateExplainability.md).

Se você fornecer um ARN preditor para `ResourceArn`, deverá definir `TimePointGranularity` e `TimeSeriesGranularity` como “ALL”. Ao criar a Explicabilidade de preditor, o Amazon Forecast considera todas as séries temporais e pontos temporais.

Se você fornecer um ARN de previsão para `ResourceArn`, poderá definir `TimePointGranularity` e `TimeSeriesGranularity` como “ALL” ou “Specific”.

## Conteúdo
<a name="API_ExplainabilityConfig_Contents"></a>

 ** TimePointGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimePointGranularity"></a>
Para criar uma Explicabilidade para todos os pontos temporais em seu horizonte de previsão, use `ALL`. Para criar uma Explicabilidade para pontos de tempo específicos em seu horizonte de previsão, use `SPECIFIC`.  
Especifique pontos de tempo com os parâmetros `StartDateTime` e `EndDateTime` dentro da operação [CreateExplainability](API_CreateExplainability.md).  
Tipo: string  
Valores Válidos: `ALL | SPECIFIC`   
Obrigatório: sim

 ** TimeSeriesGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimeSeriesGranularity"></a>
Para criar uma Explicabilidade para todas as séries temporais em seus conjuntos de dados, use `ALL`. Para criar uma Explicabilidade para séries temporais específicas em seus conjuntos de dados, use `SPECIFIC`.  
Especifique a série temporal fazendo o upload de um arquivo CSV ou Parquet em um bucket do Amazon S3 e defina a localização dentro do tipo de dados [DataDestination](API_DataDestination.md).  
Tipo: string  
Valores Válidos: `ALL | SPECIFIC`   
Exigido: Sim

## Consulte também
<a name="API_ExplainabilityConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityConfig) 

# ExplainabilityExportSummary
<a name="API_ExplainabilityExportSummary"></a>

Fornece um resumo das propriedades de exportação de Explicabilidade usadas na operação [ListExplainabilityExports](API_ListExplainabilityExports.md). Para obter um conjunto completo de propriedades, chame a operação [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) e forneça o `ExplainabilityExportArn`.

## Conteúdo
<a name="API_ExplainabilityExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilityExportSummary-CreationTime"></a>
Quando a explicabilidade foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Destination **   <a name="forecast-Type-ExplainabilityExportSummary-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: não

 ** ExplainabilityExportArn **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** ExplainabilityExportName **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportName"></a>
O nome da exportação de explicabilidade  
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_]*`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilityExportSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-ExplainabilityExportSummary-Message"></a>
Informações sobre todos os erros ocorridos durante a exportação de explicabilidade.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-ExplainabilityExportSummary-Status"></a>
O status da exportação de explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ExplainabilityExportSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityExportSummary) 

# ExplainabilityInfo
<a name="API_ExplainabilityInfo"></a>

Fornece informações sobre o recurso de explicabilidade.

## Conteúdo
<a name="API_ExplainabilityInfo_Contents"></a>

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilityInfo-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-ExplainabilityInfo-Status"></a>
O status da explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ExplainabilityInfo_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityInfo) 

# ExplainabilitySummary
<a name="API_ExplainabilitySummary"></a>

Fornece um resumo das propriedades de explicabilidade usadas na operação [ListExplainabilities](API_ListExplainabilities.md). Para obter um conjunto completo de propriedades, chame a operação [DescribeExplainability](API_DescribeExplainability.md) e forneça o `ExplainabilityArn` indicado.

## Conteúdo
<a name="API_ExplainabilitySummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilitySummary-CreationTime"></a>
Quando a explicabilidade foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** ExplainabilityConfig **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityConfig"></a>
As configurações que definem a granularidade das séries temporais e dos pontos no tempo para a explicabilidade.  
Tipo: objeto [ExplainabilityConfig](API_ExplainabilityConfig.md)  
Obrigatório: não

 ** ExplainabilityName **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityName"></a>
O nome da explicabilidade.  
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_]*`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilitySummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-ExplainabilitySummary-Message"></a>
Informações sobre todos os erros ocorridos durante o processo de criação da explicabilidade.  
Tipo: string  
Obrigatório: Não

 ** ResourceArn **   <a name="forecast-Type-ExplainabilitySummary-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor ou da previsão usado para criar a explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-ExplainabilitySummary-Status"></a>
O status da explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ExplainabilitySummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilitySummary) 

# Featurization
<a name="API_Featurization"></a>

**nota**  
Esse objeto pertence à operação [CreatePredictor](API_CreatePredictor.md). Se você criou seu preditor com[CreateAutoPredictor](API_CreateAutoPredictor.md), consulte [AttributeConfig](API_AttributeConfig.md).

Fornece informações de caracterização (transformação) para um campo de conjunto de dados. Esse objeto faz parte do objeto [FeaturizationConfig](API_FeaturizationConfig.md).

Por exemplo:

 `{` 

 `"AttributeName": "demand",` 

 `FeaturizationPipeline [ {` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}` 

 `} ]` 

 `}` 

## Conteúdo
<a name="API_Featurization_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Featurization-AttributeName"></a>
O nome do atributo do esquema que especifica o campo de dados a ser destacado. O Amazon Forecast oferece suporte ao campo de destino de `TARGET_TIME_SERIES` e dos conjuntos de dados de `RELATED_TIME_SERIES`. Por exemplo, para o domínio, `RETAIL` o alvo é `demand`, e para o domínio `CUSTOM`, o alvo é `target_value`. Para obter mais informações, consulte [Lidar com valores ausentes](howitworks-missing-values.md).  
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_]*`   
Exigido: Sim

 ** FeaturizationPipeline **   <a name="forecast-Type-Featurization-FeaturizationPipeline"></a>
Uma matriz de um objeto `FeaturizationMethod` que especifica o método de transformação do recurso.  
Tipo: matriz de objetos [FeaturizationMethod](API_FeaturizationMethod.md)  
Membros da matriz: número fixo de 1 item.  
Obrigatório: Não

## Consulte também
<a name="API_Featurization_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Featurization) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Featurization) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Featurization) 

# FeaturizationConfig
<a name="API_FeaturizationConfig"></a>

**nota**  
Esse objeto pertence à operação [CreatePredictor](API_CreatePredictor.md). Se você tiver criado seu preditor com [CreateAutoPredictor](API_CreateAutoPredictor.md), consulte [AttributeConfig](API_AttributeConfig.md).

Em uma operação [CreatePredictor](API_CreatePredictor.md), o algoritmo especificado treina um modelo usando o grupo de conjuntos de dados especificado. Você também pode instruir a operação a modificar os campos de dados antes de treinar um modelo. Essas modificações são chamadas de *caracterização*.

Você usa o objeto `FeaturizationConfig` para definir a caracterização. Você especifica uma matriz de transformações, uma para cada campo que deseja destacar. Em seguida, você inclui o objeto `FeaturizationConfig` em sua solicitação `CreatePredictor`. O Amazon Forecast aplica a caracterização aos conjuntos de dados `RELATED_TIME_SERIES` e `TARGET_TIME_SERIES` antes do treinamento do modelo.

É possível criar várias configurações de caracterização. Por exemplo, você pode chamar a operação `CreatePredictor` duas vezes especificando diferentes configurações de caracterização.

## Conteúdo
<a name="API_FeaturizationConfig_Contents"></a>

 ** ForecastFrequency **   <a name="forecast-Type-FeaturizationConfig-ForecastFrequency"></a>
A frequência das previsões em uma previsão.  
Os intervalos válidos são um número inteiro seguido de Y (ano), M (mês), W (semana), D (dia), H (hora) e min (minuto). Por exemplo, "1D" indica todos os dias e "15min" indica a cada 15 minutos. Você não pode especificar um valor que se sobreporia à próxima frequência maior. Isso significa, por exemplo, que você não pode especificar uma frequência de 60 minutos, porque isso equivale a 1 hora. Os valores válidos para cada frequência são os seguintes:  
+ Minuto: 1 a 59
+ Hora: 1 a 23
+ Dia: 1 a 6
+ Semana: 1 a 4
+ Mês: 1 a 11
+ Year (Ano): 1
Assim, se você quiser previsões a cada duas semanas, especifique "2W". Ou, se quiser previsões trimestrais, especifique "3M".  
A frequência deve ser maior ou igual à frequência de conjunto de dados TARGET\$1TIME\$1SERIES.  
Quando um conjunto de dados RELATED\$1TIME\$1SERIES é fornecido, a frequência deve ser igual à frequência de conjunto de dados TARGET\$1TIME\$1SERIES.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.  
Padrão: `^Y|M|W|D|H|30min|15min|10min|5min|1min$`   
Exigido: Sim

 ** Featurizations **   <a name="forecast-Type-FeaturizationConfig-Featurizations"></a>
Uma matriz de informações de caracterização (transformação) para os campos de um conjunto de dados.  
Tipo: Matriz de objetos [Featurization](API_Featurization.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 50 itens.  
Obrigatório: não

 ** ForecastDimensions **   <a name="forecast-Type-FeaturizationConfig-ForecastDimensions"></a>
Uma matriz de nomes de dimensão (campo) que especificam como agrupar a previsão gerada.  
Por exemplo, suponha que você esteja gerando uma previsão de vendas de itens em todas as suas lojas e que seu conjunto de dados tenha um campo `store_id`. Se você quiser a previsão de vendas para cada item por loja, especifique `store_id` como dimensão.  
Todas as dimensões de previsão especificadas no conjunto de dados `TARGET_TIME_SERIES` não precisam ser especificadas na solicitação `CreatePredictor`. Todas as dimensões de previsão especificadas no conjunto de dados `RELATED_TIME_SERIES` devem ser especificadas na solicitação `CreatePredictor`.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*`   
Obrigatório: Não

## Consulte também
<a name="API_FeaturizationConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationConfig) 

# FeaturizationMethod
<a name="API_FeaturizationMethod"></a>

Fornece informações sobre o método que caracteriza (transforma) um campo do conjunto de dados. O método faz parte do `FeaturizationPipeline` do objeto [Featurization](API_Featurization.md). 

Veja um exemplo de como especificar um objeto `FeaturizationMethod`.

 `{` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## Conteúdo
<a name="API_FeaturizationMethod_Contents"></a>

 ** FeaturizationMethodName **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodName"></a>
O nome do método. O método de “preenchimento” é o único método compatível.  
Tipo: string  
Valores Válidos: `filling`   
Obrigatório: sim

 ** FeaturizationMethodParameters **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodParameters"></a>
Os parâmetros do método (pares de valores-chave), que são um mapa dos parâmetros de substituição. Especifique esses parâmetros para substituir os valores padrão. Os atributos de séries temporais relacionados não aceitam parâmetros de agregação.  
A lista abaixo mostra os parâmetros e seus valores válidos para o método de caracterização de “preenchimento” de um conjunto de dados **Target Time Series**. Negrito significa o valor padrão.  
+  `aggregation`: **soma**, `avg`, `first`, `min`, `max` 
+  `frontfill`: **nenhum** 
+  `middlefill`: **zero**, `nan` (não é um número), `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`, `max` 
A lista abaixo mostra os parâmetros e seus valores válidos para um método de caracterização de **Related Time Series** (não há padrões):  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
Para definir um método de preenchimento para um valor específico, defina o parâmetro de preenchimento como `value` e defina o valor em um parâmetro `_value` correspondente. Por exemplo, para definir o preenchimento com um valor de 2, inclua `"backfill": "value"` e `"backfill_value":"2"`.   
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 20 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.  
Padrão de valor: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`   
Obrigatório: Não

## Consulte também
<a name="API_FeaturizationMethod_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationMethod) 

# Filter
<a name="API_Filter"></a>

Descreve um filtro para escolher um subgrupo de objetos. Cada filtro consiste em uma condição e uma declaração de correspondência. A condição é `IS` ou `IS_NOT`, que especifica se os objetos correspondentes à instrução devem ser incluídos ou excluídos, respectivamente. A declaração de correspondência consiste em uma chave e um valor.

## Conteúdo
<a name="API_Filter_Contents"></a>

 ** Condition **   <a name="forecast-Type-Filter-Condition"></a>
A condição a ser aplicada. Para incluir os objetos correspondentes à declaração, especifique `IS`. Para excluir objetos correspondentes, especifique `IS_NOT`.  
Tipo: string  
Valores Válidos: `IS | IS_NOT`   
Obrigatório: sim

 ** Key **   <a name="forecast-Type-Filter-Key"></a>
O nome do parâmetro a ser filtrado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$`   
Exigido: Sim

 ** Value **   <a name="forecast-Type-Filter-Value"></a>
O valor a ser comparado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Exigido: Sim

## Consulte também
<a name="API_Filter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Filter) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Filter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Filter) 

# ForecastExportJobSummary
<a name="API_ForecastExportJobSummary"></a>

Fornece um resumo das propriedades da tarefa de exportação prevista usadas na operação [ListForecastExportJobs](API_ListForecastExportJobs.md). Para obter o conjunto completo de propriedades, chame a operação [DescribeForecastExportJob](API_DescribeForecastExportJob.md) e forneça o `ForecastExportJobArn` indicado.

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

## Conteúdo
<a name="API_ForecastExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ForecastExportJobSummary-CreationTime"></a>
Quando o trabalho de exportação de previsão foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Destination **   <a name="forecast-Type-ForecastExportJobSummary-Destination"></a>
O caminho para o bucket do Amazon Simple Storage Service (Amazon S3) para o qual a previsão é exportada.  
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: não

 ** ForecastExportJobArn **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** ForecastExportJobName **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobName"></a>
O nome do trabalho de exportação de previsão.  
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_]*`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-ForecastExportJobSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-ForecastExportJobSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-ForecastExportJobSummary-Status"></a>
O status do trabalho de exportação de previsão. 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` do trabalho de exportação de previsão deve ser `ACTIVE` para que seja possível acessar a previsão no bucket do S3.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ForecastExportJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastExportJobSummary) 

# ForecastSummary
<a name="API_ForecastSummary"></a>

Fornece um resumo das propriedades de previsão usadas na operação [ListForecasts](API_ListForecasts.md). Para obter o conjunto completo de propriedades, chame a operação [DescribeForecast](API_DescribeForecast.md) e forneça o `ForecastArn` informado no resumo.

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

## Conteúdo
<a name="API_ForecastSummary_Contents"></a>

 ** CreatedUsingAutoPredictor **   <a name="forecast-Type-ForecastSummary-CreatedUsingAutoPredictor"></a>
Se o Forecast foi criado a partir de um AutoPredictor.  
Tipo: booliano  
Obrigatório: não

 ** CreationTime **   <a name="forecast-Type-ForecastSummary-CreationTime"></a>
Quando a tarefa de criação da previsão foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** DatasetGroupArn **   <a name="forecast-Type-ForecastSummary-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados que forneceu os dados utilizados para treinar o preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$`   
Obrigatório: não

 ** ForecastArn **   <a name="forecast-Type-ForecastSummary-ForecastArn"></a>
O ARN da previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** ForecastName **   <a name="forecast-Type-ForecastSummary-ForecastName"></a>
O nome da previsão.  
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_]*`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-ForecastSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-ForecastSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** PredictorArn **   <a name="forecast-Type-ForecastSummary-PredictorArn"></a>
O ARN do preditor usado para gerar a previsão.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-ForecastSummary-Status"></a>
O status da previsão. 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 deve ser `ACTIVE` para que você possa consultar ou exportar a previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_ForecastSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastSummary) 

# HyperParameterTuningJobConfig
<a name="API_HyperParameterTuningJobConfig"></a>

Informações de configuração para um trabalho de ajuste de hiperparâmetros. Você especifica esse objeto na solicitação [CreatePredictor](API_CreatePredictor.md).

Um *hiperparâmetro* é um parâmetro que governa o processo de treinamento do modelo. Você define hiperparâmetros antes do início do treinamento, diferentemente dos parâmetros do modelo, que são determinados durante o treinamento. Os valores dos hiperparâmetros afetam quais valores são escolhidos para os parâmetros do modelo.

Em um *trabalho de ajuste de hiperparâmetros*, o Amazon Forecast escolhe o conjunto de valores de hiperparâmetros que otimizam uma métrica específica. O Forecast faz isso executando vários trabalhos de treinamento em uma variedade de valores de hiperparâmetros. O conjunto ideal de valores depende do algoritmo, dos dados de treinamento e do objetivo métrico especificado.

## Conteúdo
<a name="API_HyperParameterTuningJobConfig_Contents"></a>

 ** ParameterRanges **   <a name="forecast-Type-HyperParameterTuningJobConfig-ParameterRanges"></a>
Especifica os intervalos de valores válidos para os hiperparâmetros.  
Tipo: objeto [ParameterRanges](API_ParameterRanges.md)  
Obrigatório: Não

## Consulte também
<a name="API_HyperParameterTuningJobConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/HyperParameterTuningJobConfig) 

# InputDataConfig
<a name="API_InputDataConfig"></a>

**nota**  
Esse objeto pertence à operação [CreatePredictor](API_CreatePredictor.md). Se você tiver criado seu preditor com [CreateAutoPredictor](API_CreateAutoPredictor.md), consulte [DataConfig](API_DataConfig.md).

Os dados usados para treinar um preditor. Os dados incluem um grupo de conjuntos de dados e os recursos complementares. Você especifica esse objeto na solicitação [CreatePredictor](API_CreatePredictor.md).

## Conteúdo
<a name="API_InputDataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-InputDataConfig-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Exigido: Sim

 ** SupplementaryFeatures **   <a name="forecast-Type-InputDataConfig-SupplementaryFeatures"></a>
Uma matriz de recursos complementares. O único recurso compatível é um calendário de feriados.  
Tipo: Matriz de objetos [SupplementaryFeature](API_SupplementaryFeature.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 2 itens.  
Obrigatório: Não

## Consulte também
<a name="API_InputDataConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/InputDataConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/InputDataConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/InputDataConfig) 

# IntegerParameterRange
<a name="API_IntegerParameterRange"></a>

Especifica um hiperparâmetro inteiro e sua faixa de valores ajustáveis. Esse objeto faz parte do objeto [ParameterRanges](API_ParameterRanges.md).

## Conteúdo
<a name="API_IntegerParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-IntegerParameterRange-MaxValue"></a>
O valor máximo ajustável do hiperparâmetro.  
Tipo: inteiro  
Obrigatório: sim

 ** MinValue **   <a name="forecast-Type-IntegerParameterRange-MinValue"></a>
O valor mínimo ajustável do hiperparâmetro.  
Tipo: inteiro  
Obrigatório: sim

 ** Name **   <a name="forecast-Type-IntegerParameterRange-Name"></a>
O nome do hiperparâmetro a ser ajustado.  
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_]*`   
Exigido: Sim

 ** ScalingType **   <a name="forecast-Type-IntegerParameterRange-ScalingType"></a>
A escala que o ajuste de hiperparâmetros usa para pesquisar a faixa de hiperparâmetros. Valores válidos:    
Auto  
O ajuste de hiperparâmetros do Amazon Forecast escolhe a melhor escala para o hiperparâmetro.  
Linear  
O ajuste de hiperparâmetros pesquisa os valores no intervalo de hiperparâmetros usando uma escala linear.  
Logarítmica  
O ajuste de hiperparâmetros pesquisa os valores no intervalo de hiperparâmetros usando uma escala logarítmica.  
A escalabilidade logarítmica funciona apenas para intervalos que têm valores maiores que 0.  
ReverseLogarithmic  
Não suportado para`IntegerParameterRange`.  
A escalabilidade logarítmica inversa funciona apenas para intervalos que estão inteiramente dentro do intervalo 0 <= x <1,0.
Para obter informações sobre como escolher uma escala de hiperparâmetros, consulte [Hyperparameter Scaling](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). Um dos seguintes valores:  
Tipo: string  
Valores Válidos: `Auto | Linear | Logarithmic | ReverseLogarithmic`   
Obrigatório: Não

## Consulte também
<a name="API_IntegerParameterRange_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/IntegerParameterRange) 

# MetricResult
<a name="API_MetricResult"></a>

Uma métrica individual de previsão calculada ao monitorar o uso do preditor. Você pode comparar o valor dessa métrica com o valor da métrica na [Baseline](API_Baseline.md) para ver as mudanças no desempenho do seu preditor.

Para obter mais informações sobre as métricas geradas pelo Forecast, consulte [Evaluating Predictor Accuracy](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html). 

## Conteúdo
<a name="API_MetricResult_Contents"></a>

 ** MetricName **   <a name="forecast-Type-MetricResult-MetricName"></a>
O nome da métrica.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** MetricValue **   <a name="forecast-Type-MetricResult-MetricValue"></a>
O valor para a métrica.  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_MetricResult_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MetricResult) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MetricResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MetricResult) 

# Metrics
<a name="API_Metrics"></a>

Fornece métricas que são usadas para avaliar o desempenho de um preditor. Esse objeto faz parte do objeto [WindowSummary](API_WindowSummary.md).

## Conteúdo
<a name="API_Metrics_Contents"></a>

 ** AverageWeightedQuantileLoss **   <a name="forecast-Type-Metrics-AverageWeightedQuantileLoss"></a>
O valor médio de todas as perdas quantis ponderadas.  
Tipo: duplo  
Obrigatório: não

 ** ErrorMetrics **   <a name="forecast-Type-Metrics-ErrorMetrics"></a>
 Fornece métricas de erro detalhadas para cada tipo de previsão. As métricas incluem Root-Mean Square-Error (RMSE), Mean Absolute Percentage Error (MAPE), Mean Absolute Scaled Error (MASE) e Weighted Average Percentage Error (WAPE).   
Tipo: matriz de objetos [ErrorMetric](API_ErrorMetric.md)  
Obrigatório: não

 ** RMSE **   <a name="forecast-Type-Metrics-RMSE"></a>
 *Esse membro está obsoleto.*   
O root-mean-square erro (RMSE).  
Tipo: duplo  
Obrigatório: não

 ** WeightedQuantileLosses **   <a name="forecast-Type-Metrics-WeightedQuantileLosses"></a>
Uma matriz de perdas quantis ponderadas. Os quantis dividem uma distribuição de probabilidade em regiões de igual probabilidade. A distribuição nesse caso é a função de perda.  
Tipo: matriz de objetos [WeightedQuantileLoss](API_WeightedQuantileLoss.md)  
Obrigatório: Não

## Consulte também
<a name="API_Metrics_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Metrics) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Metrics) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Metrics) 

# MonitorConfig
<a name="API_MonitorConfig"></a>

Os detalhes da configuração do monitor de preditores.

## Conteúdo
<a name="API_MonitorConfig_Contents"></a>

 ** MonitorName **   <a name="forecast-Type-MonitorConfig-MonitorName"></a>
O nome do recurso de monitor.  
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_]*`   
Exigido: Sim

## Consulte também
<a name="API_MonitorConfig_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorConfig) 

# MonitorDataSource
<a name="API_MonitorDataSource"></a>

A fonte dos dados que o monitor usou durante a avaliação.

## Conteúdo
<a name="API_MonitorDataSource_Contents"></a>

 ** DatasetImportJobArn **   <a name="forecast-Type-MonitorDataSource-DatasetImportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de importação do conjunto de dados usado para importar os dados que iniciaram a avaliação do monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** ForecastArn **   <a name="forecast-Type-MonitorDataSource-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão que o monitor usou durante a avaliação.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** PredictorArn **   <a name="forecast-Type-MonitorDataSource-PredictorArn"></a>
O nome do recurso da Amazon (ARN) do recurso preditor que você está monitorando.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: Não

## Consulte também
<a name="API_MonitorDataSource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorDataSource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorDataSource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorDataSource) 

# MonitorInfo
<a name="API_MonitorInfo"></a>

Fornece informações sobre o recurso de monitor.

## Conteúdo
<a name="API_MonitorInfo_Contents"></a>

 ** MonitorArn **   <a name="forecast-Type-MonitorInfo-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-MonitorInfo-Status"></a>
Monitore o status do monitor. Os estados são:  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_MonitorInfo_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorInfo) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorInfo) 

# MonitorSummary
<a name="API_MonitorSummary"></a>

Fornece um resumo das propriedades do monitor usadas na operação [ListMonitors](API_ListMonitors.md). Para obter um conjunto completo de propriedades, chame a operação [DescribeMonitor](API_DescribeMonitor.md) e forneça o `MonitorArn` indicado.

## Conteúdo
<a name="API_MonitorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-MonitorSummary-CreationTime"></a>
Quando o recurso de monitor foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-MonitorSummary-LastModificationTime"></a>
A última vez que o recurso de monitor 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.
+  `STOPPED`: quando o recurso parou.
+  `ACTIVE` ou `CREATE_FAILED`: quando a criação do monitor foi concluída ou falhou.
Tipo: carimbo de data/hora  
Obrigatório: não

 ** MonitorArn **   <a name="forecast-Type-MonitorSummary-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** MonitorName **   <a name="forecast-Type-MonitorSummary-MonitorName"></a>
O nome do recurso de monitor.  
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_]*`   
Obrigatório: não

 ** ResourceArn **   <a name="forecast-Type-MonitorSummary-ResourceArn"></a>
O Amazon Resource Name (ARN) do preditor que está sendo monitorado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-MonitorSummary-Status"></a>
Monitore o status do monitor. Os estados são:  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_MonitorSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorSummary) 

# ParameterRanges
<a name="API_ParameterRanges"></a>

Especifica os hiperparâmetros categóricos, contínuos e inteiros e seus intervalos de valores ajustáveis. A faixa de valores ajustáveis determina quais valores um trabalho de ajuste de hiperparâmetros pode escolher para o hiperparâmetro especificado. Esse objeto faz parte do objeto [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md).

## Conteúdo
<a name="API_ParameterRanges_Contents"></a>

 ** CategoricalParameterRanges **   <a name="forecast-Type-ParameterRanges-CategoricalParameterRanges"></a>
Especifica o intervalo ajustável para cada hiperparâmetro categórico.  
Tipo: Matriz de objetos [CategoricalParameterRange](API_CategoricalParameterRange.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Obrigatório: não

 ** ContinuousParameterRanges **   <a name="forecast-Type-ParameterRanges-ContinuousParameterRanges"></a>
Especifica o intervalo ajustável para cada hiperparâmetro contínuo.  
Tipo: Matriz de objetos [ContinuousParameterRange](API_ContinuousParameterRange.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Obrigatório: não

 ** IntegerParameterRanges **   <a name="forecast-Type-ParameterRanges-IntegerParameterRanges"></a>
Especifica o intervalo ajustável para cada hiperparâmetro inteiro.  
Tipo: Matriz de objetos [IntegerParameterRange](API_IntegerParameterRange.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.  
Obrigatório: Não

## Consulte também
<a name="API_ParameterRanges_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ParameterRanges) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ParameterRanges) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ParameterRanges) 

# PredictorBacktestExportJobSummary
<a name="API_PredictorBacktestExportJobSummary"></a>

Fornece um resumo das propriedades do trabalho de exportação do backtest do preditor usadas na operação [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md). Para obter um conjunto completo de propriedades, chame a operação [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) e forneça o `PredictorBacktestExportJobArn` indicado.

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

## Conteúdo
<a name="API_PredictorBacktestExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-CreationTime"></a>
Quando o trabalho de exportação do backtest do preditor foi criado.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Destination **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Destination"></a>
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).   
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Message"></a>
Informações sobre todos os erros ocorridos durante a exportação de backtests.  
Tipo: string  
Obrigatório: Não

 ** PredictorBacktestExportJobArn **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobArn"></a>
O nome do recurso da Amazon (ARN) do trabalho de exportação de backtests do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** PredictorBacktestExportJobName **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobName"></a>
O nome do trabalho de exportação de backtests do preditor.  
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_]*`   
Obrigatório: não

 ** Status **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Status"></a>
O status do trabalho de exportação de backtests do preditor. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_PredictorBacktestExportJobSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBacktestExportJobSummary) 

# PredictorBaseline
<a name="API_PredictorBaseline"></a>

Métricas que você pode usar como base para fins de comparação. Use essas métricas ao interpretar os resultados do monitoramento de um preditor automático.

## Conteúdo
<a name="API_PredictorBaseline_Contents"></a>

 ** BaselineMetrics **   <a name="forecast-Type-PredictorBaseline-BaselineMetrics"></a>
As [métricas de precisão](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) iniciais do preditor. Use essas métricas como base para fins de comparação à medida que você usa seu preditor e as métricas mudam.  
Tipo: matriz de objetos [BaselineMetric](API_BaselineMetric.md)  
Obrigatório: Não

## Consulte também
<a name="API_PredictorBaseline_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBaseline) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBaseline) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBaseline) 

# PredictorEvent
<a name="API_PredictorEvent"></a>

Fornece detalhes sobre um evento do preditor, por exemplo, reciclagem.

## Conteúdo
<a name="API_PredictorEvent_Contents"></a>

 ** Datetime **   <a name="forecast-Type-PredictorEvent-Datetime"></a>
A data e hora de quando o evento ocorreu.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Detail **   <a name="forecast-Type-PredictorEvent-Detail"></a>
O tipo de evento. Por exemplo, `Retrain`. Um evento de reciclagem indica o momento em que um preditor foi treinado novamente. Quaisquer resultados de monitor anteriores ao `Datetime` são do preditor anterior. Qualquer nova métrica é do preditor que acabou de ser treinado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_PredictorEvent_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorEvent) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorEvent) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorEvent) 

# PredictorExecution
<a name="API_PredictorExecution"></a>

O algoritmo usado para realizar um backtest e o status desses testes.

## Conteúdo
<a name="API_PredictorExecution_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-PredictorExecution-AlgorithmArn"></a>
O ARN do algoritmo usado para testar o preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** TestWindows **   <a name="forecast-Type-PredictorExecution-TestWindows"></a>
Uma matriz de janelas de teste usadas para avaliar o algoritmo. O `NumberOfBacktestWindows` do objeto [EvaluationParameters](API_EvaluationParameters.md) determina o número de janelas na matriz.  
Tipo: matriz de objetos [TestWindowSummary](API_TestWindowSummary.md)  
Obrigatório: Não

## Consulte também
<a name="API_PredictorExecution_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecution) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecution) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecution) 

# PredictorExecutionDetails
<a name="API_PredictorExecutionDetails"></a>

Contém detalhes sobre os backtests realizados para avaliar a precisão do preditor. Os testes são retornados em ordem decrescente de precisão, com o backtest mais preciso aparecendo em primeiro lugar. Você vai especificar o número de backtests a serem executados ao chamar a operação [CreatePredictor](API_CreatePredictor.md).

## Conteúdo
<a name="API_PredictorExecutionDetails_Contents"></a>

 ** PredictorExecutions **   <a name="forecast-Type-PredictorExecutionDetails-PredictorExecutions"></a>
Uma matriz dos backtests realizados para avaliar a precisão do preditor em relação a um algoritmo específico. O `NumberOfBacktestWindows` do objeto [EvaluationParameters](API_EvaluationParameters.md) determina o número de janelas na matriz.  
Tipo: Matriz de objetos [PredictorExecution](API_PredictorExecution.md)  
Membros da Matriz: número mínimo de 1 item. Número máximo de 5 itens.  
Obrigatório: Não

## Consulte também
<a name="API_PredictorExecutionDetails_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecutionDetails) 

# PredictorMonitorEvaluation
<a name="API_PredictorMonitorEvaluation"></a>

Descreve os resultados de uma avaliação de monitor.

## Conteúdo
<a name="API_PredictorMonitorEvaluation_Contents"></a>

 ** EvaluationState **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationState"></a>
O status da avaliação do monitor. O status pode ser `SUCCESS` ou `FAILURE`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** EvaluationTime **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationTime"></a>
O carimbo de data e hora que indica quando a avaliação do monitor foi iniciada.   
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Message **   <a name="forecast-Type-PredictorMonitorEvaluation-Message"></a>
Informações sobre todos os erros ocorridos durante a avaliação do monitor.  
Tipo: string  
Obrigatório: Não

 ** MetricResults **   <a name="forecast-Type-PredictorMonitorEvaluation-MetricResults"></a>
Uma lista de métricas de previsão calculadas ao monitorar um preditor. Você pode comparar o valor de cada métrica na lista com o valor da métrica na [Baseline](API_Baseline.md) para ver as mudanças no desempenho do seu preditor.  
Tipo: matriz de objetos [MetricResult](API_MetricResult.md)  
Obrigatório: não

 ** MonitorArn **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorArn"></a>
O nome do recurso da Amazon (ARN) do recurso de monitor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** MonitorDataSource **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorDataSource"></a>
A fonte dos dados do recurso de monitor usado durante a avaliação.  
Tipo: objeto [MonitorDataSource](API_MonitorDataSource.md)  
Obrigatório: não

 ** NumItemsEvaluated **   <a name="forecast-Type-PredictorMonitorEvaluation-NumItemsEvaluated"></a>
O número de itens considerados durante a avaliação.  
Tipo: longo  
Obrigatório: não

 ** PredictorEvent **   <a name="forecast-Type-PredictorMonitorEvaluation-PredictorEvent"></a>
Fornece detalhes sobre um evento do preditor, por exemplo, reciclagem.  
Tipo: objeto [PredictorEvent](API_PredictorEvent.md)  
Obrigatório: não

 ** ResourceArn **   <a name="forecast-Type-PredictorMonitorEvaluation-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso a ser monitorado.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** WindowEndDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowEndDatetime"></a>
O carimbo de data e hora que indica o final da janela usada para a avaliação do monitor.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** WindowStartDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowStartDatetime"></a>
O carimbo de data e hora que indica o início da janela usada para a avaliação do monitor.  
Tipo: carimbo de data/hora  
Obrigatório: Não

## Consulte também
<a name="API_PredictorMonitorEvaluation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorMonitorEvaluation) 

# PredictorSummary
<a name="API_PredictorSummary"></a>

Fornece um resumo das propriedades do preditor que são usadas na operação [ListPredictors](API_ListPredictors.md). Para obter o conjunto completo de propriedades, chame a operação [DescribePredictor](API_DescribePredictor.md) e forneça o `PredictorArn` indicado.

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

## Conteúdo
<a name="API_PredictorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorSummary-CreationTime"></a>
Quando a tarefa de treinamento do modelo foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** DatasetGroupArn **   <a name="forecast-Type-PredictorSummary-DatasetGroupArn"></a>
O nome do recurso da Amazon (ARN) do grupo de conjuntos de dados que contém os dados usados para treinar o preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** IsAutoPredictor **   <a name="forecast-Type-PredictorSummary-IsAutoPredictor"></a>
Se AutoPredictor foi usado para criar o preditor.  
Tipo: booliano  
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-PredictorSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-PredictorSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** PredictorArn **   <a name="forecast-Type-PredictorSummary-PredictorArn"></a>
O ARN do preditor.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** PredictorName **   <a name="forecast-Type-PredictorSummary-PredictorName"></a>
O nome do preditor.  
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_]*`   
Obrigatório: não

 ** ReferencePredictorSummary **   <a name="forecast-Type-PredictorSummary-ReferencePredictorSummary"></a>
Um resumo do preditor de referência usado caso o preditor tenha passado por novo treinamento ou tenha sido atualizado.  
Tipo: objeto [ReferencePredictorSummary](API_ReferencePredictorSummary.md)  
Obrigatório: não

 ** Status **   <a name="forecast-Type-PredictorSummary-Status"></a>
O status do preditor. Os estados são:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
O `Status` do preditor deve ser `ACTIVE` para que seja possível usar o preditor na criação de uma previsão.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Não

## Consulte também
<a name="API_PredictorSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorSummary) 

# ReferencePredictorSummary
<a name="API_ReferencePredictorSummary"></a>

Fornece um resumo do preditor de referência usado ao treinar novamente ou atualizar um preditor.

## Conteúdo
<a name="API_ReferencePredictorSummary_Contents"></a>

 ** Arn **   <a name="forecast-Type-ReferencePredictorSummary-Arn"></a>
O ARN do preditor de referência.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** State **   <a name="forecast-Type-ReferencePredictorSummary-State"></a>
Se o preditor de referência é `Active` ou `Deleted`.  
Tipo: string  
Valores Válidos: `Active | Deleted`   
Obrigatório: Não

## Consulte também
<a name="API_ReferencePredictorSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ReferencePredictorSummary) 

# S3Config
<a name="API_S3Config"></a>

O caminho para o (s) arquivo (s) em um bucket do Amazon Simple Storage Service (Amazon S3) e AWS Identity and Access Management uma função (IAM) que o Amazon Forecast pode assumir para acessar o (s) arquivo (s). Opcionalmente, inclui uma chave AWS Key Management Service (KMS). Esse objeto faz parte do objeto [DataSource](API_DataSource.md) enviado na solicitação [CreateDatasetImportJob](API_CreateDatasetImportJob.md) e faz parte do objeto [DataDestination](API_DataDestination.md).

## Conteúdo
<a name="API_S3Config_Contents"></a>

 ** Path **   <a name="forecast-Type-S3Config-Path"></a>
O caminho para um bucket do Amazon Simple Storage Service (Amazon S3) ou arquivos em um bucket do Amazon S3.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é de 7. O tamanho máximo é 4.096.  
Padrão: `^s3://[a-z0-9].+$`   
Exigido: Sim

 ** RoleArn **   <a name="forecast-Type-S3Config-RoleArn"></a>
O ARN da função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar o bucket ou os arquivos do Amazon S3. Se você fornecer um valor para a chave `KMSKeyArn`, a função deverá permitir o acesso à chave.  
Não é permitido transmitir uma função entre AWS contas. Se você passar um perfil que não esteja na sua conta, você receberá um erro `InvalidInputException`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Exigido: Sim

 ** KMSKeyArn **   <a name="forecast-Type-S3Config-KMSKeyArn"></a>
O nome de recurso da Amazon (ARN) de uma chave AWS Key Management Service (KMS).  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:aws:kms:.*:key/.*`   
Obrigatório: Não

## Consulte também
<a name="API_S3Config_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/S3Config) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/S3Config) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/S3Config) 

# Schema
<a name="API_Schema"></a>

Define os campos de um conjunto de dados.

## Conteúdo
<a name="API_Schema_Contents"></a>

 ** Attributes **   <a name="forecast-Type-Schema-Attributes"></a>
Uma matriz de atributos especificando o nome e o tipo de cada campo em um conjunto de dados.  
Tipo: Matriz de objetos [SchemaAttribute](API_SchemaAttribute.md)  
Membros da matriz: número mínimo de 1 item. Número máximo de 100 itens.  
Obrigatório: Não

## Consulte também
<a name="API_Schema_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Schema) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Schema) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Schema) 

# SchemaAttribute
<a name="API_SchemaAttribute"></a>

Um atributo de um esquema, que define um campo do conjunto de dados. Um atributo de esquema é obrigatório para cada campo em um conjunto de dados. O objeto [Schema](https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) contém uma matriz de objetos `SchemaAttribute`.

## Conteúdo
<a name="API_SchemaAttribute_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-SchemaAttribute-AttributeName"></a>
O nome do campo de conjunto de dados.  
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_]*`   
Obrigatório: não

 ** AttributeType **   <a name="forecast-Type-SchemaAttribute-AttributeType"></a>
O tipo de dados do campo.  
Para um conjunto de dados de séries temporais relacionado, além dos atributos de data, item\$1id e dimensões de previsão, todos os atributos devem ser do tipo numérico (inteiro/flutuante).  
Tipo: string  
Valores Válidos: `string | integer | float | timestamp | geolocation`   
Obrigatório: Não

## Consulte também
<a name="API_SchemaAttribute_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SchemaAttribute) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SchemaAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SchemaAttribute) 

# Statistics
<a name="API_Statistics"></a>

Fornece estatísticas para cada campo de dados importado para um conjunto de dados do Amazon Forecast com a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)operação.

## Conteúdo
<a name="API_Statistics_Contents"></a>

 ** Avg **   <a name="forecast-Type-Statistics-Avg"></a>
Para um campo numérico, o valor médio no campo.  
Tipo: duplo  
Obrigatório: não

 ** Count **   <a name="forecast-Type-Statistics-Count"></a>
O número de valores no campo. Se o valor da resposta for -1, consulte `CountLong`.  
Tipo: número inteiro  
Obrigatório: não

 ** CountDistinct **   <a name="forecast-Type-Statistics-CountDistinct"></a>
O número de valores distintos em um campo. Se o valor da resposta for -1, consulte `CountDistinctLong`.  
Tipo: número inteiro  
Obrigatório: não

 ** CountDistinctLong **   <a name="forecast-Type-Statistics-CountDistinctLong"></a>
O número de valores distintos no campo. `CountDistinctLong` será usado em vez de `CountDistinct` se o valor for maior que 2.147.483.647.  
Tipo: longo  
Obrigatório: não

 ** CountLong **   <a name="forecast-Type-Statistics-CountLong"></a>
O número de valores no campo. `CountLong` será usado em vez de `Count` se o valor for maior que 2.147.483.647.  
Tipo: longo  
Obrigatório: não

 ** CountNan **   <a name="forecast-Type-Statistics-CountNan"></a>
O número de valores NAN (não um número) no campo. Se o valor da resposta for -1, consulte `CountNanLong`.  
Tipo: número inteiro  
Obrigatório: não

 ** CountNanLong **   <a name="forecast-Type-Statistics-CountNanLong"></a>
O número de valores NAN (não um número) no campo. `CountNanLong` será usado em vez de `CountNan` se o valor for maior que 2.147.483.647.  
Tipo: longo  
Obrigatório: não

 ** CountNull **   <a name="forecast-Type-Statistics-CountNull"></a>
O número de valores nulos no campo. Se o valor da resposta for -1, consulte `CountNullLong`.  
Tipo: número inteiro  
Obrigatório: não

 ** CountNullLong **   <a name="forecast-Type-Statistics-CountNullLong"></a>
O número de valores nulos no campo. `CountNullLong` será usado em vez de `CountNull` se o valor for maior que 2.147.483.647.  
Tipo: longo  
Obrigatório: não

 ** Max **   <a name="forecast-Type-Statistics-Max"></a>
Para um campo numérico, o valor máximo no campo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$`   
Obrigatório: não

 ** Min **   <a name="forecast-Type-Statistics-Min"></a>
Para um campo numérico, o valor mínimo no campo.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_]+$`   
Obrigatório: não

 ** Stddev **   <a name="forecast-Type-Statistics-Stddev"></a>
Para um campo numérico, o desvio padrão.  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_Statistics_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Statistics) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Statistics) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Statistics) 

# SupplementaryFeature
<a name="API_SupplementaryFeature"></a>

**nota**  
Esse objeto pertence à operação [CreatePredictor](API_CreatePredictor.md). Se você tiver criado seu preditor com [CreateAutoPredictor](API_CreateAutoPredictor.md), consulte [AdditionalDataset](API_AdditionalDataset.md).

Descreve um recurso suplementar de um grupo de conjuntos de dados. Esse objeto faz parte do objeto [InputDataConfig](API_InputDataConfig.md). O Forecast é compatível com as caracterizações integradas do Weather Index e Holidays.

 **Weather Index** 

O Weather Index do Amazon Forecast é uma caracterização integrada que inclui informações meteorológicas passadas e projetadas em seu modelo. O Weather Index complementa seus conjuntos de dados com mais de dois anos de dados meteorológicos passados e até 14 dias de dados meteorológicos projetados. Para obter mais informações, consulte [Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

 **Holidays** 

Holidays é uma caracterização integrada que incorpora um conjunto de dados projetado por recursos de informações de feriados nacionais em seu modelo. Ele fornece suporte nativo para os calendários de feriados de mais de 250 países. O Amazon Forecast incorpora a [biblioteca de APIs Holiday](https://holidayapi.com/countries) e a [API Jollyday](https://jollyday.sourceforge.net/data.html) para gerar calendários de feriados. Para obter mais informações, consulte [Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

## Conteúdo
<a name="API_SupplementaryFeature_Contents"></a>

 ** Name **   <a name="forecast-Type-SupplementaryFeature-Name"></a>
O nome do recurso. Valores válidos: `"holiday"` e `"weather"`.  
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_]*`   
Exigido: Sim

 ** Value **   <a name="forecast-Type-SupplementaryFeature-Value"></a>
 **Weather Index**   
Para habilitar o Weather Index, defina o valor como `"true"`   
 **Holidays**   
Para habilitar o Holidays, especifique um país com um dos seguintes códigos de país de duas letras:  
+  Afeganistão — AF 
+  Ilhas Åland — AX 
+  Albânia — AL 
+  Argélia — DZ 
+  Samoa Americana — AS 
+  Andorra — AD 
+  Angola — AO 
+  Anguila — AI 
+  Antártica — AQ 
+  Antígua e Barbuda — AG 
+  Argentina — AR 
+  Armênia — AM 
+  Aruba — AW 
+  Austrália — AU 
+  Áustria — AT 
+  Azerbaijão — AZ 
+  Bahamas — BS 
+  Bahrein — BH 
+  Bangladesh — BD 
+  Barbados — BB 
+  Bielorrússia — BY 
+  Bélgica — BE 
+  Belize — BZ 
+  Benin — BJ 
+  Bermudas — BM 
+  Butão — BT 
+  Bolívia — BO 
+  Bósnia e Herzegovina — BA 
+  Botsuana — BW 
+  Ilha Bouvet — BV 
+  Brasil — BR 
+  Território Britânico do Oceano Índico — IO 
+  Ilhas Virgens Britânicas — VG 
+  Brunei Darussalam — BN 
+  Bulgária — BG 
+  Burkina Faso —BF 
+  Burundi — BI 
+  Camboja — KH 
+  Camarões — CM 
+  Canadá — CA 
+  Cabo Verde — CV 
+  Holanda Caribenha — BQ 
+  Ilhas Cayman — KY 
+  República Centro-Africana — CF 
+  Chade — TD 
+  Chile — CL 
+  China — CN 
+  Christmas Island — CX 
+  Ilhas Cocos (Ilhas Keeling) — CC 
+  Colômbia — CO 
+  Comores — KM 
+  Ilhas Cook — CK 
+  Costa Rica — CR 
+  Croácia — HR 
+  Cuba — CU 
+  Curaçao — CW 
+  Chipre — CY 
+  Tchéquia — CZ 
+  República Democrática do Congo — CD 
+  Dinamarca — DK 
+  Djibuti — DJ 
+  Dominica — DM 
+  República Dominicana — DO 
+  Equador — EC 
+  Egito — EG 
+  El Salvador — SV 
+  Guiné Equatorial — GQ 
+  Eritreia — ER 
+  Estônia — EE 
+  Essuatíni — SZ 
+  Etiópia — ET 
+  Ilhas Falkland — FK 
+  Ilhas Faroe — FO 
+  Fiji — FJ 
+  Finlândia — FI 
+  França — FR 
+  Guiana Francesa — GF 
+  Polinésia Francesa — PF 
+  Territórios Franceses do Sul — TF 
+  Gabão — GA 
+  Gâmbia — GM 
+  Geórgia — GE 
+  Alemanha — DE 
+  Gana — GH 
+  Gibraltar — GI 
+  Grécia — GR 
+  Groenlândia — GL 
+  Granada — GD 
+  Guadalupe — GP 
+  Guam — GU 
+  Guatemala — GT 
+  Guernsey — GG 
+  Guiné — GN 
+  Guiné-Bissau — GW 
+  Guiana — GY 
+  Haiti — HT 
+  Ilha e McDonald Ilhas Heard - HM 
+  Honduras — HN 
+  Hong Kong — HK 
+  Hungria — HU 
+  Islândia — IS 
+  Índia — IN 
+  Indonésia — ID 
+  Irã — IR 
+  Iraque — IQ 
+  Irlanda — IE 
+  Ilha de Man — IM 
+  Israel — IL 
+  Itália — IT 
+  Costa do Marfim — CI 
+  Jamaica — JM 
+  Japão — JP 
+  Jersey — JE 
+  Jordânia — JO 
+  Cazaquistão — KZ 
+  Quênia — KE 
+  Kiribati — KI 
+  Kosovo — XK 
+  Kuwait — KW 
+  Quirguistão — KG 
+  Laos — LA 
+  Letônia — LV 
+  Líbano — LB 
+  Lesoto — LS 
+  Libéria — LR 
+  Líbia — LY 
+  Liechtenstein — LI 
+  Lituânia — LT 
+  Luxemburgo — LU 
+  Macau — MO 
+  Madagáscar — MG 
+  Malawi — MW 
+  Malásia — MY 
+  Maldivas — MV 
+  Mali — ML 
+  Malta — MT 
+  Ilhas Marshall — MH 
+  Martinica — MQ 
+  Mauritânia — MR 
+  Maurício — MU 
+  Mayotte — YT 
+  México — MX 
+  Micronésia — FM 
+  Moldávia — MD 
+  Mônaco — MC 
+  Mongólia — MN 
+  Montenegro — ME 
+  Montserrat — MS 
+  Marrocos — MA 
+  Moçambique — MZ 
+  Mianmar — MM 
+  Namíbia — NA 
+  Nauru — NR 
+  Nepal — NP 
+  Países Baixos — NL 
+  Nova Caledônia — NC 
+  Nova Zelândia — NZ 
+  Nicarágua — NI 
+  Níger — NE 
+  Nigéria — NG 
+  Niue — NU 
+  Ilha Norfolk — NF 
+  Coreia do Norte — KP 
+  Macedônia do Norte — MK 
+  Ilhas Marianas do Norte — MP 
+  Noruega — NO 
+  Omã — OM 
+  Paquistão — PK 
+  Palau — PW 
+  Palestina — PS 
+  Panamá — PA 
+  Papua Nova Guiné — PG 
+  Paraguai — PY 
+  Peru — PE 
+  Filipinas — PH 
+  Ilhas Pitcairn — PN 
+  Polônia — PL 
+  Portugal — PT 
+  Porto Rico — PR 
+  Catar — QA 
+  República do Congo — CG 
+  Reunião — RE 
+  Romênia — RO 
+  Federação Russa — RU 
+  Ruanda — RW 
+  São Bartolomeu — BL 
+  “Santa Helena, Ascensão e Tristão da Cunha” — SH 
+  São Cristóvão e Nevis — KN 
+  Santa Lúcia — LC 
+  São Martinho — MF 
+  Saint Pierre e Miquelon — PM 
+  São Vicente e Granadinas — VC 
+  Samoa — WS 
+  São Marinho — SM 
+  São Tomé e Príncipe — ST 
+  Arábia Saudita — SA 
+  Senegal — SN 
+  Sérvia — RS 
+  Seychelles — SC 
+  Serra Leoa — SL 
+  Singapura — SG 
+  São Martinho — SX 
+  Eslováquia — SK 
+  Eslovênia — SI 
+  Ilhas Salomão — SB 
+  Somália — SO 
+  África do Sul — ZA 
+  Ilhas Geórgia do Sul e Sandwich do Sul — GS 
+  Coreia do Sul — KR 
+  Sudão do Sul — SS 
+  Espanha — ES 
+  Sri Lanka — LK 
+  Sudão — SD 
+  Suriname — SR 
+  Svalbard e Jan Mayen — SJ 
+  Suécia — SE 
+  Suíça — CH 
+  República Árabe da Síria — SY 
+  Taiwan — TW 
+  Tajiquistão — TJ 
+  Tanzânia — TZ 
+  Tailândia — TH 
+  Timor-Leste — TL 
+  Togo — TV 
+  Tokelau — TK 
+  Tonga — TO 
+  Trinidad e Tobago — TT 
+  Tunísia — TN 
+  Turquia — TR 
+  Turcomenistão — TM 
+  Ilhas Turcas e Caicos — TC 
+  Tuvalu — TV 
+  Uganda — UG 
+  Ucrânia — UA 
+  Emirados Árabes Unidos — AE 
+  Reino Unido — GB 
+  Nações Unidas — UN 
+  Estados Unidos — US 
+  Ilhas Menores Distantes dos Estados Unidos — UM 
+  Ilhas Virgens dos Estados Unidos — VI 
+  Uruguai — UY 
+  Uzbequistão — UZ 
+  Vanuatu — VU 
+  Cidade do Vaticano — VA 
+  Venezuela — VE 
+  Vietnã — VN 
+  Wallis e Futuna — WF 
+  Saara Ocidental — EH 
+  Iêmen — YE 
+  Zâmbia — ZM 
+  Zimbábue — ZW 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\_\-]+$`   
Exigido: Sim

## Consulte também
<a name="API_SupplementaryFeature_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SupplementaryFeature) 

# Tag
<a name="API_Tag"></a>

Os metadados opcionais que você aplica a um recurso para ajudar a categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos.

As restrições básicas a seguir se aplicam a tags:
+ Número máximo de tags por recurso: 50.
+ Em todos os recursos, cada chave de tag deve ser exclusiva e possuir apenas um valor.
+ Comprimento máximo da chave: 128 caracteres Unicode em UTF-8.
+ Comprimento máximo do valor: 256 caracteres Unicode em UTF-8.
+ Caso seu esquema de marcação seja usado em vários serviços e recursos , lembre-se de que outros serviços podem possuir restrições em caracteres permitidos. Em geral, os caracteres permitidos são: letras, números e espaços representáveis em UTF-8 e os seguintes caracteres: \$1 - = . \$1 : / @.
+ As chaves e valores das tags diferenciam maiúsculas de minúsculas.
+ Não use `aws:``AWS:`, ou qualquer combinação de maiúsculas ou minúsculas, como um prefixo para teclas, pois está reservado para uso. AWS Você não pode editar nem excluir chaves de tag com esse prefixo. Os valores podem ter esse prefixo. Se um valor de tag tiver `aws` como prefixo, mas a chave não, o Forecast o considerará uma tag de usuário e o contabilizará no limite de 50 tags. Tags com apenas o prefixo de chave da `aws` não contam em seu limite de tags por recurso.

## Conteúdo
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="forecast-Type-Tag-Key"></a>
Uma parte de um par de chave/valor que compõe uma tag. Uma `key` é um rótulo geral que age como uma categoria para valores de tag mais específicos.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.  
Padrão: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Exigido: Sim

 ** Value **   <a name="forecast-Type-Tag-Value"></a>
A parte opcional de um par de chave/valor que compõe uma tag. Um `value` atua como um descritor dentro de uma categoria de tag (chave).  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.  
Padrão: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Exigido: Sim

## Consulte também
<a name="API_Tag_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Tag) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Tag) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Tag) 

# TestWindowSummary
<a name="API_TestWindowSummary"></a>

O status, a hora de início e a hora de término de um backtest, bem como o motivo da falha, se for o caso.

## Conteúdo
<a name="API_TestWindowSummary_Contents"></a>

 ** Message **   <a name="forecast-Type-TestWindowSummary-Message"></a>
Se o teste falhou, o motivo da falha.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-TestWindowSummary-Status"></a>
O status do teste. Os valores de status possíveis são:  
+  `ACTIVE` 
+  `CREATE_IN_PROGRESS` 
+  `CREATE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** TestWindowEnd **   <a name="forecast-Type-TestWindowSummary-TestWindowEnd"></a>
A hora em que o teste terminou.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** TestWindowStart **   <a name="forecast-Type-TestWindowSummary-TestWindowStart"></a>
A hora em que o teste começou.  
Tipo: carimbo de data/hora  
Obrigatório: Não

## Consulte também
<a name="API_TestWindowSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TestWindowSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TestWindowSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TestWindowSummary) 

# TimeAlignmentBoundary
<a name="API_TimeAlignmentBoundary"></a>

O limite de tempo que o Forecast usa para alinhar e agregar seus dados de acordo com sua frequência de previsão. Forneça a unidade de tempo e o limite de tempo como um par chave-valor. Se você não fornecer um limite de tempo, o Forecast usará um conjunto de [Limites de tempo padrão](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). 

Para obter mais informações sobre agregação, consulte [Data Aggregation for Different Forecast Frequencies](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). Para obter mais informações sobre como definir um limite de tempo personalizado, consulte [Como especificar um limite de tempo](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). 

## Conteúdo
<a name="API_TimeAlignmentBoundary_Contents"></a>

 ** DayOfMonth **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfMonth"></a>
O dia do mês a ser usado para alinhamento de horário durante a agregação.  
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 28.  
Obrigatório: não

 ** DayOfWeek **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfWeek"></a>
O dia da semana a ser usado para alinhamento de horário durante a agregação. O dia deve estar em maiúsculas.  
Tipo: string  
Valores Válidos: `MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY`   
Obrigatório: não

 ** Hour **   <a name="forecast-Type-TimeAlignmentBoundary-Hour"></a>
A hora do dia a ser usada para alinhamento de horário durante a agregação.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0. Valor máximo de 23.  
Obrigatório: não

 ** Month **   <a name="forecast-Type-TimeAlignmentBoundary-Month"></a>
O mês a ser usado para alinhamento de tempo durante a agregação. O mês deve estar em maiúsculas.  
Tipo: string  
Valores Válidos: `JANUARY | FEBRUARY | MARCH | APRIL | MAY | JUNE | JULY | AUGUST | SEPTEMBER | OCTOBER | NOVEMBER | DECEMBER`   
Obrigatório: Não

## Consulte também
<a name="API_TimeAlignmentBoundary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeAlignmentBoundary) 

# TimeSeriesCondition
<a name="API_TimeSeriesCondition"></a>

Cria um subconjunto de itens dentro de um atributo que são modificados. Por exemplo, você pode usar essa operação para criar um subconjunto de itens que custam USD 5 ou menos. Para fazer isso, você especifica `"AttributeName": "price"`, `"AttributeValue": "5"` e `"Condition": "LESS_THAN"`. Combine essa operação com a [Action](API_Action.md) operação dentro da TimeSeriesTransformations operação [CreateWhatIfForecast:](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) para definir como o atributo é modificado.

## Conteúdo
<a name="API_TimeSeriesCondition_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-TimeSeriesCondition-AttributeName"></a>
O item\$1id, o nome da dimensão, o nome da mensagem instantânea ou o carimbo de data e hora que você está modificando.  
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_]*`   
Exigido: Sim

 ** AttributeValue **   <a name="forecast-Type-TimeSeriesCondition-AttributeValue"></a>
O valor que é aplicado à `Condition` escolhida.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `.+`   
Exigido: Sim

 ** Condition **   <a name="forecast-Type-TimeSeriesCondition-Condition"></a>
A condição a ser aplicada. Os valores válidos são `EQUALS`, `NOT_EQUALS`, `LESS_THAN` e `GREATER_THAN`.  
Tipo: string  
Valores Válidos: `EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN`   
Exigido: Sim

## Consulte também
<a name="API_TimeSeriesCondition_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesCondition) 

# TimeSeriesIdentifiers
<a name="API_TimeSeriesIdentifiers"></a>

Detalhes sobre o arquivo de importação que contém a série temporal para qual será criado previsões.

## Conteúdo
<a name="API_TimeSeriesIdentifiers_Contents"></a>

 ** DataSource **   <a name="forecast-Type-TimeSeriesIdentifiers-DataSource"></a>
A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite ao Amazon Forecast acessar os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)  
Obrigatório: não

 ** Format **   <a name="forecast-Type-TimeSeriesIdentifiers-Format"></a>
O formato dos dados, seja CSV ou PARQUET.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** Schema **   <a name="forecast-Type-TimeSeriesIdentifiers-Schema"></a>
Define os campos de um conjunto de dados.  
Tipo: objeto [Schema](API_Schema.md)  
Obrigatório: Não

## Consulte também
<a name="API_TimeSeriesIdentifiers_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesIdentifiers) 

# TimeSeriesReplacementsDataSource
<a name="API_TimeSeriesReplacementsDataSource"></a>

Um conjunto de dados de substituição é uma versão modificada da série temporal relacionada à linha de base que contém somente os valores que você deseja incluir em uma previsão de hipóteses. O conjunto de dados de substituição deve conter as dimensões da previsão e os identificadores do item na série temporal relacionada à linha de base, bem como pelo menos uma série temporal alterada. Esse conjunto de dados é mesclado com a série temporal relacionada à linha de base para criar um conjunto de dados transformado usado para a previsão de hipóteses.

## Conteúdo
<a name="API_TimeSeriesReplacementsDataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-S3Config"></a>
O caminho para o (s) arquivo (s) em um bucket do Amazon Simple Storage Service (Amazon S3) e AWS Identity and Access Management uma função (IAM) que o Amazon Forecast pode assumir para acessar o (s) arquivo (s). Opcionalmente, inclui uma chave AWS Key Management Service (KMS). Esse objeto faz parte do objeto [DataSource](API_DataSource.md) enviado na [CreateDatasetImportJob](API_CreateDatasetImportJob.md) solicitação e faz parte do objeto [DataDestination](API_DataDestination.md).  
Tipo: objeto [S3Config](API_S3Config.md)  
Obrigatório: sim

 ** Schema **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Schema"></a>
Define os campos de um conjunto de dados.  
Tipo: objeto [Schema](API_Schema.md)  
Obrigatório: sim

 ** Format **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Format"></a>
O formato dos dados de substituição, que deve ser CSV.  
Tipo: string  
Restrições de Tamanho: O tamanho máximo é 7.  
Padrão: `^CSV|PARQUET$`   
Obrigatório: não

 ** TimestampFormat **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-TimestampFormat"></a>
O formato do carimbo de data e hora dos dados de substituição.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `^[a-zA-Z0-9\-\:\.\,\'\s]+$`   
Obrigatório: Não

## Consulte também
<a name="API_TimeSeriesReplacementsDataSource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 

# TimeSeriesSelector
<a name="API_TimeSeriesSelector"></a>

Define o conjunto de séries temporais usadas para criar as previsões em um objeto `TimeSeriesIdentifiers`.

O objeto `TimeSeriesIdentifiers` deve ter as seguintes informações:
+  `DataSource` 
+  `Format` 
+  `Schema` 

## Conteúdo
<a name="API_TimeSeriesSelector_Contents"></a>

 ** TimeSeriesIdentifiers **   <a name="forecast-Type-TimeSeriesSelector-TimeSeriesIdentifiers"></a>
Detalhes sobre o arquivo de importação que contém a série temporal para qual será criado previsões.  
Tipo: objeto [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md)  
Obrigatório: Não

## Consulte também
<a name="API_TimeSeriesSelector_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesSelector) 

# TimeSeriesTransformation
<a name="API_TimeSeriesTransformation"></a>

Uma função de transformação é um par de operações que selecionam e modificam as linhas em uma série temporal relacionada. Você seleciona as linhas que deseja com uma operação de condição e modifica as linhas com uma operação de transformação. Todas as condições são unidas a uma operação AND, o que significa que todas as condições devem ser verdadeiras para que a transformação seja aplicada. As transformações são aplicadas na ordem em que estão indicadas.

## Conteúdo
<a name="API_TimeSeriesTransformation_Contents"></a>

 ** Action **   <a name="forecast-Type-TimeSeriesTransformation-Action"></a>
Uma matriz de ações que definem uma série temporal e como ela é transformada. Essas transformações criam uma nova série temporal que é usada para a análise de hipóteses.  
Tipo: objeto [Action](API_Action.md)  
Obrigatório: não

 ** TimeSeriesConditions **   <a name="forecast-Type-TimeSeriesTransformation-TimeSeriesConditions"></a>
Uma matriz de condições que definem quais membros da série temporal relacionada são transformados.  
Tipo: matriz de objetos [TimeSeriesCondition](API_TimeSeriesCondition.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.  
Obrigatório: Não

## Consulte também
<a name="API_TimeSeriesTransformation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesTransformation) 

# WeightedQuantileLoss
<a name="API_WeightedQuantileLoss"></a>

O valor da perda ponderada para um quantil. Esse objeto faz parte do objeto [Metrics](API_Metrics.md).

## Conteúdo
<a name="API_WeightedQuantileLoss_Contents"></a>

 ** LossValue **   <a name="forecast-Type-WeightedQuantileLoss-LossValue"></a>
A diferença entre o valor previsto e o valor real sobre o quantil, ponderada (normalizada) pela divisão pela soma de todos os quantis.  
Tipo: duplo  
Obrigatório: não

 ** Quantile **   <a name="forecast-Type-WeightedQuantileLoss-Quantile"></a>
O quantil. Os quantis dividem uma distribuição de probabilidade em regiões de igual probabilidade. Por exemplo, se a distribuição fosse dividida em 5 regiões de igual probabilidade, os quantis seriam 0,2, 0,4, 0,6 e 0,8.  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_WeightedQuantileLoss_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WeightedQuantileLoss) 

# WhatIfAnalysisSummary
<a name="API_WhatIfAnalysisSummary"></a>

Fornece um resumo das propriedades de análise de hipóteses usadas na operação [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md). Para obter o conjunto completo de propriedades, chame a operação [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) e forneça o `WhatIfAnalysisArn` que está indicado no resumo.

## Conteúdo
<a name="API_WhatIfAnalysisSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-CreationTime"></a>
Quando a análise de hipóteses foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** ForecastArn **   <a name="forecast-Type-WhatIfAnalysisSummary-ForecastArn"></a>
O nome do recurso da Amazon (ARN) da previsão da linha de base que está sendo utilizado nessa análise de hipóteses.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-WhatIfAnalysisSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-WhatIfAnalysisSummary-Status"></a>
O status da análise 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 análise de hipóteses deve ser `ACTIVE` para que seja possível acessar a análise.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

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

 ** WhatIfAnalysisName **   <a name="forecast-Type-WhatIfAnalysisSummary-WhatIfAnalysisName"></a>
O nome da análise 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_]*`   
Obrigatório: Não

## Consulte também
<a name="API_WhatIfAnalysisSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfAnalysisSummary) 

# WhatIfForecastExportSummary
<a name="API_WhatIfForecastExportSummary"></a>

Fornece um resumo das propriedades de exportação de previsão de hipóteses usadas na operação [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md). Para obter o conjunto completo de propriedades, chame a operação [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) e forneça o `WhatIfForecastExportArn` indicado no resumo.

## Conteúdo
<a name="API_WhatIfForecastExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-CreationTime"></a>
Quando a exportação de previsão de hipóteses foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** Destination **   <a name="forecast-Type-WhatIfForecastExportSummary-Destination"></a>
O caminho para o bucket do Amazon Simple Storage Service (Amazon S3) para o qual a previsão é exportada.  
Tipo: objeto [DataDestination](API_DataDestination.md)  
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-WhatIfForecastExportSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-WhatIfForecastExportSummary-Status"></a>
O status da exportação de 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 análise de hipóteses deve ser `ACTIVE` para que seja possível acessar a análise.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** WhatIfForecastArns **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastArns"></a>
Uma matriz de nomes de recursos da Amazon (ARNs) que definem as previsões hipotéticas incluídas na exportação.  
Tipo: matriz de strings  
Membros da matriz: número mínimo de 1 item. Número máximo de 50 itens.  
Restrições de tamanho: o tamanho máximo é 300.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** WhatIfForecastExportArn **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportArn"></a>
O nome do recurso da Amazon (ARN) da exportação de previsão de hipóteses.  
Tipo: string  
Comprimentos de tamanho: comprimento máximo de 300.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: não

 ** WhatIfForecastExportName **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportName"></a>
O nome da exportação 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_]*`   
Obrigatório: Não

## Consulte também
<a name="API_WhatIfForecastExportSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastExportSummary) 

# WhatIfForecastSummary
<a name="API_WhatIfForecastSummary"></a>

Fornece um resumo das propriedades de previsão de hipóteses usadas na operação [ListWhatIfForecasts](API_ListWhatIfForecasts.md). Para obter o conjunto completo de propriedades, chame a operação [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) e forneça o `WhatIfForecastArn` que está indicado no resumo.

## Conteúdo
<a name="API_WhatIfForecastSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastSummary-CreationTime"></a>
Quando a previsão de hipóteses foi criada.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastSummary-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  
Obrigatório: não

 ** Message **   <a name="forecast-Type-WhatIfForecastSummary-Message"></a>
Se ocorreu um erro, uma mensagem informativa sobre o erro.  
Tipo: string  
Obrigatório: Não

 ** Status **   <a name="forecast-Type-WhatIfForecastSummary-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 análise de hipóteses deve ser `ACTIVE` para que seja possível acessar a análise.
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

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

 ** WhatIfForecastArn **   <a name="forecast-Type-WhatIfForecastSummary-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:.*:.*:.+`   
Obrigatório: não

 ** WhatIfForecastName **   <a name="forecast-Type-WhatIfForecastSummary-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_]*`   
Obrigatório: Não

## Consulte também
<a name="API_WhatIfForecastSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastSummary) 

# WindowSummary
<a name="API_WindowSummary"></a>

As métricas de um intervalo de tempo na parte de avaliação de um conjunto de dados. Esse objeto faz parte do objeto. [EvaluationResult](API_EvaluationResult.md)

Os parâmetros `TestWindowStart` e `TestWindowEnd` são determinados pelo parâmetro `BackTestWindowOffset` do objeto [EvaluationParameters](API_EvaluationParameters.md). .

## Conteúdo
<a name="API_WindowSummary_Contents"></a>

 ** EvaluationType **   <a name="forecast-Type-WindowSummary-EvaluationType"></a>
O tipo de avaliação.  
+  `SUMMARY`: as métricas médias em todas as janelas.
+  `COMPUTED`: as métricas da janela especificada.
Tipo: string  
Valores Válidos: `SUMMARY | COMPUTED`   
Obrigatório: não

 ** ItemCount **   <a name="forecast-Type-WindowSummary-ItemCount"></a>
O número de pontos de dados na janela.  
Tipo: número inteiro  
Obrigatório: não

 ** Metrics **   <a name="forecast-Type-WindowSummary-Metrics"></a>
Fornece as métricas usadas para avaliar o desempenho de um preditor.  
Tipo: objeto [Metrics](API_Metrics.md)  
Obrigatório: não

 ** TestWindowEnd **   <a name="forecast-Type-WindowSummary-TestWindowEnd"></a>
O carimbo de data e hora que define o final da janela.  
Tipo: carimbo de data/hora  
Obrigatório: não

 ** TestWindowStart **   <a name="forecast-Type-WindowSummary-TestWindowStart"></a>
O carimbo de data e hora que define o início da janela.  
Tipo: carimbo de data/hora  
Obrigatório: Não

## Consulte também
<a name="API_WindowSummary_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WindowSummary) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WindowSummary) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WindowSummary) 

# Amazon Forecast Query Service
<a name="API_Types_Amazon_Forecast_Query_Service"></a>

Os tipos de dados a seguir são compatíveis com o Amazon Forecast Query Service:
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

# DataPoint
<a name="API_forecastquery_DataPoint"></a>

O valor previsto para uma data específica. Parte do objeto [Forecast](API_forecastquery_Forecast.md).

## Conteúdo
<a name="API_forecastquery_DataPoint_Contents"></a>

 ** Timestamp **   <a name="forecast-Type-forecastquery_DataPoint-Timestamp"></a>
A data e hora da previsão específica.  
Tipo: string  
Obrigatório: Não

 ** Value **   <a name="forecast-Type-forecastquery_DataPoint-Value"></a>
O valor da previsão.  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_forecastquery_DataPoint_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/DataPoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/DataPoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/DataPoint) 

# Forecast
<a name="API_forecastquery_Forecast"></a>

Fornece informações sobre uma previsão. Exibidos como parte da resposta [QueryForecast](API_forecastquery_QueryForecast.md).

## Conteúdo
<a name="API_forecastquery_Forecast_Contents"></a>

 ** Predictions **   <a name="forecast-Type-forecastquery_Forecast-Predictions"></a>
A previsão.  
A *string* do string-to-array mapa é um dos seguintes valores:  
+ p10
+ p50
+ p90
A configuração padrão é `["0.1", "0.5", "0.9"]`. Use o `ForecastTypes` parâmetro opcional da [CreateForecast](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html)operação para alterar os valores. Os valores variarão dependendo da definição, com um mínimo de `1` e um máximo de `5.`   
Tipo: string para a matriz do mapa de objetos [DataPoint](API_forecastquery_DataPoint.md)  
Restrições de tamanho de chave: o tamanho máximo é 4.  
Obrigatório: Não

## Consulte também
<a name="API_forecastquery_Forecast_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/Forecast) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/Forecast) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/Forecast) 

# Erros comuns
<a name="CommonErrors"></a>

Esta seção lista os erros comuns às ações de API de todos os AWS serviços. Para saber os erros específicos de uma ação de API para esse serviço, consulte o tópico sobre a ação de API em questão.

 **AccessDeniedException**   
Você não tem acesso suficiente para executar essa ação.  
Código de status HTTP: 400

 **IncompleteSignature**   
A assinatura da solicitação não está em conformidade com os AWS padrões.  
Código de status HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
O processamento da solicitação falhou por causa de um erro, uma exceção ou uma falha desconhecida.  
Código de status HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
A ação ou operação solicitada é inválida. Verifique se a ação foi digitada corretamente.  
Código de status HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
O certificado X.509 ou ID da chave de AWS acesso fornecido não existe em nossos registros.  
Código de status HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Você não tem permissão para realizar esta ação.  
Código de status HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
O ID da chave de AWS acesso precisa de uma assinatura para o serviço.  
Código de status HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
A solicitação chegou ao serviço mais de 15 minutos após o carimbo de data na solicitação ou mais de 15 minutos após a data de expiração da solicitação (como para pré-assinada URLs), ou o carimbo de data na solicitação é mais de 15 minutos no futuro.  
Código de status HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Falha na solicitação devido a um erro temporário do servidor.  
Código de status HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
A solicitação foi negada devido à limitação da solicitação.  
Código de status HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
A entrada não satisfaz as restrições especificadas por um AWS serviço.  
Código de status HTTP: 400

# Parâmetros gerais
<a name="CommonParameters"></a>

A lista a seguir contém os parâmetros que todas as ações usam para assinar solicitações do Signature versão 4 com uma string de consulta. Todos os parâmetros específicos de uma ação são listados no tópico para a ação. Para obter mais informações sobre o Signature versão 4, consulte [Solicitações de AWS API de assinatura](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) no *Guia do usuário do IAM*.

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
O algoritmo de hash que foi usado para criar a assinatura da solicitação.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Valores válidos: `AWS4-HMAC-SHA256`   
Obrigatório: condicional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
O valor de escopo da credencial, uma string que inclui a sua chave de acesso, a data, a região visada, o serviço que está sendo solicitado e uma sequência de encerramento ("aws4\$1request"). O valor é expresso no seguinte formato: *chave\$1acesso*/*AAAAMMDD*/*região*/*serviço*/aws4\$1request.  
Para obter mais informações, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
A data usada para criar a assinatura. O formato deve ser o formato básico ISO 8601 (AAAAMMDD'T'HHMMSS'Z'). Por exemplo, a data e hora a seguir é um X-Amz-Date valor válido:`20120325T120000Z`.  
Condição: X-Amz-Date é opcional para todas as solicitações; ele pode ser usado para substituir a data usada em solicitações de assinatura. Se o cabeçalho da data for especificado no formato básico ISO 8601, não X-Amz-Date é necessário. Quando X-Amz-Date usado, ele sempre substitui o valor do cabeçalho da data. Para obter mais informações, consulte [Elementos de uma assinatura de solicitação de AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) no *Guia do usuário do IAM*.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
O token de segurança temporário obtido por meio de uma chamada para AWS Security Token Service (AWS STS). Para obter uma lista de serviços que oferecem suporte a credenciais de segurança temporárias do AWS STS, consulte [Serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) no *Guia do usuário do IAM*.  
Condição: se você estiver usando credenciais de segurança temporárias do AWS STS, deverá incluir o token de segurança.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Especifica a assinatura com codificação hexadecimal que foi calculada com base na string a ser assinada e na chave de assinatura derivada.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Especifica todos os cabeçalhos HTTP que foram incluídos como parte da solicitação canônica. Para obter mais informações sobre a especificação de cabeçalhos assinados, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no Guia do *usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional