Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # API リファレンスこのセクションでは、Amazon Forecast API オペレーションについて説明します。 **Topics** + [アクション](API_Operations.md) + [データ型](API_Types.md) + [共通エラー](CommonErrors.md) + [共通パラメータ](CommonParameters.md) # アクション次のアクションは、Amazon Forecast Service でサポートされています: + [CreateAutoPredictor](API_CreateAutoPredictor.md) + [CreateDataset](API_CreateDataset.md) + [CreateDatasetGroup](API_CreateDatasetGroup.md) + [CreateDatasetImportJob](API_CreateDatasetImportJob.md) + [CreateExplainability](API_CreateExplainability.md) + [CreateExplainabilityExport](API_CreateExplainabilityExport.md) + [CreateForecast](API_CreateForecast.md) + [CreateForecastExportJob](API_CreateForecastExportJob.md) + [CreateMonitor](API_CreateMonitor.md) + [CreatePredictor](API_CreatePredictor.md) + [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) + [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) + [CreateWhatIfForecast](API_CreateWhatIfForecast.md) + [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) + [DeleteDataset](API_DeleteDataset.md) + [DeleteDatasetGroup](API_DeleteDatasetGroup.md) + [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) + [DeleteExplainability](API_DeleteExplainability.md) + [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) + [DeleteForecast](API_DeleteForecast.md) + [DeleteForecastExportJob](API_DeleteForecastExportJob.md) + [DeleteMonitor](API_DeleteMonitor.md) + [DeletePredictor](API_DeletePredictor.md) + [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) + [DeleteResourceTree](API_DeleteResourceTree.md) + [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) + [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) + [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) + [DescribeAutoPredictor](API_DescribeAutoPredictor.md) + [DescribeDataset](API_DescribeDataset.md) + [DescribeDatasetGroup](API_DescribeDatasetGroup.md) + [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) + [DescribeExplainability](API_DescribeExplainability.md) + [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) + [DescribeForecast](API_DescribeForecast.md) + [DescribeForecastExportJob](API_DescribeForecastExportJob.md) + [DescribeMonitor](API_DescribeMonitor.md) + [DescribePredictor](API_DescribePredictor.md) + [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) + [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) + [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) + [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) + [GetAccuracyMetrics](API_GetAccuracyMetrics.md) + [ListDatasetGroups](API_ListDatasetGroups.md) + [ListDatasetImportJobs](API_ListDatasetImportJobs.md) + [ListDatasets](API_ListDatasets.md) + [ListExplainabilities](API_ListExplainabilities.md) + [ListExplainabilityExports](API_ListExplainabilityExports.md) + [ListForecastExportJobs](API_ListForecastExportJobs.md) + [ListForecasts](API_ListForecasts.md) + [ListMonitorEvaluations](API_ListMonitorEvaluations.md) + [ListMonitors](API_ListMonitors.md) + [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) + [ListPredictors](API_ListPredictors.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) + [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) + [ListWhatIfForecasts](API_ListWhatIfForecasts.md) + [ResumeResource](API_ResumeResource.md) + [StopResource](API_StopResource.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDatasetGroup](API_UpdateDatasetGroup.md) 次のアクションは、Amazon Forecast Query Service でサポートされています: + [QueryForecast](API_forecastquery_QueryForecast.md) + [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) # Amazon Forecast サービス次のアクションは、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 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` の値のみを指定します。 ## リクエストの構文 ``` { "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" } } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) ** データセットグループと追加のデータセットのデータ設定。型: [DataConfig](API_DataConfig.md) オブジェクト必須: いいえ ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) ** 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) ** 予測子の Explainability リソースを作成します。タイプ: ブール値必須: いいえ ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) ** 生成された予測をグループ化する方法を指定するディメンション (フィールド) 名の配列。例えば、すべての店舗の商品の販売予測を生成していて、データセットに `store_id` フィールドが含まれている場合、各店舗の販売予測をグループ化するディメンションとして `store_id` を指定します。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。長さの制限：最小長 1、最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) ** 予測内の予測の頻度。有効な間隔は、整数の後に 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) ** モデルが予測するタイムステップの数。予測期間は予測長とも呼ばれます。最大予測期間は、500 タイムステップまたは TARGET\$1TIME\$1SERIES のデータセットの長さの 1/4 のいずれか小さい方です。既存の AutoPredictor を再トレーニングする場合、最大予測期間は、500 タイムステップまたは TARGET\$1TIME\$1SERIES のデータセットの長さの 1/3 のいずれか小さい方です。 AutoPredictor にアップグレードする場合、または既存の AutoPredictor を再トレーニングする場合、予測期間パラメータを更新することはできません。この要件は、データセットの時系列を長くすることで満たすことができます。タイプ: 整数必須: いいえ ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) ** 予測子のトレーニングに使用される予測タイプ。最大 5 つの予測タイプを指定できます。予測タイプは、0.01 以上の増分で 0.01 から 0.99 までの分位数にすることができます。`mean` で平均予測を指定することもできます。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` 必須: いいえ ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) ** 予測子モニタリングの構成の詳細。モニターの名前を指定します。予測子モニタリングにより、予測子のパフォーマンスが時間の経過とともにどのように変化するかを確認できます。詳細については、「[Predictor Monitoring](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html)」を参照してください。型: [MonitorConfig](API_MonitorConfig.md) オブジェクト必須: いいえ ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) ** 予測子を最適化するために使用される精度メトリクス。型: 文字列有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 必須：いいえ ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) ** 予測子の一意の名前タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) ** 再トレーニングまたはアップグレードする予測子の ARN。このパラメータは、予測子を再トレーニングまたはアップグレードするときにのみ使用されます。新しい予測子を作成するときは、このパラメータの値を指定しないでください。予測子をアップグレードまたは再トレーニングするときは、`ReferencePredictorArn` と `PredictorName` の値のみを指定します。`PredictorName` の値は、一意の予測子名である必要があります。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** [Tags](#API_CreateAutoPredictor_RequestSyntax) ** 予測子の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。タグには以下の制限があります。 + タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 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) ** 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) オブジェクト必須: いいえ ## レスポンスの構文 ``` { "PredictorArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) ** 予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 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) オペレーションを使用します。 ## リクエストの構文 ``` { "DataFrequency": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DataFrequency](#API_CreateDataset_RequestSyntax) ** データ収集の頻度。このパラメータは、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) ** データセットの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [DatasetType](#API_CreateDataset_RequestSyntax) ** データセットのタイプ。有効な値は、選択した `Domain` によって異なります。型: 文字列有効な値：`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 必須: はい ** [Domain](#API_CreateDataset_RequestSyntax) ** データセットに関連付けられているドメイン。データセットをデータセットグループに追加する場合、この値と、[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) ** Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト必須: いいえ ** [Schema](#API_CreateDataset_RequestSyntax) ** データセットのスキーマ。スキーマ属性とその順序は、データのフィールドと一致する必要があります。データセット `Domain` と選択した `DatasetType` によって、トレーニングデータの最小必須フィールドが決まります。特定のデータセットドメインとタイプの必須フィールドについては、「[データセットドメインとデータセットタイプ](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)」を参照してください。型: [Schema](API_Schema.md) オブジェクト必須: はい ** [Tags](#API_CreateDataset_RequestSyntax) ** サービスに適用し、データセットの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "DatasetArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) ** データセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 関連するデータセットのコレクションを保持するデータセットグループを作成します。データセットグループを作成するとき、または後で [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) オペレーションを使用します。 ## リクエストの構文 ``` { "DatasetArns": [ "string" ], "DatasetGroupName": "string", "Domain": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) ** データセットグループに含めるデータセットの Amazon リソースネーム (ARN) の配列。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) ** データセットグループの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Domain](#API_CreateDatasetGroup_RequestSyntax) ** データセットグループに関連付けられているドメイン。データセットをデータセットグループに追加する場合、この値と、[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) ** サービスに適用し、データセットグループの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "DatasetGroupArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) ** データセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 トレーニングデータを 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) オペレーションを使用します。 ## リクエストの構文 ``` { "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 } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) ** データをインポートする Amazon Forecast データセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) ** データセットのインポートジョブの名前。名前に現在のタイムスタンプを含めることをお勧めします (例: `20190721DatasetImport`)。これは、`ResourceAlreadyExistsException` 例外の発生を回避するのに役立ちます。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) ** インポートするトレーニングデータの場所と、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) ** インポートされたデータの形式は CSV または PARQUETのいずれかです。デフォルト値は「CSV」です。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) ** 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) ** データセットのインポートジョブが `FULL` インポートか `INCREMENTAL` インポートかを指定します。`FULL` データセットのインポートは、既存のデータをすべて新しくインポートされたデータに置き換えます。`INCREMENTAL` インポートでは、インポートされたデータが既存のデータに追加されます。型: 文字列有効な値：`FULL | INCREMENTAL` 必須：いいえ ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) ** サービスに適用し、データセットのインポートジョブの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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) ** データセット内のタイムスタンプの形式。指定する形式は、データセットが作成されたときに指定された `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) ** データセット内のすべての項目についての単一のタイムゾーン。このオプションは、すべてのタイムスタンプが単一のタイムゾーン内にあるデータセット、またはすべてのタイムスタンプが単一のタイムゾーンに正規化されているデータセットに最適です。有効なタイムゾーン名の完全なリストについては、「[Joda-Time API](http://joda-time.sourceforge.net/timezones.html)」を参照してください。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\/\+\-\_]+$` 必須: いいえ ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) ** geolocation 属性からタイムゾーンの情報を自動的に取得します。このオプションは、複数のタイムゾーンのタイムスタンプを含み、それらのタイムスタンプが現地時間で表されるデータセットに最適です。タイプ: ブール値必須: いいえ ## レスポンスの構文 ``` { "DatasetImportJobArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 **注記** 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` - 時間ポイントの範囲の最後のタイムスタンプ。 ## リクエストの構文 ``` { "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" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DataSource](#API_CreateExplainability_RequestSyntax) ** データのソース、Amazon Forecast がデータにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、およびオプションで AWS Key Management Service (KMS) キー。型: [DataSource](API_DataSource.md) オブジェクト必須: いいえ ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) ** AWS コンソール内で表示可能な Explainability ビジュアライゼーションを作成します。タイプ: ブール値必須: いいえ ** [EndDateTime](#API_CreateExplainability_RequestSyntax) ** `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) ** Explainability の時系列と時間ポイントの粒度を定義する構成設定。型: [ExplainabilityConfig](API_ExplainabilityConfig.md) オブジェクト必須: はい ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) ** Explainability の一意の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [ResourceArn](#API_CreateExplainability_RequestSyntax) ** Explainability の作成に使用される予測子または予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [Schema](#API_CreateExplainability_RequestSyntax) ** データセットのフィールドを定義します。型: [Schema](API_Schema.md) オブジェクト必須: いいえ ** [StartDateTime](#API_CreateExplainability_RequestSyntax) ** `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) ** リソースの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。タグには以下の制限があります。 + タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "ExplainabilityArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) ** Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト必須: はい ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) ** エクスポートする Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) ** Explainability エクスポートの一意の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Format](#API_CreateExplainabilityExport_RequestSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) ** リソースの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。タグには以下の制限があります。 + タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "ExplainabilityExportArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) ** エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 予測子のトレーニングに使用された `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` オブジェクトを使用して時系列のサブセットに関する予想を生成することはできます。入力データセットに含まれていない指定の時系列では、予想の作成はスキップされます。予想エクスポートファイルには、これらの時系列や予測値は含まれません。 ## リクエストの構文 ``` { "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" } ] } } } } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastName](#API_CreateForecast_RequestSyntax) ** 予測の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [ForecastTypes](#API_CreateForecast_RequestSyntax) ** 確率的予測が生成される分位数。**現在、予測ごとに最大 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) ** 予測の生成に使用する予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [Tags](#API_CreateForecast_RequestSyntax) ** サービスに適用し、予測の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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) ** `TimeSeriesIdentifiers` オブジェクト内の予想を作成するために使用される時系列のセットを定義します。 `TimeSeriesIdentifiers` オブジェクトには次の情報が必要です。 + `DataSource` + `Format` + `Schema` 型: [TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクト必須: いいえ ## レスポンスの構文 ``` { "ForecastArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ForecastArn](#API_CreateForecast_ResponseSyntax) ** 予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateForecast](API_CreateForecast.md) オペレーションによって作成された予測を Amazon Simple Storage Service (Amazon S3) バケットにエクスポートします。予測ファイル名は、次の規則に一致します。 \$1\$1 ここで、コンポーネントは 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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Destination](#API_CreateForecastExportJob_RequestSyntax) ** 予測を保存する場所と、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) ** エクスポートする予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) ** 予測エクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Format](#API_CreateForecastExportJob_RequestSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。デフォルト値は「CSV」です。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** [Tags](#API_CreateForecastExportJob_RequestSyntax) ** サービスに適用し、予測のエクスポートジョブの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "ForecastExportJobArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) ** エクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 既存の自動予測子の予測モニターリソースを作成します。予測子モニタリングにより、予測子のパフォーマンスが時間の経過とともにどのように変化するかを確認できます。詳細については、「[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/) ## リクエストの構文 ``` { "MonitorName": "string", "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [MonitorName](#API_CreateMonitor_RequestSyntax) ** モニターリソースの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [ResourceArn](#API_CreateMonitor_RequestSyntax) ** 監視する予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [Tags](#API_CreateMonitor_RequestSyntax) ** モニターリソースに適用する[タグ](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)のリスト。型: [Tag](API_Tag.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。必須: いいえ ## レスポンスの構文 ``` { "MonitorArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) ** モニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 **注記** このオペレーションにより、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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "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" } } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) ** モデルトレーニングに使用するアルゴリズムの 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) ** `LatencyOptimized` AutoML 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。デフォルトの AutoML 戦略を上書きするために使用されます。これは、予測子の精度を最適化するために行われます。トレーニング時間を最小限に抑える AutoML 戦略を適用するには、`LatencyOptimized` を使用します。このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。型: 文字列有効な値：`LatencyOptimized | AccuracyOptimized` 必須：いいえ ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) ** Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト必須: いいえ ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) ** 指定されたアルゴリズムのデフォルトの評価パラメータを上書きするために使用されます。Amazon Forecast は、データセットをトレーニングデータとテストデータに分割することで予測子を評価します。評価パラメータは、分割の実行方法と反復回数を定義します。型: [EvaluationParameters](API_EvaluationParameters.md) オブジェクト必須: いいえ ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) ** 特徴量化の設定。型: [FeaturizationConfig](API_FeaturizationConfig.md) オブジェクト必須: はい ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) ** モデルが予測するようにトレーニングされている時間ステップの数を指定します。予測期間は予測長とも呼ばれます。例えば、([CreateDataset](API_CreateDataset.md) オペレーションの `DataFrequency` パラメータを使用して) 毎日のデータ収集用にデータセットを設定し、予測期間を 10 に設定すると、モデルは 10 日間の予測を返します。最大予測期間は、500 タイムステップまたは TARGET\$1TIME\$1SERIES のデータセットの長さの 1/3 のいずれか小さい方です。タイプ: 整数必須: はい ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) ** 予測子のトレーニングに使用される予測タイプを指定します。最大 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) ** アルゴリズム用にハイパーパラメータの上書き値を提供します。このパラメータを指定しない場合、Amazon Forecast はデフォルト値を使用します。個々のアルゴリズムは、ハイパーパラメータ最適化 (HPO) をサポートするハイパーパラメータを指定します。詳細については、「[Amazon Forecast アルゴリズム](aws-forecast-choosing-recipes.md)」を参照してください。 `HPOConfig` オブジェクトを含めた場合は、`PerformHPO` を true に設定する必要があります。型: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクト必須: いいえ ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) ** 予測子のトレーニングに使用するデータを含むデータセットグループを記述します。型: [InputDataConfig](API_InputDataConfig.md) オブジェクト必須: はい ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) ** 予測子を最適化するために使用される精度メトリクス。デフォルト値は `AverageWeightedQuantileLoss` です。型: 文字列有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 必須：いいえ ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) ** AutoML を実行するかどうか。Amazon Forecast が AutoML を実行すると、提供するアルゴリズムが評価され、トレーニングデータセットに最適なアルゴリズムと設定が選択されます。デフォルト値は `false` です。この場合、アルゴリズムを指定する必要があります。 Amazon Forecast が AutoML を実行するように `PerformAutoML` を `true` に設定します。これは、トレーニングデータに適したアルゴリズムがわからない場合に適したオプションです。この場合、`PerformHPO` は false である必要があります。タイプ: ブール値必須: いいえ ** [PerformHPO](#API_CreatePredictor_RequestSyntax) ** ハイパーパラメータの最適化 (HPO) を実行するかどうか。HPO は、トレーニングデータに最適なハイパーパラメータ値を見つけます。HPO を実行するプロセスは、ハイパーパラメータのチューニングジョブの実行として知られています。デフォルト値は `false` です。この場合、Amazon Forecast は、選択したアルゴリズムのデフォルトのハイパーパラメータ値を使用します。デフォルト値を上書きするには、`PerformHPO` を `true` に設定し、オプションで [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクトを指定します。チューニングジョブは、最適化するメトリクス、チューニングに関係するハイパーパラメータ、およびチューニング可能な各ハイパーパラメータの有効範囲を指定します。この場合、アルゴリズムを指定する必要があり、`PerformAutoML` は false である必要があります。次のアルゴリズムは HPO をサポートします。 + DeepAR\$1 + CNN-QR タイプ: ブール値必須: いいえ ** [PredictorName](#API_CreatePredictor_RequestSyntax) ** 予測子の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Tags](#API_CreatePredictor_RequestSyntax) ** サービスに適用し、予測子の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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) ** モデルトレーニングのために上書きするハイパーパラメータ。上書きできるハイパーパラメータは、個々のアルゴリズムにリストされています。サポートされているアルゴリズムのリストについては、「[Amazon Forecast アルゴリズム](aws-forecast-choosing-recipes.md)」を参照してください。タイプ: 文字列間のマッピングマップエントリ: 最小数は 0 項目です。最大数は 100 項目です。キーの長さの制限: 最大長は 256 です。キーパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` 値の長さの制限: 最大長は 256 です。値のパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 必須: いいえ ## レスポンスの構文 ``` { "PredictorArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) ** 予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) エクスポートファイル名は、次の規則に一致します。 `__.csv` コンポーネントは、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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "PredictorArn": "string", "PredictorBacktestExportJobName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト必須: はい ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。デフォルト値は「CSV」です。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** エクスポートする予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** バックテストエクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** バックテストの分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。タグには以下の制限があります。 + タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 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 項目です。必須: いいえ ## レスポンスの構文 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) ** エクスポートする予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 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) 形式にする必要があります。 ## リクエストの構文 ``` { "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" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastArn](#API_CreateWhatIfAnalysis_RequestSyntax) ** ベースライン予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) ** What-If 予想に適用する[タグ](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)のリスト。型: [Tag](API_Tag.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。必須: いいえ ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) ** `TimeSeriesIdentifiers` オブジェクトの What-If 分析で使用される時系列のセットを定義します。What-If 分析は、このオブジェクトの時系列に対してのみ実行されます。 `TimeSeriesIdentifiers` オブジェクトには次の情報が必要です。 + `DataSource` + `Format` + `Schema` 型: [TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクト必須: いいえ ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) ** What-If 分析の名前。それぞれの名前は一意である必要があります。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ## レスポンスの構文 ``` { "WhatIfAnalysisArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [WhatIfAnalysisArn](#API_CreateWhatIfAnalysis_ResponseSyntax) ** What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 What-If 予想は、ベースライン予測を修正したバージョンから作成された予想です。各 What-If 予想には、代替データセットまたは元のデータセットに対する一連の変換が組み込まれています。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "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" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) ** What-If 予想に適用する[タグ](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)のリスト。型: [Tag](API_Tag.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。必須: いいえ ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) ** 関連する時系列データセットで変更したい行を含む代替時系列データセット。代替時系列には、ベースライン関連の時系列に含まれるすべての行が含まれている必要はありません。What-If 予想に含めたい行 (メジャーとディメンションの組み合わせ) のみを含めてください。このデータセットを元の時系列と統合して、What-If 分析に使用される変換済みデータセットを作成します。このデータセットには、変更する項目 (item\$1id や workforce\$1type など)、関連するディメンション、タイムスタンプ列、および関連する時系列列の少なくとも 1 つが含まれている必要があります。このファイルには、同じ時系列のタイムスタンプが重複してはいけません。このファイルは CSV 形式である必要があります。このデータセットに含まれていないタイムスタンプと item\$1id は What-If 分析には含まれません。型: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) オブジェクト必須: いいえ ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) ** ベースライン時系列に適用される変換。各変換には 1 つのアクションと一連の条件が含まれます。アクションはすべての条件が満たされたときにのみ適用されます。条件を指定しない場合、アクションはすべての項目に適用されます。型: [TimeSeriesTransformation](API_TimeSeriesTransformation.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 30 項目です。必須: いいえ ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) ** What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) ** What-If 予想の名前。名前は、各 What-If 分析内で一意である必要があります。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ## レスポンスの構文 ``` { "WhatIfForecastArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションによって作成された予測を Amazon Simple Storage Service (Amazon S3) バケットにエクスポートします。予測ファイル名は、次の規則に一致します。 `≈__` コンポーネントは、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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportName": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) ** 予測を保存する場所と、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) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) ** What-If 予想に適用する[タグ](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)のリスト。型: [Tag](API_Tag.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。必須: いいえ ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) ** エクスポートする What-If 予想 Amazon リソースネーム (ARN) のリスト。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) ** エクスポートする What-If 予想の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ## レスポンスの構文 ``` { "WhatIfForecastExportArn": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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) オペレーションを使用します。 ## リクエストの構文 ``` { "DatasetArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetArn](#API_DeleteDataset_RequestSyntax) ** 削除するデータセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) このオペレーションでは、データセットグループのみが削除され、グループ内のデータセットは削除されません。 ## リクエストの構文 ``` { "DatasetGroupArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) ** 削除するデータセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "DatasetImportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) ** 削除するデータセットのインポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "ExplainabilityArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) ** 削除する Explainability リソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 Explainability エクスポートを削除します。 ## リクエストの構文 ``` { "ExplainabilityExportArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) ** 削除する Explainability エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "ForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastArn](#API_DeleteForecast_RequestSyntax) ** 削除する予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "ForecastExportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) ** 削除する予測エクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 モニターリソースを削除します。削除できるのは、`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/) ## リクエストの構文 ``` { "MonitorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) ** 削除するモニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "PredictorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorArn](#API_DeletePredictor_RequestSyntax) ** 削除する予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 予測子バックテストエクスポートジョブを削除します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) ** 削除する予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 リソースツリー全体を削除します。このオペレーションでは、親リソースとその子リソースを削除します。 **重要** 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 に保存されているデータセットやエクスポートされたファイルは削除しません。 ## リクエストの構文 ``` { "ResourceArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) ** 削除する親リソースの Amazon リソースネーム (ARN)。親リソースのすべての子リソースも削除されます。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "WhatIfAnalysisArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) ** 削除する What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想を削除します。ステータスが `ACTIVE` または `CREATE_FAILED` の What-If 予想のみを削除できます。[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) オペレーションを使用して、ステータスを取得します。エクスポート中に What-If 予想を削除することはできません。What-If 予想を削除すると、What-If 分析をクエリできなくなります。 ## リクエストの構文 ``` { "WhatIfForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfForecastArn](#API_DeleteWhatIfForecast_RequestSyntax) ** 削除する What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) オペレーションを使用して作成された What-If 予想エクスポートを削除します。ステータスが `ACTIVE` または `CREATE_FAILED` の What-If 予想エクスポートのみを削除できます。[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "WhatIfForecastExportArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfForecastExportArn](#API_DeleteWhatIfForecastExport_RequestSyntax) ** 削除する What-If 予想エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 CreateAutoPredictor オペレーションを使用して作成された予測子を記述します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "PredictorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) ** 予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** CreateAutoPredictor リクエストのタイムスタンプです。タイプ: タイムスタンプ ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** データセットグループと追加のデータセットのデータ設定。型: [DataConfig](API_DataConfig.md) オブジェクト ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子のトレーニングデータをインポートするために使用されるデータセットのインポートジョブの ARN の配列。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** 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) ** 予測子トレーニングジョブが完了するまでの推定残り時間 (分)。タイプ: Long ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** Predictor Explainability のステータスと ARN を提供します。型: [ExplainabilityInfo](API_ExplainabilityInfo.md) オブジェクト ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) ** 時系列をグループ化するために使用される属性を指定するディメンション (フィールド) 名の配列。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。長さの制限：最小長 1、最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測内の予測の頻度。有効な間隔は、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) ** モデルが予測するタイムステップの数。予測期間は予測長とも呼ばれます。タイプ: 整数 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子のトレーニング中に使用される予測タイプ。デフォルト値は ["0.1","0.5","0.9"] です。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) ** エラーが発生した場合は、エラーの原因を詳しく説明するメッセージ。タイプ: 文字列 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** Amazon リソースネーム (ARN) とステータスを含む [MonitorInfo](API_MonitorInfo.md) オブジェクト。型: [MonitorInfo](API_MonitorInfo.md) オブジェクト ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子を最適化するために使用される精度メトリクス。型: 文字列有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子の Amazon リソースネーム (ARN) タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) ** 参照予測子の ARN と状態。このパラメータは、再トレーニング済みまたはアップグレード済みの予測子についてのみ有効です。型: [ReferencePredictorSummary](API_ReferencePredictorSummary.md) オブジェクト ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) ** 予測子のステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) ** Forecast がデータを集計するときに使用する時間境界。型: [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) オブジェクト ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` ## リクエストの構文 ``` { "DatasetArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) ** データセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeDataset_ResponseSyntax) ** データセットが作成された時点。タイプ: タイムスタンプ ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) ** データ収集の頻度。有効な間隔は、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) ** データセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetName](#API_DescribeDataset_ResponseSyntax) ** データセットの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [DatasetType](#API_DescribeDataset_ResponseSyntax) ** データセットのタイプ。型: 文字列有効な値：`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` ** [Domain](#API_DescribeDataset_ResponseSyntax) ** データセットに関連付けられているドメイン。型: 文字列有効な値：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) ** Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) ** データセットを作成する場合、`LastModificationTime` は `CreationTime` と同じです。データがデータセットにインポートされている間、`LastModificationTime` は `DescribeDataset` コールの現在の時刻です。[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) オペレーションが終了した後は、`LastModificationTime` はインポートジョブが終了または失敗した時点です。タイプ: タイムスタンプ ** [Schema](#API_DescribeDataset_ResponseSyntax) ** データセットフィールドを指定する `SchemaAttribute` オブジェクトの配列。各 `SchemaAttribute` がフィールドの名前とデータ型を指定します。型: [Schema](API_Schema.md) オブジェクト ** [Status](#API_DescribeDataset_ResponseSyntax) ** データセットのステータス。含まれる状態は次のとおりです。 + `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 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` ## リクエストの構文 ``` { "DatasetGroupArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** データセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "CreationTime": number, "DatasetArns": [ "string" ], "DatasetGroupArn": "string", "DatasetGroupName": "string", "Domain": "string", "LastModificationTime": number, "Status": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループが作成された時点。タイプ: タイムスタンプ ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループに含まれるデータセットの Amazon リソースネーム (ARN) の配列。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループに関連付けられているドメイン。型: 文字列有効な値：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループが作成された時点、または [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) オペレーションに対する呼び出し以降の最終更新時点。データセットグループが更新されている間、`LastModificationTime` は `DescribeDatasetGroup` コールの現在の時刻です。タイプ: タイムスタンプ ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) ** データセットグループのステータス。含まれる状態は次のとおりです。 + `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 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` - エラーが発生した場合は、エラーに関する情報。 ## リクエストの構文 ``` { "DatasetImportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** データセットのインポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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 } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブが作成された時点。タイプ: タイムスタンプ ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** トレーニングデータのインポート先であるデータセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) ** インポートジョブが終了した後のデータセットのサイズ (GB)。型: 倍精度 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) ** インポートするトレーニングデータの場所と、Amazon Forecast がデータにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。暗号化が使用されている場合、には AWS Key Management Service (KMS) キー`DataSource`が含まれます。型: [DataSource](API_DataSource.md) オブジェクト ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブが完了するまでの推定残り時間 (分)。タイプ: Long ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) ** 入力データの各フィールドに関する統計情報。タイプ: [Statistics](API_Statistics.md) オブジェクトマップへの文字列です。キーの長さの制限: 最大長は 256 です。キーパターン: `^[a-zA-Z0-9\_]+$` ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) ** インポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** geolocation 属性の形式。有効な値: `"LAT_LONG"` および `"CC_POSTALCODE"`。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9_]+$` ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブのインポートモード。完全または増分。型: 文字列有効な値：`FULL | INCREMENTAL` ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeDatasetImportJob_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセットのインポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` タイプ: 文字列長さの制約: 最大長は 256 です。 ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** データセット内のタイムスタンプの形式。指定する形式は、データセットが作成されたときに指定された `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) ** データセット内のすべての項目に適用される単一のタイムゾーンタイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\/\+\-\_]+$` ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) ** `TimeZone` が geolocation 属性から自動的に派生するかどうか。タイプ: ブール値 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "ExplainabilityArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) ** 記述する Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeExplainability_ResponseSyntax) ** Explainability リソースが作成された時点。タイプ: タイムスタンプ ** [DataSource](#API_DescribeExplainability_ResponseSyntax) ** データのソース、Amazon Forecast がデータにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、およびオプションで AWS Key Management Service (KMS) キー。型: [DataSource](API_DataSource.md) オブジェクト ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) ** Explainability リソースのためにビジュアライゼーションが有効になっているかどうか。タイプ: ブール値 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) ** `TimePointGranularity` が `SPECIFIC` に設定されている場合、Explainability の最後の時間ポイント。タイプ: 文字列長さの制限: 最大長は 19。パターン: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) ** [CreateExplainability](API_CreateExplainability.md) ジョブが完了するまでの推定残り時間 (分)。タイプ: Long ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) ** Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) ** Explainability の時系列と時間ポイントの粒度を定義する構成設定。型: [ExplainabilityConfig](API_ExplainabilityConfig.md) オブジェクト ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) ** Explainability の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeExplainability_ResponseSyntax) ** エラーが発生した場合は、エラーに関するメッセージ。タイプ: 文字列 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) ** Explainability リソースの作成に使用される予測子または予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Schema](#API_DescribeExplainability_ResponseSyntax) ** データセットのフィールドを定義します。型: [Schema](API_Schema.md) オブジェクト ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) ** `TimePointGranularity` が `SPECIFIC` に設定されている場合、Explainability の最初の時間ポイント。タイプ: 文字列長さの制限: 最大長は 19。パターン: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [Status](#API_DescribeExplainability_ResponseSyntax) ** Explainability リソースのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateExplainabilityExport](API_CreateExplainabilityExport.md) オペレーションを使用して作成された Explainability エクスポートを記述します。 ## リクエストの構文 ``` { "ExplainabilityExportArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) ** Explainability エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** Explainability エクスポートが作成された時点。タイプ: タイムスタンプ ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** Explainability エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** Explainability エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) ** Explainability エクスポートの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeExplainabilityExport_ResponseSyntax) ** エクスポート中に発生したエラーに関する情報。タイプ: 文字列 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) ** Explainability エクスポートのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` - エラーが発生した場合は、エラーに関する情報。 ## リクエストの構文 ``` { "ForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) ** 予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ] } } } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeForecast_ResponseSyntax) ** 予測作成タスクが作成された時点。タイプ: タイムスタンプ ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) ** 予測子のトレーニングに使用されるデータを提供したデータセットグループの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) ** 予測ジョブが完了するまでの推定残り時間 (分)。タイプ: Long ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) ** リクエストで指定された予測の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastName](#API_DescribeForecast_ResponseSyntax) ** 予測の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) ** 確率的予測が生成された分位数。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeForecast_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeForecast_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) ** 予測の生成に使用される予測子の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeForecast_ResponseSyntax) ** 予測のステータス。含まれる状態は次のとおりです。 + `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) ** 予想に含める時系列。型: [TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクト ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [CreateForecastExportJob](API_CreateForecastExportJob.md) オペレーションを使用して作成された予測エクスポートジョブを記述します。このオペレーションは、`CreateForecastExportJob` リクエストでユーザーによって提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。 + `CreationTime` + `LastModificationTime` + `Status` + `Message` - エラーが発生した場合は、エラーに関する情報。 ## リクエストの構文 ``` { "ForecastExportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) ** 予測エクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** 予測エクスポートジョブが作成された時点。タイプ: タイムスタンプ ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) ** 予測がエクスポートされる Amazon Simple Storage Service (Amazon S3) バケットへのパス。型: [DataDestination](API_DataDestination.md) オブジェクト ** [ForecastArn](#API_DescribeForecastExportJob_ResponseSyntax) ** エクスポートされた予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) ** 予測エクスポートジョブの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) ** 予測エクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeForecastExportJob_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) ** 予測のエクスポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` S3 バケットの予測にアクセスする前に、予測エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。タイプ: 文字列長さの制約: 最大長は 256 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 モニターリソースを説明します。このオペレーションは、[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/) ## リクエストの構文 ``` { "MonitorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) ** 説明するモニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Baseline](#API_DescribeMonitor_ResponseSyntax) ** 比較のベースラインとして使用するメトリクス。自動予測子のモニタリング結果を解釈するときは、これらの値を使用してください。型: [Baseline](API_Baseline.md) オブジェクト ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) ** モニターリソースが作成されたときのタイムスタンプ。タイプ: タイムスタンプ ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) ** モニターリソースが現在の評価を終了するまでの推定残り時間 (分)。タイプ: Long ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) ** モニターの最新の評価の状態。タイプ: 文字列長さの制約: 最大長は 256 です。 ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) ** モニターが完了した最新の評価のタイムスタンプ。タイプ: タイムスタンプ ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) ** モニターに加えられた最新の変更のタイムスタンプ。タイプ: タイムスタンプ ** [Message](#API_DescribeMonitor_ResponseSyntax) ** モニターに関するエラーメッセージ (存在する場合)。タイプ: 文字列 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) ** 説明されたモニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) ** モニターの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) ** モニタリングされる自動予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeMonitor_ResponseSyntax) ** モニターリソースのステータス。タイプ: 文字列長さの制約: 最大長は 256 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 **注記** このオペレーションは、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` - エラーが発生した場合は、エラーに関する情報。 ## リクエストの構文 ``` { "PredictorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) ** 情報を取得する予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) ** モデルトレーニングに使用されるアルゴリズムの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) ** `PerformAutoML` が指定されている場合、選択したアルゴリズムの ARN。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) ** `LatencyOptimized` AutoML 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。予測子のトレーニングに使用する AutoML 戦略。`LatencyOptimized` が指定されていない限り、AutoML 戦略は予測子の精度を最適化します。このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。型: 文字列有効な値：`LatencyOptimized | AccuracyOptimized` ** [CreationTime](#API_DescribePredictor_ResponseSyntax) ** モデルトレーニングタスクが作成された時点。タイプ: タイムスタンプ ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) ** 予測子のトレーニングデータをインポートするために使用されるデータセットのインポートジョブの ARN の配列。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) ** Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) ** 予測子トレーニングジョブが完了するまでの推定残り時間 (分)。タイプ: Long ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) ** 指定されたアルゴリズムのデフォルトの評価パラメータを上書きするために使用されます。Amazon Forecast は、データセットをトレーニングデータとテストデータに分割することで予測子を評価します。評価パラメータは、分割の実行方法と反復回数を定義します。型: [EvaluationParameters](API_EvaluationParameters.md) オブジェクト ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) ** 特徴量化の設定。型: [FeaturizationConfig](API_FeaturizationConfig.md) オブジェクト ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) ** 予測のタイムステップの数。予測期間は予測長とも呼ばれます。タイプ: 整数 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) ** 予測子のトレーニング中に使用される予測タイプ。デフォルト値は `["0.1","0.5","0.9"]` です型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) ** アルゴリズム用のハイパーパラメータの上書き値。型: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクト ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) ** 予測子のトレーニングに使用するデータを含むデータセットグループを記述します。型: [InputDataConfig](API_InputDataConfig.md) オブジェクト ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) ** 予測子が [CreateAutoPredictor](API_CreateAutoPredictor.md) を使用して作成されたかどうか。タイプ: ブール値 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribePredictor_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) ** 予測子を最適化するために使用される精度メトリクス。型: 文字列有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) ** 予測子が AutoML を実行するように設定されているかどうか。タイプ: ブール値 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) ** 予測子がハイパーパラメータ最適化 (HPO) を実行するように設定されているかどうか。タイプ: ブール値 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) ** 予測子の ARN。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) ** 予測子の精度を評価するために実行されたバックテストのステータスと結果の詳細。[CreatePredictor](API_CreatePredictor.md) オペレーションを呼び出すときに実行するバックテストの数を指定します。型: [PredictorExecutionDetails](API_PredictorExecutionDetails.md) オブジェクト ** [PredictorName](#API_DescribePredictor_ResponseSyntax) ** 予測子の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictor_ResponseSyntax) ** 予測子のステータス。含まれる状態は次のとおりです。 + `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) ** モデルトレーニング中に選択されたデフォルトのトレーニングパラメータまたは上書き。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]+$` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` (エラーが発生した場合) ## リクエストの構文 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) ** 予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 予測子バックテストエクスポートジョブが作成された時点。タイプ: タイムスタンプ ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** バックテストエクスポート中に発生した可能性のあるエラーに関する情報。タイプ: 文字列 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 予測子バックテストエクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 予測子バックテストエクスポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` ## リクエストの構文 ``` { "WhatIfAnalysisArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_RequestSyntax) ** 関心がある What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** What-If 分析が作成された日時。タイプ: タイムスタンプ ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** What-If 分析が完了するまでのおおよその残り時間 (分単位)。タイプ: Long ** [ForecastArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 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) ** `TimeSeriesIdentifiers` オブジェクト内の予想を作成するために使用される時系列のセットを定義します。 `TimeSeriesIdentifiers` オブジェクトには次の情報が必要です。 + `DataSource` + `Format` + `Schema` 型: [TimeSeriesSelector](API_TimeSeriesSelector.md) オブジェクト ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** What-If 分析の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` ## リクエストの構文 ``` { "WhatIfForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) ** 関心がある What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想が作成された日時。タイプ: タイムスタンプ ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想を完了するまでのおおよその残り時間 (分単位)。タイプ: Long ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) ** 確率的予測が生成される分位数。[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) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) ** 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) ** 置換時系列を表す `S3Config`、`Schema`、`Format` 要素の配列。型: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) オブジェクト ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) ** どの時系列にどの変換が適用されたかを記述する `Action` および `TimeSeriesConditions` 要素の配列。型: [TimeSeriesTransformation](API_TimeSeriesTransformation.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 30 項目です。 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** この What-If 予想を含む分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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` ## リクエストの構文 ``` { "WhatIfForecastExportArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) ** 関心がある What-If 予想エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** What-If 予想エクスポートが作成された日時。タイプ: タイムスタンプ ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** What-If 予想エクスポートを完了するまでのおおよその残り時間 (分単位)。タイプ: Long ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** エクスポートされたデータの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 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) ** このリソースにエクスポートされるすべての What-If 予想を表す Amazon リソースネーム (ARN) の配列。型: 文字列の配列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** What-If 予想エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** What-If 予想エクスポートの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "PredictorArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) ** メトリクスを取得する予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "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 } ] } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) ** `LatencyOptimized` AutoML 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。予測子のトレーニングに使用する AutoML 戦略。`LatencyOptimized` が指定されていない限り、AutoML 戦略は予測子の精度を最適化します。このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。型: 文字列有効な値：`LatencyOptimized | AccuracyOptimized` ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) ** 予測子が [CreateAutoPredictor](API_CreateAutoPredictor.md) を使用して作成されたかどうか。タイプ: ブール値 ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) ** 予測子を最適化するために使用される精度メトリクス。型: 文字列有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) ** 予測子の評価から得られた結果の配列。型: [EvaluationResult](API_EvaluationResult.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListDatasetGroups_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "DatasetGroups": [ { "CreationTime": number, "DatasetGroupArn": "string", "DatasetGroupName": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) ** 各データセットグループのプロパティを要約するオブジェクトの配列。型: [DatasetGroupSummary](API_DatasetGroupSummary.md) オブジェクトの配列 ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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) オブジェクトの配列を提供することにより、リストをフィルタリングできます。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "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" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) ** 各データセットのインポートジョブのプロパティを要約するオブジェクトの配列。型: [DatasetImportJobSummary](API_DatasetImportJobSummary.md) オブジェクトの配列 ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [MaxResults](#API_ListDatasets_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListDatasets_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "Datasets": [ { "CreationTime": number, "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Datasets](#API_ListDatasets_ResponseSyntax) ** 各データセットのプロパティを要約するオブジェクトの配列。型: [DatasetSummary](API_DatasetSummary.md) オブジェクトの配列 ** [NextToken](#API_ListDatasets_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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 を使用します。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListExplainabilities_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。 **フィルタープロパティ** + `Condition` - 適用する条件。有効な値は、`IS` および `IS_NOT` です。 + `Key` - フィルタリングするパラメータの名前。有効な値は、`ResourceArn` および `Status` です。 + `Value` - 照合する値。タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListExplainabilities_RequestSyntax) ** レスポンスで返された項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListExplainabilities_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには NextToken が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "Explainabilities": [ { "CreationTime": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) ** 各 Explainability リソースのプロパティを要約するオブジェクトの配列。型: [ExplainabilitySummary](API_ExplainabilitySummary.md) オブジェクトの配列 ** [NextToken](#API_ListExplainabilities_ResponseSyntax) ** レスポンスが切り捨てられた場合、このトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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 を使用します。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListExplainabilityExports_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致するリソースをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。 **フィルタープロパティ** + `Condition` - 適用する条件。有効な値は、`IS` および `IS_NOT` です。 + `Key` - フィルタリングするパラメータの名前。有効な値は、`ResourceArn` および `Status` です。 + `Value` - 照合する値。タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには NextToken が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "ExplainabilityExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) ** 各 Explainability エクスポートのプロパティを要約するオブジェクトの配列。型: [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) オブジェクトの配列 ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) ** レスポンスが切り捨てられた場合、このトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListForecastExportJobs_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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::forecast/electricityforecast" } ]` タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "ForecastExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) ** 各エクスポートジョブのプロパティを要約するオブジェクトの配列。型: [ForecastExportJobSummary](API_ForecastExportJobSummary.md) オブジェクトの配列 ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListForecasts_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListForecasts_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "Forecasts": [ { "CreatedUsingAutoPredictor": boolean, "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Forecasts](#API_ListForecasts_ResponseSyntax) ** 各予測のプロパティを要約するオブジェクトの配列。型: [ForecastSummary](API_ForecastSummary.md) オブジェクトの配列 ** [NextToken](#API_ListForecasts_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 さまざまな期間にモニターリソースによって収集されたモニタリング評価結果と予測イベントのリストを返します。 **重要** 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)」を参照してください。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "MonitorArn": "string", "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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) ** 返されるモニタリング結果の最大数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) ** 結果を取得するモニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "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 } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) ** さまざまな期間にモニターリソースによって収集されたモニタリング結果と予測イベント。モニタリングについて詳しくは、「[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) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListMonitors_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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) ** レスポンスに含めるモニターの最大数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListMonitors_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "Monitors": [ { "CreationTime": number, "LastModificationTime": number, "MonitorArn": "string", "MonitorName": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Monitors](#API_ListMonitors_ResponseSyntax) ** 各モニターのプロパティを要約するオブジェクトの配列。型: [MonitorSummary](API_MonitorSummary.md) オブジェクトの配列 ** [NextToken](#API_ListMonitors_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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 を使用します。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、ステートメントに一致する予測子バックテストエクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。 **フィルタープロパティ** + `Condition` - 適用する条件。有効な値は、`IS` および `IS_NOT` です。ステートメントに一致する予測子バックテストエクスポートジョブを含めるには、`IS` を指定します。一致する予測子バックテストエクスポートジョブを除外するには、`IS_NOT` を指定します。 + `Key` - フィルタリングするパラメータの名前。有効な値は、`PredictorArn` および `Status` です。 + `Value` - 照合する値。タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには NextToken が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "NextToken": "string", "PredictorBacktestExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** レスポンスが切り捨てられた場合、このトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** 各予測子バックテストエクスポートジョブのプロパティを要約するオブジェクトの配列。型: [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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) オブジェクトの配列を使用してリストをフィルタリングできます。 ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListPredictors_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListPredictors_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "NextToken": "string", "Predictors": [ { "CreationTime": number, "DatasetGroupArn": "string", "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListPredictors_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [Predictors](#API_ListPredictors_ResponseSyntax) ** 各予測子のプロパティを要約するオブジェクトの配列。型: [PredictorSummary](API_PredictorSummary.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 Amazon Forecast のリソースのタグを一覧表示します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "ResourceArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** タグをリストするリソースを識別する Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** リソースのタグ。型: [Tag](API_Tag.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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::forecast/electricityWhatIf" } ]` タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "NextToken": "string", "WhatIfAnalyses": [ { "CreationTime": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) ** レスポンスが切り捨てられた場合、Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) ** 一致した分析を記述する `WhatIfAnalysisSummary` オブジェクトの配列。型: [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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::forecast/electricityWIFExport" } ]` タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "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" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) ** レスポンスが切り捨てられた場合、Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) ** 一致した予想エクスポートを記述する `WhatIfForecastExports` オブジェクトの配列。型: [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 [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/) ## リクエストの構文 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) ** フィルターの配列。各フィルターについて、条件および 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::forecast/electricityWhatIfForecast" } ]` タイプ: [Filter](API_Filter.md) オブジェクトの配列必須: いいえ ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) ** レスポンスで返される項目の数。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 100 です。必須: いいえ ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` 必須: いいえ ## レスポンスの構文 ``` { "NextToken": "string", "WhatIfForecasts": [ { "CreationTime": number, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。パターン: `.+` ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) ** 一致した予想を記述する `WhatIfForecasts` オブジェクトの配列。型: [WhatIfForecastSummary](API_WhatIfForecastSummary.md) オブジェクトの配列 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 停止したモニターリソースを再開します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "ResourceArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_ResumeResource_RequestSyntax) ** 再開するモニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 リソースを停止します。 **重要** 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 エクスポートジョブ ## リクエストの構文 ``` { "ResourceArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_StopResource_RequestSyntax) ** 停止するリソースを識別する Amazon リソースネーム (ARN)。サポートされている ARN は、`DatasetImportJobArn`、`PredictorArn`、`PredictorBacktestExportJobArn`、`ForecastArn`、`ForecastExportJobArn`、`ExplainabilityArn`、および `ExplainabilityExportArn` です。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 指定されたタグを、指定された `resourceArn` を持つリソースに関連付けます。リソース上の既存のタグがリクエストパラメータで指定されていない場合、それらは変更されません。リソースが削除されると、そのリソースに関連付けられているタグも削除されます。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_TagResource_RequestSyntax) ** タグをリストするリソースを識別する Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [Tags](#API_TagResource_RequestSyntax) ** リソースに追加するタグ。タグは、キーバリューペアの配列です。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 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 項目です。必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 指定されたタグをリソースから削除します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## リクエストの構文 ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [ResourceArn](#API_UntagResource_RequestSyntax) ** タグをリストするリソースを識別する Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [TagKeys](#API_UntagResource_RequestSyntax) ** 削除するタグのキー。型: 文字列の配列配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。長さの制限：最小長 1、最大長は 128 です。パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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 データセットグループ内のデータセットを指定されたデータセットに置き換えます。 **重要** 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) オペレーションを使用します。 ## リクエストの構文 ``` { "DatasetArns": [ "string" ], "DatasetGroupArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) ** データセットグループに追加するデータセットの Amazon リソースネーム (ARN) の配列。型: 文字列の配列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) ** データセットグループの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の 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) # Amazon Forecast クエリサービス次のアクションは、Amazon Forecast Query Service でサポートされています: + [QueryForecast](API_forecastquery_QueryForecast.md) + [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) # QueryForecast 指定された基準でフィルタリングされた、単一の項目の予測を取得します。基準は、キーバリューペアです。キーは、`TARGET_TIME_SERIES` データセットからの `item_id` (もしくは同等の非タイムスタンプ、非ターゲットフィールド)、または `FeaturizationConfig` オブジェクトの一部として指定された予測ディメンションの 1 つです。デフォルトでは、`QueryForecast` は、フィルタリングされた予測の完全な日付範囲を返します。特定の日付範囲をリクエストできます。完全な予測を取得するには、[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) オペレーションを使用します。 **注記** Amazon Forecast によって生成された予測は、予測子の作成に使用されたデータセットと同じタイムゾーンにあります。 ## リクエストの構文 ``` { "EndDate": "string", "Filters": { "string" : "string" }, "ForecastArn": "string", "NextToken": "string", "StartDate": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [EndDate](#API_forecastquery_QueryForecast_RequestSyntax) ** 予測の終了日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T20:00:00。タイプ: 文字列必須: いいえ ** [Filters](#API_forecastquery_QueryForecast_RequestSyntax) ** 予測の取得時に適用するフィルター条件。例えば、電力使用量データセットの `client_21` についての予測を取得するには、次のように指定します。 `{"item_id" : "client_21"}` 完全な予測を取得するには、[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) オペレーションを使用します。タイプ: 文字列間のマッピングマップエントリ: 項目の最大数は 50 です。キーの長さの制限: 最大長は 256 です。キーパターン: `^[a-zA-Z0-9\_\-]+$` 値の長さの制限: 最大長は 256 です。必須: はい ** [ForecastArn](#API_forecastquery_QueryForecast_RequestSyntax) ** クエリする予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** [NextToken](#API_forecastquery_QueryForecast_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。必須: いいえ ** [StartDate](#API_forecastquery_QueryForecast_RequestSyntax) ** 予測の開始日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T08:00:00。タイプ: 文字列必須: いいえ ## レスポンスの構文 ``` { "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Forecast](#API_forecastquery_QueryForecast_ResponseSyntax) ** 予測。型: [Forecast](API_forecastquery_Forecast.md) オブジェクト ## エラー ** InvalidInputException ** 値が無効であるか、長すぎます。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ** LimitExceededException ** 1 秒あたりのリクエスト数の上限を超えています。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** そのリソースを見つけることができません。入力した情報を確認して、再試行してください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryForecast) # QueryWhatIfForecast What-If 予想を取得します。 ## リクエストの構文 ``` { "EndDate": "string", "Filters": { "string" : "string" }, "NextToken": "string", "StartDate": "string", "WhatIfForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [EndDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** What-If 予想の終了日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T20:00:00。タイプ: 文字列必須: いいえ ** [Filters](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 予測の取得時に適用するフィルター条件。例えば、電力使用量データセットの `client_21` についての予測を取得するには、次のように指定します。 `{"item_id" : "client_21"}` 完全な What-If 予想を取得するには、[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) オペレーションを使用します。タイプ: 文字列間のマッピングマップエントリ: 項目の最大数は 50 です。キーの長さの制限: 最大長は 256 です。キーパターン: `^[a-zA-Z0-9\_\-]+$` 値の長さの制限: 最大長は 256 です。必須: はい ** [NextToken](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 3000 です。必須: いいえ ** [StartDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** What-If 予想の開始日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T08:00:00。タイプ: 文字列必須: いいえ ** [WhatIfForecastArn](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** クエリする What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [Forecast](#API_forecastquery_QueryWhatIfForecast_ResponseSyntax) ** 予測に関する情報を提供します。[QueryForecast](API_forecastquery_QueryForecast.md) レスポンスの一部として返されます。型: [Forecast](API_forecastquery_Forecast.md) オブジェクト ## エラー ** InvalidInputException ** 値が無効であるか、長すぎます。 HTTP ステータスコード: 400 ** InvalidNextTokenException ** トークンが無効です。トークンの有効期間は 24 時間です。 HTTP ステータスコード: 400 ** LimitExceededException ** 1 秒あたりのリクエスト数の上限を超えています。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** そのリソースを見つけることができません。入力した情報を確認して、再試行してください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryWhatIfForecast) # データ型次のデータ型は、Amazon Forecast サービスでサポートされています: + [Action](API_Action.md) + [AdditionalDataset](API_AdditionalDataset.md) + [AttributeConfig](API_AttributeConfig.md) + [Baseline](API_Baseline.md) + [BaselineMetric](API_BaselineMetric.md) + [CategoricalParameterRange](API_CategoricalParameterRange.md) + [ContinuousParameterRange](API_ContinuousParameterRange.md) + [DataConfig](API_DataConfig.md) + [DataDestination](API_DataDestination.md) + [DatasetGroupSummary](API_DatasetGroupSummary.md) + [DatasetImportJobSummary](API_DatasetImportJobSummary.md) + [DatasetSummary](API_DatasetSummary.md) + [DataSource](API_DataSource.md) + [EncryptionConfig](API_EncryptionConfig.md) + [ErrorMetric](API_ErrorMetric.md) + [EvaluationParameters](API_EvaluationParameters.md) + [EvaluationResult](API_EvaluationResult.md) + [ExplainabilityConfig](API_ExplainabilityConfig.md) + [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) + [ExplainabilityInfo](API_ExplainabilityInfo.md) + [ExplainabilitySummary](API_ExplainabilitySummary.md) + [Featurization](API_Featurization.md) + [FeaturizationConfig](API_FeaturizationConfig.md) + [FeaturizationMethod](API_FeaturizationMethod.md) + [Filter](API_Filter.md) + [ForecastExportJobSummary](API_ForecastExportJobSummary.md) + [ForecastSummary](API_ForecastSummary.md) + [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) + [InputDataConfig](API_InputDataConfig.md) + [IntegerParameterRange](API_IntegerParameterRange.md) + [MetricResult](API_MetricResult.md) + [Metrics](API_Metrics.md) + [MonitorConfig](API_MonitorConfig.md) + [MonitorDataSource](API_MonitorDataSource.md) + [MonitorInfo](API_MonitorInfo.md) + [MonitorSummary](API_MonitorSummary.md) + [ParameterRanges](API_ParameterRanges.md) + [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) + [PredictorBaseline](API_PredictorBaseline.md) + [PredictorEvent](API_PredictorEvent.md) + [PredictorExecution](API_PredictorExecution.md) + [PredictorExecutionDetails](API_PredictorExecutionDetails.md) + [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) + [PredictorSummary](API_PredictorSummary.md) + [ReferencePredictorSummary](API_ReferencePredictorSummary.md) + [S3Config](API_S3Config.md) + [Schema](API_Schema.md) + [SchemaAttribute](API_SchemaAttribute.md) + [Statistics](API_Statistics.md) + [SupplementaryFeature](API_SupplementaryFeature.md) + [Tag](API_Tag.md) + [TestWindowSummary](API_TestWindowSummary.md) + [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) + [TimeSeriesCondition](API_TimeSeriesCondition.md) + [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) + [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) + [TimeSeriesSelector](API_TimeSeriesSelector.md) + [TimeSeriesTransformation](API_TimeSeriesTransformation.md) + [WeightedQuantileLoss](API_WeightedQuantileLoss.md) + [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) + [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) + [WhatIfForecastSummary](API_WhatIfForecastSummary.md) + [WindowSummary](API_WindowSummary.md) 次のデータ型は、Amazon Forecast Query Service でサポートされています: + [DataPoint](API_forecastquery_DataPoint.md) + [Forecast](API_forecastquery_Forecast.md) # Amazon Forecast サービス次のデータ型は、Amazon Forecast サービスでサポートされています: + [Action](API_Action.md) + [AdditionalDataset](API_AdditionalDataset.md) + [AttributeConfig](API_AttributeConfig.md) + [Baseline](API_Baseline.md) + [BaselineMetric](API_BaselineMetric.md) + [CategoricalParameterRange](API_CategoricalParameterRange.md) + [ContinuousParameterRange](API_ContinuousParameterRange.md) + [DataConfig](API_DataConfig.md) + [DataDestination](API_DataDestination.md) + [DatasetGroupSummary](API_DatasetGroupSummary.md) + [DatasetImportJobSummary](API_DatasetImportJobSummary.md) + [DatasetSummary](API_DatasetSummary.md) + [DataSource](API_DataSource.md) + [EncryptionConfig](API_EncryptionConfig.md) + [ErrorMetric](API_ErrorMetric.md) + [EvaluationParameters](API_EvaluationParameters.md) + [EvaluationResult](API_EvaluationResult.md) + [ExplainabilityConfig](API_ExplainabilityConfig.md) + [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) + [ExplainabilityInfo](API_ExplainabilityInfo.md) + [ExplainabilitySummary](API_ExplainabilitySummary.md) + [Featurization](API_Featurization.md) + [FeaturizationConfig](API_FeaturizationConfig.md) + [FeaturizationMethod](API_FeaturizationMethod.md) + [Filter](API_Filter.md) + [ForecastExportJobSummary](API_ForecastExportJobSummary.md) + [ForecastSummary](API_ForecastSummary.md) + [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) + [InputDataConfig](API_InputDataConfig.md) + [IntegerParameterRange](API_IntegerParameterRange.md) + [MetricResult](API_MetricResult.md) + [Metrics](API_Metrics.md) + [MonitorConfig](API_MonitorConfig.md) + [MonitorDataSource](API_MonitorDataSource.md) + [MonitorInfo](API_MonitorInfo.md) + [MonitorSummary](API_MonitorSummary.md) + [ParameterRanges](API_ParameterRanges.md) + [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) + [PredictorBaseline](API_PredictorBaseline.md) + [PredictorEvent](API_PredictorEvent.md) + [PredictorExecution](API_PredictorExecution.md) + [PredictorExecutionDetails](API_PredictorExecutionDetails.md) + [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) + [PredictorSummary](API_PredictorSummary.md) + [ReferencePredictorSummary](API_ReferencePredictorSummary.md) + [S3Config](API_S3Config.md) + [Schema](API_Schema.md) + [SchemaAttribute](API_SchemaAttribute.md) + [Statistics](API_Statistics.md) + [SupplementaryFeature](API_SupplementaryFeature.md) + [Tag](API_Tag.md) + [TestWindowSummary](API_TestWindowSummary.md) + [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) + [TimeSeriesCondition](API_TimeSeriesCondition.md) + [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) + [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) + [TimeSeriesSelector](API_TimeSeriesSelector.md) + [TimeSeriesTransformation](API_TimeSeriesTransformation.md) + [WeightedQuantileLoss](API_WeightedQuantileLoss.md) + [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) + [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) + [WhatIfForecastSummary](API_WhatIfForecastSummary.md) + [WindowSummary](API_WindowSummary.md) # Action What-If 予想の属性に対して行う変更を定義します。例えば、このオペレーションを使用して、すべての靴の 10% オフセールを調査する What-If 予想を作成できます。そのためには、`"AttributeName": "shoes"`、`"Operation": "MULTIPLY"`、`"Value": "0.90"` を指定します。このオペレーションを [CreateWhatIfForecast:TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) オペレーション内の [TimeSeriesCondition](API_TimeSeriesCondition.md) オペレーションと組み合わせて、変更される属性項目のサブセットを定義します。 ## 内容 ** AttributeName ** 変更する関連時系列。この値は大文字と小文字が区別されません。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** Operation ** 指定した属性に適用されるオペレーション。オペレーションは次のとおりです。 + `ADD` - `AttributeName` のすべての行に `Value` を加算します。 + `SUBTRACT` - `AttributeName` のすべての行から `Value` を減算します。 + `MULTIPLY` - `AttributeName` のすべての行に `Value` を乗算します。 + `DIVIDE` - `AttributeName` のすべての行を `Value` で除算します。タイプ: 文字列有効な値: `ADD | SUBTRACT | MULTIPLY | DIVIDE` 必須: はい ** Value ** 選択した `Operation` に適用される値。型: 倍精度必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Action) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Action) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Action) # AdditionalDataset 追加のデータセットを記述します。このオブジェクトは [DataConfig](API_DataConfig.md) オブジェクトの一部です。Forecast は、Weather Index と Holidays の追加データセットをサポートしています。 **Weather Index** Amazon Forecast の Weather Index はビルトインデータセットであり、履歴気象情報および予測される気象情報をモデルに組み込みます。Weather Index は、過去２年にわたる気象データと最大 14 日間の気象予報データでデータセットを補完します。詳細については、「[Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html)」(Amazon Forecast の Weather Index) を参照してください。 **Holidays** Holidays は、特徴エンジニアリングされた祝祭日情報データセットをモデルに組み込む、ビルトインの特徴量化です。250 か国を超える祝祭日カレンダーをネイティブにサポートします。Amazon Forecast には、ホリデーカレンダーを生成するための [Holiday API ライブラリ](https://holidayapi.com/countries)と [Jollyday API](https://jollyday.sourceforge.net/data.html) の両方が組み込まれています。詳細については、「[Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html)」(Holidays の特徴量化) を参照してください。 ## 内容 ** Name ** 追加データセットの名前。有効な名前: `"holiday"` および `"weather"`。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** Configuration ** **Weather Index** Weather Index を有効にするには、`Configuration` の値を指定しないでください。 **Holidays** **Holidays** Holidays を有効にするには、`CountryCode` を次の 2 文字の国コードのいずれかに設定します。 + アフガニスタン - AF + オーランド諸島 - AX + アルバニア - AL + アルジェリア - DZ + アメリカ領サモア - AS + アンドラ - AD + アンゴラ - AO + アンギラ - AI + 南極 - AQ + アンティグアバーブーダ - AG + アルゼンチン - AR + アルメニア - AM + アルバ - AW + オーストラリア - AU + オーストリア - AT + アゼルバイジャン - AZ + バハマ - BS + バーレーン - BH + バングラデシュ - BD + バルバドス - BB + ベラルーシ - BY + ベルギー - BE + ベリーズ - BZ + ベナン - BJ + バーミューダ - BM + ブータン - BT + ボリビア -BO + ボスニアヘルツェゴビナ - BA + ボツワナ - BW + ブーベ島 - BV + ブラジル - BR + 英領インド洋地域 - IO + 英領バージン諸島 - VG + ブルネイ・ダルサラーム - BN + ブルガリア - BG + ブルキナファソ - BF + ブルンジ - BI + カンボジア - KH + カメルーン - CM + カナダ - CA + カーボベルデ - CV + オランダカリブ領域 - BQ + ケイマン諸島 - KY + 中央アフリカ共和国 - CF + チャド - TD + チリ - CL + 中国 - CN + クリスマス島 - CX + ココス (キーリング) - CC + コロンビア - CO + コモロ - KM + クック諸島 -CK + コスタリカ - CR + クロアチア - HR + キューバ - CU + キュラソー - CW + キプロス - CY + チェコ - CZ + コンゴ民主共和国 - CD + デンマーク - DK + ジブチ - DJ + ドミニカ国 - DM + ドミニカ共和国 - DO + エクアドル - EC + エジプト - EG + エルサルバドル - SV + 赤道ギニア - GQ + エリトリア - ER + エストニア - EE + エスワティニ - SZ + エチオピア - ET + フォークランド諸島 - FK + フェロー諸島 - FO + フィジー - FJ + フィンランド - FI + フランス - FR + フランス領ギアナ - GF + フランス領ポリネシア - PF + フランス領南方・南極地域 - TF + ガボン - GA + ガンビア - GM + ジョージア - GE + ドイツ - DE + ガーナ - GH + ジブラルタル - GI + ギリシャ - GR + グリーンランド - GL + グレナダ - GD + グアドループ - GP + グアム - GU + グアテマラ - GT + ガーンジー - GG + ギニア - GN + ギニアビサウ - GW + ガイアナ - GY + ハイチ - HT + ハード島とマクドナルド諸島 - HM + ホンジュラス - HN + 香港 - HK + ハンガリー - HU + アイスランド - IS + インド - IN + インドネシア - ID + イラン - IR + イラク - IQ + アイルランド - IE + マン島 - IM + イスラエル - IL + イタリア - IT + コートジボワール - CI + ジャマイカ - JM + 日本 - JP + ジャージー - JE + ヨルダン - JO + カザフスタン - KZ + ケニア - KE + キリバス - KI + コソボ - XK + クウェート - KW + キルギスタン - KG + ラオス - LA + ラトビア - LV + レバノン - LB + レソト - LS + リベリア - LR + リビア - LY + リヒテンシュタイン - LI + リトアニア - LT + ルクセンブルグ - LU + マカオ - MO + マダガスカル - MG + マラウイ - MW + マレーシア - MY + モルディブ - MV + マリ - ML + マルタ - MT + マーシャル諸島共和国 - MH + マルティニーク - MQ + モーリタニア - MR + モーリシャス - MU + マヨット - YT + メキシコ - MX + ミクロネシア - FM + モルドバ - MD + モナコ - MC + モンゴル国 - MN + モンテネグロ - ME + モントセラト島 - MS + モロッコ - MA + モザンビーク - MZ + ミャンマー - MM + ナミビア - NA + ナウル - NR + ネパール - NP + オランダ - NL + ニューカレドニア - NC + ニュージーランド - NZ + ニカラグア - NI + ニジェール - NE + ナイジェリア - NG + ニウエ - NU + ノーフォーク島 - NF + 北朝鮮 - KP + 北マケドニア - MK + 北マリアナ諸島 - MP + ノルウェー - NO + オマーン - OM + パキスタン - PK + パラオ - PW + パレスチナ - PS + パナマ - PA + パプアニューギニア - PG + パラグアイ - PY + ペルー - PE + フィリピン - PH + ピトケアン諸島 - PN + ポーランド - PL + ポルトガル - PT + プエルトリコ - PR + カタール - QA + コンゴ共和国 - CG + レユニオン - RE + ルーマニア - RO + ロシア連邦 - RU + ルワンダ - RW + サン・バルテルミー - BL + セントヘレナ・アセンションおよびトリスタンダクーニャ - SH + セントクリストファーネイビス - KN + セントルシア - LC + サン・マルタン島 - MF + サンピエール・ミクロン - PM + セントビンセントおよびグレナディーン諸島 - VC + サモア - WS + サンマリノ - SM + サントメプリンシペ - ST + サウジアラビア - SA + セネガル - SN + セルビア - RS + セイシェル - SC + シエラレオネ - SL + シンガポール - SG + シントマールテン - SX + スロバキア - SK + スロベニア - SI + ソロモン諸島 - SB + ソマリア - SO + 南アフリカ - ZA + サウスジョージア・サウスサンドウィッチ諸島 - GS + 韓国 - KR + 南スーダン - SS + スペイン - ES + スリランカ - LK + スーダン - SD + スリナム - SR + スバールバル諸島およびヤンマイエン島 - SJ + スウェーデン - SE + スイス - CH + シリア・アラブ共和国 - SY + 台湾 - TW + タジキスタン - TJ + タンザニア - TZ + タイ - TH + 東ティモール - TL + トーゴ - TG + トケラウ - TK + トンガ - TO + トリニダード・トバゴ - TT + チュニジア - TN + トルコ - TR + トルクメニスタン - TM + タークスおよびカイコス諸島 - TC + ツバル - TV + ウガンダ - UG + ウクライナ - UA + アラブ首長国連邦 - AE + 英国 - GB + 国連 - UN + 米国 - US + 合衆国領有小離島 - UM + アメリカ領バージン諸島 - VI + ウルグアイ - UY + ウズベキスタン - UZ + バヌアツ - VU + バチカン市国 - VA + ベネズエラ - VE + ベトナム - VN + ウォリス・フツナ - WF + 西サハラ - EH + イエメン - YE + ザンビア - ZM + ジンバブエ - ZW タイプ: 文字列マップの配列への文字列キーの長さ制限: 最小長さは 1 です。最大長は 63 です。キーパターン: `^[a-zA-Z][a-zA-Z0-9_]*` 配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\_\-]+$` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AdditionalDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AdditionalDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AdditionalDataset) # AttributeConfig 属性の変換に使用されるメソッドに関する情報を提供します。 RETAIL ドメインを使用する例を次に示します。 `{` `"AttributeName": "demand",` `"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` `}` ## 内容 ** AttributeName ** スキーマで指定されている属性の名前。Amazon Forecast は、ターゲット時系列のターゲットフィールドと関連する時系列データセットをサポートしています。例えば、RETAIL ドメインについては、ターゲットは `demand` です。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** Transformations ** 上書きパラメータのマップであるメソッドパラメータ (キーバリューペア)。これらのパラメータを指定して、デフォルト値を上書きします。関連する時系列の属性は、集計パラメータを受け入れません。次のリストは、**ターゲット時系列**のデータセットの「filling」特徴量化メソッドのパラメータとその有効な値を示しています。デフォルト値は太字です。 + `aggregation`: **合計**、`avg`、`first`、`min`、`max` + `frontfill`: **なし** + `middlefill`: **ゼロ**、`nan` (非数値)、`value`、`median`、`mean`、`min`、`max` + `backfill`: **ゼロ**、`nan`、`value`、`median`、`mean`、`min`、`max` 次のリストは、**関連する時系列**の特徴量化メソッドのパラメータとその有効な値を示しています (デフォルトはありません)。 + `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` + `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` + `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` filling メソッドを特定の値に設定するには、fill パラメータを `value` に設定し、対応する `_value` パラメータで値を定義します。例えば、backfilling を値 2 に設定するには、`"backfill": "value"` および `"backfill_value":"2"` を含めます。型: 文字列から文字列へのマップマップエントリ: 項目の最大数は 20 です。キーの長さ制限: 最小長さは 1 です。最大長は 63 です。キーパターン: `^[a-zA-Z][a-zA-Z0-9_]*` 値の長さの制限: 最大長は 256 です。値のパターン: `^[a-zA-Z0-9\_\-]+$` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AttributeConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AttributeConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AttributeConfig) # Baseline 比較のベースラインとして使用するメトリクス。自動予測子のモニタリング結果を解釈するときは、これらのメトリクスを使用してください。 ## 内容 ** PredictorBaseline ** 監視している予測子の初期[精度メトリクス](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。予測子を使用してメトリクスが変化したときに、これらのメトリクスを比較するためのベースラインとして使用してください。型: [PredictorBaseline](API_PredictorBaseline.md) オブジェクト必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Baseline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Baseline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Baseline) # BaselineMetric モニタリング結果を評価する際に比較に使用できる個別のメトリクス。 ## 内容 ** Name ** メトリクスの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** Value ** メトリクスの値。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/BaselineMetric) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/BaselineMetric) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/BaselineMetric) # CategoricalParameterRange カテゴリハイパーパラメータとそのチューニング可能な値の範囲を指定します。このオブジェクトは [ParameterRanges](API_ParameterRanges.md) オブジェクトの一部です。 ## 内容 ** Name ** チューニングするカテゴリハイパーパラメータの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** Values ** ハイパーパラメータのチューニング可能なカテゴリのリスト。タイプ: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制約: 最大長は 256 です。 Pattern: `^[a-zA-Z0-9\_\-]+$` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CategoricalParameterRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CategoricalParameterRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CategoricalParameterRange) # ContinuousParameterRange 連続ハイパーパラメータとそのチューニング可能な値の範囲を指定します。このオブジェクトは [ParameterRanges](API_ParameterRanges.md) オブジェクトの一部です。 ## 内容 ** MaxValue ** ハイパーパラメータのチューニング可能な最大値。型: 倍精度必須: はい ** MinValue ** ハイパーパラメータのチューニング可能な最小値。型: 倍精度必須: はい ** Name ** チューニングするハイパーパラメータの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** ScalingType ** ハイパーパラメータチューニングがハイパーパラメータの範囲を検索するために使用するスケール。有効な値: Auto ハイパーパラメータの最適なスケールを Amazon Forecast ハイパーパラメータの調整が選択します。 [線形] ハイパーパラメータの調整では、線形スケールを使用してハイパーパラメータ範囲内の値を検索します。対数ハイパーパラメータの調整では、対数を使用してハイパーパラメータ範囲内の値を検索します。対数スケールは、範囲内の値が 0 より大きい場合に使用できます。逆対数ハイパーパラメータの調整では、逆対数スケールを使用してハイパーパラメータ範囲内の値を検索します。逆対数スケールは、範囲全体が範囲 0 <= x < 1.0 内に収まる場合にのみ使用できます。ハイパーパラメータのスケールの選択については、「[Hyperparameter Scaling](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type)」(ハイパーパラメータのスケーリング) を参照してください。次のいずれかの値になります。タイプ: 文字列有効な値: `Auto | Linear | Logarithmic | ReverseLogarithmic` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ContinuousParameterRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ContinuousParameterRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ContinuousParameterRange) # DataConfig データセットグループと追加のデータセットのデータ設定。 ## 内容 ** DatasetGroupArn ** 予測子のトレーニングに使用されるデータセットグループの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** AdditionalDatasets ** Holidays や Weather Index などの追加のビルトインデータセット。型: [AdditionalDataset](API_AdditionalDataset.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 2 項目です。必須: いいえ ** AttributeConfigs ** データセットグループ内の属性の集計および filling オプション。型: [AttributeConfig](API_AttributeConfig.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataConfig) # DataDestination エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。 ## 内容 ** S3Config ** Amazon Simple Storage Service (Amazon S3) バケットへのパスと、そのバケットにアクセスするための認証情報。型: [S3Config](API_S3Config.md) オブジェクト必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataDestination) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataDestination) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataDestination) # DatasetGroupSummary [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) オペレーションで使用されるデータセットグループのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) オペレーションを呼び出して、`DatasetGroupArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** データセットグループが作成された時点。型: タイムスタンプ必須: いいえ ** DatasetGroupArn ** データセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** DatasetGroupName ** データセットグループの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** LastModificationTime ** データセットグループが作成された時点、または [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) オペレーションに対する呼び出し以降の最終更新時点。データセットグループが更新されている間、`LastModificationTime` は `ListDatasetGroups` コールの現在の時刻です。型: タイムスタンプ必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetGroupSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetGroupSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetGroupSummary) # DatasetImportJobSummary [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) オペレーションで使用されるデータセットのインポートジョブのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) オペレーションを呼び出して、`DatasetImportJobArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** データセットのインポートジョブが作成された時点。型: タイムスタンプ必須: いいえ ** DatasetImportJobArn ** データセットのインポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** DatasetImportJobName ** データセットのインポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** DataSource ** インポートするトレーニングデータの場所と、Amazon Forecast がデータにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。トレーニングデータは Amazon S3 バケットに保存されている必要があります。暗号化が使用されている場合、には AWS Key Management Service (KMS) キー`DataSource`が含まれます。型: [DataSource](API_DataSource.md) オブジェクト必須: いいえ ** ImportMode ** データセットのインポートジョブのインポートモード。完全または増分。タイプ: 文字列有効な値: `FULL | INCREMENTAL` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** Status ** データセットのインポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetImportJobSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetImportJobSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetImportJobSummary) # DatasetSummary [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) オペレーションで使用されるデータセットのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) オペレーションを呼び出して、`DatasetArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** データセットが作成された時点。型: タイムスタンプ必須: いいえ ** DatasetArn ** データセットの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** DatasetName ** データセットの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** DatasetType ** データセットのタイプ。タイプ: 文字列有効な値: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 必須: いいえ ** Domain ** データセットに関連付けられているドメイン。タイプ: 文字列有効な値: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 必須: いいえ ** LastModificationTime ** データセットを作成する場合、`LastModificationTime` は `CreationTime` と同じです。データがデータセットにインポートされている間、`LastModificationTime` は `ListDatasets` コールの現在の時刻です。[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) オペレーションが終了した後は、`LastModificationTime` はインポートジョブが終了または失敗した時点です。型: タイムスタンプ必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetSummary) # DataSource データのソース、Amazon Forecast がデータにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、およびオプションで AWS Key Management Service (KMS) キー。 ## 内容 ** S3Config ** Amazon Simple Storage Service (Amazon S3) バケットに保存されたデータへのパスと、そのデータにアクセスするための認証情報。型: [S3Config](API_S3Config.md) オブジェクト必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataSource) # EncryptionConfig Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。このオプションのオブジェクトは、[CreateDataset](API_CreateDataset.md) および [CreatePredictor](API_CreatePredictor.md) リクエストで指定できます。 ## 内容 ** KMSKeyArn ** KMS キーの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:aws:kms:.*:key/.*` 必須: はい ** RoleArn ** Amazon Forecast が AWS KMS キーにアクセスするために引き受けることができる IAM ロールの ARN。 AWS アカウント間でロールを渡すことはできません。アカウントにないロールを渡すと、`InvalidInputException` エラーが発生します。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EncryptionConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EncryptionConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EncryptionConfig) # ErrorMetric 予測子のパフォーマンスを評価するための詳細なエラーメトリクスを提供します。このオブジェクトは [Metrics](API_Metrics.md) オブジェクトの一部です。 ## 内容 ** ForecastType ** WAPE、MAPE、MASE、および RMSE のコンピューティングに使用される Forecast のタイプ。タイプ: 文字列長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` 必須: いいえ ** MAPE ** 平均絶対パーセント誤差 (MAPE) 型: 倍精度浮動小数点数必須: いいえ ** MASE ** 平均絶対スケーリング誤差 (MASE) 型: 倍精度浮動小数点数必須: いいえ ** RMSE ** 二乗平均平方根誤差 (RMSE)。型: 倍精度浮動小数点数必須: いいえ ** WAPE ** 重み付き絶対誤差率 (WAPE)。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ErrorMetric) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ErrorMetric) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ErrorMetric) # EvaluationParameters データセットをトレーニングデータとテストデータに分割する方法、および実行する反復回数を定義するパラメータ。これらのパラメータは事前定義されたアルゴリズムで指定されていますが、[CreatePredictor](API_CreatePredictor.md) リクエストで上書きできます。 ## 内容 ** BackTestWindowOffset ** モデルのトレーニングとテスト (評価) のためにデータを分割するデータセットの末尾からのポイント。値をデータポイントの数として指定します。デフォルトは、予測期間の値です。`BackTestWindowOffset` は、過去の仮想予測開始日を再現するために使用できます。この値は、予測期間以上で、TARGET\$1TIME\$1SERIES データセットの長さの半分未満でなければなりません。 `ForecastHorizon` <= `BackTestWindowOffset` < 1/2 \$1 TARGET\$1TIME\$1SERIES データセットの長さタイプ: 整数必須: いいえ ** NumberOfBacktestWindows ** 入力データを分割する回数。デフォルトは 1 です。有効な値の範囲は 1～5 です。タイプ: 整数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationParameters) # EvaluationResult アルゴリズムを評価した結果。[GetAccuracyMetrics](API_GetAccuracyMetrics.md) レスポンスの一部として返されます。 ## 内容 ** AlgorithmArn ** 評価されたアルゴリズムの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** TestWindows ** アルゴリズムの評価に使用されるテストウィンドウの配列。[EvaluationParameters](API_EvaluationParameters.md) オブジェクトからの `NumberOfBacktestWindows` は、配列内のウィンドウの数を決定します。型: [WindowSummary](API_WindowSummary.md) オブジェクトの配列必須：いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationResult) # ExplainabilityConfig ExplainabilityConfig データ型は、[CreateExplainability](API_CreateExplainability.md) に含まれる時系列と時間ポイントの数を定義します。 `ResourceArn` の予測 ARN を指定する場合は、`TimePointGranularity` と `TimeSeriesGranularity` の両方を「ALL」に設定する必要があります。Predictor Explainability を作成するとき、Amazon Forecast は、すべての時系列と時間ポイントを考慮します。 `ResourceArn` の予測 ARN を指定する場合は、`TimePointGranularity` および `TimeSeriesGranularity` を「ALL」または「Specific」のいずれかに設定できます。 ## 内容 ** TimePointGranularity ** 予測期間内のすべての時間ポイントについて Explainability を作成するには、`ALL` を使用します。予測期間内の特定の時間ポイントについて Explainability を作成するには、`SPECIFIC` を使用します。 [CreateExplainability](API_CreateExplainability.md) オペレーション内の `StartDateTime` および `EndDateTime` パラメータを使用して時間ポイントを指定します。タイプ: 文字列有効な値: `ALL | SPECIFIC` 必須: はい ** TimeSeriesGranularity ** データセット内のすべての時系列について Explainability を作成するには、`ALL` を使用します。データセット内の特定の時系列について Explainability を作成するには、`SPECIFIC` を使用します。 CSV または Parquet ファイルを Amazon S3 バケットにアップロードして時系列を指定し、[DataDestination](API_DataDestination.md) データ型内のロケーションを設定します。タイプ: 文字列有効な値: `ALL | SPECIFIC` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityConfig) # ExplainabilityExportSummary [ListExplainabilityExports](API_ListExplainabilityExports.md) オペレーションで使用される Explainability エクスポートのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) オペレーションを呼び出して、`ExplainabilityExportArn` を指定します。 ## 内容 ** CreationTime ** Explainability が作成された時点。型: タイムスタンプ必須: いいえ ** Destination ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト必須: いいえ ** ExplainabilityExportArn ** Explainability エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** ExplainabilityExportName ** Explainability エクスポートの名前タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** Explainability エクスポート中に発生した可能性のあるエラーに関する情報。タイプ: 文字列必須: いいえ ** Status ** Explainability エクスポートのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityExportSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityExportSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityExportSummary) # ExplainabilityInfo Explainability リソースに関する情報を提供します。 ## 内容 ** ExplainabilityArn ** Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** Status ** Explainability のステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityInfo) # ExplainabilitySummary [ListExplainabilities](API_ListExplainabilities.md) オペレーションで使用される Explainability のプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeExplainability](API_DescribeExplainability.md) オペレーションを呼び出して、リストされた `ExplainabilityArn` を指定します。 ## 内容 ** CreationTime ** Explainability が作成された時点。型: タイムスタンプ必須: いいえ ** ExplainabilityArn ** Explainability の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** ExplainabilityConfig ** Explainability の時系列と時間ポイントの粒度を定義する構成設定。型: [ExplainabilityConfig](API_ExplainabilityConfig.md) オブジェクト必須: いいえ ** ExplainabilityName ** Explainability の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** Explainability の作成プロセス中に発生した可能性のあるエラーに関する情報。タイプ: 文字列必須: いいえ ** ResourceArn ** Explainability の作成に使用される予測子または予測の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** Status ** Explainability のステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilitySummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilitySummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilitySummary) # Featurization **注記** このオブジェクトは [CreatePredictor](API_CreatePredictor.md) オペレーションに属しています。[CreateAutoPredictor](API_CreateAutoPredictor.md) で予測子を作成した場合は、「[AttributeConfig](API_AttributeConfig.md)」を参照してください。データセットフィールドの特徴量化 (変換) 情報を提供します。このオブジェクトは [FeaturizationConfig](API_FeaturizationConfig.md) オブジェクトの一部です。以下に例を示します。 `{` `"AttributeName": "demand",` `FeaturizationPipeline [ {` `"FeaturizationMethodName": "filling",` `"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}` `} ]` `}` ## 内容 ** AttributeName ** 特徴量化するデータフィールドを指定するスキーマ属性の名前。Amazon Forecast は、`TARGET_TIME_SERIES` および `RELATED_TIME_SERIES` のデータセットのターゲットフィールドをサポートしています。例えば、`RETAIL` ドメインについては、ターゲットは `demand` です。`CUSTOM` ドメインについては、ターゲットは `target_value` です。詳細については、「[欠落した値の処理](howitworks-missing-values.md)」を参照してください。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** FeaturizationPipeline ** 特徴変換メソッドを指定する 1 つの `FeaturizationMethod` オブジェクトの配列。型: [FeaturizationMethod](API_FeaturizationMethod.md) オブジェクトの配列配列メンバー: 1 項目の定数です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Featurization) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Featurization) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Featurization) # FeaturizationConfig **注記** このオブジェクトは [CreatePredictor](API_CreatePredictor.md) オペレーションに属しています。[CreateAutoPredictor](API_CreateAutoPredictor.md) で予測子を作成した場合は、「[AttributeConfig](API_AttributeConfig.md)」を参照してください。 [CreatePredictor](API_CreatePredictor.md) オペレーションでは、指定されたアルゴリズムが、指定されたデータセットグループを使用してモデルをトレーニングします。オプションで、モデルをトレーニングする前にデータフィールドを変更するようにオペレーションに指示できます。これらの変更は、*特徴量化*と呼ばれます。 `FeaturizationConfig` オブジェクトを使用して特徴量化を定義します。特徴量化するフィールドごとに 1 つずつ、変換の配列を指定します。その後、`FeaturizationConfig` オブジェクトを `CreatePredictor` リクエストに含めます。Amazon Forecast は、モデルトレーニングの前に `TARGET_TIME_SERIES` および `RELATED_TIME_SERIES` データセットに特徴量化を適用します。複数の特徴量化設定を作成できます。例えば、異なる特徴量化の設定を指定して、`CreatePredictor` オペレーションを 2 回呼び出すことができます。 ## 内容 ** ForecastFrequency ** 予測内の予測の頻度。有効な間隔は、整数の後に Y (年)、M (月)、W (週)、D (日)、H (時)、min (分) をつけたものです。例えば、「1D」は毎日を示し、「15min」は 15 分ごとを示します。次に多頻度で重複するような値は指定できません。つまり、たとえば 60 分の間隔は 1 時間に相当するため、指定することはできません。各頻度の有効な値は以下のとおりです。 + 分 - 1～59 + 時間 - 1～23 + 日 - 1～6 + 週 - 1～4 + 月 - 1～11 + 年 - 1 したがって、隔週の予測が必要な場合は、「2W」と指定します。または、四半期ごとの予測が必要な場合は、「3M」と指定します。頻度は、TARGET\$1TIME\$1SERIES データセットの頻度以上である必要があります。 RELATED\$1TIME\$1SERIES データセットが提供される場合、頻度は TARGET\$1TIME\$1SERIES データセットの頻度と等しくなければなりません。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 5 です。 Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` 必須: はい ** Featurizations ** データセットのフィールドの特徴量化 (変換) 情報の配列。型: [Featurization](API_Featurization.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。必須: いいえ ** ForecastDimensions ** 生成された予測をグループ化する方法を指定するディメンション (フィールド) 名の配列。例えば、すべての店舗での商品販売の予測を生成していて、データセットに `store_id` フィールドが含まれているとします。店舗ごとの各商品の売上予測が必要な場合は、ディメンションとして `store_id` を指定します。 `TARGET_TIME_SERIES` データセットで指定されたすべての予測ディメンションは、`CreatePredictor` リクエストで指定する必要はありません。`RELATED_TIME_SERIES` データセットで指定されたすべての予測ディメンションは、`CreatePredictor` リクエストで指定する必要があります。タイプ: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。長さの制限：最小長 1、最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationConfig) # FeaturizationMethod データセットフィールドを特徴量化 (変換) するメソッドに関する情報を提供します。メソッドは [Featurization](API_Featurization.md) オブジェクトの `FeaturizationPipeline` の一部です。 `FeaturizationMethod` オブジェクトを指定する方法の例を次に示します。 `{` `"FeaturizationMethodName": "filling",` `"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` `}` ## 内容 ** FeaturizationMethodName ** メソッドの名前。「filling」メソッドは、サポートされている唯一のメソッドです。タイプ: 文字列有効な値: `filling` 必須: はい ** FeaturizationMethodParameters ** 上書きパラメータのマップであるメソッドパラメータ (キーバリューペア)。これらのパラメータを指定して、デフォルト値を上書きします。関連する時系列の属性は、集計パラメータを受け入れません。次のリストは、**ターゲット時系列**のデータセットの「filling」特徴量化メソッドのパラメータとその有効な値を示しています。太字はデフォルト値を示します。 + `aggregation`: **合計**、`avg`、`first`、`min`、`max` + `frontfill`: **なし** + `middlefill`: **ゼロ**、`nan` (非数値)、`value`、`median`、`mean`、`min`、`max` + `backfill`: **ゼロ**、`nan`、`value`、`median`、`mean`、`min`、`max` 次のリストは、**関連する時系列**の特徴量化メソッドのパラメータとその有効な値を示しています (デフォルトはありません)。 + `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` + `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` + `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` filling メソッドを特定の値に設定するには、fill パラメータを `value` に設定し、対応する `_value` パラメータで値を定義します。例えば、backfilling を値 2 に設定するには、`"backfill": "value"` および `"backfill_value":"2"` を含めます。型: 文字列から文字列へのマップマップエントリ: 項目の最大数は 20 です。キーの長さの制限: 最大長は 256 です。キーパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` 値の長さの制限: 最大長は 256 です。値のパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationMethod) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationMethod) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationMethod) # Filter オブジェクトのサブセットを選択するためのフィルターを記述します。各フィルターは、条件と match ステートメントで構成されます。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致するオブジェクトを含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。 ## 内容 ** Condition ** 適用する条件。ステートメントに一致するオブジェクトを含めるには、`IS` を指定します。一致するオブジェクトを除外するには、`IS_NOT` を指定します。タイプ: 文字列有効な値: `IS | IS_NOT` 必須: はい ** Key ** フィルタリングするパラメータの名前。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `^[a-zA-Z0-9\_]+$` 必須: はい ** Value ** 照合する値。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Filter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Filter) # ForecastExportJobSummary [ListForecastExportJobs](API_ListForecastExportJobs.md) オペレーションで使用される予測エクスポートジョブのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeForecastExportJob](API_DescribeForecastExportJob.md) オペレーションを呼び出して、リストされた `ForecastExportJobArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** 予測エクスポートジョブが作成された時点。型: タイムスタンプ必須: いいえ ** Destination ** 予測がエクスポートされる Amazon Simple Storage Service (Amazon S3) バケットへのパス。型: [DataDestination](API_DataDestination.md) オブジェクト必須: いいえ ** ForecastExportJobArn ** 予測エクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** ForecastExportJobName ** 予測エクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** Status ** 予測のエクスポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` S3 バケットの予測にアクセスする前に、予測エクスポートジョブの `Status` が `ACTIVE` となっている必要があります。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastExportJobSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastExportJobSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastExportJobSummary) # ForecastSummary [ListForecasts](API_ListForecasts.md) オペレーションで使用される予測のプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeForecast](API_DescribeForecast.md) オペレーションを呼び出して、概要にリストされている `ForecastArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreatedUsingAutoPredictor ** Forecast が AutoPredictor から作成されたかどうか。型: ブール値必須: いいえ ** CreationTime ** 予測作成タスクが作成された時点。型: タイムスタンプ必須: いいえ ** DatasetGroupArn ** 予測子のトレーニングに使用されるデータを提供したデータセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\_]+$` 必須: いいえ ** ForecastArn ** 予測の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** ForecastName ** 予測の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** PredictorArn ** 予測の生成に使用される予測子の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\_]+$` 必須: いいえ ** Status ** 予測のステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 予測をクエリまたはエクスポートする前に、予測の `Status` が `ACTIVE` となっている必要があります。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastSummary) # HyperParameterTuningJobConfig ハイパーパラメータのチューニングジョブの設定情報。このオブジェクトは [CreatePredictor](API_CreatePredictor.md) リクエストで指定します。 *ハイパーパラメータ*は、モデルトレーニングのプロセスを管理するパラメータです。トレーニング中に決定されるモデルパラメータとは異なり、トレーニング開始前にハイパーパラメータを設定します。ハイパーパラメータの値は、モデルパラメータ用に選択される値に影響します。 *ハイパーパラメータのチューニングジョブ*では、Amazon Forecast は、指定されたメトリクスを最適化するハイパーパラメータ値のセットを選択します。Forecast は、ハイパーパラメータ値の範囲で多くのトレーニングジョブを実行することでこれを実現します。最適な値のセットは、アルゴリズム、トレーニングデータ、および指定されたメトリクスの目的によって異なります。 ## 内容 ** ParameterRanges ** ハイパーパラメータの有効な値の範囲を指定します。型: [ParameterRanges](API_ParameterRanges.md) オブジェクト必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/HyperParameterTuningJobConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/HyperParameterTuningJobConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/HyperParameterTuningJobConfig) # InputDataConfig **注記** このオブジェクトは [CreatePredictor](API_CreatePredictor.md) オペレーションに属しています。[CreateAutoPredictor](API_CreateAutoPredictor.md) で予測子を作成した場合は、「[DataConfig](API_DataConfig.md)」を参照してください。予測子のトレーニングに使用されるデータ。データには、データセットグループと補足的な特徴が含まれます。このオブジェクトは [CreatePredictor](API_CreatePredictor.md) リクエストで指定します。 ## 内容 ** DatasetGroupArn ** データセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** SupplementaryFeatures ** 補足的な特徴の配列。サポートされている特徴は祝祭日カレンダーのみです。型: [SupplementaryFeature](API_SupplementaryFeature.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 2 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/InputDataConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/InputDataConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/InputDataConfig) # IntegerParameterRange 整数のハイパーパラメータとそのチューニング可能な値の範囲を指定します。このオブジェクトは [ParameterRanges](API_ParameterRanges.md) オブジェクトの一部です。 ## 内容 ** MaxValue ** ハイパーパラメータのチューニング可能な最大値。タイプ: 整数必須: はい ** MinValue ** ハイパーパラメータのチューニング可能な最小値。タイプ: 整数必須: はい ** Name ** チューニングするハイパーパラメータの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** ScalingType ** ハイパーパラメータチューニングがハイパーパラメータの範囲を検索するために使用するスケール。有効な値: Auto ハイパーパラメータの最適なスケールを Amazon Forecast ハイパーパラメータの調整が選択します。 [線形] ハイパーパラメータの調整では、線形スケールを使用してハイパーパラメータ範囲内の値を検索します。対数ハイパーパラメータの調整では、対数を使用してハイパーパラメータ範囲内の値を検索します。対数スケールは、範囲内の値が 0 より大きい場合に使用できます。逆対数 `IntegerParameterRange` をサポートしていません。逆対数スケールは、範囲全体が範囲 0 <= x < 1.0 内に収まる場合にのみ使用できます。ハイパーパラメータのスケールの選択については、「[Hyperparameter Scaling](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type)」(ハイパーパラメータのスケーリング) を参照してください。次のいずれかの値になります。タイプ: 文字列有効な値: `Auto | Linear | Logarithmic | ReverseLogarithmic` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/IntegerParameterRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/IntegerParameterRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/IntegerParameterRange) # MetricResult 予測子の使用量を監視する際に Forecast が計算した個別のメトリクス。このメトリクスの値を [Baseline](API_Baseline.md) 内のメトリクスの値と比較して、予測子のパフォーマンスがどのように変化しているかを確認できます。 Forecast によって生成されるメトリクスの詳細については、「[Evaluating Predictor Accuracy](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)」を参照してください。 ## 内容 ** MetricName ** メトリクスの名前。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ** MetricValue ** メトリクスの値。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MetricResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MetricResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MetricResult) # Metrics 予測子のパフォーマンスを評価するために使用されるメトリクスを提供します。このオブジェクトは [WindowSummary](API_WindowSummary.md) オブジェクトの一部です。 ## 内容 ** AverageWeightedQuantileLoss ** すべての重み付き分位損失の平均値。型: 倍精度浮動小数点数必須: いいえ ** ErrorMetrics ** 各予測タイプの詳細なエラーメトリクスを提供します。メトリクスには、二乗平均平方根誤差 (RMSE)、平均絶対パーセント誤差 (MAPE)、平均絶対スケーリング誤差 (MASE)、および重み付き絶対誤差率 (WAPE) が含まれます。型: [ErrorMetric](API_ErrorMetric.md) オブジェクトの配列必須: いいえ ** RMSE ** *このメンバーは非推奨になりました。* 二乗平均平方根誤差 (RMSE)。型: 倍精度浮動小数点数必須: いいえ ** WeightedQuantileLosses ** 重み付き分位損失の配列。分位数は、確率分布を等しい確率の領域に分割します。この場合の分布は損失関数です。型: [WeightedQuantileLoss](API_WeightedQuantileLoss.md) オブジェクトの配列必須：いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Metrics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Metrics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Metrics) # MonitorConfig 予測子モニターの構成の詳細。 ## 内容 ** MonitorName ** モニターリソースの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorConfig) # MonitorDataSource モニターが評価中に使用したデータのソース。 ## 内容 ** DatasetImportJobArn ** モニター評価を開始したデータのインポートに使用されるデータセットのインポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** ForecastArn ** 評価中にモニターが使用する予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** PredictorArn ** モニタリングする予測子リソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorDataSource) # MonitorInfo モニターリソースに関する情報を提供します。 ## 内容 ** MonitorArn ** モニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** Status ** モニターのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `ACTIVE_STOPPING`, `ACTIVE_STOPPED` + `UPDATE_IN_PROGRESS` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorInfo) # MonitorSummary [ListMonitors](API_ListMonitors.md) オペレーションで使用されるモニターのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeMonitor](API_DescribeMonitor.md) オペレーションを呼び出して、リストされた `MonitorArn` を指定します。 ## 内容 ** CreationTime ** モニターリソースが作成された時点。型: タイムスタンプ必須: いいえ ** LastModificationTime ** モニターリソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `STOPPED` - リソースが停止したとき。 + `ACTIVE` または `CREATE_FAILED` - モニターの作成が終了または失敗したとき。型: タイムスタンプ必須: いいえ ** MonitorArn ** モニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** MonitorName ** モニターリソースの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** ResourceArn ** モニタリングされる予測子の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** Status ** モニターのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `ACTIVE_STOPPING`, `ACTIVE_STOPPED` + `UPDATE_IN_PROGRESS` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorSummary) # ParameterRanges カテゴリ、連続、整数のハイパーパラメータと、それらのチューニング可能な値の範囲を指定します。チューニング可能な値の範囲によって、ハイパーパラメータチューニングジョブが指定されたハイパーパラメータ用に選択できる値が決まります。このオブジェクトは [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクトの一部です。 ## 内容 ** CategoricalParameterRanges ** 各カテゴリハイパーパラメータのチューニング可能な範囲を指定します。型: [CategoricalParameterRange](API_CategoricalParameterRange.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。必須: いいえ ** ContinuousParameterRanges ** 各連続ハイパーパラメータのチューニング可能な範囲を指定します。型: [ContinuousParameterRange](API_ContinuousParameterRange.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。必須: いいえ ** IntegerParameterRanges ** 各整数ハイパーパラメータのチューニング可能な範囲を指定します。型: [IntegerParameterRange](API_IntegerParameterRange.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ParameterRanges) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ParameterRanges) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ParameterRanges) # PredictorBacktestExportJobSummary [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) オペレーションで使用される予測子バックテストのエクスポートジョブのプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) オペレーションを呼び出して、リストされた `PredictorBacktestExportJobArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** 予測子バックテストエクスポートジョブが作成された時点。型: タイムスタンプ必須: いいえ ** Destination ** エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を指定します。型: [DataDestination](API_DataDestination.md) オブジェクト必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** バックテストエクスポート中に発生した可能性のあるエラーに関する情報。タイプ: 文字列必須: いいえ ** PredictorBacktestExportJobArn ** 予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** PredictorBacktestExportJobName ** 予測子バックテストエクスポートジョブの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** Status ** 予測子バックテストエクスポートジョブのステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBacktestExportJobSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBacktestExportJobSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBacktestExportJobSummary) # PredictorBaseline 比較のベースラインとして使用するメトリクス。自動予測子のモニタリング結果を解釈するときは、これらのメトリクスを使用してください。 ## 内容 ** BaselineMetrics ** 予測子の当初の[精度メトリクス](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。予測子を使用してメトリクスが変化したときに、これらのメトリクスを比較するためのベースラインとして使用してください。型: [BaselineMetric](API_BaselineMetric.md) オブジェクトの配列必須：いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBaseline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBaseline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBaseline) # PredictorEvent 再トレーニングなどの予測子イベントに関する詳細を提供します。 ## 内容 ** Datetime ** イベントが発生したときのタイムスタンプ。型: タイムスタンプ必須: いいえ ** Detail ** イベントのタイプ。例えば、`Retrain` と指定します。再トレーニングイベントは、予測子が再トレーニングされた時点を示します。`Datetime` の前のモニターの結果はすべて、前の予測子のものです。新しいメトリクスはすべて新しく再トレーニングされた予測子のものです。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorEvent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorEvent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorEvent) # PredictorExecution バックテストの実行に使用されるアルゴリズムとそれらのテストのステータス。 ## 内容 ** AlgorithmArn ** 予測子のテストに使用されるアルゴリズムの ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** TestWindows ** アルゴリズムの評価に使用されるテストウィンドウの配列。[EvaluationParameters](API_EvaluationParameters.md) オブジェクトからの `NumberOfBacktestWindows` は、配列内のウィンドウの数を決定します。型: [TestWindowSummary](API_TestWindowSummary.md) オブジェクトの配列必須：いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecution) # PredictorExecutionDetails 予測子の精度を評価するために実行されたバックテストの詳細が含まれています。テストは精度の高い順に返され、最も正確なバックテストが最初に表示されます。[CreatePredictor](API_CreatePredictor.md) オペレーションを呼び出すときに実行するバックテストの数を指定します。 ## 内容 ** PredictorExecutions ** 特定のアルゴリズムに対する予測子の精度を評価するために実行されるバックテストの配列。[EvaluationParameters](API_EvaluationParameters.md) オブジェクトからの `NumberOfBacktestWindows` は、配列内のウィンドウの数を決定します。型: [PredictorExecution](API_PredictorExecution.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecutionDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecutionDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecutionDetails) # PredictorMonitorEvaluation モニター評価の結果について説明します。 ## 内容 ** EvaluationState ** モニター評価の状態。状態は、`SUCCESS` または `FAILURE` にできます。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ** EvaluationTime ** モニター評価が開始された日時を示すタイムスタンプ。型: タイムスタンプ必須: いいえ ** Message ** モニター評価中に発生した可能性のあるエラーに関する情報。タイプ: 文字列必須: いいえ ** MetricResults ** 予測子を監視する際に Forecast が計算したメトリクスのリスト。リスト内の各メトリクスの値を [Baseline](API_Baseline.md) 内のメトリクスの値と比較して、予測子のパフォーマンスがどのように変化しているかを確認できます。型: [MetricResult](API_MetricResult.md) オブジェクトの配列必須: いいえ ** MonitorArn ** モニターリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** MonitorDataSource ** モニターリソースが評価中に使用したデータのソース。型: [MonitorDataSource](API_MonitorDataSource.md) オブジェクト必須: いいえ ** NumItemsEvaluated ** 評価中に考慮された項目の数。型: Long 必須: いいえ ** PredictorEvent ** 再トレーニングなどの予測子イベントに関する詳細を提供します。型: [PredictorEvent](API_PredictorEvent.md) オブジェクト必須: いいえ ** ResourceArn ** モニタリングするリソースの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WindowEndDatetime ** モニターの評価に使用される期間の終わりを知らせるタイムスタンプ。型: タイムスタンプ必須: いいえ ** WindowStartDatetime ** モニターの評価に使用される期間の開始を知らせるタイムスタンプ。型: タイムスタンプ必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorMonitorEvaluation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorMonitorEvaluation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorMonitorEvaluation) # PredictorSummary [ListPredictors](API_ListPredictors.md) オペレーションで使用される予測子のプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribePredictor](API_DescribePredictor.md) オペレーションを呼び出して、リストされた `PredictorArn` を指定します。 **重要** Amazon Forecast は、新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 内容 ** CreationTime ** モデルトレーニングタスクが作成された時点。型: タイムスタンプ必須: いいえ ** DatasetGroupArn ** 予測子のトレーニングに使用されるデータを含むデータセットグループの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** IsAutoPredictor ** AutoPredictor を使用して予測子を作成したかどうか。型: ブール値必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** PredictorArn ** 予測子の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** PredictorName ** 予測子の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** ReferencePredictorSummary ** 予測子が再トレーニングまたはアップグレードされた場合に使用される参照予測子の概要。型: [ReferencePredictorSummary](API_ReferencePredictorSummary.md) オブジェクト必須: いいえ ** Status ** 予測子のステータス。含まれる状態は次のとおりです。 + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` 予測子を使用して予測を作成する前に、予測子の `Status` が `ACTIVE` となっている必要があります。タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorSummary) # ReferencePredictorSummary 予測子を再トレーニングまたはアップグレードするときに使用される参照予測子の概要を提供します。 ## 内容 ** Arn ** 参照予測子の ARN。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** State ** 参照予測子が `Active` または `Deleted` であるかどうか。タイプ: 文字列有効な値: `Active | Deleted` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ReferencePredictorSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ReferencePredictorSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ReferencePredictorSummary) # S3Config Amazon Simple Storage Service (Amazon S3) バケット内のファイル (複数可) へのパス、および Amazon Forecast がファイル (複数可) にアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。オプションで、には AWS Key Management Service (KMS) キーが含まれます。このオブジェクトは、[CreateDatasetImportJob](API_CreateDatasetImportJob.md) リクエストで送信された [DataSource](API_DataSource.md) オブジェクトの一部であり、かつ、[DataDestination](API_DataDestination.md) オブジェクトの一部です。 ## 内容 ** Path ** Amazon Simple Storage Service (Amazon S3) バケットまたは Amazon S3 バケット内のファイルへのパス。タイプ: 文字列長さの制限: 最小長は 7 です。最大長は 4096 です。 Pattern: `^s3://[a-z0-9].+$` 必須: はい ** RoleArn ** Amazon Forecast が Amazon S3 バケットまたはファイルにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールの ARN。 Amazon S3 `KMSKeyArn` キーに値を指定する場合、ロールはキーへのアクセスを許可する必要があります。 AWS アカウント間でロールを渡すことはできません。アカウントにないロールを渡すと、`InvalidInputException` エラーが発生します。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ** KMSKeyArn ** (KMS) キーの Amazon リソースネーム AWS Key Management Service (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:aws:kms:.*:key/.*` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/S3Config) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/S3Config) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/S3Config) # Schema データセットのフィールドを定義します。 ## 内容 ** Attributes ** データセット内の各フィールドの名前とタイプを指定する属性の配列。型: [SchemaAttribute](API_SchemaAttribute.md) オブジェクトの配列配列メンバー: 最小数は 1 項目です。最大数は 100 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Schema) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Schema) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Schema) # SchemaAttribute データセットフィールドを定義するスキーマの属性。データセットのすべてのフィールドにスキーマ属性が必要です。[Schema](https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) オブジェクトには `SchemaAttribute` オブジェクト配列が含まれます。 ## 内容 ** AttributeName ** データセットフィールドの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ** AttributeType ** フィールドのデータ型。関連する時系列データセットでは、日付、item\$1id、予測ディメンション属性以外のすべての属性が数値型 (整数/浮動小数点数) である必要があります。タイプ: 文字列有効な値: `string | integer | float | timestamp | geolocation` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SchemaAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SchemaAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SchemaAttribute) # Statistics [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) オペレーションで Amazon Forecast のデータセットにインポートされた各データフィールドの統計を提供します。 ## 内容 ** Avg ** 数値フィールドについては、フィールド内の平均値。型: 倍精度浮動小数点数必須: いいえ ** Count ** フィールド内の値の数。レスポンス値が -1 の場合は、「`CountLong`」を参照してください。タイプ: 整数必須: いいえ ** CountDistinct ** フィールド内の異なる値の数。レスポンス値が -1 の場合は、「`CountDistinctLong`」を参照してください。タイプ: 整数必須: いいえ ** CountDistinctLong ** フィールド内の個別の値の数。値が 2,147,483,647 より大きい場合、`CountDistinct` の代わりに `CountDistinctLong` が使用されます。型: Long 必須: いいえ ** CountLong ** フィールド内の値の数。値が 2,147,483,647 より大きい場合、`Count` の代わりに `CountLong` が使用されます。型: Long 必須: いいえ ** CountNan ** フィールド内の NAN (非数値) の値の数。レスポンス値が -1 の場合は、「`CountNanLong`」を参照してください。タイプ: 整数必須: いいえ ** CountNanLong ** フィールド内の NAN (非数値) の値の数。値が 2,147,483,647 より大きい場合、`CountNan` の代わりに `CountNanLong` が使用されます。型: Long 必須: いいえ ** CountNull ** フィールド内の null 値の数。レスポンス値が -1 の場合は、「`CountNullLong`」を参照してください。タイプ: 整数必須: いいえ ** CountNullLong ** フィールド内の null 値の数。値が 2,147,483,647 より大きい場合、`CountNull` の代わりに `CountNullLong` が使用されます。型: Long 必須: いいえ ** Max ** 数値フィールドについては、フィールド内の最大値。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\_]+$` 必須: いいえ ** Min ** 数値フィールドについては、フィールド内の最小値。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\_]+$` 必須: いいえ ** Stddev ** 数値フィールドについては、標準偏差。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Statistics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Statistics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Statistics) # SupplementaryFeature **注記** このオブジェクトは [CreatePredictor](API_CreatePredictor.md) オペレーションに属しています。[CreateAutoPredictor](API_CreateAutoPredictor.md) で予測子を作成した場合は、「[AdditionalDataset](API_AdditionalDataset.md)」を参照してください。データセットグループの補足的な特徴を記述します。このオブジェクトは [InputDataConfig](API_InputDataConfig.md) オブジェクトの一部です。Forecast は、Weather Index と Holidays のビルトインの特徴量化をサポートしています。 **Weather Index** Amazon Forecast の Weather Index はビルトインの特徴量化であり、履歴気象情報および予測される気象情報をモデルに組み込みます。Weather Index は、2 年を超える期間にわたる履歴気象データと最大 14 日間の気象予報データでデータセットを補完します。詳細については、「[Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html)」(Amazon Forecast の Weather Index) を参照してください。 **Holidays** Holidays は、特徴エンジニアリングされた祝祭日情報データセットをモデルに組み込む、ビルトインの特徴量化です。250 か国を超える祝祭日カレンダーをネイティブにサポートします。Amazon Forecast には、ホリデーカレンダーを生成するための [Holiday API ライブラリ](https://holidayapi.com/countries)と [Jollyday API](https://jollyday.sourceforge.net/data.html) の両方が組み込まれています。詳細については、「[Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html)」(Holidays の特徴量化) を参照してください。 ## 内容 ** Name ** 機能の名前。有効な値: `"holiday"` および `"weather"`。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** Value ** **Weather Index** Weather Index を有効にするには、値を `"true"` に設定します。 **Holidays** Holidays を有効にするには、次の 2 文字の国コードで国を指定します。 + アフガニスタン - AF + オーランド諸島 - AX + アルバニア - AL + アルジェリア - DZ + アメリカ領サモア - AS + アンドラ - AD + アンゴラ - AO + アンギラ - AI + 南極 - AQ + アンティグアバーブーダ - AG + アルゼンチン - AR + アルメニア - AM + アルバ - AW + オーストラリア - AU + オーストリア - AT + アゼルバイジャン - AZ + バハマ - BS + バーレーン - BH + バングラデシュ - BD + バルバドス - BB + ベラルーシ - BY + ベルギー - BE + ベリーズ - BZ + ベナン - BJ + バーミューダ - BM + ブータン - BT + ボリビア -BO + ボスニアヘルツェゴビナ - BA + ボツワナ - BW + ブーベ島 - BV + ブラジル - BR + 英領インド洋地域 - IO + 英領バージン諸島 - VG + ブルネイ・ダルサラーム - BN + ブルガリア - BG + ブルキナファソ - BF + ブルンジ - BI + カンボジア - KH + カメルーン - CM + カナダ - CA + カーボベルデ - CV + オランダカリブ領域 - BQ + ケイマン諸島 - KY + 中央アフリカ共和国 - CF + チャド - TD + チリ - CL + 中国 - CN + クリスマス島 - CX + ココス (キーリング) - CC + コロンビア - CO + コモロ - KM + クック諸島 -CK + コスタリカ - CR + クロアチア - HR + キューバ - CU + キュラソー - CW + キプロス - CY + チェコ - CZ + コンゴ民主共和国 - CD + デンマーク - DK + ジブチ - DJ + ドミニカ国 - DM + ドミニカ共和国 - DO + エクアドル - EC + エジプト - EG + エルサルバドル - SV + 赤道ギニア - GQ + エリトリア - ER + エストニア - EE + エスワティニ - SZ + エチオピア - ET + フォークランド諸島 - FK + フェロー諸島 - FO + フィジー - FJ + フィンランド - FI + フランス - FR + フランス領ギアナ - GF + フランス領ポリネシア - PF + フランス領南方・南極地域 - TF + ガボン - GA + ガンビア - GM + ジョージア - GE + ドイツ - DE + ガーナ - GH + ジブラルタル - GI + ギリシャ - GR + グリーンランド - GL + グレナダ - GD + グアドループ - GP + グアム - GU + グアテマラ - GT + ガーンジー - GG + ギニア - GN + ギニアビサウ - GW + ガイアナ - GY + ハイチ - HT + ハード島とマクドナルド諸島 - HM + ホンジュラス - HN + 香港 - HK + ハンガリー - HU + アイスランド - IS + インド - IN + インドネシア - ID + イラン - IR + イラク - IQ + アイルランド - IE + マン島 - IM + イスラエル - IL + イタリア - IT + コートジボワール - CI + ジャマイカ - JM + 日本 - JP + ジャージー - JE + ヨルダン - JO + カザフスタン - KZ + ケニア - KE + キリバス - KI + コソボ - XK + クウェート - KW + キルギスタン - KG + ラオス - LA + ラトビア - LV + レバノン - LB + レソト - LS + リベリア - LR + リビア - LY + リヒテンシュタイン - LI + リトアニア - LT + ルクセンブルグ - LU + マカオ - MO + マダガスカル - MG + マラウイ - MW + マレーシア - MY + モルディブ - MV + マリ - ML + マルタ - MT + マーシャル諸島共和国 - MH + マルティニーク - MQ + モーリタニア - MR + モーリシャス - MU + マヨット - YT + メキシコ - MX + ミクロネシア - FM + モルドバ - MD + モナコ - MC + モンゴル国 - MN + モンテネグロ - ME + モントセラト島 - MS + モロッコ - MA + モザンビーク - MZ + ミャンマー - MM + ナミビア - NA + ナウル - NR + ネパール - NP + オランダ - NL + ニューカレドニア - NC + ニュージーランド - NZ + ニカラグア - NI + ニジェール - NE + ナイジェリア - NG + ニウエ - NU + ノーフォーク島 - NF + 北朝鮮 - KP + 北マケドニア - MK + 北マリアナ諸島 - MP + ノルウェー - NO + オマーン - OM + パキスタン - PK + パラオ - PW + パレスチナ - PS + パナマ - PA + パプアニューギニア - PG + パラグアイ - PY + ペルー - PE + フィリピン - PH + ピトケアン諸島 - PN + ポーランド - PL + ポルトガル - PT + プエルトリコ - PR + カタール - QA + コンゴ共和国 - CG + レユニオン - RE + ルーマニア - RO + ロシア連邦 - RU + ルワンダ - RW + サン・バルテルミー - BL + セントヘレナ・アセンションおよびトリスタンダクーニャ - SH + セントクリストファーネイビス - KN + セントルシア - LC + サン・マルタン島 - MF + サンピエール・ミクロン - PM + セントビンセントおよびグレナディーン諸島 - VC + サモア - WS + サンマリノ - SM + サントメプリンシペ - ST + サウジアラビア - SA + セネガル - SN + セルビア - RS + セイシェル - SC + シエラレオネ - SL + シンガポール - SG + シントマールテン - SX + スロバキア - SK + スロベニア - SI + ソロモン諸島 - SB + ソマリア - SO + 南アフリカ - ZA + サウスジョージア・サウスサンドウィッチ諸島 - GS + 韓国 - KR + 南スーダン - SS + スペイン - ES + スリランカ - LK + スーダン - SD + スリナム - SR + スバールバル諸島およびヤンマイエン島 - SJ + スウェーデン - SE + スイス - CH + シリア・アラブ共和国 - SY + 台湾 - TW + タジキスタン - TJ + タンザニア - TZ + タイ - TH + 東ティモール - TL + トーゴ - TG + トケラウ - TK + トンガ - TO + トリニダード・トバゴ - TT + チュニジア - TN + トルコ - TR + トルクメニスタン - TM + タークスおよびカイコス諸島 - TC + ツバル - TV + ウガンダ - UG + ウクライナ - UA + アラブ首長国連邦 - AE + 英国 - GB + 国連 - UN + 米国 - US + 合衆国領有小離島 - UM + アメリカ領バージン諸島 - VI + ウルグアイ - UY + ウズベキスタン - UZ + バヌアツ - VU + バチカン市国 - VA + ベネズエラ - VE + ベトナム - VN + ウォリス・フツナ - WF + 西サハラ - EH + イエメン - YE + ザンビア - ZM + ジンバブエ - ZW タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `^[a-zA-Z0-9\_\-]+$` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SupplementaryFeature) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SupplementaryFeature) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SupplementaryFeature) # Tag サービスに適用し、リソースの分類と整理に役立つオプションのメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 50 です。 + タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。 + キーの最大長 - 128 文字 (Unicode) (UTF-8)。 + 値の最大長 - 256 文字 (Unicode) (UTF-8)。 + 複数ののサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。 + タグのキーと値では、大文字と小文字が区別されます。 + `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。この組み合わせは AWS 用に予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。`aws` のキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。 ## 内容 ** Key ** タグを構成するキーと値のペアの一部。`key` は、より具体的なタグ値のカテゴリーのように動作する、一般的なラベルです。タイプ: 文字列長さの制限: 最小長は 1 です。最大長は 128 です。 Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 必須: はい ** Value ** タグを構成するキーと値のペアのオプションの一部。`value` はタグカテゴリー (キー) の記述子として機能します。タイプ: 文字列長さの制約: 最小長は 0 です。最大長は 256 です。 Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Tag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Tag) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Tag) # TestWindowSummary バックテストのステータス、開始時間、終了時間、および該当する場合は失敗の理由。 ## 内容 ** Message ** テストが失敗した場合、それが失敗した理由。タイプ: 文字列必須: いいえ ** Status ** テストのステータス。可能なステータス値は次のとおりです。 + `ACTIVE` + `CREATE_IN_PROGRESS` + `CREATE_FAILED` タイプ: 文字列長さの制約: 最大長は 256 です。必須: いいえ ** TestWindowEnd ** テストが終了した時刻。型: タイムスタンプ必須: いいえ ** TestWindowStart ** テストが開始された時刻。型: タイムスタンプ必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TestWindowSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TestWindowSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TestWindowSummary) # TimeAlignmentBoundary Forecast が、予想頻度に合わせてデータを調整および集計するために使用する時間境界です。時間単位と時間境界をキーバリューペアとして指定します。時間境界を指定しない場合、Forecast は[デフォルトの時間境界](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries)のセットを使用します。集計の詳細については、「[Data Aggregation for Different Forecast Frequencies](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html)」を参照してください。カスタム時間境界の設定について詳しくは、「[Specifying a Time Boundary](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary)」を参照してください。 ## 内容 ** DayOfMonth ** 集計中の時間調整に使用する日。タイプ: 整数有効範囲: 最小値は 1 です。最大値は 28 です。必須: いいえ ** DayOfWeek ** 集計中の時間調整に使用する曜日。日付は大文字にする必要があります。タイプ: 文字列有効な値: `MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY` 必須: いいえ ** Hour ** 集計中の時間調整に使用する時間。タイプ: 整数有効な範囲: 最小値は 0 です。最大値は 23 です。必須: いいえ ** Month ** 集計中の時間調整に使用する月。月は大文字にする必要があります。タイプ: 文字列有効な値: `JANUARY | FEBRUARY | MARCH | APRIL | MAY | JUNE | JULY | AUGUST | SEPTEMBER | OCTOBER | NOVEMBER | DECEMBER` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeAlignmentBoundary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeAlignmentBoundary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeAlignmentBoundary) # TimeSeriesCondition 変更された属性内の項目のサブセットを作成します。例えば、この操作を使用して 5 USD 以下のアイテムのサブセットを作成できます。そのためには、`"AttributeName": "price"`、`"AttributeValue": "5"`、`"Condition": "LESS_THAN"` を指定します。この操作を [CreateWhatIfForecast:TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) 操作内の [Action](API_Action.md) 操作と組み合わせて、属性の変更方法を定義します。 ## 内容 ** AttributeName ** 変更する item\$1id、ディメンション名、IM 名、またはタイムスタンプ。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。 Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** AttributeValue ** 選択した `Condition` に適用される値。タイプ: 文字列長さの制約: 最大長は 256 です。 Pattern: `.+` 必須: はい ** Condition ** 適用する条件。有効な値は、`EQUALS`、`NOT_EQUALS`、`LESS_THAN`、`GREATER_THAN` です。タイプ: 文字列有効な値: `EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN` 必須: はい ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesCondition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesCondition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesCondition) # TimeSeriesIdentifiers 予想を作成する時系列を含むインポートファイルの詳細。 ## 内容 ** DataSource ** データのソース、Amazon Forecast がデータにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、およびオプションで AWS Key Management Service (KMS) キー。型: [DataSource](API_DataSource.md) オブジェクト必須: いいえ ** Format ** データの形式は CSV または PARQUETのいずれかです。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** Schema ** データセットのフィールドを定義します。型: [Schema](API_Schema.md) オブジェクト必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesIdentifiers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesIdentifiers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesIdentifiers) # TimeSeriesReplacementsDataSource 代替データセットは、What-If 予想で含みたい値のみを含むベースライン関連の時系列を修正したバージョンです。代替データセットには、ベースライン関連の時系列の予想ディメンションおよびアイテム識別子と、少なくとも 1 つの変更された時系列が含まれている必要があります。このデータセットをベースライン関連の時系列と統合して、What-If 予想に使用される変換済みデータセットを作成します。 ## 内容 ** S3Config ** Amazon Simple Storage Service (Amazon S3) バケット内のファイル (複数可) へのパス、および Amazon Forecast がファイル (複数可) にアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。オプションで、には AWS Key Management Service (KMS) キーが含まれます。このオブジェクトは、[CreateDatasetImportJob](API_CreateDatasetImportJob.md) リクエストで送信された [DataSource](API_DataSource.md) オブジェクトの一部であり、かつ、[DataDestination](API_DataDestination.md) オブジェクトの一部です。型: [S3Config](API_S3Config.md) オブジェクト必須: はい ** Schema ** データセットのフィールドを定義します。型: [Schema](API_Schema.md) オブジェクト必須: はい ** Format ** 代替データセットの形式は CSV である必要があります。タイプ: 文字列長さの制限: 最大長は 7 です。パターン: `^CSV|PARQUET$` 必須: いいえ ** TimestampFormat ** 代替データのタイムスタンプ形式。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `^[a-zA-Z0-9\-\:\.\,\'\s]+$` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesReplacementsDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesReplacementsDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesReplacementsDataSource) # TimeSeriesSelector `TimeSeriesIdentifiers` オブジェクト内の予想を作成するために使用される時系列のセットを定義します。 `TimeSeriesIdentifiers` オブジェクトには次の情報が必要です。 + `DataSource` + `Format` + `Schema` ## 内容 ** TimeSeriesIdentifiers ** 予想を作成する時系列を含むインポートファイルの詳細。型: [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) オブジェクト必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesSelector) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesSelector) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesSelector) # TimeSeriesTransformation 変換関数は、関連する時系列の行を選択して変更する 2 つのオペレーションです。条件操作で目的の行を選択し、変換オペレーションで行を変更します。すべての条件は AND 演算で結合されます。つまり、変換を適用するにはすべての条件を満たす必要があります。変換は、記載された順序で適用されます。 ## 内容 ** Action ** 時系列とその変換方法を定義するアクションの配列。これらの変換によって新しい時系列が作成され、その時系列が what-if 分析に使用されます。型: [Action](API_Action.md) オブジェクト必須: いいえ ** TimeSeriesConditions ** 関連する時系列のどのメンバーが変換されるかを定義する条件の配列。型: [TimeSeriesCondition](API_TimeSeriesCondition.md) オブジェクトの配列の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesTransformation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesTransformation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesTransformation) # WeightedQuantileLoss 分位数の重み付き分位損失。このオブジェクトは [Metrics](API_Metrics.md) オブジェクトの一部です。 ## 内容 ** LossValue ** すべての分位数の合計で除することによって重み付け (正規化) された、分位数の予測値と実際の値の差。型: 倍精度浮動小数点数必須: いいえ ** Quantile ** 分位数。分位数は、確率分布を等しい確率の領域に分割します。例えば、分布が等しい確率の 5 つの領域に分割された場合、分位数は 0.2、0.4、0.6、および 0.8 になります。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WeightedQuantileLoss) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WeightedQuantileLoss) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WeightedQuantileLoss) # WhatIfAnalysisSummary [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) オペレーションで使用される What-If 分析のプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) オペレーションを呼び出して、概要にリストされている `WhatIfAnalysisArn` を指定します。 ## 内容 ** CreationTime ** What-If 分析が作成された日時。型: タイムスタンプ必須: いいえ ** ForecastArn ** この What-If 分析で使用さえるベースライン予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** Status ** 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 です。必須: いいえ ** WhatIfAnalysisArn ** What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WhatIfAnalysisName ** What-If 分析の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfAnalysisSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfAnalysisSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfAnalysisSummary) # WhatIfForecastExportSummary [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) オペレーションで使用される What-If 予想のエクスポートプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) オペレーションを呼び出して、概要にリストされている `WhatIfForecastExportArn` を指定します。 ## 内容 ** CreationTime ** What-If 予想エクスポートが作成された日時。型: タイムスタンプ必須: いいえ ** Destination ** 予測がエクスポートされる Amazon Simple Storage Service (Amazon S3) バケットへのパス。型: [DataDestination](API_DataDestination.md) オブジェクト必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** Status ** 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 ** エクスポートに含まれる What-If 予想を定義する Amazon リソースネーム (ARN) の配列。タイプ: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WhatIfForecastExportArn ** What-If 予想エクスポートの Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WhatIfForecastExportName ** What-If 予想エクスポートの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastExportSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastExportSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastExportSummary) # WhatIfForecastSummary [ListWhatIfForecasts](API_ListWhatIfForecasts.md) オペレーションで使用される What-If 予想のプロパティの概要を提供します。プロパティの完全なセットを取得するには、[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) オペレーションを呼び出して、概要にリストされている `WhatIfForecastArn` を指定します。 ## 内容 ** CreationTime ** What-If 予想が作成された日時。型: タイムスタンプ必須: いいえ ** LastModificationTime ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。型: タイムスタンプ必須: いいえ ** Message ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列必須: いいえ ** Status ** 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 です。必須: いいえ ** WhatIfAnalysisArn ** この What-If 予想を含む What-If 分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WhatIfForecastArn ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** WhatIfForecastName ** What-If 予想の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastSummary) # WindowSummary データセットの評価部分内の時間範囲のメトリクス。このオブジェクトは [EvaluationResult](API_EvaluationResult.md) オブジェクトの一部です。 `TestWindowStart` および `TestWindowEnd` パラメータは、[EvaluationParameters](API_EvaluationParameters.md) オブジェクトの `BackTestWindowOffset` パラメータによって決定されます。 ## 内容 ** EvaluationType ** 評価のタイプ。 + `SUMMARY` - すべてのウィンドウの平均メトリクス。 + `COMPUTED` - 指定されたウィンドウのメトリクス。タイプ: 文字列有効な値: `SUMMARY | COMPUTED` 必須: いいえ ** ItemCount ** ウィンドウ内のデータポイントの数。タイプ: 整数必須: いいえ ** Metrics ** 予測子のパフォーマンスを評価するために使用されるメトリクスを提供します。型: [Metrics](API_Metrics.md) オブジェクト必須: いいえ ** TestWindowEnd ** ウィンドウの終わりを定義するタイムスタンプ。型: タイムスタンプ必須: いいえ ** TestWindowStart ** ウィンドウの開始を定義するタイムスタンプ。型: タイムスタンプ必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WindowSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WindowSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WindowSummary) # Amazon Forecast クエリサービス次のデータ型は、Amazon Forecast Query Service でサポートされています: + [DataPoint](API_forecastquery_DataPoint.md) + [Forecast](API_forecastquery_Forecast.md) # DataPoint 特定の日付の予測値。[Forecast](API_forecastquery_Forecast.md) オブジェクトの一部。 ## 内容 ** Timestamp ** 特定の予測のタイムスタンプ。タイプ: 文字列必須: いいえ ** Value ** 予測値。型: 倍精度浮動小数点数必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/DataPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/DataPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/DataPoint) # Forecast 予測に関する情報を提供します。[QueryForecast](API_forecastquery_QueryForecast.md) レスポンスの一部として返されます。 ## 内容 ** Predictions ** 予測。 string-to-array マップの*文字列*は、次のいずれかの値です。 + p10 + p50 + p90 デフォルトの設定は`["0.1", "0.5", "0.9"]` です。[CreateForecast](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) オペレーションのオプションの `ForecastTypes` パラメータを使用して、値を変更します。値は、これがどのように設定されているかによって異なり、最小値を `1`、最大値を `5.` とします。タイプ: [DataPoint](API_forecastquery_DataPoint.md) オブジェクトマップの配列への文字列キーの長さの制限: 最大長は 4 です。必須: いいえ ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/Forecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/Forecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/Forecast) # 共通エラーこのセクションでは、すべての AWS サービスの API アクションに共通するエラーを一覧表示します。このサービスの API アクションに固有のエラーについては、その API アクションのトピックを参照してください。 **AccessDeniedException** このアクションを実行する十分なアクセス権限がありません。 HTTP ステータスコード: 400 **IncompleteSignature** リクエスト署名が AWS 標準に準拠していません。 HTTP ステータスコード: 400 **InternalFailure** リクエストの処理が、不明なエラー、例外、または障害により実行できませんでした。 HTTP ステータスコード: 500 **InvalidAction** リクエストされたアクション、またはオペレーションは無効です。アクションが正しく入力されていることを確認してください。 HTTP ステータスコード: 400 **InvalidClientTokenId** 指定された X.509 証明書または AWS アクセスキー ID がレコードに存在しません。 HTTP ステータスコード: 403 **NotAuthorized** このアクションを実行するためのアクセス許可がありません。 HTTP ステータスコード: 400 **OptInRequired** AWS アクセスキー ID には、サービスのサブスクリプションが必要です。 HTTP ステータスコード: 403 **RequestExpired** リクエストの日付スタンプの 15 分以上後またはリクエストの有効期限 (署名付き URL の場合など) の 15 分以上後に、リクエストが到着しました。または、リクエストの日付スタンプが現在より 15 分以上先です。 HTTP ステータスコード: 400 **ServiceUnavailable** サーバーの一時的な障害により、リクエストは失敗しました。 HTTP ステータスコード: 503 **ThrottlingException** リクエストのスロットリングにより、リクエストが拒否されました。 HTTP ステータスコード: 400 **ValidationError** 入力が AWS サービスで指定された制約を満たしていません。 HTTP ステータスコード: 400 # 共通パラメータ次のリストには、すべてのアクションが署名バージョン 4 リクエストにクエリ文字列で署名するために使用するパラメータを示します。アクション固有のパラメータは、アクションのトピックに示されています。署名バージョン 4 の詳細については、*IAM ユーザーガイド*[の AWS API リクエストの署名](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)を参照してください。 **X-Amz-Algorithm** リクエストの署名を作成するのに使用したハッシュアルゴリズム。条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。型: 文字列有効な値：`AWS4-HMAC-SHA256` 必須: 条件による **X-Amz-Credential** 認証情報スコープの値で、アクセスキー、日付、対象とするリージョン、リクエストしているサービス、および終了文字列 ("aws4\$1request") を含む文字列です。値は次の形式で表現されます: [*access\$1key*/*YYYYMMDD*/*リージョン*/*サービス*/aws4\$1request]。詳細については、*IAM* [ユーザーガイドの「署名付き AWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。型: 文字列必須: 条件による **X-Amz-Date** 署名を作成するときに使用する日付です。形式は ISO 8601 基本形式の YYYYMMDD'T'HHMMSS'Z' でなければなりません。例えば、日付 `20120325T120000Z` は、有効な X-Amz-Date の値です。条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 ベーシック形式で日付ヘッダーが指定されている場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、*IAM ユーザーガイド*[の AWS API リクエスト署名の要素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)を参照してください。タイプ: 文字列必須: 条件による **X-Amz-Security-Token** AWS Security Token Service () の呼び出しによって取得された一時的なセキュリティトークンAWS STS。 AWS STSの一時的なセキュリティ認証情報をサポートするサービスのリストについては、「IAM ユーザーガイド」の「[IAM と連携するAWS のサービス](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)」を参照してください。条件: から一時的なセキュリティ認証情報を使用している場合は AWS STS、セキュリティトークンを含める必要があります。タイプ: 文字列必須: 条件による **X-Amz-Signature** 署名する文字列と派生署名キーから計算された 16 進符号化署名を指定します。条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。型: 文字列必須: 条件による **X-Amz-SignedHeaders** 正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名付きヘッダーの指定の詳細については、*IAM* [ユーザーガイドの「署名付き AWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。型: 文字列必須: 条件による