

 Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# API 參考
<a name="api-reference"></a>

本節提供 Amazon Forecast API 操作的文件。

**Topics**
+ [動作](API_Operations.md)
+ [資料類型](API_Types.md)
+ [常見錯誤](CommonErrors.md)
+ [常見參數](CommonParameters.md)

# 動作
<a name="API_Operations"></a>

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) 

Amazon Forecast Query Service 支援下列動作：
+  [QueryForecast](API_forecastquery_QueryForecast.md) 
+  [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) 

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

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>

建立 Amazon Forecast 預測器。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

Amazon Forecast 會使用 AutoPredictor 建立預測器，這涉及將演算法的最佳組合套用至資料集中的每個時間序列。您可以使用 [CreateAutoPredictor](#API_CreateAutoPredictor)建立新的預測器或升級/重新訓練現有的預測器。

 **建立新的預測器** 

建立新預測器時需要下列參數：
+  `PredictorName` - 預測器的唯一名稱。
+  `DatasetGroupArn` - 用來訓練預測器之資料集群組的 ARN。
+  `ForecastFrequency` - 預測的精細程度 （每小時、每日、每週等）。
+  `ForecastHorizon` - 模型預測的時間步驟數目。預測期間也稱為預測長度。

建立新的預測器時，請勿指定 的值`ReferencePredictorArn`。

 **升級和重新訓練預測器** 

重新訓練或升級預測器時，需要下列參數：
+  `PredictorName` - 預測器的唯一名稱。
+  `ReferencePredictorArn` - 要重新訓練或升級之預測器的 ARN。

升級或重新訓練預測器時，請僅指定 `ReferencePredictorArn`和 的值`PredictorName`。

## 請求語法
<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"
   }
}
```

## 請求參數
<a name="API_CreateAutoPredictor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-DataConfig"></a>
資料集群組和任何其他資料集的資料組態。  
類型：[DataConfig](API_DataConfig.md) 物件  
必要：否

 ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色，以存取金鑰。您可以在 [CreateDataset](API_CreateDataset.md)和 [CreatePredictor](API_CreatePredictor.md)請求中指定此選用物件。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件  
必要：否

 ** [ExplainPredictor](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ExplainPredictor"></a>
為預測器建立可解釋性資源。  
類型：布林值  
必要：否

 ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastDimensions"></a>
維度 （欄位） 名稱陣列，指定如何將產生的預測分組。  
例如，如果您要在所有商店中產生項目銷售的預測，且資料集包含 `store_id` 欄位，則您可以指定 `store_id`做為維度，以將每個商店的銷售預測分組。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 10。  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastFrequency"></a>
預測中的預測頻率。  
有效間隔為整數，後跟 Y (年)、M (月)、W (週)、D (天)、H (小時) 和 min (分鐘)。例如，"1D" 表示每隔一天，"15min" 表示每隔 15 分鐘。您無法指定會與下一個較大頻率重疊的值。例如，這意味著您不能指定頻率為 60 分鐘，因為這相當於 1 小時。每個頻率的有效值如下：  
+ 分鐘–1-59
+ 小時–1-23
+ 天–1-6
+ 週–1-4
+ 月–1-11
+ 年 – 1
因此，如果您希望每兩週預測一次，請指定 "2W"。或者，如果您希望每季度預測一次，請指定 "3M"。  
頻率必須大於或等於 TARGET\$1TIME\$1SERIES 資料集頻率。  
提供 RELATED\$1TIME\$1SERIES 資料集時，頻率必須等於 RELATED\$1TIME\$1SERIES 資料集頻率。  
類型：字串  
長度限制：長度下限為 1。長度上限為 5。  
模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$`  
必要：否

 ** [ForecastHorizon](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastHorizon"></a>
模型預測的時間步驟數目。預測期間也稱為預測長度。  
最大預測期間是 500 個時間步驟或 TARGET\$1TIME\$1SERIES 資料集長度的 1/4。如果您要重新訓練現有的 AutoPredictor，則最大預測期間為 500 個時間步驟或 TARGET\$1TIME\$1SERIES 資料集長度的 1/3。  
如果您要升級至 AutoPredictor 或重新訓練現有的 AutoPredictor，則無法更新預測期間參數。您可以在資料集中提供較長的時間序列，以滿足此要求。  
類型：整數  
必要：否

 ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ForecastTypes"></a>
用來訓練預測器的預測類型。您最多可以指定五種預測類型。預測類型可以是 0.01 到 0.99 之間的分位數，增量單位為 0.01 或更高。您也可以使用 指定平均預測`mean`。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`  
必要：否

 ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-MonitorConfig"></a>
預測器監控的組態詳細資訊。提供監視器資源的名稱，以啟用預測器監控。  
預測器監控可讓您查看預測器的效能如何隨時間變化。如需詳細資訊，請參閱[預測器監控](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html)。  
類型：[MonitorConfig](API_MonitorConfig.md) 物件  
必要：否

 ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-OptimizationMetric"></a>
用於最佳化預測器的準確度指標。  
類型：字串  
有效值:`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
必要：否

 ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-PredictorName"></a>
預測器的唯一名稱  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-ReferencePredictorArn"></a>
要重新訓練或升級之預測器的 ARN。只有在重新訓練或升級預測器時，才會使用此參數。建立新的預測器時，請勿為此參數指定值。  
升級或重新訓練預測器時，請僅指定 `ReferencePredictorArn`和 的值`PredictorName`。的值`PredictorName`必須是唯一的預測器名稱。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** [Tags](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-Tags"></a>
選用中繼資料，可協助您分類和整理預測器。每個標籤皆包含由您定義的一個金鑰與一個選用值。標籤鍵與值皆區分大小寫。  
以下限制適用於標籤：  
+ 對於每個資源，每個標籤索引鍵必須是唯一的，而且每個標籤索引鍵都必須有一個值。
+ 每個資源的標籤數量上限：50。
+ 金鑰長度上限：UTF-8 128 個 Unicode 字元。
+ 最大值長度：UTF-8 256 個 Unicode 字元。
+ 接受的字元：所有字母和數字、以 UTF-8 表示的空格，以及 \$1 - = 。\$1 ：/ @。 如果您的標記結構描述用於其他 服務和資源，則這些服務的角色限制也適用。
+ 金鑰字首不能包含 或 的任何大寫`aws:`或小寫組合`AWS:`。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但索引鍵沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。您無法使用此字首編輯或刪除標籤索引鍵。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-TimeAlignmentBoundary"></a>
時間界限 Forecast 使用 來對齊和彙總任何不符合預測頻率的資料。以鍵值對形式提供時間和時間界限的單位。如需指定時間界限的詳細資訊，請參閱[指定時間界限](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary)。如果您未提供時間界限，預測會使用一組[預設時間界限](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries)。  
類型：[TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 物件  
必要：否

## 回應語法
<a name="API_CreateAutoPredictor_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateAutoPredictor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) **   <a name="forecast-CreateAutoPredictor-response-PredictorArn"></a>
預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateAutoPredictor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateAutoPredictor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateAutoPredictor) 

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

建立 Amazon Forecast 資料集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您提供的資料集相關資訊有助於 Forecast 了解如何使用資料進行模型訓練。這包含下列項目：
+  * `DataFrequency` * – 收集歷史時間序列資料的頻率。
+  * `Domain` * 和 * `DatasetType` * – 每個資料集都有網域內相關聯的資料集網域和類型。Amazon Forecast 提供每個網域內預先定義的網域和類型的清單。針對網域內每個唯一的資料集網域和類型，Amazon Forecast 要求資料包含最基本的一組預先定義欄位。
+  * `Schema` * – 結構描述指定資料集中的欄位，包括欄位名稱和資料類型。

建立資料集之後，您將訓練資料匯入至其中並將資料集新增至資料集群組。您可以使用資料集群組來建立預測器。如需詳細資訊，請參閱[匯入資料集](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。

若要取得您所有資料集的清單，請使用 [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) 操作。

如需 Forecast 資料集範例，請參閱 [Amazon Forecast 範例 GitHub 儲存庫](https://github.com/aws-samples/amazon-forecast-samples)。

**注意**  
資料集 `Status` 的必須是 `ACTIVE`，然後您才能匯入訓練資料。若要取得狀態，請使用 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作。

## 請求語法
<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"
      }
   ]
}
```

## 請求參數
<a name="API_CreateDataset_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DataFrequency](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DataFrequency"></a>
資料收集的頻率。RELATED\$1TIME\$1SERIES 資料集需要此參數。  
有效間隔為整數，後跟 Y (年)、M (月)、W (週)、D (天)、H (小時) 和 min (分鐘)。例如，"1D" 表示每隔一天，"15min" 表示每隔 15 分鐘。您無法指定會與下一個較大頻率重疊的值。例如，這意味著您不能指定頻率為 60 分鐘，因為這相當於 1 小時。每個頻率的有效值如下：  
+ 分鐘–1-59
+ 小時–1-23
+ 天–1-6
+ 週–1-4
+ 月–1-11
+ 年 – 1
因此，如果您希望每兩週預測一次，請指定 "2W"。或者，如果您希望每季度預測一次，請指定 "3M"。  
類型：字串  
長度限制：長度下限為 1。長度上限為 5。  
模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$`  
必要：否

 ** [DatasetName](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetName"></a>
資料集的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [DatasetType](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-DatasetType"></a>
資料集類型。有效值取決於選擇的 `Domain`。  
類型：字串  
有效值:`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
必要：是

 ** [Domain](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Domain"></a>
與資料集相關聯的網域。當您將資料集新增至資料集群組時，此值和為 [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 操作的 `Domain` 參數指定的值必須相符。  
`DatasetType` 您選擇的 `Domain`和 會決定您匯入資料集的訓練資料中必須存在的欄位。例如，如果您選擇`RETAIL`網域 和 `TARGET_TIME_SERIES`作為 `DatasetType`，Amazon Forecast 需要 `item_id`、 `timestamp`和 `demand` 欄位存在於您的資料中。如需詳細資訊，請參閱[匯入資料集](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。  
類型：字串  
有效值:`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
必要：是

 ** [EncryptionConfig](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件  
必要：否

 ** [Schema](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Schema"></a>
資料集的結構描述。結構描述屬性及其順序必須與資料中的欄位相符。您所選的資料集 `Domain` 和 `DatasetType` 決定了訓練資料中最基本的必要欄位。如需有關特定資料集網域和類型的必要欄位的資訊，請參閱[資料集網域和資料集類型](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)。  
類型：[Schema](API_Schema.md) 物件  
必要：是

 ** [Tags](#API_CreateDataset_RequestSyntax) **   <a name="forecast-CreateDataset-request-Tags"></a>
您套用至資料集的選用中繼資料，可協助您分類和組織這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateDataset_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateDataset_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="forecast-CreateDataset-response-DatasetArn"></a>
資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateDataset_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDataset_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDataset) 

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

建立資料集群組，其中包含一組相關資料集。在建立資料集群組時或稍後透過使用 [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) 操作，您可以將資料集新增至資料集群組。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

建立資料集群組並為其新增資料集後，您可以在建立預測器的時候使用資料集群組。如需詳細資訊，請參閱[資料集群組](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。

若要取得您所有資料集群組的清單，請使用 [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) 操作。

**注意**  
如需使用資料集群組建立預測器，資料集群組的 `Status` 必須為 `ACTIVE`。若要取得狀態，請使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作。

## 請求語法
<a name="API_CreateDatasetGroup_RequestSyntax"></a>

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

## 請求參數
<a name="API_CreateDatasetGroup_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetArns"></a>
您要包含在資料集群組中的資料集的 Amazon Resource Name (ARN) 陣列。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-DatasetGroupName"></a>
資料集群組的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [Domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Domain"></a>
與資料集群組相關聯的網域。將資料集新增至資料集群組時，此值必須與為 [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 操作的 `Domain` 參數指定的值相符。  
您所選的 `Domain` 和 `DatasetType` 決定了哪些欄位必須存在於您匯入至資料集的訓練資料中。例如，如果您選擇 `RETAIL` 網域和 `TARGET_TIME_SERIES` 作為 `DatasetType`，Amazon Forecast 要求 `item_id`、`timestamp` 以及 `demand` 欄位存在於您的資料中。如需詳細資訊，請參閱[資料集群組](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。  
類型：字串  
有效值:`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
必要：是

 ** [Tags](#API_CreateDatasetGroup_RequestSyntax) **   <a name="forecast-CreateDatasetGroup-request-Tags"></a>
您套用至資料集群組的選用中繼資料，可協助您分類和組織這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateDatasetGroup_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateDatasetGroup_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="forecast-CreateDatasetGroup-response-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateDatasetGroup_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDatasetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup) 

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

將您的訓練資料匯入 Amazon Forecast 資料集。您可以在 Amazon Simple Storage Service (Amazon S3) 儲存貯體中提供訓練資料的位置，以及您要匯入資料的資料集的 Amazon Resource Name (ARN)。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您必須指定 [DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) 物件，其中包含 Amazon Forecast 可以擔任的 AWS Identity and Access Management (IAM) 角色來存取資料，因為 Amazon Forecast 會複製您的資料並在內部 AWS 系統中處理資料。如需詳細資訊，請參閱[設定許可](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html)。

訓練資料必須是 CSV 或 Parquet 格式。分隔符號必須是逗號 (，)。

您可以指定特定檔案、S3 儲存貯體或 S3 儲存貯體中資料夾的路徑。對於後兩種情況，Amazon Forecast 會匯入所有檔案，上限為 10，000 個檔案。

由於資料集匯入不會彙總，因此您最近的資料集匯入是在訓練預測器或產生預測時使用的資料集匯入。請確定您最近的資料集匯入包含您想要建模的所有資料，而不只是自上次匯入以來所收集的新資料。

若要取得依指定條件篩選的所有資料集匯入任務清單，請使用 [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) 操作。

## 請求語法
<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
}
```

## 請求參數
<a name="API_CreateDatasetImportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetArn"></a>
您要匯入資料的 Amazon Forecast 資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DatasetImportJobName"></a>
資料集匯入任務的名稱。我們建議您在名稱中包含目前的時間戳記，例如 `20190721DatasetImport`。這可協助您避免取得`ResourceAlreadyExistsException`例外狀況。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-DataSource"></a>
要匯入的訓練資料位置和 AWS Identity and Access Management (IAM) 角色，Amazon Forecast 可以擔任該角色來存取資料。訓練資料必須存放在 Amazon S3 儲存貯體中。  
如果使用加密， `DataSource` 必須包含 AWS Key Management Service (KMS) 金鑰，且 IAM 角色必須允許 Amazon Forecast 許可存取金鑰。KMS 金鑰和 IAM 角色必須符合 [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 操作的 `EncryptionConfig` 參數中指定的金鑰和 IAM 角色。  
類型：[DataSource](API_DataSource.md) 物件  
必要：是

 ** [Format](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Format"></a>
匯入資料的格式，CSV 或 PARQUET。預設值為 CSV。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-GeolocationFormat"></a>
地理位置屬性的格式。地理位置屬性的格式有兩種：  
+  `LAT_LONG` - 十進位格式的緯度和經度 （範例：47.61\$1-122.33)。
+  `CC_POSTALCODE` （僅限美國） - 國家/地區碼 （美國），後面接著 5 位數郵遞區號 （範例：US\$198121)。
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9_]+$`  
必要：否

 ** [ImportMode](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-ImportMode"></a>
指定資料集匯入任務是 `FULL`還是 `INCREMENTAL`匯入。`FULL` 資料集匯入會將所有現有資料取代為新匯入的資料。`INCREMENTAL` 匯入會將匯入的資料附加至現有資料。  
類型：字串  
有效值:`FULL | INCREMENTAL`   
必要：否

 ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-Tags"></a>
您套用至資料集匯入任務的選用中繼資料，可協助您分類和組織這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TimestampFormat](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimestampFormat"></a>
資料集中的時間戳記格式。您指定的格式取決於建立資料集時`DataFrequency`指定的 。支援下列格式  
+ "yyyy-MM-dd"

  對於下列資料頻率：Y、M、W 和 D
+ "yyyy-MM-dd HH:mm:ss"

  對於下列資料頻率：H、30 分鐘、15 分鐘和 1 分鐘；以及選擇性：Y、M、W 和 D
如果未指定格式，Amazon Forecast 預期格式為 "yyyy-MM-dd HH：mm：ss"。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\-\:\.\,\'\s]+$`  
必要：否

 ** [TimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-TimeZone"></a>
資料集中每個項目的單一時區。此選項非常適合具有單一時區內所有時間戳記的資料集，或將所有時間戳記標準化為單一時區。  
如需有效時區名稱的完整清單，請參閱 [Joda-Time API](http://joda-time.sourceforge.net/timezones.html)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\/\+\-\_]+$`  
必要：否

 ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="forecast-CreateDatasetImportJob-request-UseGeolocationForTimeZone"></a>
從地理位置屬性自動衍生時區資訊。此選項適用於在多個時區包含時間戳記的資料集，這些時間戳記以本機時間表示。  
類型：布林值  
必要：否

## 回應語法
<a name="API_CreateDatasetImportJob_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateDatasetImportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="forecast-CreateDatasetImportJob-response-DatasetImportJobArn"></a>
資料集匯入任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDatasetImportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) 

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

**注意**  
可解釋性僅適用於從 AutoPredictor 產生的預測和預測器 ([CreateAutoPredictor](API_CreateAutoPredictor.md))

建立 Amazon Forecast 可解釋性。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

可解釋性可協助您更加了解資料集中的屬性如何影響預測。Amazon Forecast 使用稱為影響分數的指標來量化每個屬性的相對影響，並判斷它們是否增加或減少預測值。

若要啟用預測可解釋性，您的預測器必須至少包含下列其中一項：相關時間序列、項目中繼資料或假日和天氣索引等其他資料集。

**注意**  
ARIMA (AutoRegressive移動平均值）、ETS （指數平滑狀態空間模型） 和 NPTS （非參數時間序列） 模型不包含外部時間序列資料。因此，即使您包含其他資料集，這些模型也不會建立可解釋性報告。

CreateExplainability 接受預測器 ARN 或預測 ARN。若要接收資料集中所有時間序列和時間點的彙總影響分數，請提供預測器 ARN。若要接收特定時間序列和時間點的影響分數，請提供預測 ARN。

 **使用預測器 ARN CreateExplainability ** 

**注意**  
每個預測器只能有一個可解釋性資源。如果您已`ExplainPredictor`在 中啟用 [CreateAutoPredictor](API_CreateAutoPredictor.md)，則該預測器已有可解釋性資源。

提供預測器 ARN 時，需要下列參數：
+  `ExplainabilityName` - 可解釋性的唯一名稱。
+  `ResourceArn` - 預測器的 Arn。
+  `TimePointGranularity` - 必須設定為「ALL」。
+  `TimeSeriesGranularity` - 必須設定為「ALL」。

請勿指定下列參數的值：
+  `DataSource` - 僅在 TimeSeriesGranularity 為「SPECIFIC」時才有效。
+  `Schema` - 僅在 TimeSeriesGranularity 為「SPECIFIC」時才有效。
+  `StartDateTime` - 僅在 TimePointGranularity 為「SPECIFIC」時才有效。
+  `EndDateTime` - 僅在 TimePointGranularity 為「SPECIFIC」時才有效。

 **CreateExplainability 與預測 ARN** 

**注意**  
您最多可以指定 50 個時間序列和 500 個時間點。

提供預測器 ARN 時，需要下列參數：
+  `ExplainabilityName` - 可解釋性的唯一名稱。
+  `ResourceArn` - 預測的 Arn。
+  `TimePointGranularity` -「ALL」或「指定」。
+  `TimeSeriesGranularity` -「ALL」或「指定」。

如果您將 TimeSeriesGranularity 設定為「SPECIFIC」，您還必須提供下列項目：
+  `DataSource` - 指定時間序列的 CSV 檔案的 S3 位置。
+  `Schema` - 結構描述定義資料來源中列出的屬性和屬性類型。

如果您將 TimePointGranularity 設定為「SPECIFIC」，您還必須提供下列項目：
+  `StartDateTime` - 時間點範圍內的第一個時間戳記。
+  `EndDateTime` - 時間點範圍內的最後一個時間戳記。

## 請求語法
<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"
      }
   ]
}
```

## 請求參數
<a name="API_CreateExplainability_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DataSource](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-DataSource"></a>
資料來源，允許 Amazon Forecast 存取資料的 AWS Identity and Access Management (IAM) 角色，以及選擇性的 AWS Key Management Service (KMS) 金鑰。  
類型：[DataSource](API_DataSource.md) 物件  
必要：否

 ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EnableVisualization"></a>
建立可在 AWS 主控台中檢視的可解釋性視覺化。  
類型：布林值  
必要：否

 ** [EndDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EndDateTime"></a>
如果 `TimePointGranularity` 設定為 `SPECIFIC`，請定義可解釋性的最後時間點。  
使用以下時間戳記格式：yyyy-MM-ddTHH：mm：ss （範例：2015-01-01T20：00：00)  
類型：字串  
長度限制：長度上限為 19。  
模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`  
必要：否

 ** [ExplainabilityConfig](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityConfig"></a>
定義可解釋性之時間序列和時間點精細性的組態設定。  
類型：[ExplainabilityConfig](API_ExplainabilityConfig.md) 物件  
必要：是

 ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityName"></a>
可解釋性的唯一名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [ResourceArn](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ResourceArn"></a>
用於建立可解釋性的預測器或預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [Schema](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Schema"></a>
定義資料集的欄位。  
類型：[Schema](API_Schema.md) 物件  
必要：否

 ** [StartDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-StartDateTime"></a>
如果 `TimePointGranularity` 設定為 `SPECIFIC`，請定義可解釋性的第一個點。  
使用以下時間戳記格式：yyyy-MM-ddTHH：mm：ss （範例：2015-01-01T20：00：00)  
類型：字串  
長度限制：長度上限為 19。  
模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`  
必要：否

 ** [Tags](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-Tags"></a>
選用中繼資料，協助您分類和整理資源。每個標籤皆包含由您定義的一個金鑰與一個選用值。標籤鍵與值皆區分大小寫。  
以下限制適用於標籤：  
+ 對於每個資源，每個標籤索引鍵必須是唯一的，而且每個標籤索引鍵都必須有一個值。
+ 每個資源的標籤數量上限：50。
+ 金鑰長度上限：UTF-8 128 個 Unicode 字元。
+ 最大值長度：UTF-8 256 個 Unicode 字元。
+ 接受的字元：所有字母和數字、以 UTF-8 表示的空格，以及 \$1 - = 。\$1 ：/ @。 如果您的標記結構描述用於其他 服務和資源，則這些服務的角色限制也適用。
+ 金鑰字首不能包含 或 的任何大寫`aws:`或小寫組合`AWS:`。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但索引鍵沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。您無法使用此字首編輯或刪除標籤索引鍵。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateExplainability_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateExplainability_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) **   <a name="forecast-CreateExplainability-response-ExplainabilityArn"></a>
可解釋性的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateExplainability_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateExplainability_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) 

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

匯出 [CreateExplainability](API_CreateExplainability.md)操作建立的可解釋性資源。匯出的檔案會匯出至 Amazon Simple Storage Service (Amazon S3) 儲存貯體。

您必須指定包含 Amazon S3 儲存貯體和 AWS Identity and Access Management (IAM) 角色的[DataDestination](API_DataDestination.md)物件，Amazon Forecast 可以擔任該角色來存取 Amazon S3 儲存貯體。如需詳細資訊，請參閱[設定 Amazon Forecast 的許可](aws-forecast-iam-roles.md)。

**注意**  
匯出任務`Status`的 必須是 `ACTIVE`，您才能存取 Amazon S3 儲存貯體中的匯出。若要取得 狀態，請使用 [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md)操作。

## 請求語法
<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"
      }
   ]
}
```

## 請求參數
<a name="API_CreateExplainabilityExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：是

 ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityArn"></a>
可匯出性解釋的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityExportName"></a>
可解釋性匯出的唯一名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [Format](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-Tags"></a>
選用中繼資料，協助您分類和整理資源。每個標籤皆包含由您定義的一個金鑰與一個選用值。標籤鍵與值皆區分大小寫。  
以下限制適用於標籤：  
+ 對於每個資源，每個標籤索引鍵必須是唯一的，而且每個標籤索引鍵都必須有一個值。
+ 每個資源的標籤數量上限：50。
+ 金鑰長度上限：UTF-8 128 個 Unicode 字元。
+ 最大值長度：UTF-8 256 個 Unicode 字元。
+ 接受的字元：所有字母和數字、以 UTF-8 表示的空格，以及 \$1 - = 。\$1 ：/ @。 如果您的標記結構描述用於其他 服務和資源，則這些服務的角色限制也適用。
+ 金鑰字首不能包含 或 的任何大寫`aws:`或小寫組合`AWS:`。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但索引鍵沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。您無法使用此字首編輯或刪除標籤索引鍵。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateExplainabilityExport_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateExplainabilityExport_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) **   <a name="forecast-CreateExplainabilityExport-response-ExplainabilityExportArn"></a>
匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateExplainabilityExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateExplainabilityExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainabilityExport) 

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

為用於訓練預測器的`TARGET_TIME_SERIES`資料集中的每個項目建立預測。這稱為推論。若要以低延遲擷取單一項目的預測，請使用 [QueryForecast](API_forecastquery_QueryForecast.md)操作。若要將完整預測匯出至 Amazon Simple Storage Service (Amazon S3) 儲存貯體，請使用 [CreateForecastExportJob](API_CreateForecastExportJob.md)操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

預測的範圍取決於您在[CreatePredictor](API_CreatePredictor.md)請求中指定的`ForecastHorizon`值。當您查詢預測時，您可以在預測中請求特定的日期範圍。

若要取得所有預測的清單，請使用 [ListForecasts](API_ListForecasts.md)操作。

**注意**  
Amazon Forecast 產生的預測與用來建立預測器的資料集位於相同的時區。

如需詳細資訊，請參閱[產生預測](howitworks-forecast.md)。

**注意**  
預測`Status`的 必須在您可以查詢或匯出預測`ACTIVE`之前。使用 [DescribeForecast](API_DescribeForecast.md) 操作來取得狀態。

根據預設，預測包含用於訓練預測器之資料集群組中每個項目 (`item_id`) 的預測。不過，您可以使用 `TimeSeriesSelector` 物件來產生對時間序列子集的預測。對於您指定的不在輸入資料集中的任何時間序列，會略過預測建立。預測匯出檔案不會包含這些時間序列或其預測值。

## 請求語法
<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"
               }
            ]
         }
      }
   }
}
```

## 請求參數
<a name="API_CreateForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastName](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastName"></a>
預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [ForecastTypes](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-ForecastTypes"></a>
產生機率預測的分位數。**目前每個預測最多可以指定 5 個分位數**。接受的值包括 `0.01 to 0.99`（僅限 .01 的增量） 和 `mean`。當分佈非對稱時 （例如 Beta 和負二項式），平均預測與中位數 (0.50) 不同。  
預設分位數是您在預測器建立期間指定的分位數。如果您未指定分位數，預設值為 `["0.1", "0.5", "0.9"]`。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`  
必要：否

 ** [PredictorArn](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-PredictorArn"></a>
用來產生預測的預測器 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [Tags](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-Tags"></a>
您套用至預測的選用中繼資料，可協助您分類和組織這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TimeSeriesSelector](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-TimeSeriesSelector"></a>
定義用來在`TimeSeriesIdentifiers`物件中建立預測的一組時間序列。  
`TimeSeriesIdentifiers` 物件需要下列資訊：  
+  `DataSource` 
+  `Format` 
+  `Schema` 
類型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 物件  
必要：否

## 回應語法
<a name="API_CreateForecast_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ForecastArn](#API_CreateForecast_ResponseSyntax) **   <a name="forecast-CreateForecast-response-ForecastArn"></a>
預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast) 

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

將 [CreateForecast](API_CreateForecast.md)操作建立的預測匯出至 Amazon Simple Storage Service (Amazon S3) 儲存貯體。預測檔案名稱將符合下列慣例：

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

其中 <ExportTimestamp> 元件位於 Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ) 中。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您必須指定包含 (IAM) 角色的[DataDestination](API_DataDestination.md) AWS Identity and Access Management 物件，Amazon Forecast 可以擔任該角色來存取 Amazon S3 儲存貯體。如需詳細資訊，請參閱[設定 Amazon Forecast 的許可](aws-forecast-iam-roles.md)。

如需詳細資訊，請參閱[產生預測](howitworks-forecast.md)。

若要取得所有預測匯出任務的清單，請使用 [ListForecastExportJobs](API_ListForecastExportJobs.md)操作。

**注意**  
預測匯出任務`Status`的 必須是 `ACTIVE`，您才能存取 Amazon S3 儲存貯體中的預測。若要取得 狀態，請使用 [DescribeForecastExportJob](API_DescribeForecastExportJob.md)操作。

## 請求語法
<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"
      }
   ]
}
```

## 請求參數
<a name="API_CreateForecastExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Destination](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Destination"></a>
您要儲存預測的位置，以及 Amazon Forecast 可以擔任以存取該位置的 AWS Identity and Access Management (IAM) 角色。預測必須匯出至 Amazon S3 儲存貯體。  
如果使用加密， `Destination` 必須包含 AWS Key Management Service (KMS) 金鑰。IAM 角色必須允許 Amazon Forecast 許可存取金鑰。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：是

 ** [ForecastArn](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastArn"></a>
您要匯出之預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastExportJobName"></a>
預測匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [Format](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Format"></a>
匯出資料的格式，CSV 或 PARQUET。預設值為 CSV。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** [Tags](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-Tags"></a>
您套用至預測匯出任務的選用中繼資料，可協助您分類和組織這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateForecastExportJob_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateForecastExportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) **   <a name="forecast-CreateForecastExportJob-response-ForecastExportJobArn"></a>
匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateForecastExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateForecastExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) 

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

為現有的自動預測器建立預測器監控資源。預測器監控可讓您查看預測器的效能如何隨時間變化。如需詳細資訊，請參閱[預測器監控](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html)。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_CreateMonitor_RequestSyntax"></a>

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

## 請求參數
<a name="API_CreateMonitor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [MonitorName](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-MonitorName"></a>
監控資源的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [ResourceArn](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-ResourceArn"></a>
要監控之預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [Tags](#API_CreateMonitor_RequestSyntax) **   <a name="forecast-CreateMonitor-request-Tags"></a>
要套用至監視器資源的[標籤](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)清單。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreateMonitor_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateMonitor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) **   <a name="forecast-CreateMonitor-response-MonitorArn"></a>
監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateMonitor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateMonitor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateMonitor) 

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

**注意**  
 此操作會建立舊版預測器，其中不包含 Amazon Forecast 提供的所有預測器功能。若要建立與 Forecast 所有層面相容的預測器，請使用 [CreateAutoPredictor](API_CreateAutoPredictor.md)。

建立 Amazon Forecast 預測器。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

在請求中，提供資料集群組，並指定演算法，或讓 Amazon Forecast 使用 AutoML 為您選擇演算法。如果您指定演算法，也可以覆寫演算法特定的超參數。

Amazon Forecast 使用演算法，在指定的資料集群組中使用最新版本的資料集來訓練預測器。然後，您可以使用 [CreateForecast](API_CreateForecast.md)操作產生預測。

 若要查看評估指標，請使用 [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 操作。

您可以指定特徵化組態來填充和彙總`TARGET_TIME_SERIES`資料集中的資料欄位，以改善模型訓練。如需詳細資訊，請參閱[FeaturizationConfig](API_FeaturizationConfig.md)。

對於 RELATED\$1TIME\$1SERIES 資料集， `CreatePredictor` 會驗證建立資料集時`DataFrequency`指定的 是否與 相符`ForecastFrequency`。TARGET\$1TIME\$1SERIES 資料集沒有此限制。Amazon Forecast 也會驗證分隔符號和時間戳記格式。如需詳細資訊，請參閱[匯入資料集](howitworks-datasets-groups.md)。

根據預設，預測器會在 0.1 (P10)、0.5 (P50) 和 0.9 (P90) 分位數進行訓練和評估。您可以透過設定 來選擇自訂預測類型來訓練和評估您的預測器`ForecastTypes`。

 **AutoML** 

如果您希望 Amazon Forecast 評估每個演算法，並選擇將 最小化的演算法`objective function`，請將 `PerformAutoML`設定為 `true`。`objective function` 定義為預測類型加權損失的平均值。根據預設，這些是 p10、p50 和 p90 分位數損失。如需詳細資訊，請參閱[EvaluationResult](API_EvaluationResult.md)。

啟用 AutoML 時，不允許下列屬性：
+  `AlgorithmArn` 
+  `HPOConfig` 
+  `PerformHPO` 
+  `TrainingParameters` 

若要取得所有預測器的清單，請使用 [ListPredictors](API_ListPredictors.md)操作。

**注意**  
在您可以使用預測器建立預測之前，預測器`Status`的 必須是 `ACTIVE`，表示訓練已完成。若要取得 狀態，請使用 [DescribePredictor](API_DescribePredictor.md)操作。

## 請求語法
<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" 
   }
}
```

## 請求參數
<a name="API_CreatePredictor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AlgorithmArn"></a>
用於模型訓練的演算法 Amazon Resource Name (ARN)。如果 `PerformAutoML` 未設定為 ，則為必要`true`。  

**支援的演算法：**
+  `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` 
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-AutoMLOverrideStrategy"></a>
 `LatencyOptimized` AutoML 覆寫策略僅適用於私有 Beta 版。請聯絡 AWS Support 或您的客戶經理，以進一步了解 存取權限。
用來覆寫預設 AutoML 策略，也就是最佳化預測器準確度。若要套用可將訓練時間降至最低的 AutoML 策略，請使用 `LatencyOptimized`。  
此參數僅適用於使用 AutoML 訓練的預測器。  
類型：字串  
有效值:`LatencyOptimized | AccuracyOptimized`   
必要：否

 ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件  
必要：否

 ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-EvaluationParameters"></a>
用來覆寫指定演算法的預設評估參數。Amazon Forecast 透過將資料集分割為訓練資料和測試資料來評估預測器。評估參數定義如何執行分割和反覆運算的數量。  
類型：[EvaluationParameters](API_EvaluationParameters.md) 物件  
必要：否

 ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-FeaturizationConfig"></a>
特徵化組態。  
類型：[FeaturizationConfig](API_FeaturizationConfig.md) 物件  
必要：是

 ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastHorizon"></a>
指定要訓練模型預測的時間步驟數目。預測期間也稱為預測長度。  
例如，如果您為每日資料收集設定資料集 （使用 [CreateDataset](API_CreateDataset.md)操作的 `DataFrequency` 參數），並將預測期間設定為 10，則模型會傳回預測 10 天。  
最大預測期間是 500 個時間步驟或 TARGET\$1TIME\$1SERIES 資料集長度的 1/3。  
類型：整數  
必要：是

 ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-ForecastTypes"></a>
指定用於訓練預測器的預測類型。您最多可以指定五種預測類型。預測類型可以是 0.01 到 0.99 之間的分位數，增量單位為 0.01 或更高。您也可以使用 指定平均預測`mean`。  
預設值為 `["0.10", "0.50", "0.9"]`。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`  
必要：否

 ** [HPOConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-HPOConfig"></a>
提供演算法的超參數覆寫值。如果您未提供此參數，Amazon Forecast 會使用預設值。個別演算法會指定哪些超參數支援超參數最佳化 (HPO)。如需詳細資訊，請參閱[Amazon Forecast 演算法](aws-forecast-choosing-recipes.md)。  
如果您包含 `HPOConfig` 物件，則必須`PerformHPO`將 設定為 true。  
類型：[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 物件  
必要：否

 ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-InputDataConfig"></a>
描述資料集群組，其中包含用於訓練預測器的資料。  
類型：[InputDataConfig](API_InputDataConfig.md) 物件  
必要：是

 ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-OptimizationMetric"></a>
用於最佳化預測器的準確度指標。預設值為 `AverageWeightedQuantileLoss`。  
類型：字串  
有效值:`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`   
必要：否

 ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformAutoML"></a>
是否執行 AutoML。當 Amazon Forecast 執行 AutoML 時，它會評估其提供的演算法，並為訓練資料集選擇最佳演算法和組態。  
預設值為 `false`。在這種情況下，您需要指定演算法。  
`PerformAutoML` 設定為 `true`讓 Amazon Forecast 執行 AutoML。如果您不確定哪種演算法適合您的訓練資料，這是不錯的選擇。在此情況下， `PerformHPO` 必須為 false。  
類型：布林值  
必要：否

 ** [PerformHPO](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PerformHPO"></a>
是否執行超參數最佳化 (HPO)。HPO 會為您的訓練資料尋找最佳超參數值。執行 HPO 的程序稱為執行超參數調校任務。  
預設值為 `false`。在此情況下，Amazon Forecast 會使用所選演算法的預設超參數值。  
若要覆寫預設值，請將 `PerformHPO` 設定為 ，`true`並選擇性地提供 [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 物件。調校任務會指定要最佳化的指標、哪些超參數參與調校，以及每個可調校超參數的有效範圍。在此情況下，您必須指定演算法，且`PerformAutoML`必須為 false。  
下列演算法支援 HPO：  
+ DeepAR\$1
+ CNN-QR
類型：布林值  
必要：否

 ** [PredictorName](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-PredictorName"></a>
預測器的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [Tags](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-Tags"></a>
您套用至預測器的選用中繼資料，可協助您分類和整理這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) **   <a name="forecast-CreatePredictor-request-TrainingParameters"></a>
模型訓練要覆寫的超參數。您可以覆寫的超參數會列在個別演算法中。如需支援的演算法清單，請參閱 [Amazon Forecast 演算法](aws-forecast-choosing-recipes.md)。  
類型：字串到字串映射  
映射項目：最少 0 個項目。項目數上限為 100。  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`  
值長度限制：長度上限為 256。  
值模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`  
必要：否

## 回應語法
<a name="API_CreatePredictor_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreatePredictor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) **   <a name="forecast-CreatePredictor-response-PredictorArn"></a>
預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreatePredictor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreatePredictor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor) 

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

匯出 [CreateAutoPredictor](API_CreateAutoPredictor.md)或 [CreatePredictor](API_CreatePredictor.md)操作所產生的回溯測試預測和準確性指標。包含 CSV 或 Parquet 檔案的兩個資料夾會匯出至您指定的 S3 儲存貯體。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

 匯出檔案名稱將符合下列慣例：

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

<ExportTimestamp> 元件採用 Java SimpleDate 格式 (yyyy-MM-ddTHH-mm-ssZ)。

您必須指定包含 Amazon S3 儲存貯體和 AWS Identity and Access Management (IAM) 角色的[DataDestination](API_DataDestination.md)物件，Amazon Forecast 可以擔任該角色來存取 Amazon S3 儲存貯體。如需詳細資訊，請參閱[設定 Amazon Forecast 的許可](aws-forecast-iam-roles.md)。

**注意**  
匯出任務`Status`的 必須是 `ACTIVE`，您才能存取 Amazon S3 儲存貯體中的匯出。若要取得 狀態，請使用 [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md)操作。

## 請求語法
<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"
      }
   ]
}
```

## 請求參數
<a name="API_CreatePredictorBacktestExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：是

 ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Format"></a>
匯出資料的格式，CSV 或 PARQUET。預設值為 CSV。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorArn"></a>
您要匯出之預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-PredictorBacktestExportJobName"></a>
回溯測試匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-request-Tags"></a>
選用中繼資料，可協助您分類和整理回溯測試。每個標籤皆包含由您定義的一個金鑰與一個選用值。標籤鍵與值皆區分大小寫。  
以下限制適用於標籤：  
+ 對於每個資源，每個標籤索引鍵必須是唯一的，而且每個標籤索引鍵都必須有一個值。
+ 每個資源的標籤數量上限：50。
+ 金鑰長度上限：UTF-8 128 個 Unicode 字元。
+ 最大值長度：UTF-8 256 個 Unicode 字元。
+ 接受的字元：所有字母和數字、以 UTF-8 表示的空格，以及 \$1 - = 。\$1 ：/ @。 如果您的標記結構描述用於其他 服務和資源，則這些服務的角色限制也適用。
+ 金鑰字首不能包含 或 的任何大寫`aws:`或小寫組合`AWS:`。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但索引鍵沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。您無法使用此字首編輯或刪除標籤索引鍵。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

## 回應語法
<a name="API_CreatePredictorBacktestExportJob_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreatePredictorBacktestExportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-CreatePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
您要匯出之預測器回溯測試匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreatePredictorBacktestExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreatePredictorBacktestExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 

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

如果分析是一種案例建模技術，您可以在其中對時間序列進行假設性變更，並將這些變更產生的預測與基準、不變的時間序列進行比較。請務必記住，假設分析的目的是了解預測如何根據對基準時間序列的不同修改而變更。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

例如，假設您是一個服裝零售商，他正在考慮季末促銷來清空新樣式的空間。建立基準預測之後，您可以使用假設分析來調查不同的銷售策略如何影響您的目標。

您可以建立一個案例，其中所有項目都會獲得 25% 的降價，而另一個案例則會獲得固定金額的降價。您可以建立銷售持續一週的案例，以及另一個銷售持續一個月的案例。透過假設分析，您可以比較許多不同的案例。

請注意，假設分析旨在顯示預測模型學到的內容，以及它在您評估的情境中的行為。不要盲目地使用假設分析的結果來做出業務決策。例如，對於沒有可用於判斷預測是否良好的參考的新案例，預測可能不準確。

[TimeSeriesSelector](API_TimeSeriesSelector.md) 物件會在假設分析中定義您想要的項目。

**注意**  
您的資料必須是逗號分隔值 (CSV) 格式，才能建立假設分析。

## 請求語法
<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"
}
```

## 請求參數
<a name="API_CreateWhatIfAnalysis_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastArn](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-ForecastArn"></a>
基準預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-Tags"></a>
要套用至預測內容的[標籤](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)清單。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-TimeSeriesSelector"></a>
定義一組時間序列，用於搭配`TimeSeriesIdentifiers`物件的假設分析。假設分析只會針對此物件中的時間序列執行。  
`TimeSeriesIdentifiers` 物件需要下列資訊：  
+  `DataSource` 
+  `Format` 
+  `Schema` 
類型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 物件  
必要：否

 ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-WhatIfAnalysisName"></a>
假設分析的名稱。每個名稱必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

## 回應語法
<a name="API_CreateWhatIfAnalysis_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateWhatIfAnalysis_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [WhatIfAnalysisArn](#API_CreateWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-CreateWhatIfAnalysis-response-WhatIfAnalysisArn"></a>
假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateWhatIfAnalysis_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateWhatIfAnalysis_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) 

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

假設預測是從修改後的基準預測版本建立的預測。每個假設預測都會將替換資料集或一組轉換納入原始資料集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<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"
}
```

## 請求參數
<a name="API_CreateWhatIfForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-Tags"></a>
要套用至預測內容的[標籤](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)清單。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesReplacementsDataSource"></a>
取代時間序列資料集，其中包含您要在相關時間序列資料集中變更的資料列。取代時間序列不需要包含基準相關時間序列中的所有資料列。僅包含您要包含在假設預測中的資料列 （測量維度組合）。  
此資料集會與原始時間序列合併，以建立用於假設分析的轉換資料集。  
此資料集應包含要修改的項目 （例如 item\$1id 或 workforce\$1type)、任何相關維度、時間戳記欄，以及至少一個相關時間序列欄。此檔案不應包含相同時間序列的重複時間戳記。此檔案必須是 CSV 格式。  
此資料集未包含的時間戳記和 item\$1ids 不包含在假設分析中。  
類型：[TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 物件  
必要：否

 ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesTransformations"></a>
套用至基準時間序列的轉換。每個轉換都包含動作和一組條件。只有在符合所有條件時，才會套用動作。如果未提供任何條件，則動作會套用至所有項目。  
類型：[TimeSeriesTransformation](API_TimeSeriesTransformation.md) 物件陣列  
陣列成員：項目數下限為 0。最多 30 個項目。  
必要：否

 ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfAnalysisArn"></a>
假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfForecastName"></a>
假設預測的名稱。名稱在每個假設分析中必須是唯一的。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

## 回應語法
<a name="API_CreateWhatIfForecast_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateWhatIfForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecast-response-WhatIfForecastArn"></a>
假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateWhatIfForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateWhatIfForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecast) 

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

將 [CreateWhatIfForecast](API_CreateWhatIfForecast.md)操作建立的預測匯出至 Amazon Simple Storage Service (Amazon S3) 儲存貯體。預測檔案名稱將符合下列慣例：

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

<ExportTimestamp> 元件位於 Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ) 中。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您必須指定包含 (IAM) 角色的[DataDestination](API_DataDestination.md) AWS Identity and Access Management 物件，Amazon Forecast 可以擔任該角色來存取 Amazon S3 儲存貯體。如需詳細資訊，請參閱[設定 Amazon Forecast 的許可](aws-forecast-iam-roles.md)。

如需詳細資訊，請參閱[產生預測](howitworks-forecast.md)。

若要取得所有預測匯出任務的清單，請使用 [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md)操作。

**注意**  
預測匯出任務`Status`的 必須是 `ACTIVE`，您才能存取 Amazon S3 儲存貯體中的預測。若要取得 狀態，請使用 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)操作。

## 請求語法
<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"
}
```

## 請求參數
<a name="API_CreateWhatIfForecastExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Destination"></a>
您要儲存預測的位置，以及 Amazon Forecast 可以擔任以存取該位置的 AWS Identity and Access Management (IAM) 角色。預測必須匯出至 Amazon S3 儲存貯體。  
如果使用加密， `Destination` 必須包含 AWS Key Management Service (KMS) 金鑰。IAM 角色必須允許 Amazon Forecast 許可存取金鑰。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：是

 ** [Format](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-Tags"></a>
要套用至預測內容的[標籤](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)清單。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：否

 ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastArns"></a>
要匯出的預測 Amazon Resource Name (ARNs清單。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastExportName"></a>
要匯出之假設預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

## 回應語法
<a name="API_CreateWhatIfForecastExport_ResponseSyntax"></a>

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

## 回應元素
<a name="API_CreateWhatIfForecastExport_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-CreateWhatIfForecastExport-response-WhatIfForecastExportArn"></a>
假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

## 錯誤
<a name="API_CreateWhatIfForecastExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceAlreadyExistsException **   
已有具有此名稱的資源。請用不同的名稱再試一次。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateWhatIfForecastExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecastExport) 

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

刪除使用 [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 操作建立的 Amazon Forecast 資料集。您只能刪除狀態為 `ACTIVE`或 的資料集`CREATE_FAILED`。若要取得狀態，請使用 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

**注意**  
預測不會自動更新任何包含已刪除資料集的資料集群組。若要更新資料集群組，請使用 [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) 操作，省略已刪除資料集的 ARN。

## 請求語法
<a name="API_DeleteDataset_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteDataset_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetArn](#API_DeleteDataset_RequestSyntax) **   <a name="forecast-DeleteDataset-request-DatasetArn"></a>
要刪除之資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteDataset_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteDataset_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDataset_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset) 

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

刪除使用 [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 操作建立的資料集群組。您只能刪除狀態為 `ACTIVE`、 `CREATE_FAILED`或 的資料集群組`UPDATE_FAILED`。若要取得狀態，請使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

此操作只會刪除資料集群組，不會刪除群組中的資料集。

## 請求語法
<a name="API_DeleteDatasetGroup_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteDatasetGroup_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **   <a name="forecast-DeleteDatasetGroup-request-DatasetGroupArn"></a>
要刪除之資料集群組的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteDatasetGroup_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteDatasetGroup_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDatasetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup) 

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

刪除使用 [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作建立的資料集匯入任務。您只能刪除狀態為 `ACTIVE`或 的資料集匯入任務`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) 操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeleteDatasetImportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteDatasetImportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) **   <a name="forecast-DeleteDatasetImportJob-request-DatasetImportJobArn"></a>
要刪除之資料集匯入任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteDatasetImportJob_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDatasetImportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) 

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

刪除可解釋性資源。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您只能刪除狀態為 `ACTIVE`或 的預測器`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeExplainability](API_DescribeExplainability.md)操作。

## 請求語法
<a name="API_DeleteExplainability_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteExplainability_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) **   <a name="forecast-DeleteExplainability-request-ExplainabilityArn"></a>
要刪除之可解釋性資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteExplainability_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteExplainability_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteExplainability_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) 

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

刪除可解釋性匯出。

## 請求語法
<a name="API_DeleteExplainabilityExport_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteExplainabilityExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) **   <a name="forecast-DeleteExplainabilityExport-request-ExplainabilityExportArn"></a>
要刪除之可解釋性匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteExplainabilityExport_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteExplainabilityExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteExplainabilityExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainabilityExport) 

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

刪除使用 [CreateForecast](API_CreateForecast.md)操作建立的預測。您只能刪除狀態為 `ACTIVE`或 的預測`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeForecast](API_DescribeForecast.md)操作。

預測匯出時，您無法將其刪除。預測刪除後，您就無法再查詢預測。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeleteForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastArn](#API_DeleteForecast_RequestSyntax) **   <a name="forecast-DeleteForecast-request-ForecastArn"></a>
要刪除之預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteForecast_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast) 

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

刪除使用 [CreateForecastExportJob](API_CreateForecastExportJob.md)操作建立的預測匯出任務。您只能刪除狀態為 `ACTIVE`或 的匯出任務`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeForecastExportJob](API_DescribeForecastExportJob.md)操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeleteForecastExportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteForecastExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) **   <a name="forecast-DeleteForecastExportJob-request-ForecastExportJobArn"></a>
要刪除之預測匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteForecastExportJob_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteForecastExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteForecastExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) 

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

刪除監控資源。您只能刪除狀態為 `ACTIVE`、`CREATE_FAILED`、 `ACTIVE_STOPPED`或 的監視器資源`CREATE_STOPPED`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeleteMonitor_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteMonitor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) **   <a name="forecast-DeleteMonitor-request-MonitorArn"></a>
要刪除之監視器資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteMonitor_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteMonitor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteMonitor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteMonitor) 

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

刪除使用 [DescribePredictor](API_DescribePredictor.md)或 [CreatePredictor](API_CreatePredictor.md)操作建立的預測器。您只能刪除狀態為 `ACTIVE`或 的預測器`CREATE_FAILED`。若要取得 狀態，請使用 [DescribePredictor](API_DescribePredictor.md)操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeletePredictor_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeletePredictor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorArn](#API_DeletePredictor_RequestSyntax) **   <a name="forecast-DeletePredictor-request-PredictorArn"></a>
要刪除之預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeletePredictor_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeletePredictor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeletePredictor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor) 

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

刪除預測器回溯測試匯出任務。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeletePredictorBacktestExportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeletePredictorBacktestExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DeletePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
要刪除的預測器回溯測試匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeletePredictorBacktestExportJob_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeletePredictorBacktestExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeletePredictorBacktestExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 

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

刪除整個資源樹狀目錄。此操作將刪除父資源及其子資源。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

子資源是從另一個資源建立的資源。例如，當預測從預測器產生時，預測是子資源，而預測器是父資源。

Amazon Forecast 資源具有下列父子資源階層：
+  **資料集**：資料集匯入任務
+  **資料集群組**：預測器、預測器回溯測試匯出任務、預測、預測匯出任務
+  **預測器**：預測器回溯測試匯出任務、預測、預測匯出任務
+  **預測**：預測匯出任務

**注意**  
 `DeleteResourceTree` 只會刪除 Amazon Forecast 資源，而不會刪除存放在 Amazon S3 中的資料集或匯出的檔案。

## 請求語法
<a name="API_DeleteResourceTree_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteResourceTree_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) **   <a name="forecast-DeleteResourceTree-request-ResourceArn"></a>
要刪除之父資源的 Amazon Resource Name (ARN)。也會刪除父資源的所有子資源。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteResourceTree_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteResourceTree_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteResourceTree_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) 

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

刪除使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md)操作建立的假設分析。您只能刪除狀態為 `ACTIVE`或 的假設分析`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md)操作。

匯出任何預測時，您無法刪除假設分析。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DeleteWhatIfAnalysis_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteWhatIfAnalysis_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) **   <a name="forecast-DeleteWhatIfAnalysis-request-WhatIfAnalysisArn"></a>
您要刪除之假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteWhatIfAnalysis_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteWhatIfAnalysis_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteWhatIfAnalysis_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 

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

刪除使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md)操作建立的假設預測。您只能刪除狀態為 `ACTIVE`或 的假設預測`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md)操作。

匯出預測時，您無法刪除該預測。刪除假設預測後，您無法再查詢假設分析。

## 請求語法
<a name="API_DeleteWhatIfForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteWhatIfForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfForecastArn](#API_DeleteWhatIfForecast_RequestSyntax) **   <a name="forecast-DeleteWhatIfForecast-request-WhatIfForecastArn"></a>
您要刪除之假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteWhatIfForecast_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteWhatIfForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteWhatIfForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) 

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

刪除使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md)操作建立的預測匯出。您只能刪除狀態為 `ACTIVE`或 的預測匯出`CREATE_FAILED`。若要取得 狀態，請使用 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)操作。

## 請求語法
<a name="API_DeleteWhatIfForecastExport_RequestSyntax"></a>

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

## 請求參數
<a name="API_DeleteWhatIfForecastExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfForecastExportArn](#API_DeleteWhatIfForecastExport_RequestSyntax) **   <a name="forecast-DeleteWhatIfForecastExport-request-WhatIfForecastExportArn"></a>
您要刪除之假設預測匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_DeleteWhatIfForecastExport_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_DeleteWhatIfForecastExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteWhatIfForecastExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 

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

描述使用 CreateAutoPredictor 操作建立的預測器。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DescribeAutoPredictor_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeAutoPredictor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) **   <a name="forecast-DescribeAutoPredictor-request-PredictorArn"></a>
預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
   }
}
```

## 回應元素
<a name="API_DescribeAutoPredictor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-CreationTime"></a>
CreateAutoPredictor 請求的時間戳記。  
類型：Timestamp

 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DataConfig"></a>
資料集群組和任何其他資料集的資料組態。  
類型：[DataConfig](API_DataConfig.md) 物件

 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DatasetImportJobArns"></a>
資料集匯入任務的 ARNs 陣列，用於匯入預測器的訓練資料。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色，以存取金鑰。您可以在 [CreateDataset](API_CreateDataset.md)和 [CreatePredictor](API_CreatePredictor.md)請求中指定此選用物件。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EstimatedTimeRemainingInMinutes"></a>
預測器訓練任務的預估剩餘分鐘數。  
類型：Long

 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ExplainabilityInfo"></a>
提供預測器可解釋性的狀態和 ARN。  
類型：[ExplainabilityInfo](API_ExplainabilityInfo.md) 物件

 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastDimensions"></a>
維度 （欄位） 名稱陣列，指定用於將時間序列分組的屬性。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 10。  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastFrequency"></a>
預測中的預測頻率。  
有效間隔為 Y (年)、M (月)、W (週)、D (天)、H (小時)、30min (30 分鐘)、15min (15 分鐘)、10min (10 分鐘)、5min (5 分鐘) 和 1min (1 分鐘)。例如，「Y」表示每年一次，「5 分鐘」表示每五分鐘一次。  
類型：字串  
長度限制：長度下限為 1。長度上限為 5。  
模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$`

 ** [ForecastHorizon](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastHorizon"></a>
模型預測的時間步驟數目。預測期間也稱為預測長度。  
類型：整數

 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastTypes"></a>
預測器訓練期間使用的預測類型。預設值為 【"0.1"、"0.5"、"0.9"】。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`

 ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
發生錯誤時，會出現詳細說明錯誤原因的訊息。  
類型：字串

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
具有 Amazon Resource Name (ARN) 和監視器資源狀態的[MonitorInfo](API_MonitorInfo.md)物件。  
類型：[MonitorInfo](API_MonitorInfo.md) 物件

 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-OptimizationMetric"></a>
用於最佳化預測器的準確度指標。  
類型：字串  
有效值:`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorArn"></a>
預測器的 Amazon Resource Name (ARN)  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorName"></a>
預測器的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ReferencePredictorSummary"></a>
參考預測器的 ARN 和狀態。此參數僅適用於重新訓練或升級的預測器。  
類型：[ReferencePredictorSummary](API_ReferencePredictorSummary.md) 物件

 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Status"></a>
預測器的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。

 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-TimeAlignmentBoundary"></a>
彙總資料時使用的時間界限預測。  
類型：[TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 物件

## 錯誤
<a name="API_DescribeAutoPredictor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeAutoPredictor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeAutoPredictor) 

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

描述使用 [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 操作建立的 Amazon Forecast 資料集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateDataset`請求中指定的參數之外，此操作還包含下列資料集屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

## 請求語法
<a name="API_DescribeDataset_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeDataset_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="forecast-DescribeDataset-request-DatasetArn"></a>
資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeDataset_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-CreationTime"></a>
建立資料集時。  
類型：Timestamp

 ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DataFrequency"></a>
資料收集的頻率。  
有效間隔為 Y (年)、M (月)、W (週)、D (天)、H (小時)、30min (30 分鐘)、15min (15 分鐘)、10min (10 分鐘)、5min (5 分鐘) 和 1min (1 分鐘)。例如，"M" 表示每月，而 "30min" 表示每 30 分鐘。  
類型：字串  
長度限制：長度下限為 1。長度上限為 5。  
模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$`

 ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetArn"></a>
資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [DatasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetName"></a>
資料集的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [DatasetType](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-DatasetType"></a>
資料集類型。  
類型：字串  
有效值:`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 

 ** [Domain](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Domain"></a>
與資料集相關聯的網域。  
類型：字串  
有效值:`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件

 ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-LastModificationTime"></a>
當您建立資料集時， `LastModificationTime` 與 相同`CreationTime`。將資料匯入資料集時， `LastModificationTime`是`DescribeDataset`呼叫的目前時間。[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作完成後， 即`LastModificationTime`為匯入任務完成或失敗的時間。  
類型：Timestamp

 ** [Schema](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Schema"></a>
指定資料集欄位的`SchemaAttribute`物件陣列。每個 `SchemaAttribute` 指定欄位的名稱和資料類型。  
類型：[Schema](API_Schema.md) 物件

 ** [Status](#API_DescribeDataset_ResponseSyntax) **   <a name="forecast-DescribeDataset-response-Status"></a>
資料集的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
這些`UPDATE`狀態會在資料從呼叫 [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作匯入資料集時套用，並反映資料集匯入任務的狀態。例如，當匯入任務狀態為 時`CREATE_IN_PROGRESS`，資料集的狀態為 `UPDATE_IN_PROGRESS`。  
資料集`Status`的 必須是 `ACTIVE`，才能匯入訓練資料。
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeDataset_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeDataset_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset) 

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

描述使用 [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 操作建立的資料集群組。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateDatasetGroup`請求中提供的參數之外，此操作還包含下列屬性：
+  `DatasetArns` - 屬於 群組的資料集。
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 

## 請求語法
<a name="API_DescribeDatasetGroup_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeDatasetGroup_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **   <a name="forecast-DescribeDatasetGroup-request-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<a name="API_DescribeDatasetGroup_ResponseSyntax"></a>

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

## 回應元素
<a name="API_DescribeDatasetGroup_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-CreationTime"></a>
建立資料集群組時。  
類型：Timestamp

 ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetArns"></a>
包含在資料集群組中的資料集的 Amazon Resource Name (ARNs) 陣列。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupArn"></a>
資料集群組的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetGroupName"></a>
資料集群組的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Domain"></a>
與資料集群組相關聯的網域。  
類型：字串  
有效值:`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 

 ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-LastModificationTime"></a>
資料集群組從呼叫 [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) 操作建立或上次更新時。正在更新資料集群組時， `LastModificationTime`是`DescribeDatasetGroup`呼叫的目前時間。  
類型：Timestamp

 ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-Status"></a>
資料集群組的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 
這些`UPDATE`狀態會在您呼叫 [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) 操作時套用。  
資料集群組`Status`的 必須是 `ACTIVE`，才能使用資料集群組來建立預測器。
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeDatasetGroup_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeDatasetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetGroup) 

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

描述使用 [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作建立的資料集匯入任務。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateDatasetImportJob`請求中提供的參數之外，此操作還包含下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `DataSize` 
+  `FieldStatistics` 
+  `Status` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。

## 請求語法
<a name="API_DescribeDatasetImportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeDatasetImportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **   <a name="forecast-DescribeDatasetImportJob-request-DatasetImportJobArn"></a>
資料集匯入任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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
}
```

## 回應元素
<a name="API_DescribeDatasetImportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-CreationTime"></a>
資料集匯入任務建立時。  
類型：Timestamp

 ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetArn"></a>
訓練資料匯入目的地之資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobArn"></a>
資料集匯入任務的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetImportJobName"></a>
資料集匯入任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSize"></a>
匯入任務完成後，資料集的大小，以 GB (GB) 為單位。  
類型：Double

 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSource"></a>
要匯入的訓練資料位置和 AWS Identity and Access Management (IAM) 角色，Amazon Forecast 可以擔任該角色來存取資料。  
如果使用加密， `DataSource`會包含 AWS Key Management Service (KMS) 金鑰。  
類型：[DataSource](API_DataSource.md) 物件

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-EstimatedTimeRemainingInMinutes"></a>
資料集匯入任務的估計剩餘分鐘數。  
類型：Long

 ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-FieldStatistics"></a>
輸入資料中每個欄位的統計資訊。  
類型：字串到[Statistics](API_Statistics.md)物件映射  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\_]+$`

 ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Format"></a>
匯入資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`

 ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-GeolocationFormat"></a>
地理位置屬性的格式。有效值：`"LAT_LONG"` 和 `"CC_POSTALCODE"`。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9_]+$`

 ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-ImportMode"></a>
資料集匯入任務的匯入模式，FULL 或 INCREMENTAL。  
類型：字串  
有效值:`FULL | INCREMENTAL` 

 ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-Status"></a>
資料集匯入任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
類型：字串  
長度限制：長度上限為 256。

 ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimestampFormat"></a>
資料集中的時間戳記格式。您指定的格式取決於建立資料集時`DataFrequency`指定的 。支援下列格式  
+ "yyyy-MM-dd"

  對於下列資料頻率：Y、M、W 和 D
+ "yyyy-MM-dd HH:mm:ss"

  對於下列資料頻率：H、30 分鐘、15 分鐘和 1 分鐘；以及選擇性：Y、M、W 和 D
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\-\:\.\,\'\s]+$`

 ** [TimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-TimeZone"></a>
套用至資料集中每個項目的單一時區  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\/\+\-\_]+$`

 ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-UseGeolocationForTimeZone"></a>
`TimeZone` 是否自動衍生自地理位置屬性。  
類型：布林值

## 錯誤
<a name="API_DescribeDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeDatasetImportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob) 

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

描述使用 [CreateExplainability](API_CreateExplainability.md)操作建立的可解釋性資源。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DescribeExplainability_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeExplainability_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) **   <a name="forecast-DescribeExplainability-request-ExplainabilityArn"></a>
可描述性的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeExplainability_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-CreationTime"></a>
可解釋性資源建立的時間。  
類型：Timestamp

 ** [DataSource](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-DataSource"></a>
資料來源，允許 Amazon Forecast 存取資料的 AWS Identity and Access Management (IAM) 角色，以及選擇性的 AWS Key Management Service (KMS) 金鑰。  
類型：[DataSource](API_DataSource.md) 物件

 ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EnableVisualization"></a>
是否已啟用可解釋性資源的視覺化。  
類型：布林值

 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EndDateTime"></a>
如果 `TimePointGranularity` 設定為 `SPECIFIC`，則為解釋性中的最後一個時間點。  
類型：字串  
長度限制：長度上限為 19。  
模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EstimatedTimeRemainingInMinutes"></a>
[CreateExplainability](API_CreateExplainability.md) 工作完成的估計剩餘分鐘數。  
類型：Long

 ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityArn"></a>
可解釋性的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityConfig"></a>
定義可解釋性之時間序列和時間點精細性的組態設定。  
類型：[ExplainabilityConfig](API_ExplainabilityConfig.md) 物件

 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityName"></a>
可解釋性的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的訊息。  
類型：字串

 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ResourceArn"></a>
用於建立可解釋性資源的預測器或預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [Schema](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Schema"></a>
定義資料集的欄位。  
類型：[Schema](API_Schema.md) 物件

 ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-StartDateTime"></a>
如果 `TimePointGranularity` 設定為 `SPECIFIC`，則會在可解釋性中的第一個時間點。  
類型：字串  
長度限制：長度上限為 19。  
模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$`

 ** [Status](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Status"></a>
Explainability 資源的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeExplainability_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeExplainability_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability) 

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

描述使用 [CreateExplainabilityExport](API_CreateExplainabilityExport.md)操作建立的可解釋性匯出。

## 請求語法
<a name="API_DescribeExplainabilityExport_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeExplainabilityExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) **   <a name="forecast-DescribeExplainabilityExport-request-ExplainabilityExportArn"></a>
可解釋性匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeExplainabilityExport_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-CreationTime"></a>
可解釋性匯出建立時。  
類型：Timestamp

 ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件

 ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityArn"></a>
可解釋性匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportArn"></a>
可解釋性匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportName"></a>
Explainability 匯出的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`

 ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Message"></a>
匯出期間發生的任何錯誤的相關資訊。  
類型：字串

 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Status"></a>
可解釋性匯出的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeExplainabilityExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeExplainabilityExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainabilityExport) 

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

描述使用 [CreateForecast](API_CreateForecast.md)操作建立的預測。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateForecast`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `DatasetGroupArn` - 提供訓練資料的資料集群組。
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。

## 請求語法
<a name="API_DescribeForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) **   <a name="forecast-DescribeForecast-request-ForecastArn"></a>
預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
               }
            ]
         }
      }
   }
}
```

## 回應元素
<a name="API_DescribeForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-CreationTime"></a>
建立預測建立任務時。  
類型：Timestamp

 ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-DatasetGroupArn"></a>
資料集群組的 ARN，提供用於訓練預測器的資料。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-EstimatedTimeRemainingInMinutes"></a>
預測任務完成的預估剩餘分鐘數。  
類型：Long

 ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastArn"></a>
請求中指定的預測 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ForecastName](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastName"></a>
預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-ForecastTypes"></a>
產生機率預測的分位數。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`

 ** [LastModificationTime](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-PredictorArn"></a>
用來產生預測的預測器 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [Status](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-Status"></a>
預測的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
預測`Status`的 必須在您可以查詢或匯出預測`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`

 ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) **   <a name="forecast-DescribeForecast-response-TimeSeriesSelector"></a>
要包含在預測中的時間序列。  
類型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 物件

## 錯誤
<a name="API_DescribeForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecast) 

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

描述使用 [CreateForecastExportJob](API_CreateForecastExportJob.md)操作建立的預測匯出任務。

除了列出使用者在`CreateForecastExportJob`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。

## 請求語法
<a name="API_DescribeForecastExportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeForecastExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) **   <a name="forecast-DescribeForecastExportJob-request-ForecastExportJobArn"></a>
預測匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeForecastExportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-CreationTime"></a>
建立預測匯出任務時。  
類型：Timestamp

 ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Destination"></a>
匯出預測的 Amazon Simple Storage Service (Amazon S3) 儲存貯體路徑。  
類型：[DataDestination](API_DataDestination.md) 物件

 ** [ForecastArn](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastArn"></a>
匯出預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobArn"></a>
預測匯出任務的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-ForecastExportJobName"></a>
預測匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`

 ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) **   <a name="forecast-DescribeForecastExportJob-response-Status"></a>
預測匯出任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
預測匯出任務`Status`的 必須是 `ACTIVE`，您才能存取 S3 儲存貯體中的預測。
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeForecastExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeForecastExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecastExportJob) 

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

描述監視器資源。除了列出[CreateMonitor](API_CreateMonitor.md)請求中提供的屬性之外，此操作還會列出下列屬性：
+  `Baseline` 
+  `CreationTime` 
+  `LastEvaluationTime` 
+  `LastEvaluationState` 
+  `LastModificationTime` 
+  `Message` 
+  `Status` 

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_DescribeMonitor_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeMonitor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) **   <a name="forecast-DescribeMonitor-request-MonitorArn"></a>
要描述之監視器資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeMonitor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Baseline](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Baseline"></a>
您可以用來做為比較基準的指標。使用這些值來解譯自動預測器的監控結果。  
類型：[Baseline](API_Baseline.md) 物件

 ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-CreationTime"></a>
建立監控資源時的時間戳記。  
類型：Timestamp

 ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-EstimatedEvaluationTimeRemainingInMinutes"></a>
監視器資源完成其目前評估之前剩餘的估計分鐘數。  
類型：Long

 ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationState"></a>
監視器最新評估的狀態。  
類型：字串  
長度限制：長度上限為 256。

 ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastEvaluationTime"></a>
監控器完成的最新評估時間戳記。  
類型：Timestamp

 ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastModificationTime"></a>
監視器最新修改的時間戳記。  
類型：Timestamp

 ** [Message](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Message"></a>
監視器的錯誤訊息，如果有的話。  
類型：字串

 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorArn"></a>
所述的監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorName"></a>
監控器的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-ResourceArn"></a>
要監控之自動預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [Status](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Status"></a>
監控資源的狀態。  
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribeMonitor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeMonitor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeMonitor) 

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

**注意**  
 此操作僅適用於使用 CreatePredictor 建立的舊版預測器。如果您未使用舊版預測器，請使用 [DescribeAutoPredictor](API_DescribeAutoPredictor.md)。

描述使用 [CreatePredictor](API_CreatePredictor.md)操作建立的預測器。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreatePredictor`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `DatasetImportJobArns` - 用來匯入訓練資料的資料集匯入任務。
+  `AutoMLAlgorithmArns` - 如果執行 AutoML，則會評估演算法。
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。

## 請求語法
<a name="API_DescribePredictor_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribePredictor_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) **   <a name="forecast-DescribePredictor-request-PredictorArn"></a>
您希望取得資訊的預測器 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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" 
   }
}
```

## 回應元素
<a name="API_DescribePredictor_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AlgorithmArn"></a>
用於模型訓練之演算法的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLAlgorithmArns"></a>
指定 `PerformAutoML` 時，所選演算法的 ARN。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-AutoMLOverrideStrategy"></a>
 `LatencyOptimized` AutoML 覆寫策略僅適用於私有 Beta 版。請聯絡 AWS Support 或您的客戶經理，以進一步了解 存取權限。
用來訓練預測器的 AutoML 策略。除非指定 `LatencyOptimized` ，否則 AutoML 策略會最佳化預測器準確性。  
此參數僅適用於使用 AutoML 訓練的預測器。  
類型：字串  
有效值:`LatencyOptimized | AccuracyOptimized` 

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
建立模型訓練任務時。  
類型：Timestamp

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-DatasetImportJobArns"></a>
資料集匯入任務的 ARNs 陣列，用於匯入預測器的訓練資料。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EncryptionConfig"></a>
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。  
類型：[EncryptionConfig](API_EncryptionConfig.md) 物件

 ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EstimatedTimeRemainingInMinutes"></a>
預測器訓練任務的預估剩餘分鐘數。  
類型：Long

 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-EvaluationParameters"></a>
用來覆寫指定演算法的預設評估參數。Amazon Forecast 透過將資料集分割為訓練資料和測試資料來評估預測器。評估參數定義如何執行分割和反覆運算的數量。  
類型：[EvaluationParameters](API_EvaluationParameters.md) 物件

 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-FeaturizationConfig"></a>
特徵化組態。  
類型：[FeaturizationConfig](API_FeaturizationConfig.md) 物件

 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastHorizon"></a>
預測的時間步驟數目。預測期間也稱為預測長度。  
類型：整數

 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-ForecastTypes"></a>
預測器訓練期間使用的預測類型。預設值為 `["0.1","0.5","0.9"]`   
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`

 ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-HPOConfig"></a>
演算法的超參數覆寫值。  
類型：[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 物件

 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-InputDataConfig"></a>
描述資料集群組，其中包含用於訓練預測器的資料。  
類型：[InputDataConfig](API_InputDataConfig.md) 物件

 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-IsAutoPredictor"></a>
預測器是否使用 建立[CreateAutoPredictor](API_CreateAutoPredictor.md)。  
類型：布林值

 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-OptimizationMetric"></a>
用於最佳化預測器的準確度指標。  
類型：字串  
有效值:`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformAutoML"></a>
預測器是否設定為執行 AutoML。  
類型：布林值

 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PerformHPO"></a>
預測器是否設定為執行超參數最佳化 (HPO)。  
類型：布林值

 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorArn"></a>
預測器的 ARN。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorExecutionDetails"></a>
為評估預測器準確性而執行之回溯測試的狀態和結果的詳細資訊。您可以指定呼叫 [CreatePredictor](API_CreatePredictor.md)操作時要執行的回溯測試數目。  
類型：[PredictorExecutionDetails](API_PredictorExecutionDetails.md) 物件

 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-PredictorName"></a>
預測器的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [Status](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-Status"></a>
預測器的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
預測器`Status`的 必須是 `ACTIVE`，才能使用預測器建立預測。
類型：字串  
長度限制：長度上限為 256。

 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-TrainingParameters"></a>
在模型訓練期間選取的預設訓練參數或覆寫。使用 CNN-QR 或 DeepAR\$1 執行 AutoML 或選擇 HPO 時，會傳回所選超參數的最佳化值。如需詳細資訊，請參閱[Amazon Forecast 演算法](aws-forecast-choosing-recipes.md)。  
類型：字串到字串映射  
映射項目：最少 0 個項目。項目數上限為 100。  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`  
值長度限制：長度上限為 256。  
值模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`

## 錯誤
<a name="API_DescribePredictor_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribePredictor_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor) 

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

描述使用 [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md)操作建立的預測器回溯測試匯出任務。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出使用者在`CreatePredictorBacktestExportJob`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Status` 
+  `Message` （如果發生錯誤）

## 請求語法
<a name="API_DescribePredictorBacktestExportJob_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribePredictorBacktestExportJob_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-request-PredictorBacktestExportJobArn"></a>
預測器回溯測試匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribePredictorBacktestExportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-CreationTime"></a>
建立預測器回溯測試匯出任務時。  
類型：Timestamp

 ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件

 ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`

 ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Message"></a>
有關在回溯測試匯出期間可能發生的任何錯誤的資訊。  
類型：字串

 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorArn"></a>
預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
預測器回溯測試匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobName"></a>
預測器回溯測試匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

 ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Status"></a>
預測器回溯測試匯出任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_DescribePredictorBacktestExportJob_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribePredictorBacktestExportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 

# DescribeWhatIfAnalysis
<a name="API_DescribeWhatIfAnalysis"></a>

描述使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md)操作建立的假設分析。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateWhatIfAnalysis`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。
+  `Status` 

## 請求語法
<a name="API_DescribeWhatIfAnalysis_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeWhatIfAnalysis_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_RequestSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-request-WhatIfAnalysisArn"></a>
您感興趣的假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeWhatIfAnalysis_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-CreationTime"></a>
建立假設分析時。  
類型：Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-EstimatedTimeRemainingInMinutes"></a>
完成假設分析的剩餘大約時間，以分鐘為單位。  
類型：Long

 ** [ForecastArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-ForecastArn"></a>
假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Status"></a>
假設分析的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
假設分析`Status`的 必須是 `ACTIVE`，您才能存取分析。
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`

 ** [TimeSeriesSelector](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-TimeSeriesSelector"></a>
定義用來在`TimeSeriesIdentifiers`物件中建立預測的一組時間序列。  
`TimeSeriesIdentifiers` 物件需要下列資訊：  
+  `DataSource` 
+  `Format` 
+  `Schema` 
類型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 物件

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisArn"></a>
假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisName"></a>
假設分析的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

## 錯誤
<a name="API_DescribeWhatIfAnalysis_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeWhatIfAnalysis_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 

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

描述使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md)操作建立的假設預測。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateWhatIfForecast`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。
+  `Status` 

## 請求語法
<a name="API_DescribeWhatIfForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeWhatIfForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecast-request-WhatIfForecastArn"></a>
您感興趣的假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeWhatIfForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-CreationTime"></a>
建立假設預測的時間。  
類型：Timestamp

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-EstimatedTimeRemainingInMinutes"></a>
完成假設預測的剩餘大約時間，以分鐘為單位。  
類型：Long

 ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-ForecastTypes"></a>
產生機率預測的分位數。您可以在 [CreateWhatIfForecast](API_CreateWhatIfForecast.md)操作中為每個假設預測指定最多五個分位數。如果您未指定分位數，預設值為 `["0.1", "0.5", "0.9"]`。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`

 ** [LastModificationTime](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Status"></a>
假設預測的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
假設預測`Status`的 必須是 `ACTIVE`，您才能存取預測。
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`

 ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesReplacementsDataSource"></a>
描述取代時間序列的 `Schema`、 `S3Config`和 `Format`元素陣列。  
類型：[TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 物件

 ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesTransformations"></a>
`Action` 和 `TimeSeriesConditions`元素的陣列，描述要套用哪些轉換到哪個時間序列。  
類型：[TimeSeriesTransformation](API_TimeSeriesTransformation.md) 物件陣列  
陣列成員：項目數下限為 0。最多 30 個項目。

 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfAnalysisArn"></a>
包含此預測之假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastArn"></a>
假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastName"></a>
假設預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

## 錯誤
<a name="API_DescribeWhatIfForecast_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeWhatIfForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast) 

# DescribeWhatIfForecastExport
<a name="API_DescribeWhatIfForecastExport"></a>

描述使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md)操作建立的假設預測匯出。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

除了列出`CreateWhatIfForecastExport`請求中提供的屬性之外，此操作還會列出下列屬性：
+  `CreationTime` 
+  `LastModificationTime` 
+  `Message` - 如果發生錯誤，請提供錯誤的相關資訊。
+  `Status` 

## 請求語法
<a name="API_DescribeWhatIfForecastExport_RequestSyntax"></a>

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

## 請求參數
<a name="API_DescribeWhatIfForecastExport_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-request-WhatIfForecastExportArn"></a>
您感興趣的假設預測匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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"
}
```

## 回應元素
<a name="API_DescribeWhatIfForecastExport_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-CreationTime"></a>
建立預測匯出時。  
類型：Timestamp

 ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-EstimatedTimeRemainingInMinutes"></a>
完成假設預測匯出的剩餘大約時間，以分鐘為單位。  
類型：Long

 ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Format"></a>
匯出資料的格式，CSV 或 PARQUET。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`

 ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp

 ** [Message](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串

 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Status"></a>
假設預測的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
預測匯出`Status`的 必須是 `ACTIVE`，您才能存取預測匯出。
類型：字串  
長度限制：長度上限為 256。

 ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastArns"></a>
Amazon Resource Name (ARNs) 陣列，代表此資源中匯出的所有假設預測。  
類型：字串陣列  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportArn"></a>
假設預測匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`

 ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportName"></a>
假設預測匯出的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`

## 錯誤
<a name="API_DescribeWhatIfForecastExport_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeWhatIfForecastExport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 

# GetAccuracyMetrics
<a name="API_GetAccuracyMetrics"></a>

提供由 [CreatePredictor](API_CreatePredictor.md)操作訓練之模型準確性的指標。使用指標來查看模型執行的程度，並決定是否使用預測器產生預測。如需詳細資訊，請參閱[預測器指標](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

此操作會為每個已評估的回溯測試時段產生指標。回溯測試時段 (`NumberOfBacktestWindows`) 的數量是使用 物件指定，該[EvaluationParameters](API_EvaluationParameters.md)物件選擇性地包含在`CreatePredictor`請求中。如果`NumberOfBacktestWindows`未指定 ，則數字預設為 1。

`filling` 方法的參數會決定哪些項目有助於指標。如果您希望所有項目都貢獻，請指定 `zero`。如果您只想要在評估貢獻範圍內具有完整資料的項目，請指定 `nan`。如需詳細資訊，請參閱[FeaturizationMethod](API_FeaturizationMethod.md)。

**注意**  
在取得準確性指標之前，預測器`Status`的 必須是 `ACTIVE`，表示訓練已完成。若要取得 狀態，請使用 [DescribePredictor](API_DescribePredictor.md)操作。

## 請求語法
<a name="API_GetAccuracyMetrics_RequestSyntax"></a>

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

## 請求參數
<a name="API_GetAccuracyMetrics_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) **   <a name="forecast-GetAccuracyMetrics-request-PredictorArn"></a>
要取得指標之預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<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
            }
         ]
      }
   ]
}
```

## 回應元素
<a name="API_GetAccuracyMetrics_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-AutoMLOverrideStrategy"></a>
 `LatencyOptimized` AutoML 覆寫策略僅適用於私有 Beta 版。請聯絡 AWS Support 或您的客戶經理，以進一步了解 存取權限。
用來訓練預測器的 AutoML 策略。除非指定 `LatencyOptimized` ，否則 AutoML 策略會最佳化預測器準確性。  
此參數僅適用於使用 AutoML 訓練的預測器。  
類型：字串  
有效值:`LatencyOptimized | AccuracyOptimized` 

 ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-IsAutoPredictor"></a>
預測器是否使用 建立[CreateAutoPredictor](API_CreateAutoPredictor.md)。  
類型：布林值

 ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-OptimizationMetric"></a>
用於最佳化預測器的準確度指標。  
類型：字串  
有效值:`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 

 ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) **   <a name="forecast-GetAccuracyMetrics-response-PredictorEvaluationResults"></a>
評估預測器的結果陣列。  
類型：[EvaluationResult](API_EvaluationResult.md) 物件陣列

## 錯誤
<a name="API_GetAccuracyMetrics_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_GetAccuracyMetrics_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics) 

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

傳回使用 [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 操作建立的資料集群組清單。對於每個資料集群組，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以透過使用資料集群組 ARN 搭配 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作來擷取完整的屬性集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListDatasetGroups_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListDatasetGroups_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListDatasetGroups_RequestSyntax) **   <a name="forecast-ListDatasetGroups-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<a name="API_ListDatasetGroups_ResponseSyntax"></a>

```
{
   "DatasetGroups": [ 
      { 
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "DatasetGroupName": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListDatasetGroups_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-DatasetGroups"></a>
摘要每個資料集群組屬性的物件陣列。  
類型：[DatasetGroupSummary](API_DatasetGroupSummary.md) 物件陣列

 ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) **   <a name="forecast-ListDatasetGroups-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListDatasetGroups_Errors"></a>

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListDatasetGroups_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetGroups) 

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

傳回使用 [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作建立的資料集匯入任務清單。對於每個匯入任務，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以使用 ARN 搭配 [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) 操作來擷取完整的屬性集。您可以提供篩選條件物件陣列來[篩選](https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html)清單。

## 請求語法
<a name="API_ListDatasetImportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListDatasetImportJobs_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的資料集。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合陳述式的資料集，請指定 `IS`。若要排除相符的資料集，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `DatasetArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出狀態為 ACTIVE 的所有資料集匯入任務，請指定下列篩選條件：  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="forecast-ListDatasetImportJobs-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_ListDatasetImportJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-DatasetImportJobs"></a>
彙整每個資料集匯入任務屬性的物件陣列。  
類型：[DatasetImportJobSummary](API_DatasetImportJobSummary.md) 物件陣列

 ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="forecast-ListDatasetImportJobs-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListDatasetImportJobs_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListDatasetImportJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetImportJobs) 

# ListDatasets
<a name="API_ListDatasets"></a>

傳回使用 [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 操作建立的資料集清單。對於每個資料集，會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。若要擷取完整的屬性集，請使用 ARN 搭配 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListDatasets_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListDatasets_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="forecast-ListDatasets-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<a name="API_ListDatasets_ResponseSyntax"></a>

```
{
   "Datasets": [ 
      { 
         "CreationTime": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "DatasetType": "string",
         "Domain": "string",
         "LastModificationTime": number
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListDatasets_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Datasets](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-Datasets"></a>
摘要每個資料集屬性的物件陣列。  
類型：[DatasetSummary](API_DatasetSummary.md) 物件陣列

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="forecast-ListDatasets-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListDatasets_Errors"></a>

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListDatasets_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets) 

# ListExplainabilities
<a name="API_ListExplainabilities"></a>

傳回使用 [CreateExplainability](API_CreateExplainability.md)操作建立的可解釋性資源清單。此操作會傳回每個可解釋性的摘要。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

若要擷取特定可解釋性資源的完整屬性集，請使用 ARN 搭配 [DescribeExplainability](API_DescribeExplainability.md)操作。

## 請求語法
<a name="API_ListExplainabilities_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListExplainabilities_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-Filters"></a>
篩選條件陣列。針對每個篩選條件，提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要從清單中包含或排除符合陳述式的資源。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `ResourceArn` 和 `Status`。
+  `Value` - 要比對的值。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-MaxResults"></a>
回應中傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListExplainabilities_RequestSyntax) **   <a name="forecast-ListExplainabilities-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 NextToken。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_ListExplainabilities_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-Explainabilities"></a>
彙整每個可解釋性資源屬性的物件陣列。  
類型：[ExplainabilitySummary](API_ExplainabilitySummary.md) 物件陣列

 ** [NextToken](#API_ListExplainabilities_ResponseSyntax) **   <a name="forecast-ListExplainabilities-response-NextToken"></a>
如果回應被截斷，則傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListExplainabilities_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListExplainabilities_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilities) 

# ListExplainabilityExports
<a name="API_ListExplainabilityExports"></a>

傳回使用 [CreateExplainabilityExport](API_CreateExplainabilityExport.md)操作建立的可解釋性匯出清單。此操作會傳回每個可解釋性匯出的摘要。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

若要擷取特定可解釋性匯出的完整屬性集，請使用 ARN 搭配 [DescribeExplainability](API_DescribeExplainability.md)操作。

## 請求語法
<a name="API_ListExplainabilityExports_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListExplainabilityExports_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-Filters"></a>
篩選條件陣列。針對每個篩選條件，提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要包含或排除符合清單中陳述式的資源。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `ResourceArn` 和 `Status`。
+  `Value` - 要比對的值。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) **   <a name="forecast-ListExplainabilityExports-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 NextToken。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_ListExplainabilityExports_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-ExplainabilityExports"></a>
物件陣列，摘要每個可解釋性匯出的屬性。  
類型：[ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 物件陣列

 ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) **   <a name="forecast-ListExplainabilityExports-response-NextToken"></a>
如果回應被截斷，則傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListExplainabilityExports_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListExplainabilityExports_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilityExports) 

# ListForecastExportJobs
<a name="API_ListForecastExportJobs"></a>

傳回使用 [CreateForecastExportJob](API_CreateForecastExportJob.md)操作建立的預測匯出任務清單。對於每個預測匯出任務，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。若要擷取完整的屬性集，請使用 ARN 搭配 [DescribeForecastExportJob](API_DescribeForecastExportJob.md)操作。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListForecastExportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListForecastExportJobs_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的預測匯出任務。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合 陳述式的預測匯出任務，請指定 `IS`。若要排除相符的預測匯出任務，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `ForecastArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出匯出名為 *electricityforecast* 之預測的所有任務，請指定下列篩選條件：  
 `"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) **   <a name="forecast-ListForecastExportJobs-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_ListForecastExportJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-ForecastExportJobs"></a>
摘要每個匯出任務屬性的物件陣列。  
類型：[ForecastExportJobSummary](API_ForecastExportJobSummary.md) 物件陣列

 ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) **   <a name="forecast-ListForecastExportJobs-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListForecastExportJobs_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListForecastExportJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs) 

# ListForecasts
<a name="API_ListForecasts"></a>

傳回使用 [CreateForecast](API_CreateForecast.md)操作建立的預測清單。對於每個預測，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。若要擷取完整的屬性集，請使用 [DescribeForecast](API_DescribeForecast.md)操作指定 ARN。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListForecasts_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListForecasts_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的預測。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合陳述式的預測，請指定 `IS`。若要排除相符的預測，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `DatasetGroupArn`、`PredictorArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出狀態不是 ACTIVE 的所有預測，您可以指定：  
 `"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListForecasts_RequestSyntax) **   <a name="forecast-ListForecasts-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
}
```

## 回應元素
<a name="API_ListForecasts_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Forecasts](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-Forecasts"></a>
總結每個預測屬性的物件陣列。  
類型：[ForecastSummary](API_ForecastSummary.md) 物件陣列

 ** [NextToken](#API_ListForecasts_ResponseSyntax) **   <a name="forecast-ListForecasts-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListForecasts_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListForecasts_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecasts) 

# ListMonitorEvaluations
<a name="API_ListMonitorEvaluations"></a>

傳回監控評估結果清單，以及監控資源在不同時段收集的預測器事件。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

如需監控的資訊，請參閱 [預測器監控](predictor-monitoring.md)。如需擷取監控結果的詳細資訊，請參閱[檢視監控結果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。

## 請求語法
<a name="API_ListMonitorEvaluations_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "MonitorArn": "string",
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListMonitorEvaluations_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-Filters"></a>
篩選條件陣列。針對每個篩選條件，提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要從清單中包含或排除符合陳述式的資源。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。唯一有效的值為 `EvaluationState`。
+  `Value` - 要比對的值。有效值僅為 `SUCCESS`或 `FAILURE`。
例如，若要僅列出成功的監控評估，您可以指定：  
 `"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MaxResults"></a>
要傳回的監控結果數目上限。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-MonitorArn"></a>
要從中取得結果之監視器資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) **   <a name="forecast-ListMonitorEvaluations-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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
      }
   ]
}
```

## 回應元素
<a name="API_ListMonitorEvaluations_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) **   <a name="forecast-ListMonitorEvaluations-response-PredictorMonitorEvaluations"></a>
監控資源在不同時段收集的監控結果和預測器事件。  
如需監控的資訊，請參閱[檢視監控結果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。如需擷取監控結果的詳細資訊，請參閱[檢視監控結果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。  
類型：[PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 物件陣列

## 錯誤
<a name="API_ListMonitorEvaluations_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListMonitorEvaluations_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitorEvaluations) 

# ListMonitors
<a name="API_ListMonitors"></a>

傳回使用 [CreateMonitor](API_CreateMonitor.md)操作和 [CreateAutoPredictor](API_CreateAutoPredictor.md)操作建立的監視器清單。對於每個監視器資源，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以在 [DescribeMonitor](API_DescribeMonitor.md)操作中指定監視器的 ARN，以擷取監視器資源的完整屬性集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListMonitors_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListMonitors_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-Filters"></a>
篩選條件陣列。針對每個篩選條件，提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要從清單中包含或排除符合陳述式的資源。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。唯一有效的值為 `Status`。
+  `Value` - 要比對的值。
例如，若要列出狀態為 ACTIVE 的所有監視器，您可以指定：  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-MaxResults"></a>
要包含在回應中的監視器數量上限。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListMonitors_RequestSyntax) **   <a name="forecast-ListMonitors-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<a name="API_ListMonitors_ResponseSyntax"></a>

```
{
   "Monitors": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "MonitorArn": "string",
         "MonitorName": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListMonitors_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Monitors](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-Monitors"></a>
摘要每個監視器屬性的物件陣列。  
類型：[MonitorSummary](API_MonitorSummary.md) 物件陣列

 ** [NextToken](#API_ListMonitors_ResponseSyntax) **   <a name="forecast-ListMonitors-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

## 錯誤
<a name="API_ListMonitors_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListMonitors_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitors) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitors) 

# ListPredictorBacktestExportJobs
<a name="API_ListPredictorBacktestExportJobs"></a>

傳回使用 [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md)操作建立的預測器回溯測試匯出任務清單。此操作會傳回每個回溯測試匯出任務的摘要。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

若要擷取特定回溯測試匯出任務的完整屬性集，請使用 ARN 搭配 [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md)操作。

## 請求語法
<a name="API_ListPredictorBacktestExportJobs_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListPredictorBacktestExportJobs_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-Filters"></a>
篩選條件陣列。針對每個篩選條件，提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定是否要包含或排除符合清單中陳述式的預測器回溯測試匯出任務。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合 陳述式的預測器回溯測試匯出任務，請指定 `IS`。若要排除相符的預測器回溯測試匯出任務，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `PredictorArn` 和 `Status`。
+  `Value` - 要比對的值。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 NextToken。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
      }
   ]
}
```

## 回應元素
<a name="API_ListPredictorBacktestExportJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-NextToken"></a>
如果回應被截斷，則傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) **   <a name="forecast-ListPredictorBacktestExportJobs-response-PredictorBacktestExportJobs"></a>
物件陣列，摘要每個預測器回溯測試匯出任務的屬性。  
類型：[PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 物件陣列

## 錯誤
<a name="API_ListPredictorBacktestExportJobs_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListPredictorBacktestExportJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 

# ListPredictors
<a name="API_ListPredictors"></a>

傳回使用 [CreateAutoPredictor](API_CreateAutoPredictor.md)或 [CreatePredictor](API_CreatePredictor.md)操作建立的預測器清單。對於每個預測器，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

您可以使用 ARN 搭配 [DescribeAutoPredictor](API_DescribeAutoPredictor.md)和 [DescribePredictor](API_DescribePredictor.md)操作來擷取完整的屬性集。您可以使用 [Filter](API_Filter.md) 物件陣列來篩選清單。

## 請求語法
<a name="API_ListPredictors_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListPredictors_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的預測器。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合陳述式的預測器，請指定 `IS`。若要排除相符的預測器，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `DatasetGroupArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出狀態為 ACTIVE 的所有預測器，您可以指定：  
 `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListPredictors_RequestSyntax) **   <a name="forecast-ListPredictors-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
      }
   ]
}
```

## 回應元素
<a name="API_ListPredictors_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-NextToken"></a>
如果回應被截斷，Amazon Forecast 會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [Predictors](#API_ListPredictors_ResponseSyntax) **   <a name="forecast-ListPredictors-response-Predictors"></a>
摘要每個預測器屬性的物件陣列。  
類型：[PredictorSummary](API_PredictorSummary.md) 物件陣列

## 錯誤
<a name="API_ListPredictors_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListPredictors_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictors) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

列出 Amazon Forecast 資源的標籤。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListTagsForResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_ListTagsForResource_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="forecast-ListTagsForResource-request-ResourceArn"></a>
Amazon Resource Name (ARN)，可識別要列出標籤的資源。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<a name="API_ListTagsForResource_ResponseSyntax"></a>

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

## 回應元素
<a name="API_ListTagsForResource_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="forecast-ListTagsForResource-response-Tags"></a>
資源的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。

## 錯誤
<a name="API_ListTagsForResource_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListTagsForResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource) 

# ListWhatIfAnalyses
<a name="API_ListWhatIfAnalyses"></a>

傳回使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md)操作建立的假設分析清單。對於每個假設分析，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以使用 [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md)操作的假設分析 ARN 來擷取完整的屬性集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListWhatIfAnalyses_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListWhatIfAnalyses_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的假設分析任務。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合陳述式的假設分析任務，請指定 `IS`。若要排除相符的假設分析任務，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `WhatIfAnalysisArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出匯出名為 *electricityWhatIf* 之預測的所有任務，請指定下列篩選條件：  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) **   <a name="forecast-ListWhatIfAnalyses-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<a name="API_ListWhatIfAnalyses_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WhatIfAnalyses": [ 
      { 
         "CreationTime": number,
         "ForecastArn": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfAnalysisName": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListWhatIfAnalyses_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-NextToken"></a>
如果回應被截斷，預測會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) **   <a name="forecast-ListWhatIfAnalyses-response-WhatIfAnalyses"></a>
描述相符分析的`WhatIfAnalysisSummary`物件陣列。  
類型：[WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 物件陣列

## 錯誤
<a name="API_ListWhatIfAnalyses_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListWhatIfAnalyses_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfAnalyses) 

# ListWhatIfForecastExports
<a name="API_ListWhatIfForecastExports"></a>

傳回使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md)操作建立的預測匯出清單。對於每個假設預測匯出，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以使用預測匯出 ARN 搭配 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)操作來擷取完整的屬性集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListWhatIfForecastExports_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListWhatIfForecastExports_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的假設預測匯出任務。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合 陳述式的預測匯出任務，請指定 `IS`。若要排除相符的預測匯出任務，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `WhatIfForecastExportArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出匯出名為 *electricityWIFExport* 之預測的所有任務，請指定下列篩選條件：  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) **   <a name="forecast-ListWhatIfForecastExports-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個 中使用字符  請求。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<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"
      }
   ]
}
```

## 回應元素
<a name="API_ListWhatIfForecastExports_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-NextToken"></a>
如果回應被截斷，預測會傳回此字符。若要擷取下一組結果，請在下一個請求中使用字符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) **   <a name="forecast-ListWhatIfForecastExports-response-WhatIfForecastExports"></a>
描述相符預測匯出的`WhatIfForecastExports`物件陣列。  
類型：[WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 物件陣列

## 錯誤
<a name="API_ListWhatIfForecastExports_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListWhatIfForecastExports_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecastExports) 

# ListWhatIfForecasts
<a name="API_ListWhatIfForecasts"></a>

傳回使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md)操作建立的假設預測清單。對於每個假設預測，此操作會傳回其屬性的摘要，包括其 Amazon Resource Name (ARN)。您可以使用 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md)操作的假設預測 ARN 來擷取完整的屬性集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ListWhatIfForecasts_RequestSyntax"></a>

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## 請求參數
<a name="API_ListWhatIfForecasts_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-Filters"></a>
篩選條件陣列。對於每個篩選條件，您提供條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合清單中陳述式的假設預測匯出任務。比對陳述式包含索引鍵和值。  
 **篩選條件屬性**   
+  `Condition` - 要套用的條件。有效值為 `IS` 和 `IS_NOT`。若要包含符合 陳述式的預測匯出任務，請指定 `IS`。若要排除相符的預測匯出任務，請指定 `IS_NOT`。
+  `Key` - 要篩選的參數名稱。有效值為 `WhatIfForecastArn` 和 `Status`。
+  `Value` - 要比對的值。
例如，若要列出匯出名為 *electricityWhatIfForecast* 之預測的所有任務，請指定下列篩選條件：  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]`   
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-MaxResults"></a>
回應中要傳回的項目數。  
類型：整數  
有效範圍：最小值為 1。最大值為 100。  
必要：否

 ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個 中使用字符  請求。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`  
必要：否

## 回應語法
<a name="API_ListWhatIfForecasts_ResponseSyntax"></a>

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

## 回應元素
<a name="API_ListWhatIfForecasts_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個 中使用字符  請求。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
模式：`.+`

 ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-WhatIfForecasts"></a>
描述相符預測的`WhatIfForecasts`物件陣列。  
類型：[WhatIfForecastSummary](API_WhatIfForecastSummary.md) 物件陣列

## 錯誤
<a name="API_ListWhatIfForecasts_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListWhatIfForecasts_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecasts) 

# ResumeResource
<a name="API_ResumeResource"></a>

恢復已停止的監控資源。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_ResumeResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_ResumeResource_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_ResumeResource_RequestSyntax) **   <a name="forecast-ResumeResource-request-ResourceArn"></a>
要繼續之監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_ResumeResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_ResumeResource_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ResumeResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ResumeResource) 

# StopResource
<a name="API_StopResource"></a>

停止資源。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

資源會經歷下列狀態： `CREATE_STOPPING`和 `CREATE_STOPPED`。您無法在資源停止後繼續該資源。

此操作可以套用至下列資源 （及其對應的子資源）：
+ 資料集匯入任務
+ 預測器任務
+ 預測任務
+ 預測匯出任務
+ 預測器回溯測試匯出任務
+ 可解釋性任務
+ 可解釋性匯出任務

## 請求語法
<a name="API_StopResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_StopResource_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_StopResource_RequestSyntax) **   <a name="forecast-StopResource-request-ResourceArn"></a>
可識別要停止之資源的 Amazon Resource Name (ARN)。支援的 ARNs 為 `DatasetImportJobArn`、`PredictorArn`、`PredictorBacktestExportJobArn`、`ForecastArn`、`ExplainabilityArn`、 `ForecastExportJobArn`和 `ExplainabilityExportArn`。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_StopResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_StopResource_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_StopResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/StopResource) 

# TagResource
<a name="API_TagResource"></a>

將指定的標籤與指定的 資源建立關聯`resourceArn`。如果未在請求參數中指定資源上的現有標籤，則不會變更這些標籤。刪除資源時，也會刪除與該資源相關聯的標籤。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_TagResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_TagResource_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-ResourceArn"></a>
Amazon Resource Name (ARN)，可識別要列出標籤的資源。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-Tags"></a>
要新增到資源的標籤。標籤是鍵/值對的陣列。  
以下基本限制適用於 標籤：  
+ 每個資源的標籤數量上限 - 50。
+ 針對每一個資源，每個標籤鍵必須是唯一的，且每個標籤鍵只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元為：以 UTF-8 表示的字母、數字和空格，以及下列字元：\$1 - = . \$1 ： / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或任何大寫或小寫的組合，例如金鑰的字首，因為其保留供 AWS 使用。您無法使用此字首編輯或刪除標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並計入 50 個標籤的限制。只有 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。
類型：[Tag](API_Tag.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
必要：是

## 回應元素
<a name="API_TagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_TagResource_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每個帳戶的資源數量限制。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_TagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

從資源刪除指定的標籤。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## 請求語法
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## 請求參數
<a name="API_UntagResource_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-ResourceArn"></a>
Amazon Resource Name (ARN)，可識別要列出標籤的資源。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="forecast-UntagResource-request-TagKeys"></a>
要移除之標籤的索引鍵。  
類型：字串陣列  
陣列成員：項目數下限為 0。項目數上限為 200。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
必要：是

## 回應元素
<a name="API_UntagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UntagResource_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UntagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UntagResource) 

# UpdateDatasetGroup
<a name="API_UpdateDatasetGroup"></a>

將資料集群組中的資料集取代為指定的資料集。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解」](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

**注意**  
資料集群組`Status`的 必須是 `ACTIVE`，才能使用資料集群組來建立預測器。使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作來取得 狀態。

## 請求語法
<a name="API_UpdateDatasetGroup_RequestSyntax"></a>

```
{
   "DatasetArns": [ "string" ],
   "DatasetGroupArn": "string"
}
```

## 請求參數
<a name="API_UpdateDatasetGroup_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetArns"></a>
要新增至資料集群組之資料集的 Amazon Resource Name (ARNs) 陣列。  
類型：字串陣列  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) **   <a name="forecast-UpdateDatasetGroup-request-DatasetGroupArn"></a>
資料集群組的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應元素
<a name="API_UpdateDatasetGroup_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateDatasetGroup_Errors"></a>

 ** InvalidInputException **   
我們無法處理請求，因為它包含無效的值或超過有效範圍的值。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateDatasetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup) 

# Amazon Forecast Query Service
<a name="API_Operations_Amazon_Forecast_Query_Service"></a>

Amazon Forecast Query Service 支援下列動作：
+  [QueryForecast](API_forecastquery_QueryForecast.md) 
+  [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) 

# QueryForecast
<a name="API_forecastquery_QueryForecast"></a>

擷取單一項目的預測，依提供的條件篩選。

條件是鍵/值對。金鑰是來自`TARGET_TIME_SERIES`資料集的 `item_id`（或同等的非時間戳記、非目標欄位），或指定為`FeaturizationConfig`物件一部分的其中一個預測維度。

根據預設， 會`QueryForecast`傳回篩選預測的完整日期範圍。您可以請求特定的日期範圍。

若要取得完整預測，請使用 [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) 操作。

**注意**  
Amazon Forecast 產生的預測與用來建立預測器的資料集位於相同的時區。

## 請求語法
<a name="API_forecastquery_QueryForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_forecastquery_QueryForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [EndDate](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-EndDate"></a>
預測的結束日期。使用此格式指定日期：yyyy-MM-dd'T'HH：mm：ss (ISO 8601 格式）。例如，2015-01-01T20：00：00。  
類型：字串  
必要：否

 ** [Filters](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-Filters"></a>
擷取預測時要套用的篩選條件。例如，若要在用電量資料集`client_21`取得 的預測，請指定下列項目：  
 `{"item_id" : "client_21"}`   
若要取得完整預測，請使用 [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) 操作。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\_\-]+$`  
值長度限制：長度上限為 256。  
必要：是

 ** [ForecastArn](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-ForecastArn"></a>
要查詢之預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** [NextToken](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
必要：否

 ** [StartDate](#API_forecastquery_QueryForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryForecast-request-StartDate"></a>
預測的開始日期。使用此格式指定日期：yyyy-MM-dd'T'HH：mm：ss (ISO 8601 格式）。例如，2015-01-01T08：00：00。  
類型：字串  
必要：否

## 回應語法
<a name="API_forecastquery_QueryForecast_ResponseSyntax"></a>

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

## 回應元素
<a name="API_forecastquery_QueryForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Forecast](#API_forecastquery_QueryForecast_ResponseSyntax) **   <a name="forecast-forecastquery_QueryForecast-response-Forecast"></a>
預測。  
類型：[Forecast](API_forecastquery_Forecast.md) 物件

## 錯誤
<a name="API_forecastquery_QueryForecast_Errors"></a>

 ** InvalidInputException **   
值無效或太長。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到該資源。請檢查您提供的資訊，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_forecastquery_QueryForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryForecast) 

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

擷取假設預測。

## 請求語法
<a name="API_forecastquery_QueryWhatIfForecast_RequestSyntax"></a>

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

## 請求參數
<a name="API_forecastquery_QueryWhatIfForecast_RequestParameters"></a>

請求接受採用 JSON 格式的下列資料。

 ** [EndDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-EndDate"></a>
假設預測的結束日期。使用此格式指定日期：yyyy-MM-dd'T'HH：mm：ss (ISO 8601 格式）。例如，2015-01-01T20：00：00。  
類型：字串  
必要：否

 ** [Filters](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-Filters"></a>
擷取預測時要套用的篩選條件。例如，若要在用電量資料集`client_21`取得 的預測，請指定下列項目：  
 `{"item_id" : "client_21"}`   
若要取得完整的假設預測，請使用 [CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) 操作。  
類型：字串到字串映射  
映射項目：最多 50 個項目。  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\_\-]+$`  
值長度限制：長度上限為 256。  
必要：是

 ** [NextToken](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-NextToken"></a>
如果先前請求的結果遭到截斷，回應會包含 `NextToken`。若要擷取下一組結果，請在下一個請求中使用字符。字符會在 24 小時後過期。  
類型：字串  
長度限制：長度下限為 1。長度上限為 3000。  
必要：否

 ** [StartDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-StartDate"></a>
假設預測的開始日期。使用此格式指定日期：yyyy-MM-dd'T'HH：mm：ss (ISO 8601 格式）。例如，2015-01-01T08：00：00。  
類型：字串  
必要：否

 ** [WhatIfForecastArn](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-request-WhatIfForecastArn"></a>
要查詢之假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 回應語法
<a name="API_forecastquery_QueryWhatIfForecast_ResponseSyntax"></a>

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

## 回應元素
<a name="API_forecastquery_QueryWhatIfForecast_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Forecast](#API_forecastquery_QueryWhatIfForecast_ResponseSyntax) **   <a name="forecast-forecastquery_QueryWhatIfForecast-response-Forecast"></a>
提供預測的相關資訊。作為[QueryForecast](API_forecastquery_QueryForecast.md)回應的一部分傳回。  
類型：[Forecast](API_forecastquery_Forecast.md) 物件

## 錯誤
<a name="API_forecastquery_QueryWhatIfForecast_Errors"></a>

 ** InvalidInputException **   
值無效或太長。  
HTTP 狀態碼：400

 ** InvalidNextTokenException **   
字符無效。字符會在 24 小時後過期。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
HTTP 狀態碼：400

 ** ResourceInUseException **   
指定的資源正在使用中。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
我們找不到該資源。請檢查您提供的資訊，然後再試一次。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_forecastquery_QueryWhatIfForecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryWhatIfForecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryWhatIfForecast) 

# 資料類型
<a name="API_Types"></a>

Amazon Forecast Service 支援下列資料類型：
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

Amazon Forecast Query Service 支援下列資料類型：
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

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

Amazon Forecast Service 支援下列資料類型：
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

# Action
<a name="API_Action"></a>

定義您要針對假設預測對屬性進行的修改。例如，您可以使用此操作來建立假設預測，以調查所有鞋子的 9 折銷售。若要這樣做，請指定 `"AttributeName": "shoes"`、 `"Operation": "MULTIPLY"`和 `"Value": "0.90"`。將此操作與 [CreateWhatIfForecast：TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) 操作中的[TimeSeriesCondition](API_TimeSeriesCondition.md)操作配對，以定義修改的屬性項目子集。

## 目錄
<a name="API_Action_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Action-AttributeName"></a>
您正在修改的相關時間序列。此值不區分大小寫。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** Operation **   <a name="forecast-Type-Action-Operation"></a>
套用至所提供屬性的操作。這些操作包含：  
+  `ADD` - `Value`新增至 的所有資料列`AttributeName`。
+  `SUBTRACT` - `Value` 從 的所有資料列中減去 `AttributeName`。
+  `MULTIPLY` - 將 的所有資料列乘`AttributeName`以 `Value`。
+  `DIVIDE` - 將 的所有資料列除`AttributeName`以 `Value`。
類型：字串  
有效值:`ADD | SUBTRACT | MULTIPLY | DIVIDE`   
必要：是

 ** Value **   <a name="forecast-Type-Action-Value"></a>
套用至所選 的值`Operation`。  
類型：Double  
必要：是

## 另請參閱
<a name="API_Action_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Action) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Action) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Action) 

# AdditionalDataset
<a name="API_AdditionalDataset"></a>

描述其他資料集。此物件是 [DataConfig](API_DataConfig.md) 物件的一部分。預測支援天氣索引和假日其他資料集。

 **天氣索引** 

Amazon Forecast Weather Index 是內建的資料集，可將歷史和預測的天氣資訊納入您的模型。天氣索引使用超過兩年的歷史天氣資料和長達 14 天的預測天氣資料來補充您的資料集。如需詳細資訊，請參閱 [Amazon Forecast 天氣索引](https://docs.aws.amazon.com/forecast/latest/dg/weather.html)。

 **假日** 

Holidays 是內建的特徵化功能，可將功能工程設計的國定假日資訊資料集納入您的模型。它為超過 250 個國家的假日行事曆提供原生支援。Amazon Forecast 同時包含[假日 API 程式庫](https://holidayapi.com/countries)和 [Jollyday API](https://jollyday.sourceforge.net/data.html)，以產生假日行事曆。如需詳細資訊，請參閱[假日特徵化](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html)。

## 目錄
<a name="API_AdditionalDataset_Contents"></a>

 ** Name **   <a name="forecast-Type-AdditionalDataset-Name"></a>
其他資料集的名稱。有效名稱： `"holiday"`和 `"weather"`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** Configuration **   <a name="forecast-Type-AdditionalDataset-Configuration"></a>
 **天氣索引**   
若要啟用天氣索引，請勿指定 的值`Configuration`。  
 **假日**   
 **假日**   
若要啟用假日，請將 `CountryCode`設定為下列其中一個兩個字母的國家/地區代碼：  
+  阿富汗 - AF 
+  埃蘭群島 - AX 
+  阿爾巴尼亞 - AL 
+  阿爾及利亞 - DZ 
+  美屬薩摩亞 - AS 
+  安道爾 - AD 
+  安哥拉 - AO 
+  Anguilla - AI 
+  南極 - AQ 
+  安地卡和巴布達 - AG 
+  阿根廷 - AR 
+  亞美尼亞 - AM 
+  阿魯巴 - AW 
+  澳洲 - 澳洲 
+  奧地利 - AT 
+  亞塞拜然 - 亞利桑那 
+  巴哈馬 - BS 
+  巴林 - BH 
+  孟加拉 - BD 
+  Barbados - BB 
+  白俄羅斯 - BY 
+  比利時 - BE 
+  Belize - BZ 
+  貝寧 - BJ 
+  百慕達 - BM 
+  不丹 - BT 
+  玻利維亞 - BO 
+  波士尼亞與赫塞哥維納 - BA 
+  波札那 - BW 
+  Bouvet Island - BV 
+  巴西 - BR 
+  英屬印度洋領土 - IO 
+  英屬維京群島 - VG 
+  汶萊達魯薩拉姆 - BN 
+  保加利亞 - BG 
+  布吉納法索 - BF 
+  蒲隆地 - BI 
+  柬埔寨 - KH 
+  喀麥隆 - CM 
+  加拿大 - 加拿大 
+  Cape Verde - CV 
+  加勒比荷蘭 - BQ 
+  開曼群島 - 肯塔基 
+  中非共和國 - CF 
+  Chad - TD 
+  智利 - CL 
+  中國 - 中國 
+  聖誕島 - 客戶體驗 
+  Cocos （基林） 群島 - CC 
+  哥倫比亞 - CO 
+  Comoros - KM 
+  Cook Islands - CK 
+  哥斯大黎加 - CR 
+  克羅埃西亞 - HR 
+  古巴 - CU 
+  庫拉索 - CW 
+  賽普勒斯 - CY 
+  捷克 - CZ 
+  剛果民主共和國 - CD 
+  丹麥 - DK 
+  吉布地文 - DJ 
+  多米尼克文 - DM 
+  多明尼加共和國 - DO 
+  厄瓜多 - EC 
+  埃及 - EG 
+  薩爾瓦多 - SV 
+  赤道幾內亞 - GQ 
+  Eritrea - ER 
+  愛沙尼亞 - EE 
+  Eswatini - SZ 
+  衣索比亞 - ET 
+  福克蘭群島 - FK 
+  法羅群島 - FO 
+  斐濟 - FJ 
+  芬蘭 - FI 
+  法國 - FR 
+  法屬幾內亞 - GF 
+  法屬波利尼西亞 - PF 
+  法國南部領土 - TF 
+  加彭 - GA 
+  Gambia - GM 
+  Georgia - GE 
+  德國 - DE 
+  迦納 - GH 
+  直布羅陀 - GI 
+  希臘 - GR 
+  格陵蘭 - GL 
+  格林納達 - GD 
+  瓜德洛普 - GP 
+  關島 - GU 
+  瓜地馬拉 - GT 
+  Guernsey - GG 
+  幾內亞 - GN 
+  幾內亞比索 - GW 
+  蓋亞那 - GY 
+  海地 - HT 
+  赫德島和McDonald群島 - HM 
+  宏都拉斯 - HN 
+  香港 - 香港 
+  匈牙利 - HU 
+  冰島 - IS 
+  印度 - IN 
+  印尼 - ID 
+  伊朗 - IR 
+  伊拉克 - IQ 
+  愛爾蘭 - IE 
+  曼島 - IM 
+  以色列 - IL 
+  義大利 - IT 
+  象牙海岸 - CI 
+  牙買加 - JM 
+  日本 - JP 
+  澤西 - JE 
+  約旦 - JO 
+  哈薩克 - KZ 
+  肯亞 - KE 
+  Kiribati - KI 
+  Kosovo - XK 
+  科威特 - KW 
+  吉爾吉斯文 - KG 
+  寮國 - LA 
+  拉脫維亞 - LV 
+  黎巴嫩 - LB 
+  Lesotho - LS 
+  賴比瑞亞 - LR 
+  利比亞 - LY 
+  列支敦斯登 - LI 
+  立陶宛 - LT 
+  盧森堡 - LU 
+  澳門 - MO 
+  Madagascar - MG 
+  馬拉威 - MW 
+  馬來西亞 - MY 
+  馬爾地夫 - MV 
+  Mali - ML 
+  馬爾他 - MT 
+  馬紹爾群島 - MH 
+  Martinique - MQ 
+  Mauritania - MR 
+  模里西斯 - MU 
+  Mayotte - YT 
+  墨西哥 - MX 
+  密克羅尼西亞 - FM 
+  Moldova - MD 
+  摩納哥 - MC 
+  蒙古 - MN 
+  蒙特內哥羅 - ME 
+  Montserrat - MS 
+  摩洛哥 - MA 
+  Mozambique - MZ 
+  緬甸 - MM 
+  納米比亞 - 北美 
+  Nauru - NR 
+  尼泊爾 - NP 
+  荷蘭 - NL 
+  新喀里多尼亞 - NC 
+  紐西蘭 - NZ 
+  尼加拉瓜 - NI 
+  Niger - NE 
+  奈及利亞 - NG 
+  Niue - NU 
+  諾福克島 - NF 
+  北韓 - KP 
+  北馬其頓 - MK 
+  北馬利安納群島 - MP 
+  挪威 - NO 
+  阿曼 - OM 
+  巴基斯坦 - PK 
+  帛琉 - PW 
+  巴勒斯坦 - PS 
+  巴拿馬 - PA 
+  巴布亞新幾內亞 - PG 
+  巴拉圭 - PY 
+  秘魯 - PE 
+  菲律賓 - PH 
+  Pitcairn Islands - PN 
+  波蘭 - PL 
+  葡萄牙 - PT 
+  波多黎各 - PR 
+  卡達 - QA 
+  剛果共和國 - CG 
+  Réunion - RE 
+  羅馬尼亞 - RO 
+  俄羅斯聯合會 - RU 
+  Rwanda - RW 
+  聖巴西米島 - BL 
+  "聖海倫那、阿斯森頓和特里斯坦達孟加拉" - SH 
+  聖基茲和尼維斯 - KN 
+  聖露西亞 - LC 
+  聖馬丁 - MF 
+  聖皮埃爾和密克隆 - PM 
+  聖文森和格瑞那丁 - VC 
+  薩摩亞 - WS 
+  San Marino - SM 
+  Sao Tome 和 Principe - ST 
+  沙烏地阿拉伯 - SA 
+  塞內加爾文 - SN 
+  塞爾維亞 - RS 
+  塞席爾 - SC 
+  Sierra Leone - SL 
+  新加坡 - 新加坡 
+  聖馬丁島 - SX 
+  斯洛伐克 - SK 
+  斯洛維尼亞 - SI 
+  索羅門群島 - SB 
+  索馬利亞 - SO 
+  南非 - ZA 
+  南喬治亞和南桑威奇群島 - GS 
+  韓國 - KR 
+  南蘇丹 - SS 
+  西班牙 - ES 
+  斯里蘭卡 - LK 
+  蘇丹 - SD 
+  Suriname - SR 
+  Svalbard 和 Jan Mayen - SJ 
+  瑞典 - SE 
+  瑞士 - CH 
+  敘利亞阿拉伯共和國 - SY 
+  台灣 - TW 
+  Tajikistan - TJ 
+  坦尚尼亞 - TZ 
+  泰國 - TH 
+  Timor-Leste - TL 
+  Togo - TG 
+  Tokelau - TK 
+  Tonga - 結束 
+  千里達及托巴哥 - TT 
+  突尼西亞 - TN 
+  土耳其 - TR 
+  土庫曼文 - TM 
+  特克斯和凱科斯群島 - TC 
+  Tuvalu - 電視 
+  烏干達 - UG 
+  烏克蘭 - UA 
+  阿拉伯聯合大公國 - AE 
+  英國 - GB 
+  聯合國 - UN 
+  美國 - 美國 
+  美國次要離島 - UM 
+  美屬維京群島 - VI 
+  烏拉圭 - UY 
+  烏茲別克 - UZ 
+  萬那杜 - VU 
+  梵蒂岡 - 維吉尼亞 
+  委內瑞拉 - VE 
+  越南 - VN 
+  Wallis 和 Futuna - WF 
+  西撒哈拉 - EH 
+  葉門 - 黃色 
+  尚比亞 - ZM 
+  辛巴威 - ZW 
類型：字串到字串陣列映射  
索引鍵長度限制：長度下限為 1。長度上限為 63。  
金鑰模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_\-]+$`  
必要：否

## 另請參閱
<a name="API_AdditionalDataset_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AdditionalDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AdditionalDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AdditionalDataset) 

# AttributeConfig
<a name="API_AttributeConfig"></a>

提供用於轉換屬性的 方法的相關資訊。

以下是使用 RETAIL 網域的範例：

 `{` 

 `"AttributeName": "demand",` 

 `"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## 目錄
<a name="API_AttributeConfig_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-AttributeConfig-AttributeName"></a>
結構描述中指定的屬性名稱。Amazon Forecast 支援目標時間序列的目標欄位和相關的時間序列資料集。例如，對於 RETAIL 網域，目標是 `demand`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** Transformations **   <a name="forecast-Type-AttributeConfig-Transformations"></a>
方法參數 （鍵/值對），這是覆寫參數的映射。指定這些參數以覆寫預設值。相關的時間序列屬性不接受彙總參數。  
以下清單顯示「填充」特徵化方法的參數及其有效值，適用於**目標時間序列**資料集。預設值為粗體。  
+  `aggregation`：**總**和、`avg`、`first`、`min`、 `max`
+  `frontfill`：**無** 
+  `middlefill`：**零**、 `nan` （非數字）`value`、、`median`、`mean`、`min`、 `max`
+  `backfill`：**零**、`nan`、`value`、`median`、`mean`、`min`、 `max`
下列清單顯示**相關時間序列**特徵化方法的參數及其有效值 （沒有預設值）：  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
若要將填充方法設定為特定值，請將填充參數設定為 ，`value`並在對應的`_value`參數中定義值。例如，若要將回填設定為 2 的值，請包含下列項目： `"backfill": "value"`和 `"backfill_value":"2"`。  
類型：字串到字串映射  
映射項目：最多 20 個項目。  
索引鍵長度限制：長度下限為 1。長度上限為 63。  
金鑰模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
值長度限制：長度上限為 256。  
值模式：`^[a-zA-Z0-9\_\-]+$`  
必要：是

## 另請參閱
<a name="API_AttributeConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AttributeConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AttributeConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AttributeConfig) 

# Baseline
<a name="API_Baseline"></a>

您可以使用 作為基準的指標，以進行比較。當您解譯自動預測器的監控結果時，請使用這些指標。

## 目錄
<a name="API_Baseline_Contents"></a>

 ** PredictorBaseline **   <a name="forecast-Type-Baseline-PredictorBaseline"></a>
您要監控之預測器的初始[準確度指標](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。當您使用預測器和指標變更時，請使用這些指標做為比較目的的基準。  
類型：[PredictorBaseline](API_PredictorBaseline.md) 物件  
必要：否

## 另請參閱
<a name="API_Baseline_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Baseline) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Baseline) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Baseline) 

# BaselineMetric
<a name="API_BaselineMetric"></a>

您可以在評估監控結果時用於比較的個別指標。

## 目錄
<a name="API_BaselineMetric_Contents"></a>

 ** Name **   <a name="forecast-Type-BaselineMetric-Name"></a>
指標的名稱  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** Value **   <a name="forecast-Type-BaselineMetric-Value"></a>
指標的值。  
類型：Double  
必要：否

## 另請參閱
<a name="API_BaselineMetric_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/BaselineMetric) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/BaselineMetric) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/BaselineMetric) 

# CategoricalParameterRange
<a name="API_CategoricalParameterRange"></a>

指定分類超參數及其可調整值的範圍。此物件是 [ParameterRanges](API_ParameterRanges.md) 物件的一部分。

## 目錄
<a name="API_CategoricalParameterRange_Contents"></a>

 ** Name **   <a name="forecast-Type-CategoricalParameterRange-Name"></a>
要調校的分類超參數名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** Values **   <a name="forecast-Type-CategoricalParameterRange-Values"></a>
超參數的可調校類別清單。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_\-]+$`  
必要：是

## 另請參閱
<a name="API_CategoricalParameterRange_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CategoricalParameterRange) 

# ContinuousParameterRange
<a name="API_ContinuousParameterRange"></a>

指定連續超參數及其可調整值的範圍。此物件是 [ParameterRanges](API_ParameterRanges.md) 物件的一部分。

## 目錄
<a name="API_ContinuousParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-ContinuousParameterRange-MaxValue"></a>
超參數的最大可調校值。  
類型：Double  
必要：是

 ** MinValue **   <a name="forecast-Type-ContinuousParameterRange-MinValue"></a>
超參數的最小可調校值。  
類型：Double  
必要：是

 ** Name **   <a name="forecast-Type-ContinuousParameterRange-Name"></a>
要調校的超參數名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** ScalingType **   <a name="forecast-Type-ContinuousParameterRange-ScalingType"></a>
超參數調校用來搜尋超參數範圍的規模。有效值：    
Auto  
Amazon Forecast 超參數調校會選擇超參數的最佳擴展。  
線性  
超參數調校會使用線性尺度搜尋超參數範圍中的值。  
對數  
超參數調校會使用對數尺度搜尋超參數範圍中的值。  
對數擴展只適用於值大於 0 的範圍。  
ReverseLogarithmic  
超參數調校會使用反向對數縮放來搜尋超參數範圍內的值。  
反向對數擴展僅適用於完全在 0 <= x < 1.0 範圍內的範圍。
如需選擇超參數縮放的詳細資訊，請參閱[超參數縮放](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type)。下列其中一值：  
類型：字串  
有效值:`Auto | Linear | Logarithmic | ReverseLogarithmic`   
必要：否

## 另請參閱
<a name="API_ContinuousParameterRange_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ContinuousParameterRange) 

# DataConfig
<a name="API_DataConfig"></a>

資料集群組和任何其他資料集的資料組態。

## 目錄
<a name="API_DataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-DataConfig-DatasetGroupArn"></a>
用來訓練預測器之資料集群組的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** AdditionalDatasets **   <a name="forecast-Type-DataConfig-AdditionalDatasets"></a>
其他內建資料集，例如假日和天氣索引。  
類型：[AdditionalDataset](API_AdditionalDataset.md) 物件陣列  
陣列成員：項目數下限為 1。最多 2 個項目。  
必要：否

 ** AttributeConfigs **   <a name="forecast-Type-DataConfig-AttributeConfigs"></a>
資料集群組中屬性的彙總和填入選項。  
類型：[AttributeConfig](API_AttributeConfig.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
必要：否

## 另請參閱
<a name="API_DataConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataConfig) 

# DataDestination
<a name="API_DataDestination"></a>

匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。

## 目錄
<a name="API_DataDestination_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataDestination-S3Config"></a>
Amazon Simple Storage Service (Amazon S3) 儲存貯體的路徑，以及存取儲存貯體的憑證。  
類型：[S3Config](API_S3Config.md) 物件  
必要：是

## 另請參閱
<a name="API_DataDestination_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataDestination) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataDestination) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataDestination) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

提供 [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) 操作中使用的資料集群組屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作，並提供 `DatasetGroupArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_DatasetGroupSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetGroupSummary-CreationTime"></a>
資料集群組建立時。  
類型：Timestamp  
必要：否

 ** DatasetGroupArn **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** DatasetGroupName **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupName"></a>
資料集群組的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-DatasetGroupSummary-LastModificationTime"></a>
資料集群組從呼叫建立或上次更新到 [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) 操作時。資料集群組更新時， `LastModificationTime`是`ListDatasetGroups`呼叫的目前時間。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_DatasetGroupSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetGroupSummary) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

提供 [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) 操作中使用的資料集匯入任務屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) 操作，並提供 `DatasetImportJobArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetImportJobSummary-CreationTime"></a>
資料集匯入任務建立時。  
類型：Timestamp  
必要：否

 ** DatasetImportJobArn **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobArn"></a>
資料集匯入任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** DatasetImportJobName **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobName"></a>
資料集匯入任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** DataSource **   <a name="forecast-Type-DatasetImportJobSummary-DataSource"></a>
要匯入的訓練資料位置和 AWS Identity and Access Management (IAM) 角色，Amazon Forecast 可以擔任該角色來存取資料。訓練資料必須存放在 Amazon S3 儲存貯體中。  
如果使用加密， 會`DataSource`包含 AWS Key Management Service (KMS) 金鑰。  
類型：[DataSource](API_DataSource.md) 物件  
必要：否

 ** ImportMode **   <a name="forecast-Type-DatasetImportJobSummary-ImportMode"></a>
資料集匯入任務 FULL 或 INCREMENTAL 的匯入模式。  
類型：字串  
有效值:`FULL | INCREMENTAL`   
必要：否

 ** LastModificationTime **   <a name="forecast-Type-DatasetImportJobSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-DatasetImportJobSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-DatasetImportJobSummary-Status"></a>
資料集匯入任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetImportJobSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

提供 [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) 操作中使用的資料集屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作，並提供 `DatasetArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_DatasetSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetSummary-CreationTime"></a>
建立資料集時。  
類型：Timestamp  
必要：否

 ** DatasetArn **   <a name="forecast-Type-DatasetSummary-DatasetArn"></a>
資料集的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** DatasetName **   <a name="forecast-Type-DatasetSummary-DatasetName"></a>
資料集的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** DatasetType **   <a name="forecast-Type-DatasetSummary-DatasetType"></a>
資料集類型。  
類型：字串  
有效值:`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
必要：否

 ** Domain **   <a name="forecast-Type-DatasetSummary-Domain"></a>
與資料集相關聯的網域。  
類型：字串  
有效值:`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
必要：否

 ** LastModificationTime **   <a name="forecast-Type-DatasetSummary-LastModificationTime"></a>
當您建立資料集時， `LastModificationTime` 與 相同`CreationTime`。將資料匯入資料集時， `LastModificationTime`是`ListDatasets`呼叫的目前時間。[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作完成後， 即`LastModificationTime`為匯入任務完成或失敗的時間。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_DatasetSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetSummary) 

# DataSource
<a name="API_DataSource"></a>

資料來源，一種 AWS Identity and Access Management (IAM) 角色，允許 Amazon Forecast 存取資料，以及選擇性的 AWS Key Management Service (KMS) 金鑰。

## 目錄
<a name="API_DataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataSource-S3Config"></a>
存放在 Amazon Simple Storage Service (Amazon S3) 儲存貯體中的資料的路徑，以及存取資料的憑證。  
類型：[S3Config](API_S3Config.md) 物件  
必要：是

## 另請參閱
<a name="API_DataSource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataSource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataSource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataSource) 

# EncryptionConfig
<a name="API_EncryptionConfig"></a>

Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。您可以在 [CreateDataset](API_CreateDataset.md)和 [CreatePredictor](API_CreatePredictor.md)請求中指定此選用物件。

## 目錄
<a name="API_EncryptionConfig_Contents"></a>

 ** KMSKeyArn **   <a name="forecast-Type-EncryptionConfig-KMSKeyArn"></a>
KMS 金鑰的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:aws:kms:.*:key/.*`  
必要：是

 ** RoleArn **   <a name="forecast-Type-EncryptionConfig-RoleArn"></a>
Amazon Forecast 可以擔任以存取 AWS KMS 金鑰的 IAM 角色 ARN。  
不允許跨 AWS 帳戶傳遞角色。如果您傳遞的角色不在您的帳戶中，您會收到 `InvalidInputException` 錯誤。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 另請參閱
<a name="API_EncryptionConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EncryptionConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EncryptionConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EncryptionConfig) 

# ErrorMetric
<a name="API_ErrorMetric"></a>

 提供詳細的錯誤指標，以評估預測器的效能。此物件是 [Metrics](API_Metrics.md) 物件的一部分。

## 目錄
<a name="API_ErrorMetric_Contents"></a>

 ** ForecastType **   <a name="forecast-Type-ErrorMetric-ForecastType"></a>
 用於計算 WAPE、MAPE、MASE 和 RMSE 的預測類型。  
類型：字串  
長度限制：長度下限為 2。長度上限為 4。  
模式：`(^0?\.\d\d?$|^mean$)`  
必要：否

 ** MAPE **   <a name="forecast-Type-ErrorMetric-MAPE"></a>
平均絕對百分比錯誤 (MAPE)  
類型：Double  
必要：否

 ** MASE **   <a name="forecast-Type-ErrorMetric-MASE"></a>
平均絕對擴展錯誤 (MASE)  
類型：Double  
必要：否

 ** RMSE **   <a name="forecast-Type-ErrorMetric-RMSE"></a>
 root-mean-square錯誤 (RMSE)。  
類型：Double  
必要：否

 ** WAPE **   <a name="forecast-Type-ErrorMetric-WAPE"></a>
 加權絕對百分比錯誤 (WAPE)。  
類型：Double  
必要：否

## 另請參閱
<a name="API_ErrorMetric_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ErrorMetric) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ErrorMetric) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ErrorMetric) 

# EvaluationParameters
<a name="API_EvaluationParameters"></a>

定義如何將資料集分割為訓練資料和測試資料的參數，以及要執行的反覆運算數量。這些參數是在預先定義的演算法中指定，但您可以在[CreatePredictor](API_CreatePredictor.md)請求中覆寫它們。

## 目錄
<a name="API_EvaluationParameters_Contents"></a>

 ** BackTestWindowOffset **   <a name="forecast-Type-EvaluationParameters-BackTestWindowOffset"></a>
資料集結尾的點，您要分割資料以進行模型訓練和測試 （評估）。指定 值做為資料點的數量。預設值是預測時間範圍的值。 `BackTestWindowOffset` 可用來模擬過去的虛擬預測開始日期。此值必須大於或等於預測時間範圍，且小於 TARGET\$1TIME\$1SERIES 資料集長度的一半。  
 `ForecastHorizon` <= `BackTestWindowOffset` < 1/2 \$1 TARGET\$1TIME\$1SERIES 資料集長度  
類型：整數  
必要：否

 ** NumberOfBacktestWindows **   <a name="forecast-Type-EvaluationParameters-NumberOfBacktestWindows"></a>
分割輸入資料的次數。預設為 1。有效值為 1 到 5。  
類型：整數  
必要：否

## 另請參閱
<a name="API_EvaluationParameters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationParameters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationParameters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationParameters) 

# EvaluationResult
<a name="API_EvaluationResult"></a>

評估演算法的結果。作為[GetAccuracyMetrics](API_GetAccuracyMetrics.md)回應的一部分傳回。

## 目錄
<a name="API_EvaluationResult_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-EvaluationResult-AlgorithmArn"></a>
評估演算法的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** TestWindows **   <a name="forecast-Type-EvaluationResult-TestWindows"></a>
用於評估演算法的測試時段陣列。`NumberOfBacktestWindows` 來自 [EvaluationParameters](API_EvaluationParameters.md) 物件的 決定陣列中的視窗數量。  
類型：[WindowSummary](API_WindowSummary.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_EvaluationResult_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationResult) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationResult) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationResult) 

# ExplainabilityConfig
<a name="API_ExplainabilityConfig"></a>

ExplainabilityConfig 資料類型會定義包含在 中的時間序列和時間點數目[CreateExplainability](API_CreateExplainability.md)。

如果您為 提供預測器 ARN`ResourceArn`，則必須同時將 `TimePointGranularity`和 `TimeSeriesGranularity` 設定為「ALL」。建立 Predictor 可解釋性時，Amazon Forecast 會考慮所有時間序列和時間點。

如果您為 提供預測 ARN`ResourceArn`，您可以將 `TimePointGranularity`和 `TimeSeriesGranularity` 設定為「ALL」或「特定」。

## 目錄
<a name="API_ExplainabilityConfig_Contents"></a>

 ** TimePointGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimePointGranularity"></a>
若要為預測期間中的所有時間點建立可解釋性，請使用 `ALL`。若要為預測期間的特定時間點建立可解釋性，請使用 `SPECIFIC`。  
在 [CreateExplainability](API_CreateExplainability.md)操作中使用 `StartDateTime`和 `EndDateTime` 參數指定時間點。  
類型：字串  
有效值:`ALL | SPECIFIC`   
必要：是

 ** TimeSeriesGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimeSeriesGranularity"></a>
若要為資料集中的所有時間序列建立可解釋性，請使用 `ALL`。若要為資料集中的特定時間序列建立可解釋性，請使用 `SPECIFIC`。  
將 CSV 或 Parquet 檔案上傳到 Amazon S3 儲存貯體，並在[DataDestination](API_DataDestination.md)資料類型中設定位置，以指定時間序列。  
類型：字串  
有效值:`ALL | SPECIFIC`   
必要：是

## 另請參閱
<a name="API_ExplainabilityConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityConfig) 

# ExplainabilityExportSummary
<a name="API_ExplainabilityExportSummary"></a>

提供 [ListExplainabilityExports](API_ListExplainabilityExports.md)操作中使用的可解釋性匯出屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md)操作，並提供 `ExplainabilityExportArn`。

## 目錄
<a name="API_ExplainabilityExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilityExportSummary-CreationTime"></a>
可解釋性建立時。  
類型：Timestamp  
必要：否

 ** Destination **   <a name="forecast-Type-ExplainabilityExportSummary-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：否

 ** ExplainabilityExportArn **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportArn"></a>
可解釋性匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** ExplainabilityExportName **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportName"></a>
可解釋性匯出的名稱  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilityExportSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-ExplainabilityExportSummary-Message"></a>
有關在可解釋性匯出期間可能發生的任何錯誤的資訊。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-ExplainabilityExportSummary-Status"></a>
可解釋性匯出的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_ExplainabilityExportSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityExportSummary) 

# ExplainabilityInfo
<a name="API_ExplainabilityInfo"></a>

提供可解釋性資源的相關資訊。

## 目錄
<a name="API_ExplainabilityInfo_Contents"></a>

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilityInfo-ExplainabilityArn"></a>
可解釋性的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** Status **   <a name="forecast-Type-ExplainabilityInfo-Status"></a>
可解釋性的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_ExplainabilityInfo_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityInfo) 

# ExplainabilitySummary
<a name="API_ExplainabilitySummary"></a>

提供 [ListExplainabilities](API_ListExplainabilities.md)操作中使用的可解釋性屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeExplainability](API_DescribeExplainability.md)操作，並提供列出的 `ExplainabilityArn`。

## 目錄
<a name="API_ExplainabilitySummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilitySummary-CreationTime"></a>
可解釋性建立時。  
類型：Timestamp  
必要：否

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityArn"></a>
可解釋性的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** ExplainabilityConfig **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityConfig"></a>
定義可解釋性之時間序列和時間點精細性的組態設定。  
類型：[ExplainabilityConfig](API_ExplainabilityConfig.md) 物件  
必要：否

 ** ExplainabilityName **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityName"></a>
可解釋性的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilitySummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-ExplainabilitySummary-Message"></a>
有關在可解釋性建立過程中可能發生的任何錯誤的資訊。  
類型：字串  
必要：否

 ** ResourceArn **   <a name="forecast-Type-ExplainabilitySummary-ResourceArn"></a>
用於建立可解釋性的預測器或預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** Status **   <a name="forecast-Type-ExplainabilitySummary-Status"></a>
可解釋性的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_ExplainabilitySummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilitySummary) 

# Featurization
<a name="API_Featurization"></a>

**注意**  
此物件屬於 [CreatePredictor](API_CreatePredictor.md)操作。如果您使用 建立預測器[CreateAutoPredictor](API_CreateAutoPredictor.md)，請參閱 [AttributeConfig](API_AttributeConfig.md)。

提供資料集欄位的特徵化 （轉換） 資訊。此物件是 [FeaturizationConfig](API_FeaturizationConfig.md) 物件的一部分。

例如：

 `{` 

 `"AttributeName": "demand",` 

 `FeaturizationPipeline [ {` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}` 

 `} ]` 

 `}` 

## 目錄
<a name="API_Featurization_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Featurization-AttributeName"></a>
結構描述屬性的名稱，指定要特徵化的資料欄位。Amazon Forecast 支援 `TARGET_TIME_SERIES`和`RELATED_TIME_SERIES`資料集的目標欄位。例如，對於`RETAIL`網域，目標為 `demand`，對於`CUSTOM`網域，目標為 `target_value`。如需詳細資訊，請參閱[處理遺失值](howitworks-missing-values.md)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** FeaturizationPipeline **   <a name="forecast-Type-Featurization-FeaturizationPipeline"></a>
指定特徵轉換方法的一個`FeaturizationMethod`物件陣列。  
類型：[FeaturizationMethod](API_FeaturizationMethod.md) 物件陣列  
陣列成員：固定項目數為 1。  
必要：否

## 另請參閱
<a name="API_Featurization_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Featurization) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Featurization) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Featurization) 

# FeaturizationConfig
<a name="API_FeaturizationConfig"></a>

**注意**  
此物件屬於 [CreatePredictor](API_CreatePredictor.md)操作。如果您使用 建立預測器[CreateAutoPredictor](API_CreateAutoPredictor.md)，請參閱 [AttributeConfig](API_AttributeConfig.md)。

在 [CreatePredictor](API_CreatePredictor.md)操作中，指定的演算法會使用指定的資料集群組來訓練模型。您可以在訓練模型之前，選擇性地告知 操作修改資料欄位。這些修改稱為*特徵化*。

您可以使用 `FeaturizationConfig` 物件定義特徵化。您可以指定轉換的陣列，每個您要讓其成為焦點的欄位各一個。然後，您可以在`CreatePredictor`請求中包含 `FeaturizationConfig` 物件。Amazon Forecast 會在模型訓練之前將特徵化套用至 `TARGET_TIME_SERIES`和 `RELATED_TIME_SERIES`資料集。

您可以建立多個特徵化組態。例如，您可以透過指定不同的特徵化組態來呼叫`CreatePredictor`操作兩次。

## 目錄
<a name="API_FeaturizationConfig_Contents"></a>

 ** ForecastFrequency **   <a name="forecast-Type-FeaturizationConfig-ForecastFrequency"></a>
預測中的預測頻率。  
有效間隔為整數，後跟 Y (年)、M (月)、W (週)、D (天)、H (小時) 和 min (分鐘)。例如，"1D" 表示每隔一天，"15min" 表示每隔 15 分鐘。您無法指定會與下一個較大頻率重疊的值。例如，這意味著您不能指定頻率為 60 分鐘，因為這相當於 1 小時。每個頻率的有效值如下：  
+ 分鐘–1-59
+ 小時–1-23
+ 天–1-6
+ 週–1-4
+ 月–1-11
+ 年 – 1
因此，如果您希望每兩週預測一次，請指定 "2W"。或者，如果您希望每季度預測一次，請指定 "3M"。  
頻率必須大於或等於 TARGET\$1TIME\$1SERIES 資料集頻率。  
提供 RELATED\$1TIME\$1SERIES 資料集時，頻率必須等於 TARGET\$1TIME\$1SERIES 資料集頻率。  
類型：字串  
長度限制：長度下限為 1。長度上限為 5。  
模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$`  
必要：是

 ** Featurizations **   <a name="forecast-Type-FeaturizationConfig-Featurizations"></a>
資料集欄位的特徵化 （轉換） 資訊陣列。  
類型：[Featurization](API_Featurization.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
必要：否

 ** ForecastDimensions **   <a name="forecast-Type-FeaturizationConfig-ForecastDimensions"></a>
維度 （欄位） 名稱陣列，指定如何將產生的預測分組。  
例如，假設您正在為所有商店的項目銷售產生預測，且資料集包含 `store_id` 欄位。如果您想要依商店區分每個項目的銷售預測，您可以指定 `store_id`做為維度。  
不需要在`CreatePredictor`請求中指定`TARGET_TIME_SERIES`資料集中指定的所有預測維度。必須在`CreatePredictor`請求中指定`RELATED_TIME_SERIES`資料集中指定的所有預測維度。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 10。  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

## 另請參閱
<a name="API_FeaturizationConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationConfig) 

# FeaturizationMethod
<a name="API_FeaturizationMethod"></a>

提供有關使資料集欄位成為特徵 （轉換） 的方法的資訊。方法是 [Featurization](API_Featurization.md) 物件`FeaturizationPipeline`的一部分。

以下是如何指定`FeaturizationMethod`物件的範例。

 `{` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## 目錄
<a name="API_FeaturizationMethod_Contents"></a>

 ** FeaturizationMethodName **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodName"></a>
方法的名稱。「填充」方法是唯一支援的方法。  
類型：字串  
有效值:`filling`   
必要：是

 ** FeaturizationMethodParameters **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodParameters"></a>
方法參數 （鍵/值對），這是覆寫參數的映射。指定這些參數以覆寫預設值。相關的時間序列屬性不接受彙總參數。  
以下清單顯示「填充」特徵化方法的參數及其有效值，適用於**目標時間序列**資料集。粗體表示預設值。  
+  `aggregation`：**總**和、`avg`、`first`、`min`、 `max`
+  `frontfill`：**無** 
+  `middlefill`：**零**、 `nan` （非數字）`value`、、`median`、`mean`、`min`、 `max`
+  `backfill`：**零**、`nan`、`value`、`median`、`mean`、`min`、 `max`
下列清單顯示**相關時間序列**特徵化方法的參數及其有效值 （沒有預設值）：  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
若要將填充方法設定為特定值，請將填充參數設定為 ，`value`並在對應的`_value`參數中定義值。例如，若要將回填設定為 2 的值，請包含下列項目： `"backfill": "value"`和 `"backfill_value":"2"`。  
類型：字串到字串映射  
映射項目：最多 20 個項目。  
金鑰長度限制：長度上限為 256。  
金鑰模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`  
值長度限制：長度上限為 256。  
值模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`  
必要：否

## 另請參閱
<a name="API_FeaturizationMethod_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationMethod) 

# Filter
<a name="API_Filter"></a>

描述用於選擇物件子集的篩選條件。每個篩選條件都包含條件和相符陳述式。條件為 `IS`或 `IS_NOT`，指定要分別包含或排除符合陳述式的物件。比對陳述式包含金鑰和值。

## 目錄
<a name="API_Filter_Contents"></a>

 ** Condition **   <a name="forecast-Type-Filter-Condition"></a>
要套用的條件。若要包含符合陳述式的物件，請指定 `IS`。若要排除相符的物件，請指定 `IS_NOT`。  
類型：字串  
有效值:`IS | IS_NOT`   
必要：是

 ** Key **   <a name="forecast-Type-Filter-Key"></a>
要篩選的參數名稱。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`  
必要：是

 ** Value **   <a name="forecast-Type-Filter-Value"></a>
要比對的值。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

## 另請參閱
<a name="API_Filter_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Filter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Filter) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Filter) 

# ForecastExportJobSummary
<a name="API_ForecastExportJobSummary"></a>

提供 [ListForecastExportJobs](API_ListForecastExportJobs.md)操作中使用的預測匯出任務屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeForecastExportJob](API_DescribeForecastExportJob.md)操作，並提供列出的 `ForecastExportJobArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_ForecastExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ForecastExportJobSummary-CreationTime"></a>
預測匯出任務建立時。  
類型：Timestamp  
必要：否

 ** Destination **   <a name="forecast-Type-ForecastExportJobSummary-Destination"></a>
匯出預測的 Amazon Simple Storage Service (Amazon S3) 儲存貯體路徑。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：否

 ** ForecastExportJobArn **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobArn"></a>
預測匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** ForecastExportJobName **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobName"></a>
預測匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-ForecastExportJobSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-ForecastExportJobSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-ForecastExportJobSummary-Status"></a>
預測匯出任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
預測匯出任務`Status`的 必須在您可以存取 S3 儲存貯體中的預測`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_ForecastExportJobSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastExportJobSummary) 

# ForecastSummary
<a name="API_ForecastSummary"></a>

提供 [ListForecasts](API_ListForecasts.md)操作中使用的預測屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeForecast](API_DescribeForecast.md)操作，並提供摘要中列出的 `ForecastArn` 。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_ForecastSummary_Contents"></a>

 ** CreatedUsingAutoPredictor **   <a name="forecast-Type-ForecastSummary-CreatedUsingAutoPredictor"></a>
預測是否從 AutoPredictor 建立。  
類型：布林值  
必要：否

 ** CreationTime **   <a name="forecast-Type-ForecastSummary-CreationTime"></a>
建立預測建立任務時。  
類型：Timestamp  
必要：否

 ** DatasetGroupArn **   <a name="forecast-Type-ForecastSummary-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)，提供用於訓練預測器的資料。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`  
必要：否

 ** ForecastArn **   <a name="forecast-Type-ForecastSummary-ForecastArn"></a>
預測的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** ForecastName **   <a name="forecast-Type-ForecastSummary-ForecastName"></a>
預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-ForecastSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-ForecastSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** PredictorArn **   <a name="forecast-Type-ForecastSummary-PredictorArn"></a>
用來產生預測的預測器 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`  
必要：否

 ** Status **   <a name="forecast-Type-ForecastSummary-Status"></a>
預測的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
預測`Status`的 必須在您可以查詢或匯出預測`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_ForecastSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastSummary) 

# HyperParameterTuningJobConfig
<a name="API_HyperParameterTuningJobConfig"></a>

超參數調校任務的組態資訊。您可以在[CreatePredictor](API_CreatePredictor.md)請求中指定此物件。

*超參數*是管理模型訓練程序的參數。您在訓練開始前設定超參數，與訓練期間決定的模型參數不同。超參數的值會影響為模型參數選擇的值。

在*超參數調校任務*中，Amazon Forecast 會選擇一組超參數值，以最佳化指定的指標。預測會透過在超參數值範圍內執行許多訓練任務來完成此目的。最佳值集取決於演算法、訓練資料和指定的指標目標。

## 目錄
<a name="API_HyperParameterTuningJobConfig_Contents"></a>

 ** ParameterRanges **   <a name="forecast-Type-HyperParameterTuningJobConfig-ParameterRanges"></a>
指定超參數的有效值範圍。  
類型：[ParameterRanges](API_ParameterRanges.md) 物件  
必要：否

## 另請參閱
<a name="API_HyperParameterTuningJobConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/HyperParameterTuningJobConfig) 

# InputDataConfig
<a name="API_InputDataConfig"></a>

**注意**  
此物件屬於 [CreatePredictor](API_CreatePredictor.md)操作。如果您使用 建立預測器[CreateAutoPredictor](API_CreateAutoPredictor.md)，請參閱 [DataConfig](API_DataConfig.md)。

用來訓練預測器的資料。資料包含資料集群組和任何補充功能。您可以在[CreatePredictor](API_CreatePredictor.md)請求中指定此物件。

## 目錄
<a name="API_InputDataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-InputDataConfig-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** SupplementaryFeatures **   <a name="forecast-Type-InputDataConfig-SupplementaryFeatures"></a>
補充功能的陣列。唯一支援的功能是假日行事曆。  
類型：[SupplementaryFeature](API_SupplementaryFeature.md) 物件陣列  
陣列成員：項目數下限為 1。最多 2 個項目。  
必要：否

## 另請參閱
<a name="API_InputDataConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/InputDataConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/InputDataConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/InputDataConfig) 

# IntegerParameterRange
<a name="API_IntegerParameterRange"></a>

指定整數超參數及其可調整值的範圍。此物件是 [ParameterRanges](API_ParameterRanges.md) 物件的一部分。

## 目錄
<a name="API_IntegerParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-IntegerParameterRange-MaxValue"></a>
超參數的最大可調校值。  
類型：整數  
必要：是

 ** MinValue **   <a name="forecast-Type-IntegerParameterRange-MinValue"></a>
超參數的最小可調校值。  
類型：整數  
必要：是

 ** Name **   <a name="forecast-Type-IntegerParameterRange-Name"></a>
要調校的超參數名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** ScalingType **   <a name="forecast-Type-IntegerParameterRange-ScalingType"></a>
超參數調校用來搜尋超參數範圍的規模。有效值：    
Auto  
Amazon Forecast 超參數調校會選擇超參數的最佳擴展。  
線性  
超參數調校會使用線性尺度搜尋超參數範圍中的值。  
對數  
超參數調校會使用對數尺度搜尋超參數範圍中的值。  
對數擴展只適用於值大於 0 的範圍。  
ReverseLogarithmic  
不支援 `IntegerParameterRange`。  
反向對數擴展僅適用於完全在 0 <= x < 1.0 範圍內的範圍。
如需選擇超參數縮放的詳細資訊，請參閱[超參數縮放](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type)。下列其中一值：  
類型：字串  
有效值:`Auto | Linear | Logarithmic | ReverseLogarithmic`   
必要：否

## 另請參閱
<a name="API_IntegerParameterRange_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/IntegerParameterRange) 

# MetricResult
<a name="API_MetricResult"></a>

監控預測器用量時計算的個別指標預測。您可以將此指標的值與 中的指標值進行比較[Baseline](API_Baseline.md)，以查看預測器效能的變化。

如需預測產生之指標的詳細資訊，請參閱[評估預測器準確性](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) 

## 目錄
<a name="API_MetricResult_Contents"></a>

 ** MetricName **   <a name="forecast-Type-MetricResult-MetricName"></a>
指標的名稱  
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** MetricValue **   <a name="forecast-Type-MetricResult-MetricValue"></a>
指標的值。  
類型：Double  
必要：否

## 另請參閱
<a name="API_MetricResult_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MetricResult) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MetricResult) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MetricResult) 

# Metrics
<a name="API_Metrics"></a>

提供用來評估預測器效能的指標。此物件是 [WindowSummary](API_WindowSummary.md) 物件的一部分。

## 目錄
<a name="API_Metrics_Contents"></a>

 ** AverageWeightedQuantileLoss **   <a name="forecast-Type-Metrics-AverageWeightedQuantileLoss"></a>
所有加權四分位數損失的平均值。  
類型：Double  
必要：否

 ** ErrorMetrics **   <a name="forecast-Type-Metrics-ErrorMetrics"></a>
 提供每個預測類型的詳細錯誤指標。指標包括根平均平方錯誤 (RMSE)、平均絕對百分比錯誤 (MAPE)、平均絕對縮放錯誤 (MASE) 和加權平均百分比錯誤 (WAPE)。  
類型：[ErrorMetric](API_ErrorMetric.md) 物件陣列  
必要：否

 ** RMSE **   <a name="forecast-Type-Metrics-RMSE"></a>
 *此成員已遭移除。*  
root-mean-square錯誤 (RMSE)。  
類型：Double  
必要：否

 ** WeightedQuantileLosses **   <a name="forecast-Type-Metrics-WeightedQuantileLosses"></a>
加權四分位數損失的陣列。Quantiles 會將機率分佈分割為機率相等的區域。在此情況下，分佈是損失函數。  
類型：[WeightedQuantileLoss](API_WeightedQuantileLoss.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_Metrics_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Metrics) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Metrics) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Metrics) 

# MonitorConfig
<a name="API_MonitorConfig"></a>

預測器監視器的組態詳細資訊。

## 目錄
<a name="API_MonitorConfig_Contents"></a>

 ** MonitorName **   <a name="forecast-Type-MonitorConfig-MonitorName"></a>
監控資源的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

## 另請參閱
<a name="API_MonitorConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorConfig) 

# MonitorDataSource
<a name="API_MonitorDataSource"></a>

監視器在評估期間使用的資料來源。

## 目錄
<a name="API_MonitorDataSource_Contents"></a>

 ** DatasetImportJobArn **   <a name="forecast-Type-MonitorDataSource-DatasetImportJobArn"></a>
資料集匯入任務的 Amazon Resource Name (ARN)，用於匯入啟動監控評估的資料。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** ForecastArn **   <a name="forecast-Type-MonitorDataSource-ForecastArn"></a>
預測評估期間使用的監視器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** PredictorArn **   <a name="forecast-Type-MonitorDataSource-PredictorArn"></a>
您正在監控的預測器資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

## 另請參閱
<a name="API_MonitorDataSource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorDataSource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorDataSource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorDataSource) 

# MonitorInfo
<a name="API_MonitorInfo"></a>

提供有關監控資源的資訊。

## 目錄
<a name="API_MonitorInfo_Contents"></a>

 ** MonitorArn **   <a name="forecast-Type-MonitorInfo-MonitorArn"></a>
監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** Status **   <a name="forecast-Type-MonitorInfo-Status"></a>
監視器的狀態。狀態包括：  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_MonitorInfo_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorInfo) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorInfo) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorInfo) 

# MonitorSummary
<a name="API_MonitorSummary"></a>

提供 [ListMonitors](API_ListMonitors.md)操作中使用的監視器屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeMonitor](API_DescribeMonitor.md)操作，並提供列出的 `MonitorArn`。

## 目錄
<a name="API_MonitorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-MonitorSummary-CreationTime"></a>
監視器資源建立時。  
類型：Timestamp  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-MonitorSummary-LastModificationTime"></a>
上次修改監視器資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `STOPPED` - 資源停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 監視器建立完成或失敗時。
類型：Timestamp  
必要：否

 ** MonitorArn **   <a name="forecast-Type-MonitorSummary-MonitorArn"></a>
監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** MonitorName **   <a name="forecast-Type-MonitorSummary-MonitorName"></a>
監控資源的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** ResourceArn **   <a name="forecast-Type-MonitorSummary-ResourceArn"></a>
要監控之預測器的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** Status **   <a name="forecast-Type-MonitorSummary-Status"></a>
監視器的狀態。狀態包括：  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_MonitorSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorSummary) 

# ParameterRanges
<a name="API_ParameterRanges"></a>

指定分類、連續和整數超參數，及其可調校值的範圍。可調整值的範圍決定超參數調校任務可以為指定的超參數選擇哪些值。此物件是 [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 物件的一部分。

## 目錄
<a name="API_ParameterRanges_Contents"></a>

 ** CategoricalParameterRanges **   <a name="forecast-Type-ParameterRanges-CategoricalParameterRanges"></a>
指定每個類別超參數的可調校範圍。  
類型：[CategoricalParameterRange](API_CategoricalParameterRange.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
必要：否

 ** ContinuousParameterRanges **   <a name="forecast-Type-ParameterRanges-ContinuousParameterRanges"></a>
指定每個連續超參數的可調校範圍。  
類型：[ContinuousParameterRange](API_ContinuousParameterRange.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
必要：否

 ** IntegerParameterRanges **   <a name="forecast-Type-ParameterRanges-IntegerParameterRanges"></a>
指定每個整數超參數的可調校範圍。  
類型：[IntegerParameterRange](API_IntegerParameterRange.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 20。  
必要：否

## 另請參閱
<a name="API_ParameterRanges_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ParameterRanges) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ParameterRanges) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ParameterRanges) 

# PredictorBacktestExportJobSummary
<a name="API_PredictorBacktestExportJobSummary"></a>

提供 [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md)操作中使用的預測器回溯測試匯出任務屬性摘要。若要取得完整的屬性集，請呼叫 [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md)操作，並提供列出的 `PredictorBacktestExportJobArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_PredictorBacktestExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-CreationTime"></a>
建立預測器回溯測試匯出任務時。  
類型：Timestamp  
必要：否

 ** Destination **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Destination"></a>
匯出任務的目的地。提供 S3 路徑、允許 Amazon Forecast 存取位置的 AWS Identity and Access Management (IAM) 角色，以及 AWS Key Management Service (KMS) 金鑰 （選用）。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Message"></a>
有關在回溯測試匯出期間可能發生的任何錯誤的資訊。  
類型：字串  
必要：否

 ** PredictorBacktestExportJobArn **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobArn"></a>
預測器回溯測試匯出任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** PredictorBacktestExportJobName **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobName"></a>
預測器回溯測試匯出任務的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** Status **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Status"></a>
預測器回溯測試匯出任務的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_PredictorBacktestExportJobSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBacktestExportJobSummary) 

# PredictorBaseline
<a name="API_PredictorBaseline"></a>

您可以使用 作為基準的指標，用於比較目的。當您解譯自動預測器的監控結果時，請使用這些指標。

## 目錄
<a name="API_PredictorBaseline_Contents"></a>

 ** BaselineMetrics **   <a name="forecast-Type-PredictorBaseline-BaselineMetrics"></a>
預測器的初始[準確度指標](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。當您使用預測器和指標變更時，請使用這些指標做為比較目的的基準。  
類型：[BaselineMetric](API_BaselineMetric.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_PredictorBaseline_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBaseline) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBaseline) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBaseline) 

# PredictorEvent
<a name="API_PredictorEvent"></a>

提供預測器事件的詳細資訊，例如重新訓練。

## 目錄
<a name="API_PredictorEvent_Contents"></a>

 ** Datetime **   <a name="forecast-Type-PredictorEvent-Datetime"></a>
事件發生時的時間戳記。  
類型：Timestamp  
必要：否

 ** Detail **   <a name="forecast-Type-PredictorEvent-Detail"></a>
事件的類型。例如：`Retrain`。重新訓練事件表示重新訓練預測器的時間點。之前的任何監控結果`Datetime`都來自先前的預測器。任何新的指標都適用於新重新訓練的預測器。  
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_PredictorEvent_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorEvent) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorEvent) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorEvent) 

# PredictorExecution
<a name="API_PredictorExecution"></a>

用來執行回溯測試的演算法，以及這些測試的狀態。

## 目錄
<a name="API_PredictorExecution_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-PredictorExecution-AlgorithmArn"></a>
用來測試預測器的演算法 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** TestWindows **   <a name="forecast-Type-PredictorExecution-TestWindows"></a>
用來評估演算法的測試時段陣列。`NumberOfBacktestWindows` 來自 [EvaluationParameters](API_EvaluationParameters.md) 物件的 決定陣列中的視窗數量。  
類型：[TestWindowSummary](API_TestWindowSummary.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_PredictorExecution_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecution) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecution) 

# PredictorExecutionDetails
<a name="API_PredictorExecutionDetails"></a>

包含為評估預測器準確性而執行的回溯測試的詳細資訊。測試會依準確度遞減順序傳回，最準確的回溯測試會先出現。您可以指定呼叫 [CreatePredictor](API_CreatePredictor.md)操作時要執行的回溯測試數目。

## 目錄
<a name="API_PredictorExecutionDetails_Contents"></a>

 ** PredictorExecutions **   <a name="forecast-Type-PredictorExecutionDetails-PredictorExecutions"></a>
為評估預測器對特定演算法的準確性所執行的回溯測試陣列。`NumberOfBacktestWindows` 來自 [EvaluationParameters](API_EvaluationParameters.md) 物件的 決定陣列中的視窗數量。  
類型：[PredictorExecution](API_PredictorExecution.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 5。  
必要：否

## 另請參閱
<a name="API_PredictorExecutionDetails_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecutionDetails) 

# PredictorMonitorEvaluation
<a name="API_PredictorMonitorEvaluation"></a>

描述監視器評估的結果。

## 目錄
<a name="API_PredictorMonitorEvaluation_Contents"></a>

 ** EvaluationState **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationState"></a>
監視器評估的狀態。狀態可以是 `SUCCESS`或 `FAILURE`。  
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** EvaluationTime **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationTime"></a>
指出監視器評估何時開始的時間戳記。  
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-PredictorMonitorEvaluation-Message"></a>
有關監控評估期間可能發生的任何錯誤的資訊。  
類型：字串  
必要：否

 ** MetricResults **   <a name="forecast-Type-PredictorMonitorEvaluation-MetricResults"></a>
監控預測器時計算的指標預測清單。您可以比較清單中每個指標的值與 中的指標值[Baseline](API_Baseline.md)，以了解預測器的效能如何變更。  
類型：[MetricResult](API_MetricResult.md) 物件陣列  
必要：否

 ** MonitorArn **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorArn"></a>
監控資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** MonitorDataSource **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorDataSource"></a>
評估期間監控資源所使用的資料來源。  
類型：[MonitorDataSource](API_MonitorDataSource.md) 物件  
必要：否

 ** NumItemsEvaluated **   <a name="forecast-Type-PredictorMonitorEvaluation-NumItemsEvaluated"></a>
評估期間考慮的項目數量。  
類型：Long  
必要：否

 ** PredictorEvent **   <a name="forecast-Type-PredictorMonitorEvaluation-PredictorEvent"></a>
提供預測器事件的詳細資訊，例如重新訓練。  
類型：[PredictorEvent](API_PredictorEvent.md) 物件  
必要：否

 ** ResourceArn **   <a name="forecast-Type-PredictorMonitorEvaluation-ResourceArn"></a>
要監控之資源的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WindowEndDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowEndDatetime"></a>
表示用於監控評估之視窗結尾的時間戳記。  
類型：Timestamp  
必要：否

 ** WindowStartDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowStartDatetime"></a>
表示用於監控評估之視窗開始的時間戳記。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_PredictorMonitorEvaluation_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorMonitorEvaluation) 

# PredictorSummary
<a name="API_PredictorSummary"></a>

提供 [ListPredictors](API_ListPredictors.md)操作中使用的預測器屬性摘要。若要取得完整的屬性集，請呼叫 [DescribePredictor](API_DescribePredictor.md)操作，並提供列出的 `PredictorArn`。

**重要**  
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。[進一步了解"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

## 目錄
<a name="API_PredictorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorSummary-CreationTime"></a>
建立模型訓練任務時。  
類型：Timestamp  
必要：否

 ** DatasetGroupArn **   <a name="forecast-Type-PredictorSummary-DatasetGroupArn"></a>
資料集群組的 Amazon Resource Name (ARN)，其中包含用於訓練預測器的資料。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** IsAutoPredictor **   <a name="forecast-Type-PredictorSummary-IsAutoPredictor"></a>
AutoPredictor 是否用於建立預測器。  
類型：布林值  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-PredictorSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-PredictorSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** PredictorArn **   <a name="forecast-Type-PredictorSummary-PredictorArn"></a>
預測器的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** PredictorName **   <a name="forecast-Type-PredictorSummary-PredictorName"></a>
預測器的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** ReferencePredictorSummary **   <a name="forecast-Type-PredictorSummary-ReferencePredictorSummary"></a>
如果重新訓練或升級預測器，使用的參考預測器摘要。  
類型：[ReferencePredictorSummary](API_ReferencePredictorSummary.md) 物件  
必要：否

 ** Status **   <a name="forecast-Type-PredictorSummary-Status"></a>
預測器的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
預測器`Status`的 必須在您可以使用預測器建立預測`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

## 另請參閱
<a name="API_PredictorSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorSummary) 

# ReferencePredictorSummary
<a name="API_ReferencePredictorSummary"></a>

提供重新訓練或升級預測器時所使用的參考預測器摘要。

## 目錄
<a name="API_ReferencePredictorSummary_Contents"></a>

 ** Arn **   <a name="forecast-Type-ReferencePredictorSummary-Arn"></a>
參考預測器的 ARN。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** State **   <a name="forecast-Type-ReferencePredictorSummary-State"></a>
參考預測器是 `Active`還是 `Deleted`。  
類型：字串  
有效值:`Active | Deleted`   
必要：否

## 另請參閱
<a name="API_ReferencePredictorSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ReferencePredictorSummary) 

# S3Config
<a name="API_S3Config"></a>

Amazon Simple Storage Service (Amazon S3) 儲存貯體中檔案的路徑，以及 Amazon Forecast 可以擔任以存取檔案的 AWS Identity and Access Management (IAM) 角色。或者， 包含 AWS Key Management Service (KMS) 金鑰。此物件是[CreateDatasetImportJob](API_CreateDatasetImportJob.md)請求中提交的[DataSource](API_DataSource.md)物件的一部分，也是[DataDestination](API_DataDestination.md)物件的一部分。

## 目錄
<a name="API_S3Config_Contents"></a>

 ** Path **   <a name="forecast-Type-S3Config-Path"></a>
Amazon S3 儲存貯體中 Amazon Simple Storage Service (Amazon S3) 儲存貯體或 檔案的路徑。  
類型：字串  
長度限制：長度下限為 7。長度上限為 4096。  
模式：`^s3://[a-z0-9].+$`  
必要：是

 ** RoleArn **   <a name="forecast-Type-S3Config-RoleArn"></a>
Amazon Forecast 可以擔任以存取 Amazon S3 儲存貯體或檔案的 AWS Identity and Access Management (IAM) 角色 ARN。如果您為`KMSKeyArn`金鑰提供值，角色必須允許存取金鑰。  
不允許跨 AWS 帳戶傳遞角色。如果您傳遞的角色不在您的帳戶中，您會收到 `InvalidInputException` 錯誤。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：是

 ** KMSKeyArn **   <a name="forecast-Type-S3Config-KMSKeyArn"></a>
(KMS) 金鑰的 Amazon Resource Name AWS Key Management Service (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:aws:kms:.*:key/.*`  
必要：否

## 另請參閱
<a name="API_S3Config_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/S3Config) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/S3Config) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/S3Config) 

# Schema
<a name="API_Schema"></a>

定義資料集的欄位。

## 目錄
<a name="API_Schema_Contents"></a>

 ** Attributes **   <a name="forecast-Type-Schema-Attributes"></a>
屬性陣列，指定資料集中每個欄位的名稱和類型。  
類型：[SchemaAttribute](API_SchemaAttribute.md) 物件陣列  
陣列成員：項目數下限為 1。項目數上限為 100。  
必要：否

## 另請參閱
<a name="API_Schema_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Schema) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Schema) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Schema) 

# SchemaAttribute
<a name="API_SchemaAttribute"></a>

結構描述的屬性，定義資料集欄位。資料集中的每個欄位都需要結構描述屬性。[結構描述](https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html)物件包含 `SchemaAttribute` 物件陣列。

## 目錄
<a name="API_SchemaAttribute_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-SchemaAttribute-AttributeName"></a>
資料集欄位的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

 ** AttributeType **   <a name="forecast-Type-SchemaAttribute-AttributeType"></a>
欄位的資料類型。  
對於相關的時間序列資料集，除了日期、 item\$1id 和預測維度屬性之外，所有屬性都應該是數值類型 （整數/浮點）。  
類型：字串  
有效值:`string | integer | float | timestamp | geolocation`   
必要：否

## 另請參閱
<a name="API_SchemaAttribute_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SchemaAttribute) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SchemaAttribute) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SchemaAttribute) 

# Statistics
<a name="API_Statistics"></a>

使用 [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 操作，提供匯入至 Amazon Forecast 資料集的每個資料欄位的統計資料。

## 目錄
<a name="API_Statistics_Contents"></a>

 ** Avg **   <a name="forecast-Type-Statistics-Avg"></a>
對於數值欄位，欄位的平均值。  
類型：Double  
必要：否

 ** Count **   <a name="forecast-Type-Statistics-Count"></a>
欄位中的值數目。如果回應值為 -1，請參閱 `CountLong`。  
類型：整數  
必要：否

 ** CountDistinct **   <a name="forecast-Type-Statistics-CountDistinct"></a>
欄位中不同值的數量。如果回應值為 -1，請參閱 `CountDistinctLong`。  
類型：整數  
必要：否

 ** CountDistinctLong **   <a name="forecast-Type-Statistics-CountDistinctLong"></a>
欄位中不同值的數量。`CountDistinct`如果值大於 2，147，483，647，`CountDistinctLong`則會使用 而非 。  
類型：Long  
必要：否

 ** CountLong **   <a name="forecast-Type-Statistics-CountLong"></a>
欄位的值數目。`Count`如果值大於 2，147，483，647，`CountLong`則會使用 而非 。  
類型：Long  
必要：否

 ** CountNan **   <a name="forecast-Type-Statistics-CountNan"></a>
欄位中 NAN （非數字） 值的數目。如果回應值為 -1，請參閱 `CountNanLong`。  
類型：整數  
必要：否

 ** CountNanLong **   <a name="forecast-Type-Statistics-CountNanLong"></a>
欄位中的 NAN （非數字） 值數目。`CountNan`如果值大於 2，147，483，647，`CountNanLong`則會使用 而非 。  
類型：Long  
必要：否

 ** CountNull **   <a name="forecast-Type-Statistics-CountNull"></a>
欄位中的 null 值數目。如果回應值為 -1，請參閱 `CountNullLong`。  
類型：整數  
必要：否

 ** CountNullLong **   <a name="forecast-Type-Statistics-CountNullLong"></a>
欄位中的 null 值數目。`CountNull`如果值大於 2，147，483，647，`CountNullLong`則會使用 而非 。  
類型：Long  
必要：否

 ** Max **   <a name="forecast-Type-Statistics-Max"></a>
對於數值欄位，欄位的最大值。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`  
必要：否

 ** Min **   <a name="forecast-Type-Statistics-Min"></a>
對於數值欄位，請在 欄位中設定最小值。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_]+$`  
必要：否

 ** Stddev **   <a name="forecast-Type-Statistics-Stddev"></a>
對於數值欄位，則為標準差。  
類型：Double  
必要：否

## 另請參閱
<a name="API_Statistics_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Statistics) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Statistics) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Statistics) 

# SupplementaryFeature
<a name="API_SupplementaryFeature"></a>

**注意**  
此物件屬於 [CreatePredictor](API_CreatePredictor.md)操作。如果您使用 建立預測器[CreateAutoPredictor](API_CreateAutoPredictor.md)，請參閱 [AdditionalDataset](API_AdditionalDataset.md)。

描述資料集群組的補充功能。此物件是 [InputDataConfig](API_InputDataConfig.md) 物件的一部分。預測支援天氣索引和假日內建功能。

 **天氣索引** 

Amazon Forecast Weather Index 是內建的特徵化，可將歷史和預測的天氣資訊納入您的模型。天氣索引使用超過兩年的歷史天氣資料和長達 14 天的預測天氣資料來補充您的資料集。如需詳細資訊，請參閱 [Amazon Forecast 天氣索引](https://docs.aws.amazon.com/forecast/latest/dg/weather.html)。

 **假日** 

Holidays 是內建的特徵化功能，可將功能工程設計的國定假日資訊資料集納入您的模型。它為超過 250 個國家的假日行事曆提供原生支援。Amazon Forecast 同時包含[假日 API 程式庫](https://holidayapi.com/countries)和 [Jollyday API](https://jollyday.sourceforge.net/data.html)，以產生假日行事曆。如需詳細資訊，請參閱[假日特徵化](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html)。

## 目錄
<a name="API_SupplementaryFeature_Contents"></a>

 ** Name **   <a name="forecast-Type-SupplementaryFeature-Name"></a>
功能的名稱。有效值：`"holiday"` 和 `"weather"`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** Value **   <a name="forecast-Type-SupplementaryFeature-Value"></a>
 **天氣索引**   
若要啟用天氣索引，請將 值設定為 `"true"`   
 **假日**   
若要啟用假日，請指定具有下列其中一個兩個字母國家/地區代碼的國家/地區：  
+  阿富汗 - AF 
+  埃蘭群島 - AX 
+  阿爾巴尼亞 - AL 
+  阿爾及利亞 - DZ 
+  美屬薩摩亞 - AS 
+  安道爾 - AD 
+  安哥拉 - AO 
+  Anguilla - AI 
+  南極 - AQ 
+  安地卡和巴布達 - AG 
+  阿根廷 - AR 
+  亞美尼亞 - AM 
+  阿魯巴 - AW 
+  澳洲 - 澳洲 
+  奧地利 - AT 
+  亞塞拜然 - 亞利桑那 
+  巴哈馬 - BS 
+  巴林 - BH 
+  孟加拉 - BD 
+  Barbados - BB 
+  白俄羅斯 - BY 
+  比利時 - BE 
+  Belize - BZ 
+  貝寧 - BJ 
+  百慕達 - BM 
+  不丹 - BT 
+  玻利維亞 - BO 
+  波士尼亞與赫塞哥維納 - BA 
+  波札那 - BW 
+  Bouvet Island - BV 
+  巴西 - BR 
+  英屬印度洋領土 - IO 
+  英屬維京群島 - VG 
+  汶萊達魯薩拉姆 - BN 
+  保加利亞 - BG 
+  布吉納法索 - BF 
+  蒲隆地 - BI 
+  柬埔寨 - KH 
+  喀麥隆 - CM 
+  加拿大 - 加拿大 
+  Cape Verde - CV 
+  加勒比荷蘭 - BQ 
+  開曼群島 - 肯塔基 
+  中非共和國 - CF 
+  Chad - TD 
+  智利 - CL 
+  中國 - 中國 
+  聖誕島 - 客戶體驗 
+  Cocos （基林） 群島 - CC 
+  哥倫比亞 - CO 
+  Comoros - KM 
+  Cook Islands - CK 
+  哥斯大黎加 - CR 
+  克羅埃西亞 - HR 
+  古巴 - CU 
+  庫拉索 - CW 
+  賽普勒斯 - CY 
+  捷克 - CZ 
+  剛果民主共和國 - CD 
+  丹麥 - DK 
+  吉布地文 - DJ 
+  多米尼克文 - DM 
+  多明尼加共和國 - DO 
+  厄瓜多 - EC 
+  埃及 - EG 
+  薩爾瓦多 - SV 
+  赤道幾內亞 - GQ 
+  Eritrea - ER 
+  愛沙尼亞 - EE 
+  Eswatini - SZ 
+  衣索比亞 - ET 
+  福克蘭群島 - FK 
+  法羅群島 - FO 
+  斐濟 - FJ 
+  芬蘭 - FI 
+  法國 - FR 
+  法屬幾內亞 - GF 
+  法屬波利尼西亞 - PF 
+  法國南部領土 - TF 
+  加彭 - GA 
+  Gambia - GM 
+  Georgia - GE 
+  德國 - DE 
+  迦納 - GH 
+  直布羅陀 - GI 
+  希臘 - GR 
+  格陵蘭 - GL 
+  格林納達 - GD 
+  瓜德洛普 - GP 
+  關島 - GU 
+  瓜地馬拉 - GT 
+  Guernsey - GG 
+  幾內亞 - GN 
+  幾內亞比索 - GW 
+  蓋亞那 - GY 
+  海地 - HT 
+  赫德島和McDonald群島 - HM 
+  宏都拉斯 - HN 
+  香港 - 香港 
+  匈牙利 - HU 
+  冰島 - IS 
+  印度 - IN 
+  印尼 - ID 
+  伊朗 - IR 
+  伊拉克 - IQ 
+  愛爾蘭 - IE 
+  曼島 - IM 
+  以色列 - IL 
+  義大利 - IT 
+  象牙海岸 - CI 
+  牙買加 - JM 
+  日本 - JP 
+  澤西 - JE 
+  約旦 - JO 
+  哈薩克 - KZ 
+  肯亞 - KE 
+  Kiribati - KI 
+  Kosovo - XK 
+  科威特 - KW 
+  吉爾吉斯文 - KG 
+  寮國 - LA 
+  拉脫維亞 - LV 
+  黎巴嫩 - LB 
+  Lesotho - LS 
+  賴比瑞亞 - LR 
+  利比亞 - LY 
+  列支敦斯登 - LI 
+  立陶宛 - LT 
+  盧森堡 - LU 
+  澳門 - MO 
+  Madagascar - MG 
+  馬拉威 - MW 
+  馬來西亞 - MY 
+  馬爾地夫 - MV 
+  Mali - ML 
+  馬爾他 - MT 
+  馬紹爾群島 - MH 
+  Martinique - MQ 
+  Mauritania - MR 
+  模里西斯 - MU 
+  Mayotte - YT 
+  墨西哥 - MX 
+  密克羅尼西亞 - FM 
+  Moldova - MD 
+  摩納哥 - MC 
+  蒙古 - MN 
+  蒙特內哥羅 - ME 
+  Montserrat - MS 
+  摩洛哥 - MA 
+  Mozambique - MZ 
+  緬甸 - MM 
+  納米比亞 - 北美 
+  Nauru - NR 
+  尼泊爾 - NP 
+  荷蘭 - NL 
+  新喀里多尼亞 - NC 
+  紐西蘭 - NZ 
+  尼加拉瓜 - NI 
+  Niger - NE 
+  奈及利亞 - NG 
+  Niue - NU 
+  諾福克島 - NF 
+  北韓 - KP 
+  北馬其頓 - MK 
+  北馬利安納群島 - MP 
+  挪威 - NO 
+  阿曼 - OM 
+  巴基斯坦 - PK 
+  帛琉 - PW 
+  巴勒斯坦 - PS 
+  巴拿馬 - PA 
+  巴布亞新幾內亞 - PG 
+  巴拉圭 - PY 
+  秘魯 - PE 
+  菲律賓 - PH 
+  Pitcairn Islands - PN 
+  波蘭 - PL 
+  葡萄牙 - PT 
+  波多黎各 - PR 
+  卡達 - QA 
+  剛果共和國 - CG 
+  Réunion - RE 
+  羅馬尼亞 - RO 
+  俄羅斯聯合會 - RU 
+  Rwanda - RW 
+  聖巴西米島 - BL 
+  "聖海倫那、阿斯森頓和特里斯坦達孟加拉" - SH 
+  聖基茲和尼維斯 - KN 
+  聖露西亞 - LC 
+  聖馬丁 - MF 
+  聖皮埃爾和密克隆 - PM 
+  聖文森和格瑞那丁 - VC 
+  薩摩亞 - WS 
+  San Marino - SM 
+  Sao Tome 和 Principe - ST 
+  沙烏地阿拉伯 - SA 
+  塞內加爾文 - SN 
+  塞爾維亞 - RS 
+  塞席爾 - SC 
+  Sierra Leone - SL 
+  新加坡 - 新加坡 
+  聖馬丁島 - SX 
+  斯洛伐克 - SK 
+  斯洛維尼亞 - SI 
+  索羅門群島 - SB 
+  索馬利亞 - SO 
+  南非 - ZA 
+  南喬治亞和南桑威奇群島 - GS 
+  韓國 - KR 
+  南蘇丹 - SS 
+  西班牙 - ES 
+  斯里蘭卡 - LK 
+  蘇丹 - SD 
+  Suriname - SR 
+  Svalbard 和 Jan Mayen - SJ 
+  瑞典 - SE 
+  瑞士 - CH 
+  敘利亞阿拉伯共和國 - SY 
+  台灣 - TW 
+  Tajikistan - TJ 
+  坦尚尼亞 - TZ 
+  泰國 - TH 
+  Timor-Leste - TL 
+  Togo - TG 
+  Tokelau - TK 
+  Tonga - 結束 
+  千里達及托巴哥 - TT 
+  突尼西亞 - TN 
+  土耳其 - TR 
+  土庫曼文 - TM 
+  特克斯和凱科斯群島 - TC 
+  Tuvalu - 電視 
+  烏干達 - UG 
+  烏克蘭 - UA 
+  阿拉伯聯合大公國 - AE 
+  英國 - GB 
+  聯合國 - UN 
+  美國 - 美國 
+  美國次要離島 - UM 
+  美屬維京群島 - VI 
+  烏拉圭 - UY 
+  烏茲別克 - UZ 
+  萬那杜 - VU 
+  梵蒂岡 - 維吉尼亞 
+  委內瑞拉 - VE 
+  越南 - VN 
+  Wallis 和 Futuna - WF 
+  西撒哈拉 - EH 
+  葉門 - 黃色 
+  尚比亞 - ZM 
+  辛巴威 - ZW 
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\_\-]+$`  
必要：是

## 另請參閱
<a name="API_SupplementaryFeature_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SupplementaryFeature) 

# Tag
<a name="API_Tag"></a>

您套用至資源的選用中繼資料，可協助您分類和整理這些中繼資料。每個標籤皆包含由您定義的一個金鑰與一個選用值。

以下基本限制適用於標籤：
+ 每個資源的標籤數量上限 - 50。
+ 對於每一個資源，每個標籤金鑰必須是唯一的，且每個標籤金鑰只能有一個值。
+ 金鑰長度上限 - UTF-8 中的 128 個 Unicode 字元。
+ 最大值長度 - UTF-8 中的 256 個 Unicode 字元。
+ 如果您的標記結構描述是跨多項服務和資源使用，請記得其他服務可能會有字元使用限制。通常允許的字元包括：可用 UTF-8 表示的英文字母、數字和空格，還有以下字元：\$1 - = . \$1 : / @。
+ 標籤鍵與值皆區分大小寫。
+ 請勿使用 `aws:`、 `AWS:`或 的任何大寫或小寫組合，例如保留供 AWS 使用的金鑰字首。您無法編輯或刪除具有此字首的標籤索引鍵。值可以有此字首。如果標籤值具有 `aws` 作為其字首，但金鑰沒有，則預測會將其視為使用者標籤，並將計入 50 個標籤的限制。僅包含 金鑰字首的標籤`aws`不會計入每個資源限制的標籤。

## 目錄
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="forecast-Type-Tag-Key"></a>
組成標籤的鍵值對的一部分。`key` 是一般標籤，作用如同更為特定的標籤值類別。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
必要：是

 ** Value **   <a name="forecast-Type-Tag-Value"></a>
組成標籤之鍵值對的選用部分。`value` 作用如同標籤類別 (索引鍵) 內的描述項。  
類型：字串  
長度限制：長度下限為 0。長度上限為 256。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
必要：是

## 另請參閱
<a name="API_Tag_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Tag) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Tag) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Tag) 

# TestWindowSummary
<a name="API_TestWindowSummary"></a>

回溯測試的狀態、開始時間和結束時間，以及故障原因，如適用。

## 目錄
<a name="API_TestWindowSummary_Contents"></a>

 ** Message **   <a name="forecast-Type-TestWindowSummary-Message"></a>
如果測試失敗，則表示失敗的原因。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-TestWindowSummary-Status"></a>
測試的狀態。可能的狀態值為：  
+  `ACTIVE` 
+  `CREATE_IN_PROGRESS` 
+  `CREATE_FAILED` 
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** TestWindowEnd **   <a name="forecast-Type-TestWindowSummary-TestWindowEnd"></a>
測試結束的時間。  
類型：Timestamp  
必要：否

 ** TestWindowStart **   <a name="forecast-Type-TestWindowSummary-TestWindowStart"></a>
測試開始的時間。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_TestWindowSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TestWindowSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TestWindowSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TestWindowSummary) 

# TimeAlignmentBoundary
<a name="API_TimeAlignmentBoundary"></a>

時間界限預測使用 來對齊和彙總您的資料，以符合您的預測頻率。以索引鍵值對形式提供時間和時間界限的單位。如果您未提供時間界限，預測會使用一組[預設時間界限](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries)。

如需彙總的詳細資訊，請參閱[不同預測頻率的資料彙總](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html)。如需設定自訂時間界限的詳細資訊，請參閱[指定時間界限](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary)。

## 目錄
<a name="API_TimeAlignmentBoundary_Contents"></a>

 ** DayOfMonth **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfMonth"></a>
在彙總期間用於時間一致性的月份日期。  
類型：整數  
有效範圍：最小值為 1。最大值為 28。  
必要：否

 ** DayOfWeek **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfWeek"></a>
在彙總期間用於時間對齊的星期幾。日期必須為大寫。  
類型：字串  
有效值:`MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY`   
必要：否

 ** Hour **   <a name="forecast-Type-TimeAlignmentBoundary-Hour"></a>
在彙總期間用於時間對齊的一天中小時。  
類型：整數  
有效範圍：最小值為 0。最大值為 23。  
必要：否

 ** Month **   <a name="forecast-Type-TimeAlignmentBoundary-Month"></a>
在彙總期間用於時間對齊的月份。月份必須為大寫。  
類型：字串  
有效值:`JANUARY | FEBRUARY | MARCH | APRIL | MAY | JUNE | JULY | AUGUST | SEPTEMBER | OCTOBER | NOVEMBER | DECEMBER`   
必要：否

## 另請參閱
<a name="API_TimeAlignmentBoundary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeAlignmentBoundary) 

# TimeSeriesCondition
<a name="API_TimeSeriesCondition"></a>

在已修改的屬性內建立項目子集。例如，您可以使用此操作來建立 5 美元或以下項目的子集。若要這樣做，請指定 `"AttributeName": "price"`、 `"AttributeValue": "5"`和 `"Condition": "LESS_THAN"`。將此操作與 [CreateWhatIfForecast：TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) 操作中的[Action](API_Action.md)操作配對，以定義屬性的修改方式。

## 目錄
<a name="API_TimeSeriesCondition_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-TimeSeriesCondition-AttributeName"></a>
您正在修改的 item\$1id、維度名稱、IM 名稱或時間戳記。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：是

 ** AttributeValue **   <a name="forecast-Type-TimeSeriesCondition-AttributeValue"></a>
套用至所選 的值`Condition`。  
類型：字串  
長度限制：長度上限為 256。  
模式：`.+`  
必要：是

 ** Condition **   <a name="forecast-Type-TimeSeriesCondition-Condition"></a>
要套用的條件。有效值為 `EQUALS`、 `NOT_EQUALS``LESS_THAN`和 `GREATER_THAN`。  
類型：字串  
有效值:`EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN`   
必要：是

## 另請參閱
<a name="API_TimeSeriesCondition_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesCondition) 

# TimeSeriesIdentifiers
<a name="API_TimeSeriesIdentifiers"></a>

包含您要為其建立預測之時間序列的匯入檔案詳細資訊。

## 目錄
<a name="API_TimeSeriesIdentifiers_Contents"></a>

 ** DataSource **   <a name="forecast-Type-TimeSeriesIdentifiers-DataSource"></a>
資料來源，一種 AWS Identity and Access Management (IAM) 角色，允許 Amazon Forecast 存取資料，以及選擇性的 AWS Key Management Service (KMS) 金鑰。  
類型：[DataSource](API_DataSource.md) 物件  
必要：否

 ** Format **   <a name="forecast-Type-TimeSeriesIdentifiers-Format"></a>
CSV 或 PARQUET 資料格式。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** Schema **   <a name="forecast-Type-TimeSeriesIdentifiers-Schema"></a>
定義資料集的欄位。  
類型：[Schema](API_Schema.md) 物件  
必要：否

## 另請參閱
<a name="API_TimeSeriesIdentifiers_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesIdentifiers) 

# TimeSeriesReplacementsDataSource
<a name="API_TimeSeriesReplacementsDataSource"></a>

替換資料集是基準相關時間序列的修改版本，只包含您想要包含在假設預測中的值。替換資料集必須包含基準相關時間序列中的預測維度和項目識別符，以及至少 1 個已變更的時間序列。此資料集會與基準相關時間序列合併，以建立用於假設預測的轉換資料集。

## 目錄
<a name="API_TimeSeriesReplacementsDataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-S3Config"></a>
Amazon Simple Storage Service (Amazon S3) 儲存貯體中檔案的路徑，以及 Amazon Forecast 可以擔任以存取檔案的 AWS Identity and Access Management (IAM) 角色。或者， 包含 AWS Key Management Service (KMS) 金鑰。此物件是[CreateDatasetImportJob](API_CreateDatasetImportJob.md)請求中提交的[DataSource](API_DataSource.md)物件的一部分，也是[DataDestination](API_DataDestination.md)物件的一部分。  
類型：[S3Config](API_S3Config.md) 物件  
必要：是

 ** Schema **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Schema"></a>
定義資料集的欄位。  
類型：[Schema](API_Schema.md) 物件  
必要：是

 ** Format **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Format"></a>
取代資料的格式，必須是 CSV。  
類型：字串  
長度限制：長度上限為 7。  
模式：`^CSV|PARQUET$`  
必要：否

 ** TimestampFormat **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-TimestampFormat"></a>
替換資料的時間戳記格式。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\-\:\.\,\'\s]+$`  
必要：否

## 另請參閱
<a name="API_TimeSeriesReplacementsDataSource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 

# TimeSeriesSelector
<a name="API_TimeSeriesSelector"></a>

定義用來在`TimeSeriesIdentifiers`物件中建立預測的時間序列集。

`TimeSeriesIdentifiers` 物件需要下列資訊：
+  `DataSource` 
+  `Format` 
+  `Schema` 

## 目錄
<a name="API_TimeSeriesSelector_Contents"></a>

 ** TimeSeriesIdentifiers **   <a name="forecast-Type-TimeSeriesSelector-TimeSeriesIdentifiers"></a>
包含您要為其建立預測之時間序列的匯入檔案詳細資訊。  
類型：[TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 物件  
必要：否

## 另請參閱
<a name="API_TimeSeriesSelector_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesSelector) 

# TimeSeriesTransformation
<a name="API_TimeSeriesTransformation"></a>

轉換函數是一組操作，可選取和修改相關時間序列中的資料列。您可以使用條件操作選取您想要的資料列，並使用轉換操作修改資料列。所有條件都與 AND 操作聯結，這表示所有條件都必須為 true，才能套用轉換。轉換會依列出的順序套用。

## 目錄
<a name="API_TimeSeriesTransformation_Contents"></a>

 ** Action **   <a name="forecast-Type-TimeSeriesTransformation-Action"></a>
定義時間序列及其轉換方式的動作陣列。這些轉換會建立新的時間序列，用於假設分析。  
類型：[Action](API_Action.md) 物件  
必要：否

 ** TimeSeriesConditions **   <a name="forecast-Type-TimeSeriesTransformation-TimeSeriesConditions"></a>
定義相關時間序列中哪些成員轉換的條件陣列。  
類型：[TimeSeriesCondition](API_TimeSeriesCondition.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 10。  
必要：否

## 另請參閱
<a name="API_TimeSeriesTransformation_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesTransformation) 

# WeightedQuantileLoss
<a name="API_WeightedQuantileLoss"></a>

四分位數的加權損失值。此物件是 [Metrics](API_Metrics.md) 物件的一部分。

## 目錄
<a name="API_WeightedQuantileLoss_Contents"></a>

 ** LossValue **   <a name="forecast-Type-WeightedQuantileLoss-LossValue"></a>
預測值與四分位數的實際值之間的差異，加權 （標準化） 乘以所有四分位數的總和。  
類型：Double  
必要：否

 ** Quantile **   <a name="forecast-Type-WeightedQuantileLoss-Quantile"></a>
四分位數。Quantiles 會將機率分佈分割為機率相等的區域。例如，如果分佈分為 5 個相等機率的區域，則四分位數將為 0.2、0.4、0.6 和 0.8。  
類型：Double  
必要：否

## 另請參閱
<a name="API_WeightedQuantileLoss_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WeightedQuantileLoss) 

# WhatIfAnalysisSummary
<a name="API_WhatIfAnalysisSummary"></a>

提供[ListWhatIfAnalyses](API_ListWhatIfAnalyses.md)操作中使用的假設分析屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md)操作，並提供摘要中列出的 `WhatIfAnalysisArn` 。

## 目錄
<a name="API_WhatIfAnalysisSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-CreationTime"></a>
建立假設分析時。  
類型：Timestamp  
必要：否

 ** ForecastArn **   <a name="forecast-Type-WhatIfAnalysisSummary-ForecastArn"></a>
在此假設分析中使用的基準預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-WhatIfAnalysisSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-WhatIfAnalysisSummary-Status"></a>
假設分析的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
假設分析`Status`的 必須在您能夠存取分析`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** WhatIfAnalysisArn **   <a name="forecast-Type-WhatIfAnalysisSummary-WhatIfAnalysisArn"></a>
假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WhatIfAnalysisName **   <a name="forecast-Type-WhatIfAnalysisSummary-WhatIfAnalysisName"></a>
假設分析的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

## 另請參閱
<a name="API_WhatIfAnalysisSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfAnalysisSummary) 

# WhatIfForecastExportSummary
<a name="API_WhatIfForecastExportSummary"></a>

提供 [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md)操作中使用的假設預測匯出屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md)操作，並提供摘要中列出的 `WhatIfForecastExportArn` 。

## 目錄
<a name="API_WhatIfForecastExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-CreationTime"></a>
建立預測匯出時。  
類型：Timestamp  
必要：否

 ** Destination **   <a name="forecast-Type-WhatIfForecastExportSummary-Destination"></a>
匯出預測的 Amazon Simple Storage Service (Amazon S3) 儲存貯體路徑。  
類型：[DataDestination](API_DataDestination.md) 物件  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-WhatIfForecastExportSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-WhatIfForecastExportSummary-Status"></a>
假設預測匯出的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
假設分析`Status`的 必須在您能夠存取分析`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** WhatIfForecastArns **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastArns"></a>
Amazon Resource Name (ARNs) 陣列，定義匯出中包含的假設預測。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 50。  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WhatIfForecastExportArn **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportArn"></a>
假設預測匯出的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WhatIfForecastExportName **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportName"></a>
假設預測匯出名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

## 另請參閱
<a name="API_WhatIfForecastExportSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastExportSummary) 

# WhatIfForecastSummary
<a name="API_WhatIfForecastSummary"></a>

提供 [ListWhatIfForecasts](API_ListWhatIfForecasts.md)操作中使用的假設預測屬性摘要。若要取得完整的屬性集，請呼叫 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md)操作，並提供摘要中列出的 `WhatIfForecastArn` 。

## 目錄
<a name="API_WhatIfForecastSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastSummary-CreationTime"></a>
建立假設預測時。  
類型：Timestamp  
必要：否

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastSummary-LastModificationTime"></a>
上次修改資源的時間。時間戳記取決於任務的狀態：  
+  `CREATE_PENDING` - `CreationTime`。
+  `CREATE_IN_PROGRESS` - 目前的時間戳記。
+  `CREATE_STOPPING` - 目前的時間戳記。
+  `CREATE_STOPPED` - 任務停止時。
+  `ACTIVE` 或 `CREATE_FAILED` - 任務完成或失敗時。
類型：Timestamp  
必要：否

 ** Message **   <a name="forecast-Type-WhatIfForecastSummary-Message"></a>
如果發生錯誤，則會顯示有關錯誤的資訊訊息。  
類型：字串  
必要：否

 ** Status **   <a name="forecast-Type-WhatIfForecastSummary-Status"></a>
假設預測的狀態。狀態包括：  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
假設分析`Status`的 必須在您能夠存取分析`ACTIVE`之前。
類型：字串  
長度限制：長度上限為 256。  
必要：否

 ** WhatIfAnalysisArn **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfAnalysisArn"></a>
包含此假設預測之假設分析的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WhatIfForecastArn **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfForecastArn"></a>
假設預測的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制條件：長度上限為 300。  
模式：`arn:([a-z\d-]+):forecast:.*:.*:.+`  
必要：否

 ** WhatIfForecastName **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfForecastName"></a>
假設預測的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
模式：`^[a-zA-Z][a-zA-Z0-9_]*`  
必要：否

## 另請參閱
<a name="API_WhatIfForecastSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastSummary) 

# WindowSummary
<a name="API_WindowSummary"></a>

資料集評估部分內的時間範圍指標。此物件是 [EvaluationResult](API_EvaluationResult.md) 物件的一部分。

`TestWindowStart` 和 `TestWindowEnd` 參數由 [EvaluationParameters](API_EvaluationParameters.md) 物件的 `BackTestWindowOffset` 參數決定。

## 目錄
<a name="API_WindowSummary_Contents"></a>

 ** EvaluationType **   <a name="forecast-Type-WindowSummary-EvaluationType"></a>
評估的類型。  
+  `SUMMARY` - 所有視窗的平均指標。
+  `COMPUTED` - 指定時段的指標。
類型：字串  
有效值:`SUMMARY | COMPUTED`   
必要：否

 ** ItemCount **   <a name="forecast-Type-WindowSummary-ItemCount"></a>
視窗內的資料點數量。  
類型：整數  
必要：否

 ** Metrics **   <a name="forecast-Type-WindowSummary-Metrics"></a>
提供用來評估預測器效能的指標。  
類型：[Metrics](API_Metrics.md) 物件  
必要：否

 ** TestWindowEnd **   <a name="forecast-Type-WindowSummary-TestWindowEnd"></a>
定義視窗結尾的時間戳記。  
類型：Timestamp  
必要：否

 ** TestWindowStart **   <a name="forecast-Type-WindowSummary-TestWindowStart"></a>
定義視窗開始的時間戳記。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_WindowSummary_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WindowSummary) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WindowSummary) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WindowSummary) 

# Amazon Forecast Query Service
<a name="API_Types_Amazon_Forecast_Query_Service"></a>

Amazon Forecast Query Service 支援下列資料類型：
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

# DataPoint
<a name="API_forecastquery_DataPoint"></a>

特定日期的預測值。[Forecast](API_forecastquery_Forecast.md) 物件的一部分。

## 目錄
<a name="API_forecastquery_DataPoint_Contents"></a>

 ** Timestamp **   <a name="forecast-Type-forecastquery_DataPoint-Timestamp"></a>
特定預測的時間戳記。  
類型：字串  
必要：否

 ** Value **   <a name="forecast-Type-forecastquery_DataPoint-Value"></a>
預測值。  
類型：Double  
必要：否

## 另請參閱
<a name="API_forecastquery_DataPoint_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/DataPoint) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/DataPoint) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/DataPoint) 

# Forecast
<a name="API_forecastquery_Forecast"></a>

提供預測的相關資訊。作為[QueryForecast](API_forecastquery_QueryForecast.md)回應的一部分傳回。

## 目錄
<a name="API_forecastquery_Forecast_Contents"></a>

 ** Predictions **   <a name="forecast-Type-forecastquery_Forecast-Predictions"></a>
預測。  
string-to-array映射的*字串*是下列其中一個值：  
+ p10
+ p50
+ p90
預設設定為 `["0.1", "0.5", "0.9"]`。使用 [CreateForecast](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) 操作的選用`ForecastTypes`參數來變更值。這些值會根據設定方式而有所不同，最小值為 `1`，最大值為 `5.`   
類型：[DataPoint](API_forecastquery_DataPoint.md)物件陣列的字串映射  
金鑰長度限制：長度上限為 4。  
必要：否

## 另請參閱
<a name="API_forecastquery_Forecast_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/Forecast) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/Forecast) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/Forecast) 

# 常見錯誤
<a name="CommonErrors"></a>

本節列出所有 AWS 服務的 API 動作常見的錯誤。如需此服務之 API 動作的特定錯誤，請參閱該 API 動作的主題。

 **AccessDeniedException**   
您沒有足夠存取權可執行此動作。  
HTTP 狀態碼：400

 **IncompleteSignature**   
請求簽章不符合 AWS 標準。  
HTTP 狀態碼：400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
由於不明的錯誤、例外狀況或故障，處理請求失敗。  
HTTP 狀態碼：500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
請求的動作或操作無效。確認已正確輸入動作。  
HTTP 狀態碼：400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
提供的 X.509 憑證或 AWS 存取金鑰 ID 不存在於我們的記錄中。  
HTTP 狀態碼：403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
您沒有執行此動作的許可。  
HTTP 狀態碼：400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
 AWS 存取金鑰 ID 需要訂閱 服務。  
HTTP 狀態碼：403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
請求送達服務已超過戳印日期於請求上之後的 15 分鐘，或者已超過請求過期日期之後的 15 分鐘 (例如預先簽章的 URL)，或者請求上的日期戳印在未來將超過 15 分鐘。  
HTTP 狀態碼：400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
由於伺服器暫時故障，請求失敗。  
HTTP 狀態碼：503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
由於請求調節，因此請求遭到拒絕。  
HTTP 狀態碼：400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
輸入無法滿足 AWS 服務指定的限制條件。  
HTTP 狀態碼：400

# 常見參數
<a name="CommonParameters"></a>

以下清單內含所有動作用來簽署 Signature 第 4 版請求的參數以及查詢字串。任何專屬於特定動作的參數則列於該動作的主題中。如需 Signature 第 4 版的詳細資訊，請參閱《*IAM 使用者指南*》中的[簽署 AWS API 請求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
建立請求簽章時所使用的雜湊演算法。  
條件：當您在查詢字串中而非 HTTP 授權標頭中納入驗證資訊時，應指定此參數。  
類型：字串  
有效值:`AWS4-HMAC-SHA256`   
必要：有條件

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
憑證範圍值，此為一個字串，其中包含您的存取金鑰、日期、您的目標區域、您請求的服務，以及終止字串 (“aws4\$1request”)。值以下列格式表示：*access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request。  
如需詳細資訊，請參閱《*IAM 使用者指南*》中的[建立已簽署的 AWS API 請求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
條件：當您在查詢字串中而非 HTTP 授權標頭中納入驗證資訊時，應指定此參數。  
類型：字串  
必要：有條件

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
用來建立簽署的日期。格式必須是 ISO 8601 基本格式 (YYYYMMDD'T'HHMMSS'Z')。例如，以下日期時間是有效的 X-Amz-Date 值：`20120325T120000Z`  
條件： 對所有請求而言，X-Amz-Date 皆為選用，可用來覆寫用於簽署請求的日期。如果規定日期標頭採用 ISO 8601 基本格式，則不需要 X-Amz-Date。當使用 X-Amz-Date 時，其一律會覆寫日期標頭的值。如需詳細資訊，請參閱《*IAM 使用者指南*》中的 [AWS API 請求簽章的元素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)。  
類型：字串  
必要：有條件

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
透過呼叫 AWS Security Token Service () 取得的臨時安全字符AWS STS。如需支援 AWS STS的臨時安全憑證的服務清單，請參閱《IAM 使用者指南》**中的[可搭配 IAM 運作的AWS 服務](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)。  
條件：如果您使用來自 的臨時安全登入資料 AWS STS，則必須包含安全字符。  
類型：字串  
必要：有條件

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
指定從要簽署的字串和衍生的簽署金鑰中計算出的十六進位編碼簽章。  
條件：當您在查詢字串中而非 HTTP 授權標頭中納入驗證資訊時，應指定此參數。  
類型：字串  
必要：有條件

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
指定納入作為標準請求一部分的所有 HTTP 標頭。如需指定已簽章標頭的詳細資訊，請參閱《*IAM 使用者指南*》中的[建立已簽章的 AWS API 請求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
條件：當您在查詢字串中而非 HTTP 授權標頭中納入驗證資訊時，應指定此參數。  
類型：字串  
必要：有條件