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

# 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)