Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# Amazon Forecast サービス
<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>
予測子の Explainability リソースを作成します。  
タイプ: ブール値  
必須: いいえ

 ** [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>
予測子のトレーニングに使用される予測タイプ。最大 5 つの予測タイプを指定できます。予測タイプは、0.01 以上の増分で 0.01 から 0.99 までの分位数にすることができます。`mean` で平均予測を指定することもできます。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。  
長さの制限: 最小長は 2 です。最大長は 4 です。  
パターン: `(^0?\.\d\d?$|^mean$)`   
必須: いいえ

 ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-MonitorConfig"></a>
予測子モニタリングの構成の詳細。モニターの名前を指定します。  
予測子モニタリングにより、予測子のパフォーマンスが時間の経過とともにどのように変化するかを確認できます。詳細については、「[Predictor Monitoring](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>
予測子の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。  
タグには以下の制限があります。  
+ タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ リソースあたりのタグの最大数: 50。
+ キーの最大長 128 文字 (Unicode) (UTF-8)。
+ 値の最大長: 256 文字 (Unicode) (UTF-8)。
+ 使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および \$1 - = 。\$1 : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。
+ キープレフィックスには、`aws:` または `AWS:` の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。`aws` のキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。このプレフィックスが含まれるタグキーを編集したり削除することはできません。
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

 ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) **   <a name="forecast-CreateAutoPredictor-request-TimeAlignmentBoundary"></a>
Forecast が、予想頻度に合わないすべてのデータを調整および集計するために使用する時間境界です。時間単位と時間境界をキーバリューペアとして指定します。時間境界の指定について詳しくは、「[Specifying a Time Boundary](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary)」を参照してください。時間境界を指定しない場合、Forecast は[デフォルトの時間境界](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) 
+  [AWS SDK for Ruby V3](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 Sample GitHub repository](https://github.com/aws-samples/amazon-forecast-samples)」(Amazon Forecast のサンプル GitHubリポジトリ) を参照してください。

**注記**  
データセットの `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` パラメータ用に指定された値は一致する必要があります。  
`Domain` と `DatasetType` を選択すると、データセットにインポートするトレーニングデータに存在しなければならないフィールドが決まります。例えば、`RETAIL` ドメインを選択し、`DatasetType` として `TARGET_TIME_SERIES` を指定した場合、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 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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` ドメインを選択し、`DatasetType` として `TARGET_TIME_SERIES` を指定した場合、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 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) を指定します。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

Amazon Forecast がデータのコピーを作成し、内部 AWS システムで処理するため、データにアクセスするために Amazon Forecast が引き受けることができる AWS Identity and Access Management (IAM) ロールを含む [DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) オブジェクトを指定する必要があります。詳細については、「[Set up permissions](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html)」を参照してください。

トレーニングデータは CSV または Parquet 形式である必要があります。区切り文字はカンマ (,) にしてください。

特定のファイル、S3 バケット、または S3 バケット内のフォルダへのパスを指定できます。後者の 2 つのケースでは、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 リソースネーム (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>
インポートするトレーニングデータの場所と、Amazon Forecast がデータにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。トレーニングデータは Amazon S3 バケットに保存されている必要があります。  
暗号化を使用する場合、 には AWS Key Management Service (KMS) キーを含める`DataSource`必要があり、IAM ロールは Amazon Forecast にキーへのアクセス許可を付与する必要があります。KMS キーと IAM ロールは、[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) オペレーションの `EncryptionConfig` パラメータで指定されたものと一致する必要があります。  
型: [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>
geolocation 属性の形式。geolocation 属性は、次の 2 つの方法のいずれかでフォーマットできます。  
+  `LAT_LONG` - 10 進数のフォーマットの緯度と経度 (例: 47.61\$1-122.33)。
+  `CC_POSTALCODE` (米国のみ) - 国コード (US) の後に 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 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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、30min、15min、および 1min。オプションで、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>
geolocation 属性からタイムゾーンの情報を自動的に取得します。このオプションは、複数のタイムゾーンのタイムスタンプを含み、それらのタイムスタンプが現地時間で表されるデータセットに最適です。  
タイプ: ブール値  
必須: いいえ

## レスポンスの構文
<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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) 

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

**注記**  
Explainability は、AutoPredictor ([CreateAutoPredictor](API_CreateAutoPredictor.md)) から生成された予測および予測子でのみ使用できます

Amazon Forecast Explainability を作成します。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

Explainability は、データセットの属性が予測にどのように影響するかをよりよく理解するのに役立ちます。Amazon Forecast は、Impact スコアと呼ばれるメトリクスを使用して、各属性の相対的な影響を定量化し、それらが予測値を増加させるか減少させるかを決定します。

Forecast Explainability を有効にするには、関連する時系列、項目メタデータ、または祝祭日や Weather Index などの追加のデータセットの少なくとも 1 つを予測子に含める必要があります。

**注記**  
ARIMA (AutoRegressive Integrated Moving Average)、ETS (Exponential Smoothing State Space Model)、および NPTS (Non-Parametric Time Series) モデルには、外部時系列データは組み込まれていません。したがって、これらのモデルは、追加のデータセットを含めていても、説明可能性レポートを作成しません。

CreateExplainability は、Predictor ARN または Forecast ARN のいずれかを受け入れます。データセット内のすべての時系列と時間ポイントの集計された Impact スコアを受け取るには、予測子 ARN を入力します。特定の時系列および時間ポイントの Impact スコアを受け取るには、予測 ARN を入力します。

 **予測子 ARN を使用した CreateExplainability** 

**注記**  
予測子ごとに持つことができる Explainability リソースは 1 つだけです。[CreateAutoPredictor](API_CreateAutoPredictor.md) で `ExplainPredictor` を既に有効にしている場合、その予測子には既に Explainability リソースがあります。

Predictor ARN を入力する場合は、次のパラメータが必要です。
+  `ExplainabilityName` - Explainability の一意の名前。
+  `ResourceArn` - 予測子の Arn。
+  `TimePointGranularity` - 「ALL」に設定する必要があります。
+  `TimeSeriesGranularity` - 「ALL」に設定する必要があります。

次のパラメータには値を指定しないでください。
+  `DataSource` - TimeSeriesGranularity が [SPECIFIC] の場合にのみ有効です。
+  `Schema` - TimeSeriesGranularity が [SPECIFIC] の場合にのみ有効です。
+  `StartDateTime` - TimePointGranularity が [SPECIFIC] の場合にのみ有効です。
+  `EndDateTime` - TimePointGranularity が [SPECIFIC] の場合にのみ有効です。

 **Forecast ARN を持つ CreateExplainability** 

**注記**  
最大 50 の時系列と 500 の時間ポイントを指定できます。

Predictor ARN を入力する場合は、次のパラメータが必要です。
+  `ExplainabilityName` - Explainability の一意の名前。
+  `ResourceArn` - 予測の Arn。
+  `TimePointGranularity` - 「ALL」または「SPECIFIC」のいずれか。
+  `TimeSeriesGranularity` - 「ALL」または「SPECIFIC」のいずれか。

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 コンソール内で表示可能な Explainability ビジュアライゼーションを作成します。  
タイプ: ブール値  
必須: いいえ

 ** [EndDateTime](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-EndDateTime"></a>
`TimePointGranularity` が `SPECIFIC` に設定されている場合、Explainability の最後の時間ポイントを定義します。  
次のタイムスタンプ形式を使用します: 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>
Explainability の時系列と時間ポイントの粒度を定義する構成設定。  
型: [ExplainabilityConfig](API_ExplainabilityConfig.md) オブジェクト  
必須: はい

 ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ExplainabilityName"></a>
Explainability の一意の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*`   
必須: はい

 ** [ResourceArn](#API_CreateExplainability_RequestSyntax) **   <a name="forecast-CreateExplainability-request-ResourceArn"></a>
Explainability の作成に使用される予測子または予測の Amazon リソースネーム (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` に設定されている場合、Explainability の最初のポイントを定義します。  
次のタイムスタンプ形式を使用します: 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>
リソースの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。  
タグには以下の制限があります。  
+ タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ リソースあたりのタグの最大数: 50。
+ キーの最大長 128 文字 (Unicode) (UTF-8)。
+ 値の最大長: 256 文字 (Unicode) (UTF-8)。
+ 使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および \$1 - = 。\$1 : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。
+ キープレフィックスには、`aws:` または `AWS:` の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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>
Explainability の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) 

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

[CreateExplainability](API_CreateExplainability.md) オペレーションによって作成された Explainability リソースをエクスポートします。エクスポートされたファイルは、Amazon Simple Storage Service (Amazon S3) バケットにエクスポートされます。

Amazon S3 バケットと、Amazon Forecast が Amazon S3 バケットにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールを含む[DataDestination](API_DataDestination.md)オブジェクトを指定する必要があります。詳細については、「[Amazon Forecast のアクセス許可を設定する](aws-forecast-iam-roles.md)」を参照してください。

**注記**  
Amazon S3 バケットのエクスポートにアクセスする前に、エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。[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>
エクスポートする Explainability の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) **   <a name="forecast-CreateExplainabilityExport-request-ExplainabilityExportName"></a>
Explainability エクスポートの一意の名前。  
タイプ: 文字列  
長さの制約: 最小長は 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>
リソースの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。  
タグには以下の制限があります。  
+ タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ リソースあたりのタグの最大数: 50。
+ キーの最大長 128 文字 (Unicode) (UTF-8)。
+ 値の最大長: 256 文字 (Unicode) (UTF-8)。
+ 使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および \$1 - = 。\$1 : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。
+ キープレフィックスには、`aws:` または `AWS:` の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) 
+  [AWS SDK for Ruby V3](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` が含まれます。分布が対称でない場合 (例えば、ベータおよび負の二項)、平均予測は中央値 (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 リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [Tags](#API_CreateForecast_RequestSyntax) **   <a name="forecast-CreateForecast-request-Tags"></a>
サービスに適用し、予測の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。  
タグには以下のベーシックな制限があります。  
+ リソースあたりのタグの最大数は 50 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) 
+  [AWS SDK for Ruby V3](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/) 

Amazon Forecast が Amazon S3 バケットにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールを含む [DataDestination](API_DataDestination.md) オブジェクトを指定する必要があります。詳細については、「[Amazon Forecast のアクセス許可を設定する](aws-forecast-iam-roles.md)」を参照してください。

詳細については、「[予測の生成](howitworks-forecast.md)」を参照してください。

すべての予測エクスポートジョブのリストを取得するには、[ListForecastExportJobs](API_ListForecastExportJobs.md) オペレーションを使用します。

**注記**  
Amazon S3 バケットの予測にアクセスする前に、予測エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。[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 バケットにエクスポートする必要があります。  
暗号化を使用する場合は、 AWS Key Management Service (KMS) キーを含める`Destination`必要があります。IAM ロールは、Amazon Forecast がキーにアクセスすることを許可する必要があります。  
型: [DataDestination](API_DataDestination.md) オブジェクト  
必須: はい

 ** [ForecastArn](#API_CreateForecastExportJob_RequestSyntax) **   <a name="forecast-CreateForecastExportJob-request-ForecastArn"></a>
エクスポートする予測の Amazon リソースネーム (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 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) 

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

既存の自動予測子の予測モニターリソースを作成します。予測子モニタリングにより、予測子のパフォーマンスが時間の経過とともにどのように変化するかを確認できます。詳細については、「[Predictor Monitoring](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 リソースネーム (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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) 
+  [AWS SDK for Ruby V3](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/) 

リクエストで、データセットグループを指定し、アルゴリズムを指定するか、AutoML を使用して Amazon Forecast にアルゴリズムを選択させます。アルゴリズムを指定すると、アルゴリズム固有のハイパーパラメータを上書きすることもできます。

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 リソースネーム (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 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。
デフォルトの 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>
予測子のトレーニングに使用される予測タイプを指定します。最大 5 つの予測タイプを指定できます。予測タイプは、0.01 以上の増分で 0.01 から 0.99 までの分位数にすることができます。`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` です。この場合、アルゴリズムを指定する必要があります。  
Amazon Forecast が AutoML を実行するように `PerformAutoML` を `true` に設定します。これは、トレーニングデータに適したアルゴリズムがわからない場合に適したオプションです。この場合、`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 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) 
+  [AWS SDK for Ruby V3](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 ファイルを含む 2 つのフォルダが、指定した 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 バケットと、Amazon Forecast が Amazon S3 バケットにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールを含む[DataDestination](API_DataDestination.md)オブジェクトを指定する必要があります。詳細については、「[Amazon Forecast のアクセス許可を設定する](aws-forecast-iam-roles.md)」を参照してください。

**注記**  
Amazon S3 バケットのエクスポートにアクセスする前に、エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。[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 リソースネーム (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>
バックテストの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。  
タグには以下の制限があります。  
+ タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ リソースあたりのタグの最大数: 50。
+ キーの最大長 128 文字 (Unicode) (UTF-8)。
+ 値の最大長: 256 文字 (Unicode) (UTF-8)。
+ 使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および \$1 - = 。\$1 : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。
+ キープレフィックスには、`aws:` または `AWS:` の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) 

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

What-If 分析は、時系列に仮定の変更を加え、その変化によって生成された予想を、ベースラインの未変更時系列と比較するシナリオモデリング手法です。What-If 分析の目的は、ベースラインの時系列にさまざまな変更が加えられた場合に、予想がどのように変化するかを理解することであることを覚えておいてください。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

例えば、ある衣料品小売業者が、新しいスタイル用にスペースを空けるためにシーズン終了時のセールを検討していると想像してみてください。ベースライン予想を作成したら、What-If 分析を使用して、さまざまな販売戦略が目標にどのように影響するかを調査できます。

すべてに 25% の値下げを付与するシナリオと、すべてに固定ドルの値下げを付与するシナリオを作成できます。セールが 1 週間続くシナリオと、セールが 1 か月続くシナリオを作成できます。What-if 分析では、さまざまなシナリオを互いに比較できます。

What-If 分析は、予想モデルが学習した内容と、評価中のシナリオで予想モデルがどのように動作するかを表示するためのものであることに注意してください。What-If 分析の結果をやみくもにビジネス上の意思決定に使用しないでください。例えば、予想が適切かどうかを判断するための参考資料がないような新しいシナリオでは、予想が正確でない可能性があります。

[TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクトは what-if 分析に必要な項目を定義します。

**注記**  
What-If 分析を作成するには、データをカンマ区切り値 (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 リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-Tags"></a>
What-If 予想に適用する[タグ](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` オブジェクトの What-If 分析で使用される時系列のセットを定義します。What-If 分析は、このオブジェクトの時系列に対してのみ実行されます。  
`TimeSeriesIdentifiers` オブジェクトには次の情報が必要です。  
+  `DataSource` 
+  `Format` 
+  `Schema` 
型: [TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクト  
必須: いいえ

 ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) **   <a name="forecast-CreateWhatIfAnalysis-request-WhatIfAnalysisName"></a>
What-If 分析の名前。それぞれの名前は一意である必要があります。  
タイプ: 文字列  
長さの制約: 最小長は 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>
What-If 分析の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) 

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

What-If 予想は、ベースライン予測を修正したバージョンから作成された予想です。各 What-If 予想には、代替データセットまたは元のデータセットに対する一連の変換が組み込まれています。

**重要**  
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>
What-If 予想に適用する[タグ](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>
関連する時系列データセットで変更したい行を含む代替時系列データセット。代替時系列には、ベースライン関連の時系列に含まれるすべての行が含まれている必要はありません。What-If 予想に含めたい行 (メジャーとディメンションの組み合わせ) のみを含めてください。  
このデータセットを元の時系列と統合して、What-If 分析に使用される変換済みデータセットを作成します。  
このデータセットには、変更する項目 (item\$1id や workforce\$1type など)、関連するディメンション、タイムスタンプ列、および関連する時系列列の少なくとも 1 つが含まれている必要があります。このファイルには、同じ時系列のタイムスタンプが重複してはいけません。このファイルは CSV 形式である必要があります。  
このデータセットに含まれていないタイムスタンプと item\$1id は What-If 分析には含まれません。  
型: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) オブジェクト  
必須: いいえ

 ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-TimeSeriesTransformations"></a>
ベースライン時系列に適用される変換。各変換には 1 つのアクションと一連の条件が含まれます。アクションはすべての条件が満たされたときにのみ適用されます。条件を指定しない場合、アクションはすべての項目に適用されます。  
型: [TimeSeriesTransformation](API_TimeSeriesTransformation.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 30 項目です。  
必須: いいえ

 ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfAnalysisArn"></a>
What-If 分析の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) **   <a name="forecast-CreateWhatIfForecast-request-WhatIfForecastName"></a>
What-If 予想の名前。名前は、各 What-If 分析内で一意である必要があります。  
タイプ: 文字列  
長さの制約: 最小長は 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>
What-If 予想の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) 
+  [AWS SDK for Ruby V3](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/) 

Amazon Forecast が Amazon S3 バケットにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールを含む [DataDestination](API_DataDestination.md) オブジェクトを指定する必要があります。詳細については、「[Amazon Forecast のアクセス許可を設定する](aws-forecast-iam-roles.md)」を参照してください。

詳細については、「[予測の生成](howitworks-forecast.md)」を参照してください。

すべての What-If 予想エクスポートジョブのリストを取得するには、[ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) オペレーションを使用します。

**注記**  
Amazon S3 バケットの予測にアクセスする前に、予測エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。[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 バケットにエクスポートする必要があります。  
暗号化を使用する場合は、 AWS Key Management Service (KMS) キーを含める`Destination`必要があります。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>
What-If 予想に適用する[タグ](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>
エクスポートする What-If 予想 Amazon リソースネーム (ARN) のリスト。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。  
長さの制限: 最大長は 300 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) **   <a name="forecast-CreateWhatIfForecastExport-request-WhatIfForecastExportName"></a>
エクスポートする What-If 予想の名前。  
タイプ: 文字列  
長さの制約: 最小長は 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>
What-If 予想の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) 
+  [AWS SDK for Ruby V3](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/) 

**注記**  
Forecast は、削除されたデータセットを含むデータセットグループを自動的に更新しません。データセットグループを更新するには、削除されたデータセットの ARN を省略して、[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) オペレーションを使用します。

## リクエストの構文
<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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) 

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

Explainability リソースを削除します。

**重要**  
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>
削除する Explainability リソースの Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) 

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

Explainability エクスポートを削除します。

## リクエストの構文
<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>
削除する Explainability エクスポートの Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) 

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

モニターリソースを削除します。削除できるのは、`ACTIVE`、`ACTIVE_STOPPED`、`CREATE_FAILED`、または `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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) 
+  [AWS SDK for Ruby V3](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 のリソースには、次の親-子リソース階層があります。
+  **[Dataset]** (データセット) : データセットのインポートジョブ
+  **[Dataset Group]** (データセットグループ) : 予測子、予測子バックテストエクスポートジョブ、予測、予測エクスポートジョブ
+  **[Predictor]** (予測子) : 予測子バックテストエクスポートジョブ、予測、予測エクスポートジョブ
+  **[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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) 

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

[CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) オペレーションを使用して作成された What-If 分析を削除します。削除できるのは、ステータスが `ACTIVE` または `CREATE_FAILED` の What-If 分析だけです。[DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) オペレーションを使用して、ステータスを取得します。

予想のいずれかがエクスポートされている間は、What-If 分析を削除することはできません。

**重要**  
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>
削除する What-If 分析の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) 

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

[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想を削除します。ステータスが `ACTIVE` または `CREATE_FAILED` の What-If 予想のみを削除できます。[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) オペレーションを使用して、ステータスを取得します。

エクスポート中に What-If 予想を削除することはできません。What-If 予想を削除すると、What-If 分析をクエリできなくなります。

## リクエストの構文
<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>
削除する What-If 予想の Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) 

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

[CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) オペレーションを使用して作成された What-If 予想エクスポートを削除します。ステータスが `ACTIVE` または `CREATE_FAILED` の What-If 予想エクスポートのみを削除できます。[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>
削除する What-If 予想エクスポートの Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リクエストのタイムスタンプです。  
タイプ: タイムスタンプ

 ** [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>
予測子のトレーニングデータをインポートするために使用されるデータセットのインポートジョブの ARN の配列。  
型: 文字列の配列  
長さの制約: 最大長は 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>
Predictor Explainability のステータスと 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] は毎年を示し、[5min] は 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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
エラーが発生した場合は、エラーの原因を詳しく説明するメッセージ。  
タイプ: 文字列

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
Amazon リソースネーム (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 リソースネーム (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>
Forecast がデータを集計するときに使用する時間境界。  
型: [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) オブジェクト

## エラー
<a name="API_DescribeAutoPredictor_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
データセットが作成された時点。  
タイプ: タイムスタンプ

 ** [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 リソースネーム (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` はインポートジョブが終了または失敗した時点です。  
タイプ: タイムスタンプ

 ** [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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
データセットグループが作成された時点。  
タイプ: タイムスタンプ

 ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="forecast-DescribeDatasetGroup-response-DatasetArns"></a>
データセットグループに含まれるデータセットの Amazon リソースネーム (ARN) の配列。  
型: 文字列の配列  
長さの制約: 最大長は 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` コールの現在の時刻です。  
タイプ: タイムスタンプ

 ** [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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
データセットのインポートジョブが作成された時点。  
タイプ: タイムスタンプ

 ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DatasetArn"></a>
トレーニングデータのインポート先であるデータセットの Amazon リソースネーム (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)。  
型: 倍精度

 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-DataSource"></a>
インポートするトレーニングデータの場所と、Amazon Forecast がデータにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。  
暗号化が使用されている場合、 には AWS Key Management Service (KMS) キー`DataSource`が含まれます。  
型: [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>
geolocation 属性の形式。有効な値: `"LAT_LONG"` および `"CC_POSTALCODE"`。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `^[a-zA-Z0-9_]+$` 

 ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="forecast-DescribeDatasetImportJob-response-ImportMode"></a>
データセットのインポートジョブのインポートモード。完全または増分。  
型: 文字列  
有効な値：`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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [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、30min、15min、および 1min。オプションで、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` が geolocation 属性から自動的に派生するかどうか。  
タイプ: ブール値

## エラー
<a name="API_DescribeDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob) 

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

[CreateExplainability](API_CreateExplainability.md) オペレーションを使用して作成された Explainability リソースを記述します。

**重要**  
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>
記述する Explainability の Amazon リソースネーム (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>
Explainability リソースが作成された時点。  
タイプ: タイムスタンプ

 ** [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>
Explainability リソースのためにビジュアライゼーションが有効になっているかどうか。  
タイプ: ブール値

 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EndDateTime"></a>
`TimePointGranularity` が `SPECIFIC` に設定されている場合、Explainability の最後の時間ポイント。  
タイプ: 文字列  
長さの制限: 最大長は 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>
Explainability の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityConfig"></a>
Explainability の時系列と時間ポイントの粒度を定義する構成設定。  
型: [ExplainabilityConfig](API_ExplainabilityConfig.md) オブジェクト

 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityName"></a>
Explainability の名前。  
タイプ: 文字列  
長さの制約: 最小長は 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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Message"></a>
エラーが発生した場合は、エラーに関するメッセージ。  
タイプ: 文字列

 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ResourceArn"></a>
Explainability リソースの作成に使用される予測子または予測の Amazon リソースネーム (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` に設定されている場合、Explainability の最初の時間ポイント。  
タイプ: 文字列  
長さの制限: 最大長は 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability) 

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

[CreateExplainabilityExport](API_CreateExplainabilityExport.md) オペレーションを使用して作成された Explainability エクスポートを記述します。

## リクエストの構文
<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>
Explainability エクスポートの Amazon リソースネーム (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>
Explainability エクスポートが作成された時点。  
タイプ: タイムスタンプ

 ** [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>
Explainability エクスポートの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-ExplainabilityExportArn"></a>
Explainability エクスポートの Amazon リソースネーム (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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-response-Message"></a>
エクスポート中に発生したエラーに関する情報。  
タイプ: 文字列

 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) **   <a name="forecast-DescribeExplainabilityExport-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_DescribeExplainabilityExport_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainabilityExport) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
予測作成タスクが作成された時点。  
タイプ: タイムスタンプ

 ** [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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
予測エクスポートジョブが作成された時点。  
タイプ: タイムスタンプ

 ** [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 リソースネーム (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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [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` 
S3 バケットの予測にアクセスする前に、予測エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。
タイプ: 文字列  
長さの制約: 最大長は 256 です。

## エラー
<a name="API_DescribeForecastExportJob_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
モニターリソースが作成されたときのタイムスタンプ。  
タイプ: タイムスタンプ

 ** [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>
モニターが完了した最新の評価のタイムスタンプ。  
タイプ: タイムスタンプ

 ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-LastModificationTime"></a>
モニターに加えられた最新の変更のタイムスタンプ。  
タイプ: タイムスタンプ

 ** [Message](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-Message"></a>
モニターに関するエラーメッセージ (存在する場合)。  
タイプ: 文字列

 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) **   <a name="forecast-DescribeMonitor-response-MonitorArn"></a>
説明されたモニターリソースの Amazon リソースネーム (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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeMonitor) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。
予測子のトレーニングに使用する AutoML 戦略。`LatencyOptimized` が指定されていない限り、AutoML 戦略は予測子の精度を最適化します。  
このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。  
型: 文字列  
有効な値：`LatencyOptimized | AccuracyOptimized`

 ** [CreationTime](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-CreationTime"></a>
モデルトレーニングタスクが作成された時点。  
タイプ: タイムスタンプ

 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) **   <a name="forecast-DescribePredictor-response-DatasetImportJobArns"></a>
予測子のトレーニングデータをインポートするために使用されるデータセットのインポートジョブの ARN の配列。  
型: 文字列の配列  
長さの制約: 最大長は 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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [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>
モデルトレーニング中に選択されたデフォルトのトレーニングパラメータまたは上書き。AutoML を実行するか、CNN-QR または DeepAR\$1 で 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
予測子バックテストエクスポートジョブが作成された時点。  
タイプ: タイムスタンプ

 ** [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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-Message"></a>
バックテストエクスポート中に発生した可能性のあるエラーに関する情報。  
タイプ: 文字列

 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorArn"></a>
予測子の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) **   <a name="forecast-DescribePredictorBacktestExportJob-response-PredictorBacktestExportJobArn"></a>
予測子バックテストエクスポートジョブの Amazon リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) 

# DescribeWhatIfAnalysis
<a name="API_DescribeWhatIfAnalysis"></a>

[CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) オペレーションを使用して作成された What-If 分析について説明します。

**重要**  
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>
関心がある What-If 分析の Amazon リソースネーム (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>
What-If 分析が作成された日時。  
タイプ: タイムスタンプ

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-EstimatedTimeRemainingInMinutes"></a>
What-If 分析が完了するまでのおおよその残り時間 (分単位)。  
タイプ: Long

 ** [ForecastArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-ForecastArn"></a>
What-If 予想の Amazon リソースネーム (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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Message"></a>
エラーが発生した場合は、エラーに関する情報メッセージ。  
タイプ: 文字列

 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-Status"></a>
What-If 分析のステータス。含まれる状態は次のとおりです。  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
分析にアクセスするには、What-If 分析の `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>
What-If 分析の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) **   <a name="forecast-DescribeWhatIfAnalysis-response-WhatIfAnalysisName"></a>
What-If 分析の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 

## エラー
<a name="API_DescribeWhatIfAnalysis_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) 

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

[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想を記述します。

**重要**  
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>
関心がある What-If 予想の Amazon リソースネーム (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>
What-If 予想が作成された日時。  
タイプ: タイムスタンプ

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-EstimatedTimeRemainingInMinutes"></a>
What-If 予想を完了するまでのおおよその残り時間 (分単位)。  
タイプ: Long

 ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-ForecastTypes"></a>
確率的予測が生成される分位数。[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションでの What-If 予想ごとに最大 5 つの分位を指定できます。分位数を指定しなかった場合、デフォルト値は `["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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Message"></a>
エラーが発生した場合は、エラーに関する情報メッセージ。  
タイプ: 文字列

 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-Status"></a>
What-If 予想のステータス。含まれる状態は次のとおりです。  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
予想にアクセスするには、What-If 予想の `Status` が `ACTIVE` である必要があります。
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `^[a-zA-Z0-9\_]+$` 

 ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-TimeSeriesReplacementsDataSource"></a>
置換時系列を表す `S3Config`、`Schema`、`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>
この What-If 予想を含む分析の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastArn"></a>
What-If 予想の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最大長は 300 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecast-response-WhatIfForecastName"></a>
What-If 予想の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 

## エラー
<a name="API_DescribeWhatIfForecast_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast) 

# DescribeWhatIfForecastExport
<a name="API_DescribeWhatIfForecastExport"></a>

[CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) オペレーションを使用して作成された What-If 予想エクスポートを記述します。

**重要**  
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>
関心がある What-If 予想エクスポートの Amazon リソースネーム (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>
What-If 予想エクスポートが作成された日時。  
タイプ: タイムスタンプ

 ** [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>
What-If 予想エクスポートを完了するまでのおおよその残り時間 (分単位)。  
タイプ: 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` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Message"></a>
エラーが発生した場合は、エラーに関する情報メッセージ。  
タイプ: 文字列

 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-Status"></a>
What-If 予想のステータス。含まれる状態は次のとおりです。  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
予想エクスポートにアクセスするには、What-If 予想エクスポートの `Status` が `ACTIVE` である必要があります。
タイプ: 文字列  
長さの制約: 最大長は 256 です。

 ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastArns"></a>
このリソースにエクスポートされるすべての What-If 予想を表す Amazon リソースネーム (ARN) の配列。  
型: 文字列の配列  
長さの制限: 最大長は 300 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportArn"></a>
What-If 予想エクスポートの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制限: 最大長は 300 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) **   <a name="forecast-DescribeWhatIfForecastExport-response-WhatIfForecastExportName"></a>
What-If 予想エクスポートの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 

## エラー
<a name="API_DescribeWhatIfForecastExport_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
その Amazon リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) 

# GetAccuracyMetrics
<a name="API_GetAccuracyMetrics"></a>

[CreatePredictor](API_CreatePredictor.md) オペレーションによってトレーニングされたモデルの精度に関するメトリクスを提供します。メトリクスを使用して、モデルのパフォーマンスを確認し、予測子を使用して予測を生成するかどうかを決定します。詳細については、「[Predictor Metrics](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 リソースネーム (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 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。
予測子のトレーニングに使用する 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) オペレーションでデータセットグループ ARN を使用すると、プロパティの完全なセットを取得できます。

**重要**  
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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) オペレーションで ARN を使用すると、プロパティの完全なセットを取得できます。[Filter](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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致するデータセットをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) を含むプロパティの概要が返されます。プロパティの完全なセットを取得するには、[DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) オペレーションで ARN を使用します。

**重要**  
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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets) 

# ListExplainabilities
<a name="API_ListExplainabilities"></a>

[CreateExplainability](API_CreateExplainability.md) オペレーションを使用して作成された Explainability リソースのリストを返します。このオペレーションは、各 Explainability に関する要約を返します。[Filter](API_Filter.md) オブジェクトの配列を使用してリストをフィルタリングできます。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

特定の Explainability リソースのプロパティの完全なセットを取得するには、[DescribeExplainability](API_DescribeExplainability.md) オペレーションで ARN を使用します。

## リクエストの構文
<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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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>
各 Explainability リソースのプロパティを要約するオブジェクトの配列。  
型: [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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilities) 

# ListExplainabilityExports
<a name="API_ListExplainabilityExports"></a>

[CreateExplainabilityExport](API_CreateExplainabilityExport.md) オペレーションを使用して作成された Explainability エクスポートのリストを返します。このオペレーションは、各 Explainability のエクスポートに関する要約を返します。[Filter](API_Filter.md) オブジェクトの配列を使用してリストをフィルタリングできます。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

特定の Explainability エクスポートのプロパティの完全なセットを取得するには、[DescribeExplainability](API_DescribeExplainability.md) オペレーションで ARN を使用します。

## リクエストの構文
<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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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>
各 Explainability エクスポートのプロパティを要約するオブジェクトの配列。  
型: [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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilityExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilityExports) 

# ListForecastExportJobs
<a name="API_ListForecastExportJobs"></a>

[CreateForecastExportJob](API_CreateForecastExportJob.md) オペレーションを使用して作成された予測エクスポートジョブのリストを返します。このオペレーションは、各予測エクスポートジョブについて、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。プロパティの完全なセットを取得するには、[DescribeForecastExportJob](API_DescribeForecastExportJob.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_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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する予測エクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs) 

# ListForecasts
<a name="API_ListForecasts"></a>

[CreateForecast](API_CreateForecast.md) オペレーションを使用して作成された予測のリストを返します。このオペレーションは、各予測について、Amazon リソースネーム (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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する予測をリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts) 
+  [AWS SDK for Ruby V3](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)」を参照してください。モニタリング結果の取得について詳しくは、「[Viewing Monitoring Results](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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 リソースネーム (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>
さまざまな期間にモニターリソースによって収集されたモニタリング結果と予測イベント。  
モニタリングについて詳しくは、「[Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)」を参照してください。モニタリング結果の取得について詳しくは、「[Viewing Monitoring Results](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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitors) 
+  [AWS SDK for Ruby V3](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/) 

特定のバックテストエクスポートジョブのプロパティの完全なセットを取得するには、[DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) オペレーションで ARN を使用します。

## リクエストの構文
<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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致する予測子バックテストエクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictorBacktestExportJobs) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) を含むプロパティの概要を返します。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

[DescribeAutoPredictor](API_DescribeAutoPredictor.md) および [DescribePredictor](API_DescribePredictor.md) オペレーションで ARN を使用すると、プロパティの完全なセットを取得できます。[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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する予測子をリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource) 

# ListWhatIfAnalyses
<a name="API_ListWhatIfAnalyses"></a>

[CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) オペレーションを使用して作成された What-If 分析のリストを返します。このオペレーションは、各 What-If 分析について、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) オペレーションで What-If 分析 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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する What-If 分析ジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `Condition` - 適用する条件。有効な値は、`IS` および `IS_NOT` です。ステートメントに一致する What-If 分析を含めるには、`IS` を指定します。一致する What-If 分析ジョブを除外するには、`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>
レスポンスが切り捨てられた場合、Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。  
タイプ: 文字列  
長さの制約: 最小長は 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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfAnalyses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfAnalyses) 

# ListWhatIfForecastExports
<a name="API_ListWhatIfForecastExports"></a>

[CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) オペレーションを使用して作成された What-If 予想エクスポートのリストを返します。このオペレーションは、各 What-If 予想エクスポートについて、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) オペレーションで What-If 予想エクスポート ARN を使用すると、プロパティの完全なセットを取得できます。

**重要**  
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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する What-If 予想エクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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>
レスポンスが切り捨てられた場合、Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。  
タイプ: 文字列  
長さの制約: 最小長は 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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecastExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecastExports) 

# ListWhatIfForecasts
<a name="API_ListWhatIfForecasts"></a>

[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想のリストを返します。このオペレーションは、各 What-If 予想について、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) オペレーションで What-If 予想 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>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する What-If 予想エクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) 
+  [AWS SDK for Ruby V3](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`。リソースが停止されると、そのリソースを再開することはできません。

このオペレーションは、次のリソース (および対応する子リソース) に適用できます。
+ データセットのインポートジョブ
+ 予測子ジョブ
+ 予測ジョブ
+ 予測エクスポートジョブ
+ 予測子バックテストエクスポートジョブ
+ Explainability ジョブ
+ Explainability エクスポートジョブ

## リクエストの構文
<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 リソースネーム (ARN)。サポートされている ARN は、`DatasetImportJobArn`、`PredictorArn`、`PredictorBacktestExportJobArn`、`ForecastArn`、`ForecastExportJobArn`、`ExplainabilityArn`、および `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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="forecast-TagResource-request-Tags"></a>
リソースに追加するタグ。タグは、キーバリューペアの配列です。  
タグには以下のベーシックな制限があります。  
+ リソースあたりのタグの最大数は 50 です。
+ タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
+ キーの最大長 - 128 文字 (Unicode) (UTF-8)。
+ 値の最大長 - 256 文字 (Unicode) (UTF-8)。
+ 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。
+ タグのキーと値では、大文字と小文字が区別されます。
+ `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) 
+  [AWS SDK for Ruby V3](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 リソースネーム (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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN) の配列。  
型: 文字列の配列  
長さの制約: 最大長は 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 リソースネーム (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 SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup)