amazon forecast - 開発者ガイド...amazon forecast 開発者ガイド amazon forecast...

Amazon Forecast開発者ガイド

Amazon Forecast 開発者ガイド

Amazon Forecast: 開発者ガイドCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's,in any manner that is likely to cause confusion among customers, or in any manner that disparages or discreditsAmazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may notbe affiliated with, connected to, or sponsored by Amazon.


Table of ContentsAmazon Forecast とは ........................................................................................................................ 1

Amazon Forecast を初めてお使いになる方向けの情報 ..................................................................... 1Amazon Forecast の詳細 ..................................................................................................................... 2

データセットおよびデータセットグループ ...................................................................................... 2Datasets ............................................................................................................................ 2データセットグループ ......................................................................................................... 5データ収集頻度の競合の解決 ................................................................................................ 5関連する時系列 .................................................................................................................. 7項目メタデータ ................................................................................................................. 10欠落した値の処理 .............................................................................................................. 12データセットのガイドライン .............................................................................................. 14

予測子 ..................................................................................................................................... 16予測子の作成 .................................................................................................................... 16予測子の評価 .................................................................................................................... 16: 仕組み次のトピック ....................................................................................................... 17

予測 ........................................................................................................................................ 17仕組み: 次のトピック ........................................................................................................ 17

セットアップ .................................................................................................................................... 18AWS にサインアップする .......................................................................................................... 18AWS CLI のセットアップ ........................................................................................................... 18アクセス権限の設定 .................................................................................................................. 19

Amazon Forecast の IAM ロールを作成する (IAM コンソール) ................................................. 19Amazon Forecast の IAM を作成する (AWS CLI) ................................................................... 21

Getting Started ................................................................................................................................. 23入力データを準備する ............................................................................................................... 23開始方法 (コンソール) ............................................................................................................... 24開始方法 (AWS CLI) .................................................................................................................. 39Getting Started (Python Notebook) .............................................................................................. 48Clean Up Resources ................................................................................................................. 49

事前定義済みのデータセットドメインとデータセットタイプ ................................................................... 50RETAIL ドメイン ...................................................................................................................... 51

ターゲット時系列データセットタイプ .................................................................................. 51関連する時系列データセットタイプ ..................................................................................... 52項目メタデータデータセットタイプ ..................................................................................... 52

CUSTOM ドメイン ................................................................................................................... 53ターゲット時系列データセットタイプ .................................................................................. 53関連する時系列データセットタイプ ..................................................................................... 53項目メタデータデータセットタイプ ..................................................................................... 53

INVENTORY_PLANNING ドメイン .............................................................................................. 54ターゲット時系列データセットタイプ .................................................................................. 54関連する時系列データセットタイプ ..................................................................................... 54項目メタデータデータセットタイプ ..................................................................................... 54

EC2 CAPACITY ドメイン .......................................................................................................... 55ターゲット時系列データセットタイプ .................................................................................. 55関連する時系列データセットタイプ ..................................................................................... 55

WORK_FORCE ドメイン ........................................................................................................... 56ターゲット時系列データセットタイプ .................................................................................. 56関連する時系列データセットタイプ ..................................................................................... 56項目メタデータデータセットタイプ ..................................................................................... 56

WEB_TRAFFIC ドメイン ........................................................................................................... 57ターゲット時系列データセットタイプ .................................................................................. 57関連する時系列データセットタイプ ..................................................................................... 57

METRICS ドメイン ................................................................................................................... 58ターゲット時系列データセットタイプ .................................................................................. 58

iii


関連する時系列データセットタイプ ..................................................................................... 58項目メタデータデータセットタイプ ..................................................................................... 58

アルゴリズムを選択する ................................................................................................................... 60組み込みの予測アルゴリズム ...................................................................................................... 60

CNN-QR(CNN-QR) ............................................................................................................ 60DeepAR+ ......................................................................................................................... 60Prophet ........................................................................................................................... 60NPTS .............................................................................................................................. 60ARIMA ............................................................................................................................ 61ETS ................................................................................................................................ 61

予測アルゴリズムの比較 ............................................................................................................ 61ARIMA .................................................................................................................................... 62

仕組み ............................................................................................................................. 62ハイパーパラメータおよびチューニング ............................................................................... 62

CNN-QR(CNN-QR) .................................................................................................................... 62はじめに .......................................................................................................................... 63仕組み ............................................................................................................................. 63関連データ ....................................................................................................................... 65ハイパーパラメータ .......................................................................................................... 65ヒントとベストプラクティス .............................................................................................. 67

DeepAR+ ................................................................................................................................. 67: 仕組み ........................................................................................................................... 68ハイパーパラメータ .......................................................................................................... 70モデルの調整 .................................................................................................................... 72

ETS ........................................................................................................................................ 73仕組み ............................................................................................................................. 73ハイパーパラメータおよびチューニング ............................................................................... 73

NPTS ...................................................................................................................................... 74: 仕組み ........................................................................................................................... 74ハイパーパラメータ .......................................................................................................... 75

Prophet ................................................................................................................................... 76仕組み ............................................................................................................................. 77ハイパーパラメータと関連する時系列 .................................................................................. 77

予測子のメトリクス .......................................................................................................................... 78データの更新 .................................................................................................................................... 81タグ付け .......................................................................................................................................... 82

タグの管理 ............................................................................................................................... 82IAM ポリシーでのタグの使用 ...................................................................................................... 83リソースにタグを追加する ......................................................................................................... 84追加情報 .................................................................................................................................. 85

セキュリティ .................................................................................................................................... 86データ保護 ............................................................................................................................... 86

保管時の暗号化 ................................................................................................................. 87転送中の暗号化 ................................................................................................................. 87キーの管理 ....................................................................................................................... 87

アイデンティティとアクセスの管理 ............................................................................................. 87Audience ......................................................................................................................... 88アイデンティティを使用した認証 ....................................................................................... 88ポリシーを使用したアクセスの管理 ..................................................................................... 90Amazon Forecast と IAM の連携 ......................................................................................... 91アイデンティティベースのポリシーの例 ............................................................................... 93トラブルシューティング .................................................................................................... 98

ログ記録とモニタリング ........................................................................................................... 100AWS CloudTrail を使用した Forecast API コールのログ作成 .................................................. 100Amazon Forecast の CloudWatch メトリクス ...................................................................... 102

コンプライアンス検証 .............................................................................................................. 103耐障害性 ................................................................................................................................ 103

iv


インフラストラクチャセキュリティ ........................................................................................... 104ガイドラインとクォータ ................................................................................................................... 105

AWS でサポートされているリージョン ...................................................................................... 105Compliance ............................................................................................................................ 105サービスクォータ .................................................................................................................... 105

予約フィールド名 ............................................................................................................................ 107API リファレンス ............................................................................................................................ 127

Actions .................................................................................................................................. 127Amazon Forecast Service ................................................................................................. 128Amazon Forecast Query Service ....................................................................................... 214

Data Types ............................................................................................................................ 217Amazon Forecast Service ................................................................................................. 218Amazon Forecast Query Service ....................................................................................... 267

Common Errors ...................................................................................................................... 269Common Parameters ............................................................................................................... 271

ドキュメント履歴 ............................................................................................................................ 273AWS の用語集 ................................................................................................................................ 275................................................................................................................................................ cclxxvi

v

Amazon Forecast 開発者ガイドAmazon Forecast を初めてお使いになる方向けの情報

Amazon Forecast とはAmazon Forecast は、時系列予測のためのフルマネージド型サービスです。Amazon Forecast に過去の時系列データを提供することで、時系列の未来のポイントを予測できます。時系列予測は、小売、財務計画、サプライチェーン、ヘルスケアなど、複数の分野で役立ちます。Amazon Forecast を使用して、インベントリ管理や人員とリソースの計画と管理に関する運用上のメトリクスを予測することもできます。

たとえば、Amazon Forecast を使用して以下を予測できます。

• 小売製品の需要 (ウェブサイト上または特定の店舗やロケーションで販売されている製品に対する需要など)

• サプライチェーンの需要 (製造に必要な原材料、サービス、またはその他の投入量を含む)• リソース要件 (コールセンターのエージェント数、契約社員、IT スタッフ、需要を満たすのに必要なエ

ネルギーなど)• 運用上のメトリクス (サーバーへのウェブトラフィック、AWS の使用状況、IoT センサーの使用状況な

ど)• ビジネス上のメトリクス (地域ごとまたはサービスごとのキャッシュフロー、売上、利益、および経費

など)

Amazon Forecast は、機械学習モデルの構築を大幅に簡素化します。Forecast には、一連の事前定義済みアルゴリズムに加えて、モデルをトレーニングするための AutoML オプションが用意されています。AutoML は、アルゴリズムの選択、ハイパーパラメータの調整、反復モデリング、モデル評価などの複雑な機械学習タスクを自動化します。開発者に機械学習の専門知識がない場合でも、Amazon ForecastAPI、AWS Command Line Interface (AWS CLI)、または Amazon Forecast コンソールを使用して、トレーニングデータを 1 つ以上の Amazon Forecast データセットにインポートして、予測子をトレーニングし、予測を生成することができます。

Amazon Forecast には、他にも次の利点があります。

• 精度 – Amazon Forecast は、深層ニューラルネットワークと従来の統計手法を使用して予測を生成します。関連する時系列が多数ある場合は、 Amazon Forecast ディープラーニングアルゴリズムディープAR+ (p. 67) および CNN-QR (p. 62) は、指数平滑法などの従来の方法で作成された予測よりも正確である傾向があります。

• 使いやすさ – Amazon Forecast コンソールでは、さまざまな詳細度で任意の時系列の予測を検索および視覚化できます。また、予測の精度のメトリクスも表示されます。

ユースケースや基礎となるサービス原則などの Amazon Forecast の詳細については、「Amazon Forecastの時系列予測原則」を参照してください。

Amazon Forecast を初めてお使いになる方向けの情報

Amazon Forecast を初めて使用する場合には、以下をお読みになることをお勧めします。

1. Amazon Forecast の詳細 (p. 2) – Amazon Forecast の主な概念と、Amazon Forecast が予測子を構築する方法について説明します。このトピックは、最初から最後まで読むことをお勧めします。

2. Getting Started (p. 23) – 最初の Amazon Forecast 予測子を作成する方法を説明します。3. Actions (p. 127) – Amazon Forecast API オペレーションについて説明します。

1

https://d1.awsstatic.com/whitepapers/time-series-forecasting-principles-amazon-forecast.pdf?did=wp_card&trk=wp_card

https://d1.awsstatic.com/whitepapers/time-series-forecasting-principles-amazon-forecast.pdf?did=wp_card&trk=wp_card

Amazon Forecast 開発者ガイドデータセットおよびデータセットグループ

Amazon Forecast の詳細Amazon Forecast で予測プロジェクトを作成するときは、次のリソースを使用します。

• データセットおよびデータセットグループ (p. 2) – データセットは、入力データのコレクションです。データセットグループは、補完的な情報を含むデータセットのコレクションです。 Forecast アルゴリズムは、データセットグループを使用して、予測子と呼ばれるカスタム予測モデルをトレーニングします。

• 予測子 (p. 16) – 予測子は、データに基づいてトレーニングされたカスタムモデルです。予想子をトレーニングするには、事前に構築されたアルゴリズムを選択するか、Amazon Forecast で最適なアルゴリズムが選択されるように AutoML オプションを選択します。

• 予測 (p. 17) – 時系列データの予測を生成したり、QueryForecast API を使用して予測したり、コンソールで視覚化したりできます。

トピック• データセットおよびデータセットグループ (p. 2)• Predictors (p. 16)• 予測 (p. 17)

データセットおよびデータセットグループデータセットには、予測子 (p. 16)のトレーニングに使用するデータが含まれます。1 つ以上の AmazonForecast データセットを作成し、トレーニングデータをインポートします。データセットグループは、一連の変化するパラメータを一定の期間にわたって詳細に説明する認定データセットのコレクションです。データセットグループを作成したら、それを使用して予想子をトレーニングします。

各データセットグループには、それぞれ 1 つのデータセットとして、最大 3 つのデータセットを含めることができます。データセット (p. 3) 種類: ターゲット時系列、関連する時系列、およびアイテムメタデータ。

Forecast データセットおよびデータセットグループを作成および管理するには、Forecast コンソール、AWS Command Line Interface (AWS CLI)、または AWS SDK を使用します。

例えば、 Forecast データセット、 Amazon Forecast サンプル GitHub リポジトリ.

トピック• Datasets (p. 2)• データセットグループ (p. 5)• データ収集頻度の競合の解決 (p. 5)• 関連する時系列データセットの使用 (p. 7)• 項目メタデータデータセットの使用 (p. 10)• 欠落した値の処理 (p. 12)• Forecast のデータセットのガイドライン (p. 14)

Datasets作成と管理するには Forecast データセットでは、 Forecast APIsには、 CreateDataset (p. 129) およびDescribeDataset (p. 165) オペレーション。の詳しいリストについては、 Forecast APIs、参照 API リファレンス (p. 127).

2

https://docs.aws.amazon.com/forecast/latest/dg/API_forecastquery_QueryForecast.html

https://github.com/aws-samples/amazon-forecast-samples

Amazon Forecast 開発者ガイドDatasets

データセットを作成するときは、次のような情報を入力します。

• データを記録した頻度/間隔。たとえば、週ごとに小売商品の売上を集計して記録するとします。GettingStarted (p. 23) 演習では、1 時間あたりの平均電力使用量のデータを使用します。

• [ 予測フォーマット( ドメイン)およびデータセットタイプ(ドメイン内). データセットドメインは、実行する予測のタイプを指定し、データセットタイプは、トレーニングデータの整理に役立ちます。Forecast- フレンドリーなカテゴリー。

• データセットスキーマ。スキーマは、データセットの列ヘッダーをマップします。たとえば、需要をモニタリングする場合、1 時間ごとの商品販売データを複数の店舗で収集する場合があります。この場合、スキーマは、トレーニングデータファイルにタイムスタンプ、場所、時間ごとの売上が表示される順序を左から右に定義します。スキーマは、string または integer など、各列のデータタイプも定義します。

Forecast データセット内の各列は、予測ディメンションまたは機能を表します。予測属性は、時間の経過とともに変化しないデータの側面を示します。 store 又は location. 予測機能には、次のような時間ごとに変化するデータ内のパラメータが含まれます。 price 又は promotion. いくつかの寸法、例えばtimestamp 又は itemIdは、ターゲットタイムシリーズおよび関連するタイムシリーズデータセットで必要です。

データセットドメインとデータセットタイプForecast データセットを作成するときに、ドメインとデータセットタイプを選択します。 Forecast は、小売の需要予測やウェブトラフィックなど、多くのユースケースのドメインを提供します。カスタムドメインを作成することもできます。の詳しいリストについては、 Forecast ドメイン、参照事前定義済みのデータセットドメインとデータセットタイプ (p. 50).

各ドメイン内で、Forecast ユーザーは次のタイプのデータセットを指定できます。

• ターゲット時系列データセット (必須) – トレーニングデータが時系列の場合、このデータセットタイプを使用します。および予測を生成するフィールドが含まれます。このフィールドは、ターゲットフィールドと呼ばれます。

• 関連時系列データセット (オプション) – トレーニングデータが時系列の場合、このデータセットタイプを選択します。しかしはターゲットフィールドを含める. たとえば、項目の需要を予測している場合、関連する時系列データセットにはフィールドとして price が含まれますが、demand は含まれません。

• 項目メタデータデータセット(オプション) – トレーニングデータがは時系列データが含まれますが、ターゲットタイムシリーズまたは関連するタイムシリーズデータセット内の項目に関するメタデータ情報. たとえば、アイテムの需要を予測する場合、アイテムメタデータデータセットは、 color 又はbrand 属性として。 Forecast では、 CNN-QR(CNN-QR) (p. 62) 又はディープAR+ (p. 67) アルゴリズム。

トレーニングデータの情報と予測する内容によっては、複数のデータセットを作成する場合があります。

たとえば、靴や靴下などの小売商品の需要の予測を生成するとします。RETAIL ドメインに次のデータセットを作成します。

• ターゲット時系列データセット – 小売商品の履歴時系列需要データが含まれます (例:item_id、timestamp、およびターゲットフィールド demand)。予測するターゲットフィールドを指定するため、データセットグループには少なくとも 1 つのターゲット時系列データセットが必要です。

ターゲット時系列データセットに最大 10 個のディメンションを追加することもできます。データセットグループにターゲット時系列データセットのみを含める場合、詳細度のみの項目レベルまたは予測ディメンションレベルで予測を作成できます。詳細については、CreatePredictor (p. 146) を参照してください。

• 関連時系列データセット – 次のような、ターゲットフィールド以外の時系列の履歴データが含まれます。 price 又は revenue. 関連する時系列データは、ターゲット時系列データにマッピング可能であ

3

Amazon Forecast 開発者ガイドDatasets

る必要があるため、関連する時系列データセットはそれぞれ同じ識別フィールドを含む必要があります。RETAIL ドメインでは、item_id や timestamp になります。

関連する時系列データセットは、含むターゲット時系列データセットから作成された予測を絞り込むデータ。たとえば、予測を生成する将来の日付の price データを関連する時系列データセットに含めることができます。これにより、Forecast は、コンテキストの追加ディメンションを使用して予測を行うことができます。詳細については、関連する時系列データセットの使用 (p. 7) を参照してください。

• 項目メタデータデータセット – 小売商品のメタデータが含まれます。メタデータの例: brand、category,color、および genre.

予測ディメンションを持つデータセットの例

前述の例の続きとして、店舗の過去の売上に基づき、靴と靴下の需要を予測するとします。次のターゲット時系列データセットで、store は時系列予測ディメンション、demand はターゲットフィールドです。靴下は 2 つの店舗 (NYC と SFO) で販売されており、靴は ORD でのみ販売されています。

このテーブルの最初の 3 行には、NYC、SFO、および ORD ストアで有効な最初の販売データが含まれています。最後の 3 行には、各店舗の最後に記録された販売データが含まれています。... 行は、最初のエントリと最後のエントリの間に記録されたすべての商品の販売データを表します。

timestamp item_id store demand

2019-01-01 socks NYC 25

2019-01-05 socks SFO 45

2019-02-01 shoes ORD 10

...

2019-06-01 socks NYC 100

2019-06-05 socks SFO 5

2019-07-01 shoes ORD 50

データセットスキーマ各データセットには、トレーニングデータのフィールドのユーザー指定の JSON マッピングであるスキーマが必要です。データセットに含める必要のあるディメンションとオプションのディメンションおよび機能がいずれも一覧表示されています。

一部のドメインには、含めることをお勧めするオプションのディメンションがあります。オプションのディメンションは、このガイドの後半にある各ドメインの説明に記載されています。例については、「RETAIL ドメイン (p. 51)」を参照してください。オプションのすべてのディメンションは、stringのデータ型になります。

スキーマは、すべてのデータセットに必要です。. 上記のターゲット時系列データセットの例に付随するスキーマを次に示します。

{ "attributes": [ { "AttributeName": "timestamp", "AttributeType": "timestamp"

4

Amazon Forecast 開発者ガイドデータセットグループ

}, { "AttributeName": "item_id", "AttributeType": "string" }, { "AttributeName": "store", "AttributeType": "string" }, { "AttributeName": "demand", "AttributeType": "float" } ]}

このスキーマを使用するデータセットにトレーニングデータをアップロードすると、Forecast はtimestamp フィールドが列 1、item_id フィールドが列 2、store フィールドが列 3、そしてターゲットフィールドである demand フィールドが列 4 であるとみなします。

関連する時系列データセットタイプの場合、すべての関連機能に属性タイプ float または integer が必要です。項目メタデータデータセットタイプの場合は、すべての機能に文字列の属性タイプが必要です。詳細については、SchemaAttribute (p. 256) を参照してください。

Note

データセット内のすべての列に attributeName と attributeType のペアが必要です。Forecast では、多くの名前が予約されており、これらをスキーマ属性の名前として使用することはできません。予約名のリストについては、「予約フィールド名 (p. 107)」を参照してください。

データセットグループA データセットグループデータセットグループは、 1 ～ 3 個の補完データセット、各データセットタイプのいずれか 1 つ。データセットをデータセットグループにインポートし、データセットグループを使用して予想子をトレーニングします。

Forecast には、データセットグループを作成し、データセットを追加するための次の操作が含まれています。

• CreateDatasetGroup (p. 133)• UpdateDatasetGroup (p. 213)

データ収集頻度の競合の解決Forecast は、 CreateDataset (p. 129) 操作。たとえば、収集頻度が時間単位であるデータをインポートし、一部のデータにタイムスタンプが時間の先頭にないデータをインポートできます(02:20、02:45)。Forecast データを集計する調整された値と一致させる. 次の表は、集計の例を示しています。

変換前

Time データ時間の冒頭

2018-03-03 01:00:00 100 あり

2018-03-03 02:20:00 50 なし

5

Amazon Forecast 開発者ガイドデータ収集頻度の競合の解決

Time データ時間の冒頭

2018-03-03 02:45:00 20 なし

2018-03-03 04:00:00 120 あり

変換後

Time データコメント

2018-03-03 01:00:00 100

2018-03-03 02:00:00 70 02:00:00～02:59:59 (50 + 20) の間の値の合計

2018-03-03 03:00:00 空白 03:00:00～03:59:59 の間に値はありません

2018-03-03 04:00:00 120

時間境界時間境界

次の表は、時間配置境界 Forecast 使用条件集計データ。

Frequency 境界

年年始 (1 月 1 日)

月毎月 1 日

週直近の月曜日

時間時間の末尾 (09:00:00、13:00:00)

分分の末尾 (45:00、06:00)

次の図に、 Forecast データを変換して、毎週境界:

6

Amazon Forecast 開発者ガイド関連する時系列

データ集約のガイドライン[ FeaturizationMethod API で、集計方法を FeaturizationMethodParameters. 集計パラメータは、次の値を受け入れます。sum、 avg、 first、 min、および max. デフォルト値は sum.

Forecast は、データが特定のタイムゾーンのものであると想定しません。ただし、時系列データを集計するときは、次の前提になります。

• すべてのデータは同じタイムゾーンからのものです。• すべての予測は、データセットのデータと同じタイムゾーンにあります。• _を指定した場合 the section called “SupplementaryFeature” (p. 259) ホリデー機能を the section

called “InputDataConfig” (p. 244) のパラメータ the section called “CreatePredictor” (p. 146) 入力データは、同じ国のものです。

関連する時系列データセットの使用関連する時系列データセットには、ターゲット時系列データセットに含まれていない時系列データが含まれており、予測子の精度が向上する場合があります。

たとえば、需要予測ドメインでは、ターゲット時系列データセットには、 timestamp および item_id属性。一方、補完的な関連する時系列データセットには、次の補足機能も含まれます。item price、promotion、および weather.

関連する時系列データセットには、最大 10 個の予測ディメンション (ターゲット時系列データセット内のものと同じ) と最大 13 個の関連する時系列機能を含めることができます。

関連する時系列データセットは、 CNN-QR(CNN-QR) (p. 62)、ディープAR+ (p. 67)、および預言者 (p. 76) アルゴリズムです。NPTS (p. 74)、アリマ (p. 62)、および ETS(エッツ) (p. 73) は、関連する時系列データを受け入れません。

ヒストリカルおよびフォワードルッキングな関連時系列関連の時系列は、次の 2 つの形式で表示されます。

• 時系列の履歴: 時系列なし予測期間内のデータポイント。• 将来を見据えた時系列: 時系列と予測期間内のデータポイント。

履歴関連の時系列には、予測期間までのデータポイントが含まれており、予測期間内のデータポイントは含まれません。将来予測に関連する時系列には、以下のデータポイントが含まれます。および予測期間内です。

Note

予測期間内の任意の値を含む関連する時系列は、将来の時系列として扱われます。

7


次の表は、Amazon Forecast の各アルゴリズムが受け付ける関連時系列のタイプを示しています。

CNN-QR(CNN-QR)

DeepAR+ Prophet NPTS ARIMA ETS

履歴関連の時系列

将来予想に関する時系列

利用時 AutoMLでは、過去の時系列データおよび将来予測に関連する時系列データの両方を提供できます。また、予測では、該当する時系列のみを使用します。

以下を提供する場合将来を見据えた関連する時系列データ、 Forecast 関連データをCNN-QRで使用し、DeepAR+、および Prophet であり、NPTS、ARIMA、ETS では関連データを使用しません。提供される場合履歴関連する時系列データ、 Forecast 関連データはCNN-QRで使用し、関連データはCNN-QRで使用しない DeepAR+、Prophet、NPTS、ARIMA、ETS。

関連する時系列データセットの検証関連する時系列データセットには次の制限があります。

• ターゲット時系列のターゲット値を含めることはできません。• これには、item_id および timestamp ディメンションと、少なくとも 1 つの関連機能 (price など)

が含まれている必要があります。• 関連する時系列機能データは、int または float データ型である必要があります。• ターゲット時系列全体を使用するには、ターゲット時系列データセットのすべての項目も、関連する時

系列データセットに含める必要があります。関連時系列に対象時系列からの項目のサブセットのみが含まれている場合、モデル作成と予測生成は項目の特定のサブセットに限定されます。

たとえば、ターゲット時系列に 1000 項目が含まれ、関連する時系列データセットに 100 項目のみが含まれている場合、モデルと予測は 100 項目のみに基づきます。

• 関連する時系列データセットにデータを記録する頻度は、予測を生成する間隔 (予測の精度) と一致する必要があります。

たとえば、週単位の精度で予測を生成する場合、ターゲットの時系列にデータを記録する頻度が毎日であっても、関連する時系列でデータを記録する頻度も週単位である必要があります。

• 関連する時系列データセット内の各項目のデータは、ターゲット時系列データセット内の対応するitem_id の先頭の timestamp またはそれより前に開始する必要があります。

たとえば、socks のターゲット時系列データが 2019-01-01 に開始し、shoes のターゲット時系列データが 2019-02-01 に開始する場合、socks の関連する時系列データは 2019-01-01 以前、shoes のデータは 2019-02-01 以前に開始する必要があります。

• 将来予測に関連する時系列データセットでは、すべての項目の最後のタイムスタンプは、ユーザーが指定した予測ウィンドウの最後のタイムスタンプになければなりません( 予測期間)。

以下の関連する時系列ファイルの例では、靴下と靴の両方の timestamp データは 2019-07-01 (最後に記録されたタイムスタンプ) かつ予測期間の後に終了する必要があります。対象時系列のデータ頻度が日次で、予測期間を 10 日とする場合、2019-07-11 まで、予測に関連する時系列ファイルに日次データポイントを指定する必要があります。

• 履歴関連の時系列データセットでは、各項目の最後のタイムスタンプが、ターゲット時系列の最後のタイムスタンプと一致する必要があります。

8


次の関連する時系列ファイルの例では、 timestamp ソックスとシューズのデータは、2019-07-01(最後に記録されたタイムスタンプ)に終了する必要があります。

• [ Forecast 関連の時系列データセットで提供されるディメンションは、ターゲット時系列データセットに指定されたディメンションと同じか、またはサブセットである必要があります。

• 関連時系列に欠落している値を含めることはできません。関連する時系列データセット内の欠落している値については、以下を参照してください。不足値の処理 (p. 12).

例: フォワードルッキングな関連時系列ファイル次の表は、正しく設定された関連する時系列データセットファイルを示しています。この例では、次のことを前提としています。

• 最後のデータポイントは、2019-07-01 にターゲット時系列データセットに記録されました。• 予測期間は 10 日です。• 予測の精度は毎日です (D)。

A "…"行は、前の行と後続の行の間のすべてのデータポイントを示します。

timestamp item_id store price

2019-01-01 socks NYC 10

2019-01-02 socks NYC 10

2019-01-03 socks NYC 15

...

2019-06-01 socks NYC 10

...

2019-07-01 socks NYC 10

...

2019-07-11 socks NYC 20

2019-01-05 socks SFO 45

...

2019-06-05 socks SFO 10

...

2019-07-01 socks SFO 10

...

2019-07-11 socks SFO 30

2019-02-01 shoes ORD 50

...

2019-07-01 shoes ORD 75

9

Amazon Forecast 開発者ガイド項目メタデータ

timestamp item_id store price

...

2019-07-11 shoes ORD 60

例: 詳細度の予測次の表は、毎週の粒度で予測するターゲット時系列および関連する時系列の互換性のあるデータ記録頻度を示しています。関連する時系列データセットのデータは集計できないため、 Forecast は、選択した予測粒度と同じ関連する時系列データ頻度のみを受け入れます。

ターゲット入力データの頻度

関連する時系列の頻度詳細度の予測 Forecast によりサポートされていますか?

1 日 1 回毎週毎週はい

毎週毎週毎週あり

該当なし毎週毎週はい

1 日 1 回 1 日 1 回毎週なし

項目メタデータデータセットの使用A アイテムメタデータデータセットには、 CNN-QR (p. 62) またはディープAR+ (p. 67) アルゴリズム。関連する時系列データセットとは異なり、項目メタデータデータセットは静的な情報を提供します。つまり、項目の色やブランドのように、データ値は時間が経過しても一定に保たれます。項目メタデータデータセットは、データセットグループへのオプションの追加であり、予測子をトレーニングするときにのみ考慮されます。 CNN-QR (p. 62) またはディープAR+ (p. 67) 。項目メタデータを使用できるのは、ターゲットの時系列データセット内のすべての項目が、対応する項目メタデータデータセットに存在する場合だけです。

項目メタデータには、特定の項目のブランド、色、モデル、カテゴリ、製造場所、その他の補足機能が含まれる場合があります。たとえば、項目メタデータデータセットは、32 GB のストレージを持つ黒のAmazon E-reader の売り上げを表す、ターゲットの時系列データセットで見つかった需要データの一部のコンテキストを提供することがあります。これらの特性は、日々または時間ごとに変化しないため、項目メタデータデータセットに属します。

項目メタデータは、時系列データの説明パターンを検出して追跡するのに便利です。データセットグループに項目メタデータデータセットを含めると、Forecast は、項目間の類似性に基づいてより正確な予測を行うようにモデルをトレーニングできます。たとえば、Amazon 製の仮想アシスタント製品は、他の会社が製造した製品よりも売り切れる可能性が高く、サプライチェーンをそれに応じて計画することができます。

項目メタデータは、予測を行うための直接的な履歴データはほとんどないが、類似したメタデータ属性を持つ項目の履歴データがある、コールドスタート予測シナリオで特に便利です。お客様が持っている小さなデータのコンテキストを提供する場合、Forecast 予測子は、予測精度を高めるための、データ内の項目について有用で明白でない推論を行うことができます。

項目メタデータデータセットの各行には、最大 10 個のメタデータフィールドを含めることができます。そのうちの 1 つは、メタデータをターゲットの時系列の項目に一致させる識別フィールドである必要があります。すべてのデータセットタイプと同様に、各フィールドの値はデータセットスキーマによって指定されます。

10

Amazon Forecast 開発者ガイド項目メタデータ

例: 。アイテムメタデータファイルとスキーマ次の表は、Amazon E-reader を説明する、正しく設定された項目メタデータデータセットファイルのセクションを示しています。この例では、ヘッダー行がデータセットのスキーマを表し、リストされた各項目が、対応するターゲットの時系列データセットにあると仮定します。

item_id brand model color waterproof

1 Amazon paperwhite black yes

2. Amazon paperwhite blue yes

3. Amazon base_model black no

4. Amazon base_model white no

...

以下は、CSV 形式で表された同じ情報です。

1,amazon,paperwhite,black,yes2,amazon,paperwhite,blue,yes3,amazon,base_model,black,no4,amazon,base_model,white,no...

このサンプルデータセットのスキーマを次に示します。

{ "attributes": [ { "AttributeName": "item_id", "AttributeType": "string" }, { "AttributeName": "brand", "AttributeType": "string" }, { "AttributeName": "model", "AttributeType": "string" }, { "AttributeName": "color", "AttributeType": "string" }, { "AttributeName": "waterproof", "AttributeType": "string" } ]}

以下の資料も参照してください。アイテムメタデータデータセットの使用についての詳細なウォークスルーについては、以下を参照してください。アイテムメタデータデータセットを Predictor に組み込むの Amazon Forecast サンプルGitHubリポジトリ.

11

https://github.com/aws-samples/amazon-forecast-samples/blob/master/notebooks/advanced/Incorporating_Item_Metadata_Dataset_to_your_Predictor/Incorporating_Item_Metadata_Dataset_to_your_Predictor.ipynb



Amazon Forecast 開発者ガイド欠落した値の処理

欠落した値の処理時系列予測データの一般的な問題は、欠落した値の存在です。データには、測定の失敗、フォーマットの問題、人為的ミス、記録する情報の不足など、さまざまな理由で欠落した値が含まれている可能性があります。たとえば、小売店の製品需要を予測しているときに、商品が売り切れたり使用不能になったりすると、その品目が在庫切れになっている間に記録する売上データは存在しないことになります。十分に優勢な場合、欠落した値がモデルの精度に影響を与える可能性があります。

Amazon Forecast には、ターゲット時系列および関連する時系列データセットの欠落した値を処理するための多数のフィル方法が用意されています。フィルは、データセット内の欠落しているエントリに標準化された値を追加するプロセスです。

Forecast では、以下のフィル方法がサポートされています。

• [Middle filling (中間フィル)] – データセットの項目の開始日と項目の終了日の間の欠落した値を埋めます。

• [Back filling (後方フィル)] – データセットの最後に記録されたデータポイントとデータセットのグローバル終了日との間の欠落した値を埋めます。

• [Future filling (related time series only) (将来のフィル (関連する時系列のみ))] – データセットのグローバル終了日から予測期間の終了までの間に欠落した値を埋めます。

次の図は、さまざまなフィル方法を視覚的に示しています。

フィルロジックの選択フィルロジックを選択するときは、モデルによってロジックがどのように解釈されるかを考慮する必要があります。たとえば、小売のシナリオでは、利用可能な品目の販売数 0 を記録することは、利用できない品目の販売数 0 を記録することとは異なります。後者の場合、品目に対するお客様の関心がないことを意味するものではありません。このため、ターゲット時系列での 0 フィルでは、予測で予測子の偏りが不足することがありますが、NaN フィルでは、販売されている利用可能な品目 0 個の実際の出現が無視され、予測子の偏りが過剰になる可能性があります。

次の時系列グラフは、誤ったフィル値を選択するとモデルの精度に大きく影響することを示しています。グラフ A と B は、一部在庫切れの品目の需要をプロットし、黒い線は実際の売上データを表します。A1の欠落した値は 0 で埋められ、A2 では比較的偏りのない予測 (点線で表される) につながります。同様に、B1 の欠落した値は NaN で埋められ、B2 のより正確な予測につながります。

12

Amazon Forecast 開発者ガイド欠落した値の処理

サポートされているフィルロジックのリストについては、次のセクションを参照してください。

ターゲット時系列および関連する時系列フィルロジックターゲット時系列データセットと関連する時系列データセットの両方に対してフィルを実行できます。データセットタイプごとに異なる入力ガイドラインと制限があります。

フィルガイドライン

データセットタイプ

デフォルトでフィルしますか?

サポートされているフィル方法

デフォルトのフィルロジック

受け付けた充填ロジック

ターゲット時系列あり中間フィルと後方フィル

0 • zero - 0 フィル。

• value -整数または浮動小数。

• nan -数字ではありません。

• mean -データ系列の平均値。

• median -データ系列の中央値。

• min -データ系列の最小値。

• max -データ系列の最大値。

関連する時系列なし中間、後方、および将来のフィル

デフォルトなし • zero - 0 フィル。

• value - 整数または浮動小数点値。

• mean -データ系列の平均値。

• median -データ系列の中央値。

• min -データ系列の最小値。

• max -データ系列の最大値。

Important

ターゲットデータセットおよび関連する時系列データセットの両方について、 mean、median、 min、および max は、欠落している値の前に、64個の最新のデータ入力のローリングウィンドウに基づいて計算されます。

13

Amazon Forecast 開発者ガイドデータセットのガイドライン

欠落した値の構文不足している値の塗りつぶしを実行するには、予測を作成 (p. 146) 操作。フィルロジックはFeatuRizationMethod (p. 236) オブジェクトで指定されます。

次の抜粋は、ターゲット時系列属性および関連する時系列属性 (target_value および price) に対して正しくフォーマットされた FeaturizationMethod オブジェクトを示しています。

充填方法を特定の値に設定するには、fillパラメータを value 対応する _value パラメータ。下に示すように、関連する時系列のバックフィルは、次のように 2 の値に設定されます。"backfill": "value"および "backfill_value":"2".

[ { "AttributeName": "target_value", "FeaturizationPipeline": [ { "FeaturizationMethodName": "filling", "FeaturizationMethodParameters": { "aggregation": "sum", "middlefill": "zero", "backfill": "zero" } } ] }, { "AttributeName": "price", "FeaturizationPipeline": [ { "FeaturizationMethodName": "filling", "FeaturizationMethodParameters": { "middlefill": "median", "backfill": "value", "backfill_value": "2", "futurefill": "max" } } ] }]

Forecast のデータセットのガイドラインAmazon Forecast がデータセットのインポートに失敗する場合、またはデータセットが期待どおりに機能しない場合は、次のガイドラインを参照してください。

タイムスタンプ形式

年 (Y)、月 (M)、週 (W)、および日 (D) の収集頻度の場合、Forecast はタイムスタンプ形式 yyyy-MM-dd (例: 2019-08-21) と、オプションで HH:mm:ss 形式 (例: 2019-08-21 15:00:00) をサポートします。

時 (H) と分 (M) の頻度では、Forecast は yyyy-MM-dd HH:mm:ss 形式 (例: 2019-08-21 15:00:00)のみをサポートしています。

ガイドライン: データセットの収集頻度のタイムスタンプ形式をサポートされている形式に変更します。

14

Amazon Forecast 開発者ガイドデータセットのガイドライン

Amazon S3 ファイルまたはバケット

データセットをインポートするとき、データを含む Amazon Simple Storage Service (Amazon S3)バケットの CSV ファイルへのパス、またはデータを含む S3 バケットの名前を指定できます。CSVファイルを指定すると、Forecast はそのファイルのみをインポートします。S3 バケットを指定すると、Forecast はバケット内のすべての CSV ファイルを最大 10,000 ファイルインポートします。バケット名を指定して複数のファイルをインポートする場合は、すべての CSV ファイルが、指定されたスキーマに準拠する必要があります。

ガイドライン: 次の構文を使用して、CSV ファイルまたは S3 バケットを指定します。

s3://bucket-name/example-object.csv

s3://bucket-name/prefix/

s3://bucket-name

データセットの更新

データセットのインポートジョブは集計されないため、最新のデータセットインポートは、予想子のトレーニング時や予測の生成時に使用されるものです。

ガイドライン: 最新のデータセットインポートに、前回のインポート以降に収集された新しいデータだけでなく、モデル化するすべてのデータが含まれていることを確認します。

属性の順序

スキーマ定義で指定された属性の順序は、インポートする CSV ファイルの列の順序と一致する必要があります。たとえば、最初の属性として timestamp を定義した場合、timestamp は入力 CSV ファイルの最初の列でもある必要があります。

ガイドライン: CSV ファイルの列が、作成したスキーマ属性と同じ順序であることを確認してください。

データセットヘッダー

入力 CSV ファイルのデータセットヘッダーにより、検証エラーが発生する場合があります。ヘッダーを省略することをお勧めします。

ガイドライン: データセットヘッダーを削除し、インポートを再試行します。データセットのステータス

the section called “CreateDatasetImportJob” (p. 136) オペレーションでトレーニングデータをインポートするには、データセットの Status が ACTIVE である必要があります。

ガイドライン: DescribeDataset (p. 165) オペレーションを使用して、データセットのステータスを取得します。データセットの作成または更新に失敗した場合は、データセットファイルの形式を確認して、もう一度作成してください。

ファイル形式と区切り記号

Forecast では、カンマ区切り値 (CSV) ファイル形式のみがサポートされています。タブ、スペース、コロン、またはその他の文字を使用して値を区切ることはできません。

ガイドライン: データセットを CSV 形式に変換し (区切り文字としてカンマのみを使用)、ファイルのインポートを再試行します。

ファイル名

ファイル名には、アルファベットを 1 文字以上含める必要があります。名前が数値のみのファイルはインポートできません。

ガイドライン: 少なくともアルファベットが 1 文字以上含まれるように CSV データセットの名前を変更し、ファイルのインポートを再試行します。

15

Amazon Forecast 開発者ガイド予測子

Predictors予測子は、時系列データに基づいて予測を行うために使用される、Amazon Forecast のトレーニング済みモデルです。トレーニング中、Amazon Forecast は予測子を評価し、予測子を使用して予測を生成するかどうかを決定するために使用する精度メトリクスを生成します。

トピック• 予測子の作成 (p. 16)• 予測子の評価 (p. 16)• : 仕組み次のトピック (p. 17)

予測子の作成Amazon Forecast は、予測子と呼ばれる予測モデルをトレーニングします。予測子を作成するには、CreatePredictor (p. 146) オペレーションを使用します。

予測子を作成するには、以下を指定します。

• データセットグループ – 予測子をトレーニングするためのデータを提供します。詳細については、Datasets (p. 2) を参照してください。

• 特徴化設定 – 予測頻度を指定し、モデルのトレーニング前にデータを変換するための情報を提供します。データは、トレーニングアルゴリズムとの互換性を高めるために変換されます。

• 予測期間 – 作成する時間ステップの数。予測期間は予測長とも呼ばれます。• 評価パラメータ – データセットをトレーニングデータセットとテストデータセットに分割する方法。• 次のいずれかです。

• アルゴリズム – このアルゴリズムは、モデルをトレーニングするために使用され、ハイパーパラメータ最適化(DeepAR+およびCNN-QRのみ)、評価パラメータ、およびトレーニングパラメータのデフォルト値を指定します。アルゴリズムを指定することで、これらのパラメータ値をオーバーライドすることもできます。

• AutoML の実行 – Amazon Forecast には、事前に定義されたアルゴリズムが用意されています。どのアルゴリズムを選ぶべきかわからない場合は、PerformAutoML オプションを使用してください。このオプションでは、すべてのアルゴリズムを評価し、データセットに基づいて最適なアルゴリズムを選択するよう Amazon Forecast に指示します。このオプションを使用すると、モデルのトレーニングに時間がかかることがありますが、正しいアルゴリズムおよびパラメータの選択を懸念する必要がありません。AutoML は、重み付けされた P10、P50、および P90 分位損失の平均を最適化し、最小値のアルゴリズムを返します。

アルゴリズムの詳細については、「Amazon Forecast アルゴリズムを選択する (p. 60)」を参照してください。

予測子の評価予測子を作成したら、 GetAccuracyMetrics (p. 188) オペレーションを実行して、生成される予測の正確性を評価できます。

評価パラメータ

評価パラメータは、バックテストウィンドウの評価のためにデータセットをトレーニングデータセットとテストデータセットに分割する方法、および実行するバックテストの反復回数を定義します。これらのパラメータのデフォルト値は、CreatePredictor (p. 146) リクエストでオーバーライドすることができます。

16

Amazon Forecast 開発者ガイド: 仕組み次のトピック

評価パラメータは、 NumberOfBacktestWindows および BackTestWindowOffset パラメータで構成されます。

NumberOfBacktestWindows は、入力データを分割する回数を指定します。範囲は 1～5 です。

BackTestWindowOffset は、モデルのトレーニングとテスト (評価) のためにデータが分割されるデータセットの末尾からのポイントを定義します。値は、データポイント数として指定されます。BackTestWindowOffset は、予測期間以上、および目標時系列データセットの長さの半分未満でなければなりません。このパラメータは、過去の仮想予測開始日を模倣するために使用できます。

詳細については、予測精度の評価 (p. 78) を参照してください。

: 仕組み次のトピック予測 (p. 17)

予測Amazon Forecast の予測子を作成したら、CreateForecast (p. 140) オペレーションを呼び出して予測を作成します。予測の作成中、Amazon Forecast はモデルをホストして推論を行う前に、データセット全体でモデルをトレーニングします。このオペレーションにより、予測子のトレーニングに使用されたデータセットグループ内のすべてのアイテム (item_id) の予測が作成されます。予測が作成されたら、予測をクエリするか、Amazon Simple Storage Service (Amazon S3) バケットにエクスポートできます。

デフォルトでは、予測頻度は、CreateDataset (p. 129) オペレーションでデータセットを作成したときに指定したデータ収集頻度です。必要に応じて、データセットに指定された頻度よりもわずかに大きい間隔を指定することができます。次に、オペレーションは予測データを集計して結果を返します。たとえば、データ収集頻度が「毎日」だったとします。その後、毎日または毎月の予測を取得できますが、毎時の予測は取得できません。

QueryForecast (p. 215) オペレーションを使用して予測をクエリします。デフォルトでは、予測の全範囲が返ります。完全な予測内で特定の日付範囲をリクエストできます。

予測をクエリする際、フィルタリング条件を指定する必要があります。フィルタはキーと値のペアです。キーは、予測の作成に使用されるいずれかのデータセットのスキーマ属性名 (予測ディメンションを含む)の 1 つです。値は、指定されたキーの有効な値です。複数のキーと値のペアを指定できます。返る予測には、すべての条件を満たすアイテムのみが含まれます。

予測をエクスポートするには、CreateForecastExportJob (p. 143) オペレーションを呼び出すことができます。このオペレーションでは、予測を CSV ファイルとして Amazon S3 バケットにコピーします。必要に応じて、バケットに書き込まれる前にデータを暗号化する AWS Key Management Service キーを指定できます。

仕組み: 次のトピックGetting Started (p. 23)

17

Amazon Forecast 開発者ガイドAWS にサインアップする

セットアップAmazon Forecast を使用して時系列データを評価または予測する前に、AWS アカウントを作成して、アクセス権限を設定し、AWS コマンドラインインターフェイス (AWS CLI) をセットアップします。

トピック• AWS にサインアップする (p. 18)• AWS CLI のセットアップ (p. 18)• Amazon Forecast のアクセス許可を設定する (p. 19)

AWS にサインアップするアマゾンウェブサービス (AWS) にサインアップすると、AWS アカウントが AWS 内のすべてのサービス(Amazon Forecast など) に自動的にサインアップされます。料金が発生するのは、実際に使用したサービスの分のみです。

すでに AWS アカウントをお持ちの場合は次のタスクに進んでください。AWS アカウントをお持ちでない場合は、次に説明する手順にしたがってアカウントを作成してください。

AWS にサインアップするには

1. https://aws.amazon.com/ を開いて、[AWS アカウントの作成] を選択します。2. 画面上の指示に従ってアカウントの作成を完了します。12 桁の AWS アカウント番号を書き留めま

す。サインアップ手順の一環として、通話呼び出しを受け取り、電話のキーパッドを用いて PIN を入力することが求められます。

3. (オプション) AWS Identity and Access Management (IAM) 管理ユーザーを作成します。手順については、AWS Identity and Access Management ユーザーガイドの最初の IAM 管理者のユーザーおよびグループの作成を参照してください。

AWS CLI のセットアップAWS コマンドラインインターフェイス (AWS CLI) は、Amazon Forecast を含む AWS のサービスを管理するための統合された開発者用ツールです。このツールをインストールして使用することをお勧めします。

1. AWS CLI をインストールするには、AWS Command Line Interface ユーザーガイドの AWS CommandLine Interface をインストールするを参照してください。

2. AWS CLI を設定し、それを呼び出すようにプロファイルをセットアップするには、AWS CommandLine Interface ユーザーガイドの AWS CLI の設定の手順に従います。

3. AWS CLI プロファイルが適切に設定されていることを確認するには、コマンドウィンドウで次のコマンドを実行します。

aws configure --profile default

プロファイルが正しく設定されている場合は、次のような出力が表示されます。

AWS Access Key ID [****************52FQ]:

18

https://portal.aws.amazon.com

https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-admin-group.html

https://docs.aws.amazon.com/cli/latest/userguide/installing.html

https://docs.aws.amazon.com/cli/latest/userguide/installing.html

https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html

Amazon Forecast 開発者ガイドアクセス権限の設定

AWS Secret Access Key [****************xgyZ]: Default region name [us-west-2]: Default output format [json]:

4. AWS CLI が Amazon Forecast 用に設定されていることを確認するには、以下のコマンドを実行します。

aws forecast help

aws forecastquery help

AWS CLI が正しく設定されていれば、Amazon Forecast または Amazon Forecast クエリでサポートされている CLI コマンドのリストが表示されます。

Amazon Forecast のアクセス許可を設定するAmazon Forecast は、Amazon Simple Storage Service (Amazon S3) を使用してターゲットの時系列データを保存します。このデータは、予測を生成できる予測子をトレーニングするために使用されます。Amazon Forecast がお客様に代わって Amazon S3 にアクセスするには、アクセス許可を設定する必要があります。

お客様の代わりに Amazon S3 を使用するためのアクセス許可を Amazon Forecast に付与するには、アカウントで AWS Identity and Access Management (IAM) ロールと IAM ポリシーを設定する必要があります。IAM ポリシーで必要なアクセス許可を指定し、IAM ロールに付与する必要があります。

IAM ロールとポリシーを作成し、そのポリシーをロールに付与するには、IAM コンソールまたは AWSCommand Line Interface (AWS CLI) を使用します。

Note

Forecast は AWS VPC と通信できないため、S3 VPCE ゲートウェイをサポートできません。VPCアクセスのみを許可するS3バケットを使用すると、 AccessDenied エラーです。

トピック• Amazon Forecast の IAM ロールを作成する (IAM コンソール) (p. 19)• Amazon Forecast の IAM を作成する (AWS CLI) (p. 21)

Amazon Forecast の IAM ロールを作成する (IAM コンソール)AWS IAM コンソールを使用して以下を実行できます。

• 信頼できるエンティティとして Amazon Forecast を使用して IAM ロールを作成する• Amazon Forecast に Amazon S3 バケットのデータの表示、読み取り、書き込みを許可するアクセス許

可を使用して IAM ポリシーを作成する• IAM ポリシーを IAM ロールに付与する

Amazon S3 (IAM コンソール) へのアクセスを Amazon Forecast に許可する IAM ロールとポリシーを作成するには

1. IAM コンソール (https://console.aws.amazon.com/iam) にサインインします。

19

https://console.aws.amazon.com/iam

Amazon Forecast 開発者ガイドAmazon Forecast の IAM ロールを作成する (IAM コンソール)

2. [ポリシー] を選択して次の手順を実行し、必要なポリシーを作成します。

a. [ポリシーの作成] ページのポリシーエディタで [JSON] タブを選択します。b. 次のポリシーをコピーし、エディタ内に貼り付けてテキストを置き換えます。bucket-name を

必ず S3 バケットの名前に置き換えてから、[ポリシーの確認] を選択します。

{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "s3:Get*", "s3:List*", "s3:PutObject" ], "Resource":[ "arn:aws:s3:::bucket-name", "arn:aws:s3:::bucket-name/*" ] } ]}

c. [ポリシーの確認] ページで [名前] にポリシーの名前を入力します。例えば、AWSS3BucketAccess。オプションで、このポリシーの説明を入力し、ポリシーの作成.

3. ナビゲーションペインで [ロール] を選択します。次の手順に従って IAM ロールを作成します。

a. [Create Role (ロールの作成)] を選択します。b. [Select type of trusted entity (信頼されたエンティティのタイプの選択)] で、[AWS のサービス] を

選択します。c. [このロールを使用するサービスを選択] で [Amazon Forecast] がリストに表示されていない場合

は、[EC2] を選択します。それ以外の場合は [Amazon Forecast] を選択します。d. [次] を選択します。アクセス許可e. [アクセス権限ポリシーをアタッチする] ページで、作成したポリシーの横にあるチェックボック

スをオンにします。リストの特定のポリシーを表示するには、[Filter policies (ポリシーのフィルター)] クエリフィルターで、ポリシー名の一部を入力します。続いて、[次へ] を選択します。タグ

f. タグを追加する必要はありませんので、次へ: 確認g. [確認] セクションの [ロール名] に、ロールの名前を入力します (例: ForecastRole)。[ロールの

説明] で、ロールの説明を更新し、[ロールの作成] を選択します。h. 新しいロールを選択して、ロールの詳細ページを開きます。i. [概要] で、[ロール ARN] の値をコピーして保存します。データセットを Amazon Forecast 内にイ

ンポートするときに必要になります。j. このロールを使用するサービスとして [Amazon Forecast] を選択しなかった場合は、[信頼関係]

を選択し、[信頼関係の編集] を選択して、信頼ポリシーを次のように更新します。

{ "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "forecast.amazonaws.com" }, "Action": "sts:AssumeRole" }

20

Amazon Forecast 開発者ガイドAmazon Forecast の IAM を作成する (AWS CLI)

]}

Amazon Forecast の IAM を作成する (AWS CLI)AWS CLI は、以下のことを実行するために使用できます。

• 信頼できるエンティティとして Amazon Forecast を使用して IAM ロールを作成する• Amazon Forecast に Amazon S3 バケットのデータの表示、読み取り、書き込みを許可するアクセス許

可を使用して IAM ポリシーを作成する• IAM ポリシーを IAM ロールに付与する

Amazon S3 (AWS CLI) へのアクセスを Amazon Forecast に許可する IAM ロールとポリシーを作成するには

1. 信頼されたエンティティとして Amazon Forecast を使用して、お客様の代わりとなる IAM ロールを作成します。

aws iam create-role \ --role-name ForecastRole \ --assume-role-policy-document '{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Principal":{ "Service":"forecast.amazonaws.com" }, "Action":"sts:AssumeRole" } ]}

このコマンドは、デフォルトの AWS 設定プロファイルが、Amazon Forecast でサポートされている AWS リージョンをターゲットとしていることを前提としています。別のプロファイル(たとえば、aws-forecast)を使用して、Amazon Forecast でサポートされていない AWS 地域をターゲットにするには、 profile コマンドのパラメータ。たとえば、 --profile aws-forecast。設定の詳細については、 AWS CLI 構成プロファイルについては、 AWS CLI 構成コマンド。

コマンドが正常にロールを作成すると、それが次のような出力として返されます。

{ "Role": { "RoleName": "ForecastRole", "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Action": "sts:AssumeRole", "Principal": { "Service": "forecast.amazonaws.com" }, "Effect": "Allow" } ] }, "Arn": "arn:aws:iam::your-acct-ID:role/ForecastRole",

21

https://docs.aws.amazon.com/cli/latest/reference/configure/

Amazon Forecast 開発者ガイドAmazon Forecast の IAM を作成する (AWS CLI)

"CreateDate": "2018-09-12T00:23:06Z", "RoleId": "AROAITEGTQ3NN3FYHXNJU", "Path": "/" }}

ロールの ARN をメモします。これは、Amazon Forecast 予測子をトレーニングするためのデータセットをインポートする際に必要です。

2. Amazon S3 のデータの一覧表示、読み取り、書き込みを行うためのアクセス許可を指定した IAM ポリシーを作成し、ステップ 1 で作成した IAM ロールに付与します。

aws iam put-role-policy \ --role-name ForecastRole \ --policy-name ForecastBucketAccessPolicy \ --policy-document '{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "s3:Get*", "s3:List*", "s3:PutObject" ], "Resource":[ "arn:aws:s3:::bucket-name", "arn:aws:s3:::bucket-name/*" ] } ]}'

22

Amazon Forecast 開発者ガイド入力データを準備する

Getting Started使用を開始するには Amazon Forecastでは、以下を行います。

• Create an Forecast dataset and import training data.• Create a Forecast predictor. The algorithm that you choose, trains a predictor using the datasets. You

specify both the algorithm and dataset when you create the predictor.• Generate a forecast.

この演習では、公開されている利用可能な電力使用量データセットの修正版を使用して予測子をトレーニングします。データセットの削除の詳細については、「ElectricityLoadDiagrams20112014 データセット」を参照してください。以下はデータセットのサンプル行です。

2014-01-01 01:00:00, 2.53807106598985, client_02014-01-01 01:00:00, 23.648648648648624, client_12014-01-01 02:00:00, 9.648648648612345, client_0

この演習では、データセットを使用して予測子をトレーニングしてから、クライアントによる時間単位の電力使用量を予測します。

次のいずれかを使用できます。 Forecast コンソールまたは AWS Command Line Interface (AWSCLI)。Amazon Forecast リソースはリージョン間で共有されないため、Amazon Forecast コンソール、AWS CLI、および Amazon Forecast SDK のデフォルトリージョンに注意してください。

Important

始める前に、AWS アカウントを持っており、AWS CLI をインストールしたことを確認してください。詳細については、「セットアップ (p. 18)」を参照してください。Amazon Forecast の詳細 (p. 2) についても確認することをお勧めします。

トピック• 入力データを準備する (p. 23)• 開始方法 (コンソール) (p. 24)• 開始方法 (AWS CLI) (p. 39)• Getting Started (Python Notebook) (p. 48)• Clean Up Resources (p. 49)

入力データを準備するAmazon Forecast コンソールと AWS Command Line Interface (AWS CLI) のいずれかを使用して予測プロジェクトを設定するかにかかわらず、入力データを設定する必要があります。データを準備するには、次の操作を実行します。

• トレーニングデータをコンピュータにダウンロードして、AWS アカウントの Amazon Simple StorageService (Amazon S3) バケットにアップロードします。データを Amazon Forecast データセットにインポートするには、データを Amazon S3 バケットに保存する必要があります。

• AWS Identity and Access Management (IAM) ロールを作成します。Amazon Forecast に IAM ロールを使用して S3 バケットにアクセスするアクセス許可を付与します。IAM ロールの詳細については、『IAMユーザーガイド』の「IAM ロール」を参照してください。

23

https://archive.ics.uci.edu/ml/datasets/ElectricityLoadDiagrams20112014

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html

Amazon Forecast 開発者ガイド開始方法 (コンソール)

トレーニングデータを準備するには

1. zip ファイル、electricityusagedata.zip をダウンロードします。

この演習では、個々の家庭の電力消費量データセットを使用します。(Dua、D. および KarraTaniskidou、E。(2017)。UCI Machine Learning リポジトリ [http://archive.ics.uci.edu/ml]。カリフォルニア州アーバイン: カリフォルニア大学情報コンピュータサイエンス学部。) 使用状況データは時間単位で集計されます。

2. コンテンツを解凍し、electricityusagedata.csv としてローカルに保存します。3. S3 バケットにデータファイルをアップロードします。

詳しいステップについては、『Amazon Simple Storage Service コンソールユーザーガイド』の「ドラッグアンドドロップを使用したファイルとフォルダのアップロード」を参照してください。

4. IAM ロールを作成します。

「開始方法」の演習で AWS CLI を使用する場合は、IAM を作成する必要があります。コンソールを使用している場合は、それを使ってロールを作成できます。手順については、「Amazon Forecast のアクセス許可を設定する (p. 19)」を参照してください。

これで、Amazon Forecast コンソールまたは AWS CLI を使用して、予測子をトレーニングし、予測を生成して、そしてその予測を確認します。

• 開始方法 (コンソール) (p. 24)• 開始方法 (AWS CLI) (p. 39)

開始方法 (コンソール)この演習では、Amazon Forecast コンソールを使用して電力使用量の時系列データをインポートし、入力データセットに基づいて Amazon Forecast 予測子を作成します。また入力時間間隔に基づいて将来の電力使用量を予測します。

この演習では、個々の家庭の電力消費量データセットが使用されます。(Dua、D. および KarraTaniskidou、E。(2017)。UCI Machine Learning リポジトリ [http://archive.ics.uci.edu/ml]。カリフォルニア州アーバイン: カリフォルニア大学情報コンピュータサイエンス学部。) 使用状況データは時間単位で集計されます。

前提条件

• AWS アカウント。AWS アカウントをまだ持っていない場合は、AWS にサインアップする (p. 18) の手順に従って作成します。

• Amazon Simple Storage Service (Amazon S3) バケットのトレーニングデータ。詳細については、「入力データを準備する (p. 23)」を参照してください。

• AWS Identity and Access Management による S3 バケットの読み書きを許可する IAM (AmazonForecast) ロール。詳細については、「Amazon Forecast の IAM ロールを作成する (IAM コンソール) (p. 19)」を参照してください。

ステップ 1: トレーニングデータをインポートする時系列データを Amazon Forecast にインポートするには、データセットグループを作成し、データセットグループのドメインを選択します。データの詳細を指定して、Amazon Forecast にデータの S3 の場所を指定します。ターゲットの時系列データの例として、時系列の過去の電力使用量 (p. 23)を使用します。

24

samples/electricityusagedata.zip

http://archive.ics.uci.edu/ml

https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-objects.html

https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-objects.html

http://archive.ics.uci.edu/ml


Note

この演習では、データセットグループを作成していないことを前提としています。以前にデータセットグループを作成した場合、表示される内容は、次のスクリーンショットや手順とは若干異なります。

時系列データをインポートして予測するには

1. AWS マネジメントコンソールにサインインし、Amazon Forecast コンソール (https://console.aws.amazon.com/forecast/) を開きます。

2. Amazon Forecast ホームページで、[Create dataset group (データセットグループの作成)] を選択します。

3. [Create dataset group (データセットグループの作成)] ページの [Dataset group details (データセットグループの詳細)] に、次の情報を入力します。

• [Dataset group name (データセットグループ名)] – データセットグループの名前を入力します。• [ドメインの予測] – ドロップダウンメニューから [カスタム] を選択します。予測ドメインの選択方

法の詳細については、「Amazon Forecast の詳細 (p. 2)」および「データセットドメインとタイプ (p. 50)」を参照してください。

画面の表示は次のようになります。

4. [Next] を選択します。5. [Create target time series dataset (ターゲット時系列データセットの作成)] ページの [Dataset details

(データセットの詳細)] に、次の情報を入力します。

• [データセット名] – データセットグループの名前を入力します。• [Frequency of your data (データの頻度)] – デフォルト値の 1 のままにして、ドロップダウンメ

ニューから [hour] を選択します。この設定は、入力時系列データの設定と一致している必要があります。サンプルの電気使用量データの時間間隔は 1 時間です。

25

https://console.aws.amazon.com/forecast/



• [データスキーマ] – データタイプと順序で、時系列データの列に一致するようにスキーマを更新します。電力使用量入力データは、タイムスタンプ、指定時刻の電力使用量 (target_value)、その電力使用量に対して課金されたお客様の ID (string) の順に列が対応しています。


6. [Next] を選択します。7. [Import target time series data (ターゲット時系列データセットのインポート)]ページの [Dataset import

job details (データセットインポートジョブの詳細)] に次の情報を入力します。

• [データセットのインポートジョブ名] – データセットの名前を入力します。• [Timestamp format (タイムスタンプ形式)] – デフォルト (yyyy-MM-dd HH:mm:ss) のままにしてお

きます。この形式は、入力時系列データの設定と一致している必要があります。• [IAM Role (IAM ロール)] – デフォルトの [カスタム IAM ロールの ARN の入力] のままにします。

26


または、[Create a new role (新しいロールを作成)] を選択し、ドロップダウンメニューから、画面の指示に従って、Amazon Forecastに必要な IAM ロールを自動的に作成させることもできます。

• [カスタム IAM ロールの ARN] – Amazon Forecast の IAM ロールを作成する (IAM コンソール) (p. 19) で作成した IAM ロールの Amazon リソースネーム (ARN) を入力します。

• [Data location (データの場所)] – 以下の形式を使用して、Amazon S3 上の .csv ファイルの場所を入力してください。

s3://<name of your S3 bucket>/<folder path>/<filename.csv>


8. [Start import (インポートの開始)] を選択します。9. データセットグループの [ダッシュボード] ページが表示されます。画面の表示は次のようになりま

す。

27


[ターゲット時系列データ] に、インポートジョブのステータスが表示されます。Amazon Forecastで、時系列データのインポートが完了するまで待ちます。このプロセスには、数分以上かかることがあります。データセットがインポートされると、ステータスは [Active] に変わります。さらに、ダッシュボードの上部にあるバナーが変わり、次のメッセージが表示されます。

ターゲット時系列データセットがインポートされました。これで、予測子をトレーニングできます。

28


ステップ 2: 予測子をトレーニングする予測子 (トレーニング済みモデル) を作成するには、アルゴリズムと、行う予測の数 (長さ × 頻度) を選択します。特定のアルゴリズムを選択するか、[AutoML] を選択して Amazon Forecast にデータを処理させてデータセットグループに最適なアルゴリズムを選択するかを選択できます。アルゴリズムについては、アルゴリズムを選択する (p. 60) を参照してください。

予測子をトレーニングするには

1. ターゲット時系列データセットのインポートが完了すると、データセットグループの [ダッシュボード] は次のようになります。

[予測子をトレーニングする] で、[Start (開始)] を選択します。[Train predictor (予測子をトレーニングする)] ページが表示されます。

Note

[ターゲット時系列データ] の Status は Active である必要があります。これは、インポートが正常に終了していることを示します。これで予測子をトレーニングすることができます。

2. [Train predictor (予測子をトレーニングする)] ページで、[Predictor details (予測子の詳細)] に次の情報を入力します。

• [Predictor name (予測子名)] – 予測子の名前を入力します。• [予測期間] – 今後予測を実行する期間を選択します。この数値に、「Step 1: Import theTraining Data」で指定したデータ入力頻度 (hourly) を乗算して、今後予測を実行する期間が決定されます。この演習では、この数値を 36 に設定し、36 時間の予測を行います。

29


• [予測頻度] – デフォルト値の 1 のままにします。ドロップダウンメニューから [hour] を選択します。この設定は、入力時系列データの設定と一致している必要があります。サンプルの電気使用量データの時間間隔は 1 時間です。

• [アルゴリズム選択] – デフォルト値の [Manual] のままにします。ドロップダウンメニューから、[ETS] アルゴリズムを選択します。レシピの詳細については、「Amazon Forecast アルゴリズムを選択する (p. 60)」を参照してください。

残りの設定はオプションのため、デフォルト値のままにします。画面の表示は次のようになります。

30


31


3. [Train predictor (予測子のトレーニング)] を選択します。データセットグループの [ダッシュボード]ページが表示されます。画面の表示は次のようになります。

[Predictor training (予測子トレーニング)] に、トレーニングのステータスが表示されます。AmazonForecast で予測子のトレーニングが完了するまで待ちます。このプロセスには、数分以上かかることがあります。予測子がトレーニングされると、ステータスは [Active] に変わります。さらに、ダッシュボードの上部にあるバナーが変わり、次のメッセージが表示されます。

32


予測子がトレーニングされました。これで、予測を作成できます。

ステップ 3: 予測を作成する予測 (推論) を行うには、予測子を使用して予測を作成します。予測は予測のグループであり、ターゲットデータセット内のすべての項目に対して 1 つです。単一のアイテムの予測を取得するには、予測をクエリします。完全な予測を取得するには、エクスポートジョブを作成します。

予測を取得および表示するには

1. 予測子のトレーニングが終了したら、データセットグループの [ダッシュボード] は次のようになります。

[Forecast generation (予測の生成)] で、[Start (開始)] を選択します。[Create a forecast (予測の作成)]ページが表示されます。

Note

予測を生成するには、[予測子のトレーニング] の Status が Active である必要があります。

2. [Create a forecast (予測の作成)] ページの [Forecast details (予測の詳細)] に次の情報を入力します。

• [予測名] – 予測の名前を入力します。• [予測子] – ドロップダウンメニューから、Step 2: Train a Predictor で作成した予測子を選

択します。

残りの設定はオプションのため、デフォルト値のままにします。画面の表示は次のようになります。

33


3. [Create a forecast (予測の作成)] を選択します。データセットグループの [ダッシュボード] ページが表示されます。画面の表示は次のようになります。

34


[Forecast generation (予測の生成)] に、予測生成のステータスが表示されます。Amazon Forecastで、予測の作成が終了するまで待ちます。このプロセスには、数分以上かかることがあります。予測が作成されると、進行状況は [Active] に変わります。さらに、ダッシュボードの上部にあるバナーが変わり、次のメッセージが表示されます。

予測が作成されました。予測をクエリまたはエクスポートできます。

ステップ 4: 予測を取得する予測が作成されたら、単一のアイテムをクエリするか、完全な予測をエクスポートできます。

単一のアイテムをクエリするには

1. ダッシュボードが表示されていない場合は、ナビゲーションペインのデータセットグループの [ダッシュボード] を選択します。

2. ダッシュボードの [予測の生成] で、[予測のルックアップ] を選択します。[Forecast lookup (予測のルックアップ)] ページが表示されます。

3. [Forecast lookup (予測のルックアップ)] ページの [Forecast details (予測の詳細)] に次の情報を入力します。

• [予測] – ドロップダウンメニューから、Step 3: Create a Forecast で作成した予測を選択します。

• [開始日] – 2015/01/01 と入力します。デフォルト時間である 00:00:00 のままにします。• [終了日] – 2015/01/02 と入力します。時間を 12:00:00 に変更します。

36 時間の日付範囲は、Step 2: Train a Predictor で指定した [予測期間] に相当します。• [Choose which keys/filters] – [予測キーの追加] を選択します。• [予測キー] – ドロップダウンメニューから [item_id] を選択します。• [値] – 電力使用状況データの入力時系列の item_id 列から値を入力します。item_id (たとえ

ば、client_21) はデータセットに含まれている特定のクライアントを識別します。


35


4. [予測の取得] を選択します。予測が表示されたら、client_21 の電力使用量の予測を確認します。

予測は以下のようになります。

36


完全な予測をエクスポートするには

1. ナビゲーションペインで、データセットグループの [予測] を選択します。2. Step 3: Create a Forecast で作成した予測の横にあるラジオボタンを選択します。3. [Create forecast export (予測エクスポートの作成)] を選択します。[Create forecast export (予測エクス

ポートの作成)] ページが表示されます。4. [Create forecast export (予測エクスポートの作成)] ページの [エクスポートの詳細] に次の情報を入力

します。

• [エクスポート名] – 予測エクスポートジョブの名前を入力します。• [Generated forecast (生成された予測)] – ドロップダウンメニューから、Step 3: Create aForecast で作成した予測を選択します。

• [IAM Role (IAM ロール)] – デフォルトの [カスタム IAM ロールの ARN の入力] のままにします。

または、[Create a new role (新しいロールを作成)] を選択し、ドロップダウンメニューから、画面の指示に従って、Amazon Forecastに必要な IAM ロールを自動的に作成させることもできます。

• [カスタム IAM ロールの ARN] – Amazon Forecast の IAM ロールを作成する (IAM コンソール) (p. 19) で作成した IAM ロールの Amazon リソースネーム (ARN) を入力します。

• [S3 予測エクスポートの場所] – 次の形式を使用して、Amazon Simple Storage Service (Amazon S3)バケットまたはバケットのフォルダの場所を入力します。

s3://<name of your S3 bucket>/<folder path>/


37


5. [Create forecast export (予測エクスポートの作成)] を選択します。[my_forecast] ページが表示されます。


ステータスの進行状況が表示されます。 Amazon Forecast で、予測のエクスポートが終了するまで待ちます。このプロセスには、数分以上かかることがあります。予測がエクスポートされたら、ステータスが [Active] に変わり、S3 バケットで予測ファイルを見つけることができます。

38

Amazon Forecast 開発者ガイド開始方法 (AWS CLI)

開始方法 (AWS CLI)この演習では、AWS コマンドラインインターフェイス (CLI) を使用して Amazon Forecast を検証します。Amazon Forecast データセットを作成し、予測子をトレーニングして、結果の予測子を使用して予測を生成します。始める前に、AWS アカウントを作成し、AWS CLI を設定してください。詳細については、「セットアップ (p. 18)」を参照してください。

Note

この演習の CLI コマンドは Linux でテストされています。Windows で CLI コマンドを使用する方法については、AWS Command Line Interface ユーザーガイドの「AWS コマンドラインインターフェイスのパラメータ値の指定」を参照してください。

ステップ 1: トレーニングデータをインポートするまずデータセットを作成し、そこに電力使用量データをインポートすることから始めます。

Amazon Forecast データセットを作成するには

1. 適切なドメインとデータセットのタイプを決定します。

データセットにインポートするトレーニングデータは、データセットのドメインとタイプの選択に影響します。それでは、電力使用量データのいくつかのサンプル行を確認しましょう。

2014-01-01 01:00:00, 2.53807106598985, client_02014-01-01 01:00:00, 23.648648648648624, client_12014-01-01 02:00:00, 9.648648648612345, client_0

データ形式は CSV (カンマ区切り値) で、(タイムスタンプで示されるように) 1 時間ごとに収集されます。これらの列が含まれています。

• 列 1 – 電力使用量がいつ記録されたかを示すタイムスタンプ。• 列 2 – 時間ごとの電力使用量の値 (タイムスタンプ値が 1 時間ごとに増加する様子に注意してくださ

い)。• 列 3 – 電気を使用しているお客様を識別するクライアント ID の値。

このデータに対して、次の事前定義されているデータセットドメインとデータセットタイプを選択します。

• カスタムドメイン – METRICS、RETAIL、または WEB_TRAFFIC などのデータセットドメインはこのデータには適用されないため、カスタムドメインを選択します。

• ターゲット時系列タイプ – 時間の経過とともに、電力使用量を追跡するため、データは時系列です。また、予測するターゲット (列 2、電力使用量) も含まれています。したがって、ターゲット時系列データセットタイプを選択します。

このタイプを選択する理由を理解するには、「事前定義済みのデータセットドメインとデータセットタイプ (p. 50)」を参照してください。

2. データセットのスキーマを決定します。

CUSTOM ドメイン (p. 53) のターゲット時系列タイプには、timestamp、target_value、および item_id などのフィールドが必要です。target_value フィールドはターゲットです。AmazonForecast は、このフィールドの予測を生成します。

必須フィールドをデータ内の列にマップするには、スキーマを作成します。スキーマの各属性が、データ内のフィールドにマッピングされます。

39

https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html

https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html


Important

スキーマ内の属性の順序は、トレーニングデータ内のフィールドの順序と一致している必要があります。

{ "Attributes":[ { "AttributeName": "timestamp", "AttributeType": "timestamp" }, { "AttributeName": "target_value", "AttributeType": "float" }, { "AttributeName": "item_id", "AttributeType": "string" } ]}

これで、データセットを作成してデータをインポートするために必要な情報が得られました。3. データセットを作成します。

aws forecast create-dataset \--dataset-name electricity_demand_ds \--domain CUSTOM \--dataset-type TARGET_TIME_SERIES \--data-frequency H \--schema '{ "Attributes": [ { "AttributeName": "timestamp", "AttributeType": "timestamp" }, { "AttributeName": "target_value", "AttributeType": "float" }, { "AttributeName": "item_id", "AttributeType": "string" } ]}'

このリクエストでは、data-frequency 値 H は 1 時間ごとのデータ収集頻度を表します。以下に、応答の例を示します。

{ "DatasetArn": "arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds"}

このオペレーションの詳細については、「CreateDataset (p. 129)」を参照してください。4. (オプション) データセットの説明を取得します。

aws forecast describe-dataset \

40


--dataset-arn arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds

以下に、応答の例を示します。

{ "DatasetName": "electricity_demand_ds", "DatasetArn": "arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds", "CreationTime": 1564533087.907, "LastModificationTime": 1564533087.907, "Domain": "CUSTOM", "DatasetType": "TARGET_TIME_SERIES", "DataFrequency": "H", "Schema": { ... }, "EncryptionConfig": {}, "Status": "ACTIVE"}

Note

レスポンスのキーと値のペアの順序は任意です。5. データセットグループを作成し、データセットを追加します。domain パラメータの値は、データ

セットの domain と一致する必要があります。

aws forecast create-dataset-group \--dataset-group-name electricity_ds_group \--dataset-arns arn:aws:forecast:us-west-2:acct-id:ds/electricity_demand_ds \--domain CUSTOM


{ "DatasetGroupArn": "arn:aws:forecast:us-west-2:acct-id:dataset-group/electricity_ds_group"}

このオペレーションの詳細については、「CreateDatasetGroup (p. 133)」を参照してください。6. (オプション) データセットグループの説明を取得します。

aws forecast describe-dataset-group \--dataset-group-arn arn:aws:forecast:us-west-2:acct-id:dataset-group/electricity_ds_group


{ "DatasetGroupName": "electricity_ds_group", "DatasetGroupArn": "arn:aws:forecast:us-west-2:acct-id:dataset-group/electricity_ds_group", "DatasetArns": [ "arn:aws:forecast:us-west-2:acct-id:dataset-group/electricity_ds_group" ], "Domain": "CUSTOM", "CreationTime": 1564533719.852, "LastModificationTime": 1564533719.852, "Status": "ACTIVE"}

41


7. Amazon S3 バケットからデータセットに電力使用量トレーニングデータをインポートします。指定した IAM ロールには、S3 バケットのデータを読み込むためのアクセス許可が必要です。IAM ロールの作成方法については、Amazon Forecast の IAM を作成する (AWS CLI) (p. 21) を参照してください。

aws forecast create-dataset-import-job \--dataset-arn arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds \--dataset-import-job-name electricity_ds_import_job \--data-source '{ "S3Config": { "Path": "s3://bucket/electricityusagedata.csv", "RoleArn": "arn:aws:iam::acct-id:role/Role" } }'

以下は、data-source パラメータの短縮構文です。

--data-source S3Config="{Path='s3://bucket/electricityusagedata.csv',RoleArn='arn:aws:iam::acct-id:role/Role'}"


{ "DatasetImportJobArn": "arn:aws:forecast:us-west-2:acct-id:dataset-import-job/electricity_demand_ds/electricity_ds_import_job"}

このオペレーションの詳細については、「CreateDatasetImportJob (p. 136)」を参照してください。8. インポートのステータスを確認します。

aws forecast describe-dataset-import-job \--dataset-import-job-arn arn:aws:forecast:us-west-2:acct-id:dataset-import-job/electricity_demand_ds/electricity_ds_import_job


{ "DatasetImportJobName": "electricity_ds_import_job", "DatasetImportJobArn": "arn:aws:forecast:us-west-2:acct-id:dataset-import-job/electricity_demand_ds/electricity_ds_import_job", "DatasetArn": "arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds", "DataSource": { "S3Config": { "Path": "s3://bucket/electricityusagedata.csv", "RoleArn": "arn:aws:iam::acct-id:role/ForecastRole" } }, "DataSize": 0.14639010466635227, "TimeStampFormat": "yyyy-MM-dd HH:mm:ss", "CreationTime": 1564537011.114, "LastModificationTime": 1564537028.223, "Status": "CREATE_IN_PROGRESS"}

データがすべてインポートされると、ステータスは ACTIVE に変わり、次の例に示すように、データの統計がレスポンスに含まれます。

{

42


"DatasetArn": "arn:aws:forecast:us-west-2:acct-id:dataset/electricity_demand_ds", "Status": "ACTIVE", "FieldStatistics": { "date": { "Min": "2014-01-01T01:00:00Z", "Max": "2015-01-01T00:00:00Z", "Count": 3241200, "CountDistinct": 8760, "CountNull": 0 }, "target": { "Min": "0.0", "Max": "168200.0", "Avg": 606.5167610461679, "Stddev": 3518.405223972031, "Count": 3241200, "CountDistinct": 1196961, "CountNull": 0, "CountNan": 0 }, "item": { "Count": 3241200, "CountDistinct": 370, "CountNull": 0 } }, ...}

Important

データセットグループで予測子を作成するには、ステータスが ACTIVE になるまで待つ必要があります。

このオペレーションの詳細については、「DescribeDatasetImportJob (p. 172)」を参照してください。

ステップ 2: 予測子をトレーニングする予測子を作成するには、CreatePredictor (p. 146) オペレーションを使用し、次の情報を入力します。

• アルゴリズム – Amazon Forecast は、アルゴリズムを使用して、データセットグループのデータで予測子をトレーニングします。この演習では、Amazon Forecast によって提供されているforecast_DEEP_AR_PLUS というアルゴリズムを使用します。Amazon Forecast で用意されているアルゴリズムのリストについては、Amazon Forecast アルゴリズムを選択する (p. 60) を参照してください。

Note

使用するアルゴリズムがわからない場合は、CreatePredictor オペレーションでPerformAutoML フラグを設定して、AutoML を実行するように Amazon Forecast に指示できます。AutoML は、予測子のトレーニングに使用するアルゴリズムを判別します。

• データセットグループ – 前のステップでデータセットグループを作成しました。

予測子が作成されたら、Amazon Forecast によって生成された精度メトリクスを確認します。メトリクスは、予測の生成に予測子を使用するかどうかを決定するのに役立ちます。予測子の詳細については、「Predictors (p. 16)」を参照してください。

43


予測子を作成して、精度メトリクスを確認するには

1. 予測子を作成します。

aws forecast create-predictor \--predictor-name electricitypredictor \--algorithm-arn arn:aws:forecast:::algorithm/Deep_AR_Plus \--input-data-config DatasetGroupArn="arn:aws:forecast:us-west-2:acct-id:dsgroup/electricity_ds_group" \--forecast-horizon 20 \--featurization-config '{ "ForecastFrequency": "H" }'


{ "PredictorArn": "arn:aws:forecast:us-west-2:acct-id:predictor/electricitypredictor"}

2. 予測子のステータスを取得します。

aws forecast describe-predictor \--predictor-arn arn:aws:forecast:us-west-2:acct-id:predictor/electricitypredictor


{ "PredictorName": "electricitypredictor", "PredictorArn": "arn:aws:forecast:us-west-2:acct-id:predictor/electricitypredictor", "AlgorithmArn": "arn:aws:forecast:::algorithm/Deep_AR_Plus", "DatasetImportJobArns": [ "arn:aws:forecast:us-west-2:acct-id:dataset-import-job/electricity_demand_ds/electricity_ds_import_job" ], "InputDataConfig": { "DatasetGroupArn": "arn:aws:forecast:us-west-2:acct-id:dataset-group/electricity_ds_group" }, "ForecastHorizon": 20, "FeaturizationConfig": { "ForecastFrequency": "H", "Featurizations": [ { "AttributeName": "target_value", "FeaturizationPipeline": [ { "FeaturizationMethodName": "filling", "FeaturizationMethodParameters": { "frontfill": "none", "aggregation": "sum", "backfill": "zero", "middlefill": "zero" } } ] } ] }, "CreationTime": 1564611261.617,

44


"LastModificationTime": 1564611279.896, "PerformAutoML": false, "PerformHPO": false, "EvaluationParameters": { "BackTestWindowOffset": 20, "NumberOfBacktestWindows": 1 }, "Status": "CREATE_IN_PROGRESS"}

Important

モデルトレーニングには時間がかかります。トレーニングが完了し、予測子の状況がACTIVE になるまで続行しないでください。

3. 予測子の精度メトリクスを取得します。

aws forecast get-accuracy-metrics \--predictor-arn arn:aws:forecast:us-west-2:acct-id:predictor/electricitypredictor


{ "PredictorEvaluationResults": [ { "TestWindows": [ { "EvaluationType": "SUMMARY", "Metrics": { "RMSE": 448.19602551622864, "WeightedQuantileLosses": [ { "Quantile": 0.9, "LossValue": 0.11574311406253326 }, { "Quantile": 0.5, "LossValue": 0.1706269067283527 }, { "Quantile": 0.1, "LossValue": 0.11724164222477837 } ] } }, { "EvaluationType": "COMPUTED", "Metrics": { "RMSE": 448.19602551622864, "WeightedQuantileLosses": [ { "Quantile": 0.9, "LossValue": 0.11574311406253326 }, { "Quantile": 0.5, "LossValue": 0.1706269067283527 }, { "Quantile": 0.1, "LossValue": 0.11724164222477837 }

45


] }, "TestWindowEnd": 1420070400.0, "TestWindowStart": 1420002000.0 } ] } ]}

メトリクスは各分位数のエラー損失を示します。たとえば、最初の分位に 11.7％の誤差がありました。メトリクスには二乗平均平方根誤差 (RMSE) の値も表示されます。

要約メトリクスは、すべてのテストウィンドウで計算されたメトリクスの平均を示します。テストウィンドウは 1 つのみのため、要約と計算されたメトリクスは等しくなります。

このオペレーションの詳細については、「GetAccuracyMetrics (p. 188)」を参照してください。

ステップ 3: 予測を作成するAmazon Forecast は、データセット内の一意の item_id ごとに、target_value フィールド (データセットドメインとタイプによって決定される) の予測を生成します。この例では、target_value フィールドは電力使用量を提供し、item_id はクライアント ID を提供します。お客様ごとの時間ごとの電気使用量の予測を取得します。

予測が作成されたら、単一のアイテムをクエリするか、完全な予測をエクスポートできます。

予測を作成、取得、エクスポートするには

1. 予測を作成します。

aws forecast create-forecast \--forecast-name electricityforecast \--predictor-arn arn:aws:forecast:us-west-2:acct-id:predictor/electricitypredictor

このオペレーションでは、予測子を使用して予測を作成します。レスポンスで、予測の Amazon リソースネーム (ARN) を取得します。この ARN を使用して予測を取得およびエクスポートします。以下に、応答の例を示します。

{ "ForecastArn": "arn:aws:forecast:us-west-2:acct-id:forecast/electricityforecast"}

このオペレーションの詳細については、「CreateForecast (p. 140)」を参照してください。2. client_1 の予測の最初の 2 時間を取得します。

Note

サービス名 forecastquery は、他で使用されているサービス名とは異なります。

aws forecastquery query-forecast \--forecast-arn arn:aws:forecast:us-west-2:acct-id:forecast/electricityforecast \--start-date 2015-01-01T00:00:00 \--end-date 2015-01-01T02:00:00 \--filters '{"item_id":"client_1"}'

このオペレーションには次のパラメータが含まれます。

46


• start-date および end-date – 予測を取得するためのオプションの日付範囲を指定します。これらのパラメータを指定しないと、このオペレーションは client_1 の予測全体を返します。

• filters – client_1 の電力予測を取得する item_id フィルタを指定します。

以下は、filters パラメータの短縮構文です。

--filters item_id="client_1"


{ "Forecast": { "Predictions": { "mean": [ { "Timestamp": "2015-01-01T01:00:00", "Value": 20.952411651611328 }, { "Timestamp": "2015-01-01T02:00:00", "Value": 19.11078453063965 } ], "p90": [ { "Timestamp": "2015-01-01T01:00:00", "Value": 24.524038314819336 }, { "Timestamp": "2015-01-01T02:00:00", "Value": 22.319091796875 } ], "p50": [ { "Timestamp": "2015-01-01T01:00:00", "Value": 20.7841739654541 }, { "Timestamp": "2015-01-01T02:00:00", "Value": 19.237524032592773 } ], "p10": [ { "Timestamp": "2015-01-01T01:00:00", "Value": 18.507278442382812 }, { "Timestamp": "2015-01-01T02:00:00", "Value": 16.15062141418457 } ] } }}

これは 1 時間ごとの予測であるため、レスポンスには 1 時間ごとの予測値が表示されます。レスポンスで、以下の点に注意してください。

47

Amazon Forecast 開発者ガイドGetting Started (Python Notebook)

• mean – 特定の日時の平均値は、そのお客様の予測平均電力使用量です。• p90、p50、p10 – 指定された日時に実際の値が記載された値を下回る信頼レベルを指定します。た

とえば、Amazon Forecast は、電気使用量が 2015-01-01T01:00:00 に 24.5 を下回ると 90％確信しています。 Amazon Forecast は、使用量が 20.8 を下回ると 50％確信し、18.5 を下回ると 10％確信します。

このオペレーションの詳細については、「QueryForecast (p. 215)」を参照してください。3. 完全な予測を Amazon S3 バケットにエクスポートします。提供する IAM ロールには、データを

S3 バケットに書き込むことを許可するアクセス許可が必要です。IAM ロールの作成方法については、Amazon Forecast の IAM を作成する (AWS CLI) (p. 21) を参照してください。

予測エクスポートジョブを作成します。

aws forecast create-forecast-export-job \--forecast-export-job-name electricityforecast_exportjob \--forecast-arn arn:aws:forecast:us-west-2:acct-id:forecast/electricityforecast \--destination S3Config="{Path='s3://bucket',RoleArn='arn:aws:iam::acct-id:role/Role'}"


{ "ForecastExportJobArn": "arn:aws:forecast::us-west-2:acct-id:forecast-export/64bbc087"}

このオペレーションの詳細については、「CreateForecastExportJob (p. 143)」を参照してください。

4. エクスポートジョブのステータスを取得します。

aws forecast describe-forecast-export-job \--forecast-export-job-arn arn:aws:forecast:us-west-2:acct-id:forecast/electricityforecast


{ "ForecastExportJobArn": "arn:aws:forecast::us-west-2:acct-id:forecast-export/64bbc087", "ForecastExportJobName": "electricityforecast_exportjob", "Status": "CREATE_IN_PROGRESS"}

ステータスが ACTIVE の場合は、指定した S3 バケットの予測ファイルを確認できます。

Getting Started (Python Notebook)Amazon Forecast を確認するには、Jupyter (Python) ノートブックを使用できます。詳細については、以下を参照してください。の Forecast サンプル GitHubで

48


Amazon Forecast 開発者ガイドClean Up Resources

Clean Up Resources不要な料金が発生しないようにするには、使用開始実習の終了後に作成したリソースを削除します。リソースを削除するには、Amazon Forecast コンソール、SDK の Delete API、または AWS CommandLine Interface (AWS CLI) を使用します。たとえば、DeleteDataset (p. 153) API を使用してデータセットを削除します。

リソースを削除するには、そのステータスは ACTIVE、 CREATE_FAILED、または UPDATE_FAILED。を使用してステータスを確認します。 Describe たとえば、APIは DescribeDataset (p. 165).

次の表に示すように、一部のリソースは他のものよりも前に削除する必要があります。このプロセスには時間がかかる場合があります。

アップロードしたトレーニングデータ ( electricityusagedata.csv) を削除するには、「S3 バケットからオブジェクトを削除する方法」を参照してください。

削除するリソース最初にこちらを削除しますメモ:

ForecastExportJob

Forecast エクスポート中に予測を削除することはできません。予測を削除すると、予測のクエリを実行できなくなります。

Predictor 関連するすべての予測。

DatasetImportJob 削除できません。

Dataset データセットを対象にするすべての DatasetImportJob も削除されます。

予想子によって使用されているDataset は削除できません。

DatasetSchema スキーマを参照するすべてのデータセット。

DatasetGroup 関連するすべての予想子関連するすべての予測。

データセットグループのすべてのデータセット。

予想子で使用されているDataset を含む DatasetGroupは削除できません。

49

https://docs.aws.amazon.com/AmazonS3/latest/user-guide/delete-objects.html

https://docs.aws.amazon.com/AmazonS3/latest/user-guide/delete-objects.html


事前定義済みのデータセットドメインとデータセットタイプ

予測子をトレーニングするには、1 つまたは複数のデータセットを作成し、データセットグループに追加して、トレーニング用のデータセットグループを提供します。

作成したデータセットごとに、データセットドメインとデータセットタイプを関連付けます。データセットドメインは、一般的ユースケースのために事前定義されたデータセットスキーマを指定し、モデルアルゴリズムやハイパーパラメータには影響しません。

Amazon Forecast では、以下のデータセットドメインがサポートされています。

• RETAIL ドメイン (p. 51) – 小売の需要予測• INVENTORY_PLANNING ドメイン (p. 54) – サプライチェーンとインベントリの計画• EC2 CAPACITY ドメイン (p. 55) – Amazon Elastic Compute Cloud (Amazon EC2) キャパシティの予

測• WORK_FORCE ドメイン (p. 56) – 従業員の計画• WEB_TRAFFIC ドメイン (p. 57) – 今後のウェブトラフィックの見積もり• METRICS ドメイン (p. 58) – 収益およびキャッシュフローなどの予測メトリクス• CUSTOM ドメイン (p. 53) – その他すべての時系列予測のタイプ

ドメインごとに、1～3 つのデータセットタイプがあります。ドメイン用に作成するデータセットタイプは、所有しているデータのタイプとトレーニングに含めるものに基づいています。

各ドメインにはターゲット時系列データセットが必要です。オプションで、関連する時系列および項目メタデータデータセットタイプをサポートします。

データセットタイプは次のとおりです。

• ターゲット時系列 – 唯一必要なデータセットタイプ。このタイプは、予測を生成するターゲットフィールドを定義します。たとえば、一連の製品の売上を予測する場合は、予測する製品ごとに履歴の時系列データのデータセットを作成する必要があります。同様に、予測する収益、キャッシュフローおよび売上など、メトリクス用のターゲット時系列データセットを作成できます。

• 関連する時系列 – ターゲットの時系列データに関連する時系列データ。たとえば、価格は製品の売上データに関連しているため、関連する時系列として指定できます。

• 項目メタデータ – ターゲットの時系列データに適用可能なメタデータ。たとえば、特定の商品の売上を予測している場合、商品の属性 (ブランド、色、ジャンルなど) は、項目メタデータの一部になります。EC2 インスタンスの EC2 キャパシティを予測するとき、メタデータにはインスタンスタイプのCPU とメモリが含まれる場合があります。

データセットのタイプごとに、入力データに特定の必須フィールドが含まれている必要があります。Amazon Forecast が提案したオプションのフィールドを含めることもできます。

次の例は、データセットドメインとそれに対応するデータセットタイプを選択する方法を示しています。

Example 例 1 : RETAIL ドメインのデータセットタイプ

商品の需要予測に関心のある小売業者であれば、RETAIL ドメインに次のデータセットを作成できます。

50

Amazon Forecast 開発者ガイドRETAIL ドメイン

• ターゲット時系列は、各アイテム (小売業者が販売する各製品) の履歴時系列需要 (売上) データの必須データセットです。RETAIL ドメインでは、このデータセットタイプでは、データセットにitem_id、timestamp、および demand の各フィールドが含まれている必要があります。demandフィールドは予測ターゲットであり、通常は特定の週または日に小売業者によって販売された商品の数です。

• オプションで、関連する時系列タイプのデータセット。RETAIL ドメインでは、このタイプにはprice、inventory_onhand、webpage_hits などのオプションの、ただし推奨される時系列情報を含めることができます。

• オプションで、項目メタデータタイプのデータセット。RETAIL ドメインでは、Amazon Forecast はbrand、color、category、および genre など、ターゲット時系列で提供した項目に関連するメタデータ情報を提供することをお勧めします。

Example 例 2: METRICS ドメインのデータセットタイプ

収益、売上、キャッシュフローなど、組織の主要なメトリクスを予測する場合は、次のデータセットをAmazon Forecast に提供できます。

• 予測するメトリクスの履歴時系列データを提供するターゲット時系列データセット。組織内のすべてのビジネスユニットの収益を予測する場合は、metric、business unit、および metric_value の各フィールドを使用して target time series データセットを作成できます。

• category や location など、必要とされない各メトリクスのメタデータがある場合は、関連する時系列および項目メタデータタイプのデータセットを提供します。

ターゲットメトリクスの予測を生成するには、少なくとも Forecast のターゲット時系列データセットを提供する必要があります。

Example 例 3 : CUSTOM ドメインのデータセットタイプ

予測アプリケーションのトレーニングデータは、どの Amazon Forecast ドメインにも適合しない可能性があります。そのような場合は、CUSTOM ドメインを選択してください。ターゲット時系列データセットを提供する必要がありますが、独自のカスタムフィールドを追加することができます。

Getting Started (p. 23) 演習では、クライアントの電力使用量を予測します。電力使用量トレーニングデータはどのデータセットドメインにも適合しないため、CUSTOM ドメインを使用しました。この演習では、ターゲット時系列タイプという 1 つのデータセットタイプのみを使用します。データフィールドをデータセットタイプに必要な最小フィールドにマップします。

RETAIL ドメインRETAIL ドメインは、次のデータセットタイプをサポートしています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。

トピック• ターゲット時系列データセットタイプ (p. 51)• 関連する時系列データセットタイプ (p. 52)• 項目メタデータデータセットタイプ (p. 52)

ターゲット時系列データセットタイプターゲット時系列は、小売組織によって販売された各品目または製品の履歴時系列データです。以下のフィールドが必要です。

51

Amazon Forecast 開発者ガイド関連する時系列データセットタイプ

• item_id (文字列) – 需要を予測する商品または製品の固有の ID。• timestamp (タイムスタンプ)• demand (float) – タイムスタンプ時の商品の販売数。これは、Amazon Forecast が予測を生成するター

ゲットフィールドでもあります。

次のディメンションはオプションです。予測の精度を変更するために使用できます。

• location (文字列) – 商品が販売されたストアの場所。これは、複数のストア/場所がある場合にのみ使用してください。

これらの必須フィールド、およびオプションのディメンションのみが含まれている状態が理想です。その他の時系列情報は関連する時系列データセットに含めます。

関連する時系列データセットタイプ特定の日に項目が受け取った価格やウェブヒット数など、関連する時系列データセットを AmazonForecast に提供できます。情報が多いほど、予測はより正確になります。以下のフィールドが必要です。

• item_id (文字列)• timestamp (タイムスタンプ)

次のフィールドはオプションです。予測結果の改善に役立ちます。

• price (浮動) – タイムスタンプ時の商品の価格。• promotion_applied (integer; 1=true, 0=false) – タイムスタンプ時にその商品のマーケティングプロ

モーションがあったかどうかを指定するフラグ。

必須および推奨されるオプションのフィールドに加えて、トレーニングデータに他のフィールドを含めることができます。データセットに他のフィールドを含めるには、データセットを作成するときにスキーマにフィールドを指定します。

項目メタデータデータセットタイプこのデータセットは、需要が予測されている商品のメタデータ (属性) に関する情報を Amazon Forecast に提供します。以下のフィールドが必要です。

• item_id (文字列)


• category (文字列)• brand (文字列)• color (文字列)• genre (文字列)


52

Amazon Forecast 開発者ガイドCUSTOM ドメイン

CUSTOM ドメインCUSTOM ドメインは、次のデータセットタイプをサポートしています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。


ターゲット時系列データセットタイプ以下のフィールドが必要です。

• item_id (文字列)• timestamp (タイムスタンプ)• target_value (浮動小数点整数) – これは、Amazon Forecast が予測を生成する target フィールドで

す。

これらの必須フィールドのみ含まれている状態が理想です。その他の時系列情報は関連する時系列データセットに含めます。

関連する時系列データセットタイプ以下のフィールドが必要です。


必須フィールドに加えて、トレーニングデータに他のフィールドを含めることができます。データセットに他のフィールドを含めるには、データセットを作成するときにスキーマにフィールドを指定します。

項目メタデータデータセットタイプ以下のフィールドが必要です。



• category (文字列)


53

Amazon Forecast 開発者ガイドINVENTORY_PLANNING ドメイン

INVENTORY_PLANNING ドメインINVENTORY_PLANNING ドメインを使用して、原材料の需要を予測し、特定の商品の在庫をどれだけ在庫するかを決定します。以下のデータセットタイプがサポートされています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。



• item_id (文字列)• timestamp (タイムスタンプ)• demand (浮動) – これは、Amazon Forecast が予測を生成するための target フィールドです。


• location (文字列) – 商品が在庫されている流通センターの場所。これは、複数のストア/場所がある場合にのみ使用してください。





• price (浮動) – 商品の価格




54

Amazon Forecast 開発者ガイドEC2 CAPACITY ドメイン


• category (文字列) – 商品のカテゴリ。• brand (文字列) – 商品のブランド。• lead_time (文字列) – 商品を製造するためのリードタイム (日数)。• order_cycle (文字列) – 注文サイクルは、作業が開始されたときに開始され、商品の出荷準備が整った

ときに終了します。• safety_stock (文字列) – その商品を保持するための最小在庫量。


EC2 CAPACITY ドメインAmazon EC2 キャパシティを予測するには、EC2 CAPACITY ドメインを使用します。以下のデータセットタイプがサポートされています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。


• instance_type (文字列) – インスタンスのタイプ (例: c5.xlarge)。• timestamp (タイムスタンプ)• number_of_instances (整数) – タイムスタンプで消費された特定のインスタンスタイプのインスタン

スの数。これは、Amazon Forecast が予測を生成するための target フィールドです。


• location (文字列) – us-west-2 や us-east-1 などの AWS リージョンを指定できます。これは、複数のリージョンをモデリングしている場合にのみ使用してください。

これらの必須および提案されたオプションのフィールドのみ含まれている状態が理想です。その他の時系列情報は関連する時系列データセットに含めます。


• instance_type (文字列)• timestamp (タイムスタンプ)


55

Amazon Forecast 開発者ガイドWORK_FORCE ドメイン

WORK_FORCE ドメインWORK_FORCE ドメインを使用して労働力需要を予測します。以下のデータセットタイプがサポートされています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。



• workforce_type (文字列) – 予測されているタイプの労働力。たとえば、コールセンターの需要やフルフィルメントセンターの労働需要などです。

• timestamp (タイムスタンプ)• workforce_demand (浮動小数点整数) – これは、Amazon Forecast が予測を生成する target フィー

ルドです。


• location (文字列) – 労働力資源が求められている場所。これは、複数のストア/場所がある場合に使用してください。



• workforce_type (文字列)• timestamp (タイムスタンプ)



• workforce_type (文字列)


• wages (浮動) – その特定の労働力タイプの平均賃金。

56

Amazon Forecast 開発者ガイドWEB_TRAFFIC ドメイン

• shift_length (文字列) – シフトの長さ。• location (文字列) – 労働力の場所。


WEB_TRAFFIC ドメインウェブプロパティまたは一連のウェブプロパティへのウェブトラフィックを予測するには、WEB_TRAFFIC ドメインを使用します。以下のデータセットタイプがサポートされています。関連トピックでは、データセットタイプがサポートする必須フィールドとオプションのフィールドについて説明しています。これらのフィールドをトレーニングデータの列にマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。

トピック• ターゲット時系列データセットタイプ (p. 57)• 関連する時系列データセットタイプ (p. 57)


• item_id (文字列) – 予測されている各ウェブプロパティの一意の識別子。• timestamp (タイムスタンプ)• value (浮動) – これは、Amazon Forecast が予測を生成するための target フィールドです。









57

Amazon Forecast 開発者ガイドMETRICS ドメイン


METRICS ドメイン収益、売上、キャッシュフローなどの予測メトリクスには METRICS ドメインを使用します。以下のデータセットタイプがサポートされています。データセットのタイプごとに、必須フィールドとオプションフィールドをリストします。トレーニングデータの列にフィールドをマッピングする方法については、「データセットドメインとデータセットタイプ (p. 3)」を参照してください。



• metric_name (文字列)• timestamp (タイムスタンプ)• metric_value (浮動小数点整数) – これは、Amazon Forecast が予測を生成する target フィールドで

す (たとえば、特定の日に生成される収益額)。



• metric_name (文字列)• timestamp (タイムスタンプ)



• metric_name (文字列)



58

Amazon Forecast 開発者ガイド項目メタデータデータセットタイプ


59

Amazon Forecast 開発者ガイド組み込みの予測アルゴリズム

Amazon Forecast アルゴリズムを選択する

アン Amazon Forecast 予測子はアルゴリズムを使用して、時系列データセットでモデルをトレーニングします。そして、トレーニングを受けたモデルを使用して、メトリックと予測を生成します。

モデルのトレーニングに使用するアルゴリズムが不明な場合は、 AutoML 予測因子を作成し、 Forecast 10位、中央値、90位までの分位点の平均損失が最も低いアルゴリズムを選択します。そうでない場合は、内蔵アルゴリズムの1つを手動で選択できます。

組み込みの予測アルゴリズムAmazon Forecast には、選択可能な6つの内蔵アルゴリズムが用意されています。これらの範囲は、自動回帰統合移動平均(ARIMA)などの一般的に使用される統計アルゴリズムから、CNN-QRや DeepAR+。

CNN-QR(CNN-QR) (p. 62)arn:aws:forecast:::algorithm/CNN-QR

Amazon Forecast CNN-QR、畳み込みニューラルネットワーク - Quantile 回帰は、原因畳み込みニューラルネットワーク(CNN)を使用した時系列の予測のための独自の機械学習アルゴリズムです。CNN-QRは、何百もの時系列を含む大規模なデータセットで最適に機能します。アイテムメタデータが受け入れられ、Forecast 将来の値なしで関連する時系列データを受け入れるアルゴリズム。

DeepAR+ (p. 67)arn:aws:forecast:::algorithm/Deep_AR_Plus

Amazon Forecast DeepAR+ は、反復ニューラルネットワーク (RNN) を使用して時系列を予測するための独自の機械学習アルゴリズムです。 DeepAR+ は、何百もの機能時系列を含む大規模なデータセットで最適に動作します。アルゴリズムは、フォワードルッキング関連の時系列およびアイテムメタデータを受け入れます。

Prophet (p. 76)arn:aws:forecast:::algorithm/Prophet

Prophet は、非線形トレンドが年、週、日ごとの季節性に適合する付加モデルに基づく時系列予測アルゴリズムです。これは、強力な季節効果と数シーズンのヒストリカルデータを持つ時系列と最適に機能します。

NPTS (p. 74)arn:aws:forecast:::algorithm/NPTS

Amazon Forecast Non-Parametric Time Series (NPTS) 独自のアルゴリズムは、スケーラブルで確率論的なベースライン予測ツールです。NPTS は、スパースまたは断続的な時系列で作業する場合に特に便利で

60

Amazon Forecast 開発者ガイドARIMA

す。Forecastは4つのアルゴリズムバリアントを提供します。標準 NPTS、季節性 NPTS、気候予測器、季節性気候予測器。

ARIMA (p. 62)arn:aws:forecast:::algorithm/ARIMA

自動回帰統合移動平均(ARIMA)は、時系列予測に一般的に使用される統計アルゴリズムです。このアルゴリズムは、100 未満の時系列を持つ単純なデータセットに特に便利です。

ETS (p. 73)arn:aws:forecast:::algorithm/ETS

指数平滑化 (ETS) は、時系列予測に一般的に使用される統計アルゴリズムです。このアルゴリズムは、100 未満の時系列を持つ単純なデータセットや、季節性パターンを持つデータセットに特に便利です。ETSは、時系列データセットのすべての観測値に対する加重平均をその予測値として計算し、経時的に指数関数的に重みを減らします。

予測アルゴリズムの比較次の表を使用して、時系列データセットに最適なオプションを見つけます。

神経ネットワーク

柔軟なローカル・アルゴリズム

ベースラインアルゴリズム

計算集約的なトレーニングプロセス高高ミディアム低低低

履歴関連の時系列を受理*

将来の見通しに関連する時系列を受容する*

アイテムのメタデータ(商品の色、ブランドなど)を受け入れる

スパースデータセットに最適

ハイパーパラメータ最適化(HPO)を実行

デフォルトのハイパーパラメータ値のオーバーライドを許可します

What-If 分析に最適

コールドスタートのシナリオに最適(履歴データがほとんどまたは全くない予測)

*関連時系列の詳細については、以下を参照してください。関連時系列 (p. 7).

61

Amazon Forecast 開発者ガイドARIMA

自己回帰和分移動平均 (ARIMA) のアルゴリズム自己回帰和分移動平均 (ARIMA) は、時系列予測に一般的に使用される局所統計アルゴリズムです。ARIMAは、入力データセットの標準的時間構造 (時間のパターン化された編成) をキャプチャします。AmazonForecast ARIMA のアルゴリズムでは、Comprehensive R Archive Network (CRAN) の Package'forecast' の Arima 関数を呼び出します。

ARIMA の仕組みARIMA アルゴリズムは、定常時系列にマッピングできるデータセットに特に役立ちます。定常時系列の統計プロパティ (自己相関など) は、時間に依存しません。定常時系列を持つデータセットには通常、信号とノイズの組み合わせが含まれます。信号は正弦波振動のパターンを示すか、または季節的な構成要素を含む可能性があります。ARIMA は、信号をノイズから分離するフィルターのように動作し、今後の信号を推定して予測を立てます。

ARIMA のハイパーパラメータおよびチューニングARIMA のハイパーパラメータおよびチューニングについては、「CRANのPackage 'forecast'」の Arima関数のドキュメントを参照してください。

Amazon Forecast は、次の表を使用して、CreateDataset (p. 129) オペレーションで指定したDataFrequency パラメータを R の ts 関数の frequency パラメータに変換します。

DataFrequency (文字列) R ts frequency (整数)

Y 1

M 12

W 52

D 7

H 24

30 分 2

15 分 4

10 分 6

5 分 12

1 min 60

24 未満の頻度または短い時系列の場合、ハイパーパラメータは CRAN の Package 'forecast' のauto.arima 関数を使用して設定されます。24 以上の頻度または長い時系列の場合は、「Forecastingwith long seasonal periods」で説明するように、K = 4 のフーリエ級数を使用します。

表にないサポートされているデータ頻度のデフォルト値は、ts 頻度 1 に設定されます。

CNN-QRアルゴリズムAmazon Forecast CNN-QR、畳み込みニューラルネットワーク - Quantile 回帰は、原因畳み込みニューラルネットワーク(CNN)を使用してスカラー(一次元)時系列を予測するための独自の機械学習アルゴリズムで

62

https://en.wikipedia.org/wiki/Autoregressive_integrated_moving_average

https://cran.r-project.org/web/packages/forecast/forecast.pdf#Rfn.Arima.1

https://cran.r-project.org

https://cran.r-project.org/web/packages/forecast/forecast.pdf

https://www.rdocumentation.org/packages/stats/versions/3.6.1/topics/ts


https://robjhyndman.com/hyndsight/longseasonality/

https://robjhyndman.com/hyndsight/longseasonality/

Amazon Forecast 開発者ガイドはじめに

す。この教師付き学習アルゴリズムは、大規模な時系列のコレクションから1つのグローバルモデルを訓練し、量子デコーダを使用して確率予測を行います。

トピック• CNN-QRを使ってみる (p. 63)• CNN-QRの仕組み (p. 63)• CNN-QRでの関連データの使用 (p. 65)• CNN-QRハイパーパラメータ (p. 65)• ヒントとベストプラクティス (p. 67)

CNN-QRを使ってみるCNN-QRで予測因子をトレーニングするには、次の2つの方法があります。

1. 手動でCNN-QRアルゴリズムを選択する。2. 選択 AutoML (CNN-QRは AutoML)。

使用するアルゴリズムが不明な場合は、 AutoML、および Forecast は、データに対して最も正確なアルゴリズムである場合、CNN-QRを選択します。CNN-QRが最も正確なモデルとして選択されたかどうかを確認するには、予測者の説明 API またはコンソールで予測名を選択します。

CNN-QRの主な使用例は次のとおりです。

• 大規模で複雑なデータセットによる予測 - CNN-QRは、大規模で複雑なデータセットでトレーニングされた場合に最も効果的です。ニューラルネットワークは、多くのデータセットで学習できます。これは、関連する時系列と項目のメタデータがある場合に便利です。

• 履歴に関連する時系列での予測 - CNN-QRは、関連する時系列が予測期間内のデータポイントを含む必要はありません。この柔軟性の向上により、項目価格、イベント、Web メトリック、製品カテゴリなど、関連する時系列および項目メタデータの幅広い範囲を含めることができます。

• 特殊ケースの予測 - CNN-QRは、履歴データがほとんどない、またはまったく存在しないコールドスタートシナリオに使用できます。アイテムメタデータおよび関連する時系列を使用して、コールドスタート予測を生成できます。トレーニングを受けたモデルで、関連する時系列データの異なるバージョンを使用すると、異なるシナリオや反事実に対して What-if 分析を実行できます。

CNN-QRの仕組みCNN-QRは、予測がデコード配列をどの程度うまく再構築するかを、コード配列に基づいて試験する確率予測のための配列間(Seq2Seq)モデルである。

このアルゴリズムでは、エンコードおよびデコードシーケンスのさまざまな機能を使用できるため、エンコーダで関連する時系列を使用し、デコーダからその時系列を省略できます(逆の場合も同様)。デフォルトで、予測ホライズンにデータポイントがある関連する時系列は、エンコーダとデコーダの両方に含まれます。予測ホライゾンにデータポイントがない関連時系列は、エンコーダのみに含まれます。

CNN-QRは、学習可能な特徴抽出器として機能する階層的な原因CNNを用いて、分位回帰を実行する。

CNN-QR は、週末のスパイクなどの学習時間依存型パターンを容易にするために、時系列粒度に基づいて機能時系列を自動的に作成します。たとえば、CNN-QR は、2 つの機能時系列(月と年の日)を週次の時系列頻度で作成します。アルゴリズムは、これらの派生機能時系列を、トレーニングおよび推論中に提供されるカスタム機能時系列とともに使用します。次の例は、ターゲットタイムシリーズを示しています。zi,t、および 2 つの派生時系列要素: ui,1,t は、1 日の時間を表します。 ui,2,t は曜日を表します。

63

https://docs.aws.amazon.com/forecast/latest/dg/API_DescribePredictor.html

Amazon Forecast 開発者ガイド仕組み

CNN-QRは、データ頻度およびトレーニングデータのサイズに基づいて、これらの機能時系列を自動的に含めます。次の表に、サポートされている基本的な頻度ごとに、派生させることのできる特徴を示します。

時系列の頻度派生する特徴

分分、時、曜日、月初からの日付、年初からの日付

時間時、曜日、月初からの日付、年初からの日付

日。曜日、月初からの日付、年初からの日付

週月初からの日付、年初からの日付

月年あたりの月

トレーニング中、トレーニングデータセットの各時系列は、隣接するコンテキストと予測ウィンドウのペアと、あらかじめ定義された固定長で構成されます。これは下図に示されています。ここでは、コンテキストウィンドウは緑色で表示され、予測ウィンドウは青色で表示されます。

特定のトレーニングセットでトレーニングされたモデルを使用して、トレーニングセットの時系列の予測を生成したり、他の時系列で予測したりできます。トレーニングデータセットは、関連するタイムシリーズのリストとアイテムメタデータに関連付けられたターゲットタイムシリーズで構成されます。

下図は、インデックス付けされたトレーニングデータセットの要素に対して、これがどのように機能するかを示しています。 i. トレーニングデータセットは、ターゲットタイムシリーズで構成されます。zi,t、および関連する 2 つの関連時系列 xi,1,t および xi,2,t. 最初の関連する時系列は、 xi,1,tは、将来を見据えた時系列であり、2番目の時系列は、 xi,2,tは過去の時系列です。

CNN-QRはターゲット時系列で学習し、 zi,t、および関連する時系列、 xi,1,t および xi,2,tは、オレンジ色の線で表される予測ウィンドウで予測を生成します。

64

Amazon Forecast 開発者ガイド関連データ

CNN-QRでの関連データの使用CNN-QRは Forecast 予測対象期間まで拡張するために、関連する時系列データセットを必要としないアルゴリズム。つまり、関連する時系列の将来の値を入力または予測する必要はありません。履歴および将来の関連時系列の詳細については、以下を参照してください。関連する時系列データセットの使用。 (p. 7)

また、CNN-QR でアイテムメタデータデータセットを使用することもできます。これらは、ターゲットタイムシリーズ内の項目に関する静的情報を持つデータセットです。項目メタデータは、履歴データがほとんどない、またはまったくないコールドスタート予測シナリオで特に便利です。項目メタデータの詳細については、以下を参照してください。アイテムのメタデータ。 (p. 10)

CNN-QRハイパーパラメータAmazon Forecast は、選択したハイパーパラメータのCNN-QRモデルを最適化します。CNN-QRを手動で選択する場合、これらのハイパーパラメータのトレーニングパラメータを渡すオプションがあります。次の表は、CNN-QRアルゴリズムの調整可能なハイパーパラメータの一覧です。

パラメータ名 [値] 説明

context_length 有効な値

正の整数有効範囲

10 ～ 500一般的な値

2 *ForecastHorizon～ 12 *ForecastHorizon

調整可能な HPO

あり

予測を行う前にモデルが読み取る時間ポイントの数。通常、CNN-QRは、 context_length 以下より DeepAR+ CNN-QRは、ラグを使用して、さらなる履歴データを調べることはありません。

次の値の場合: context_length は、事前に定義された範囲外です。CNN-QRは自動的にデフォルトを設定します。 context_length 適切な値にします。

use_related_data 有効な値

ALL

NONE

HISTORICAL

FORWARD_LOOKING

デフォルト値

ALL

調整可能な HPO

あり

モデルに含める関連時系列データの種類を決定します。

次の4つのオプションから1つ選択します。

• ALL: 提供されたすべての関連する時系列を含めます。

• NONE: 提供されたすべての関連する時系列を除外します。

• HISTORICAL: 関連する時系列のみを含める実施しない予測期間まで拡大します。

• FORWARD_LOOKING: 関連する時系列のみを含めるする予測期間まで拡大します。

HISTORICAL すべての履歴関連時系列を含むFORWARD_LOOKING には、すべての将来予想関連の時系列が含まれます。次のサブセットは選択できません: HISTORICAL 又は FORWARD_LOOKING関連時系列。

65

Amazon Forecast 開発者ガイドハイパーパラメータ

パラメータ名 [値] 説明

use_item_metadata 有効な値

ALL

NONE

デフォルト値

ALL

調整可能な HPO

あり

モデルにアイテムのメタデータが含まれるかどうかを決定します。

次の2つのオプションのいずれかを選択します。

• ALL: 提供されたすべてのアイテムメタデータを含めます。

• NONE: 提供されたすべてのアイテムのメタデータを出力します。

use_item_metadata には、提供されたすべてのアイテムメタデータまたはなしが含まれます。項目メタデータのサブセットを選択することはできません。

epochs 有効な値

正の整数一般的な値

10～1000デフォルト値

100調整可能な HPO

なし

トレーニングデータの完全なパスの最大数。小さいデータセットでは、より多くのエポックが必要です。

大きな値の場合: ForecastHorizon およびcontext_lengthトレーニング時間を改善するために、エポックを減らすことを検討してください。

ハイパーパラメータ最適化(HPO)ハイパーパラメータ最適化(HPO)は、特定の学習目標に対して最適なハイパーパラメータ値を選択するタスクです。予測では、このプロセスを次の2つの方法で自動化できます。

1. 選択 AutoML、CNN-QRはHPOが自動実行する。2. CNN-QRの手動選択と設定 PerformHPO = TRUE.

関連の時系列やアイテムのメタデータを追加しても、CNN-QRモデルの精度が必ずしも向上するとは限りません。実行時 AutoML または HPO を有効にすると、CNN-QR は、提供された関連する時系列とアイテムのメタデータの有無に関係なくモデルの精度をテストし、最高の精度でモデルを選択します。

Amazon Forecast は、HPO 中に次の 3 つのハイパーパラメータを自動的に最適化し、トレーニング済みの最終値を提供します。

• コンテキスト_長さ - ネットワークがどの程度過去まで見ることができるかを決定します。HPOプロセスでは、 context_length トレーニング時間を考慮しながら、モデルの精度を最大限に高めます。

• 使用_関連_データ - モデルに含める関連時系列データのフォームを決定します。HPO プロセスは、関連する時系列データがモデルを改善するかどうかを自動的にチェックし、最適な設定を選択します。

• use_item_メタデータ - モデルにアイテムのメタデータを含めるかどうかを指定します。HPO プロセスは、アイテムメタデータがモデルを改善するかどうかを自動的にチェックし、最適な設定を選択します。

66

Amazon Forecast 開発者ガイドヒントとベストプラクティス

Note

次の場合: use_related_data はに設定されています NONE 又は HISTORICAL のとき Holiday補正機能が選択されているので、休日データを含めるとモデルの精度が向上しないことを意味します。

HPO構成は、 context_length ハイパーパラメータを PerformHPO = TRUE 手動で選択します。ただし、HPO 構成のどの側面も、 AutoML. HPO構成の詳細については、インターガーパラメータ範囲 API。

ヒントとベストプラクティス大きな値を避ける ForecastHorizon - 100を超える値を ForecastHorizon はトレーニング時間を増やし、モデルの精度を低下させます。未来の予測をさらに生成するには、より高い頻度で情報を集約することを検討してください。たとえば、1min ではなく 5min を使用します。

CNNは、より高いコンテキスト長を可能にします - CNN-QRでは、 context_length やや高い DeepAR+、として CNNs より効率的です。 RNNs.

関連データの機能エンジニアリング - モデルのトレーニング時に、関連する時系列と項目メタデータの異なる組み合わせを試し、追加情報が精度を改善するかどうかを評価します。関連する時系列と項目のメタデータの異なる組み合わせと変換によって、異なる結果が得られます。

CNN-QRは平均分位数で予測しない – 設定する場合 ForecastTypes ～ mean と CreateForecast API、予測は代わりに、中央値分位点(0.5 又は P50)。

コールドスタート項目予測 – CNN-QRなどのグローバルモデルは、ターゲット時系列、関連時系列、項目メタデータにわたって学習するため、コールドスタートのシナリオに適しています。CNN-QRは、新品目の需要予測と SKUs 履歴データを持つ他のアイテムと類似した特性を共有します。フォローするノートブックの例始めましょう。

What-If 分析 – トレーニングを受けたCNN-QRモデルで、過去の時系列データや将来予測に関連する時系列データの異なるバージョンを使用することで、異なるシナリオや反事実の予測を作成できます。たとえば、プロモーションの有無に関係なく、製品の需要を予測できます。フォローするノートブックの例始めましょう。

DeepAR+ アルゴリズムAmazon Forecast DeepAR は、再帰型ニューラルネットワーク (RNN) を使用してスカラー (1 次元) 時系列を予測するための、教師あり学習アルゴリズムです。自己回帰和分移動平均 (ARIMA) や指数平滑法 (ETS)などの古典的な予測方法は、1 つのモデルを個々の時系列に適合させ、そのモデルを使用して時系列を未来に当てはめます。ただし多くのアプリケーションでは、一連の横断的な単位にわたって同様の時系列が多数あります。これらの時系列グループは、さまざまな製品、サーバーの負荷、およびウェブページのリクエストを要求します。この場合、これらすべての時系列で、連携して単一のモデルをトレーニングすることが効果的です。DeepAR はこのアプローチを使用します。データセットに何百もの特徴の時系列データが含まれている場合、DeepAR+ アルゴリズムは標準の ARIMA や ETS メソッドよりも優れています。トレーニングしたモデルを使用して、トレーニングしたモデルと似た新しい時系列の予測を生成することもできます。

トピック• DeepAR+ の仕組み (p. 68)• DeepAR+ ハイパーパラメータ (p. 70)• DeepAR+ モデルを調整する (p. 72)

67

https://docs.aws.amazon.com/forecast/latest/dg/API_IntegerParameterRange.html

https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html

https://github.com/aws-samples/amazon-forecast-samples/blob/master/notebooks/advanced/Forecast%20with%20Cold%20Start%20Items/Forecast%20with%20Cold%20Start%20Items.ipynb

https://github.com/aws-samples/amazon-forecast-samples/blob/master/notebooks/advanced/Forecast%20with%20Cold%20Start%20Items/Forecast%20with%20Cold%20Start%20Items.ipynb

https://github.com/aws-samples/amazon-forecast-samples/blob/master/notebooks/advanced/WhatIf_Analysis/WhatIf_Analysis.ipynb

Amazon Forecast 開発者ガイド: 仕組み

DeepAR+ の仕組みトレーニング中、DeepAR+ はトレーニングデータセットとオプションのテストデータセットを使用します。テストデータセットは、トレーニングされたモデルを評価するために使用されます。一般的に、トレーニングデータセットとテストデータセットに同じ一連の時系列を含める必要はありません。特定のトレーニングセットでトレーニングされたモデルを使用すると、トレーニングセット内の時系列の今後の予測と他の時系列の予測を生成できます。トレーニングデータセットとテストデータセットはどちらも (可能な場合は複数の) ターゲット時系列で構成されています。オプションで、要素時系列のベクトルおよびカテゴリ要素のベクトルに関連付けることができます(詳細は、 DeepAR入力/出力インタフェースの SageMaker 開発者ガイド)。次の例は、インデックス付けされたトレーニングデータセットのエレメントに対して、これがどのように機能するかを示しています。 i。トレーニングデータセットは、目標時系列、 zi,t、および2つの関連機能時系列、 xi,1,t および xi,2,t.

ターゲット時系列には欠落した値が含まれている可能性があります (グラフでは時系列の切れ目で示されています)。DeepAR+ は、今後認識される特徴の時系列のみをサポートします。これにより、事実に反した「what-if」シナリオを実行できます。たとえば、「製品の価格を何らかの方法で変更した場合はどうなりますか?」などです。

各ターゲット時系列は、複数のカテゴリ別特徴に関連付けることもできます。これらを使用して、時系列が特定のグループに属していることをエンコードできます。カテゴリ別特徴を使用すると、モデルはそれらのグループ化の典型的な動作を学習することができ、それによって精度が向上します。モデルはこれを実装するために、グループ内のすべての時系列の共通プロパティをキャプチャする各グループの埋め込みベクトルを学習します。

週末の急増などの時間依存パターンの学習を容易にするために、DeepAR+ は時系列の詳細度に基づいて特徴の時系列を自動的に作成します。たとえば、DeepAR+ は、週に 1 回の頻度で 2 つの特徴の時系列 (月初からの日付と年初からの日付) を作成します。DeepAR+ は、このように派生した特徴の時系列を使用するだけでなく、トレーニングと推論の間にユーザーが提供するカスタムの特徴の時系列も使用します。次の例は、2 つの派生時系列機能を示しています。ui,1,t は1日の時間を表し、 ui,2,t 週の曜日です

DeepAR+ は、データの頻度とトレーニングデータのサイズに基づいて、これらの特徴の時系列を自動的に組み込みます。次の表に、サポートされている基本的な頻度ごとに、派生させることのできる特徴を示します。

68

https://docs.aws.amazon.com/sagemaker/latest/dg/deepar.html#deepar-inputoutput

Amazon Forecast 開発者ガイド: 仕組み

時系列の頻度派生する特徴

分分、時、曜日、月初からの日付、年初からの日付

時間時、曜日、月初からの日付、年初からの日付

日。曜日、月初からの日付、年初からの日付

週月初からの日付、年初からの日付


DeepAR+ モデルは、トレーニングデータセットの各時系列からいくつかのトレーニング例をランダムにサンプリングすることによってトレーニングされます。各トレーニング例は、事前定義された固定長を持つ一対の隣接コンテキストと予測ウィンドウで構成されています。context_length ハイパーパラメータは、どの程度の過去まで遡ってネットワークを調べられるのかを制御し、ForecastHorizon パラメータは、どの程度の未来まで予測を生成できるかを制御します。トレーニング中、Amazon Forecast は、指定された予測長より時系列が短いトレーニングデータセット内の要素を無視します。次の例は、コンテキスト長(緑色で強調表示)が 12 時間、予測長(青色で強調表示)が 6 時間の 5 つのサンプルを示しています。i。簡潔にするため、機能時系列を除外しました。 xi,1,t および ui,2,t.

季節的パターンをキャプチャするために、DeepAR+ はターゲット時系列から遅延した (過去の期間の) 値も自動的にフィードします。1 時間に 1 回の頻度で各時間インデックス t = T のサンプルを取得したこの例では、モデルは zi,t 値を公開します。これらは過去約 1、2、および 3 日 (ピンクでハイライト表示) に発生したものです。

トレーニングされたモデルは、推論のために、トレーニング中に使用されたかどうかにかかわらず、ターゲット時系列を入力として受け取り、それ以降の ForecastHorizon 値の確率分布を予測します。DeepAR+ はデータセット全体についてトレーニングされるため、予測では同様の時系列からの学習パターンが考慮されます。

DeepAR+ の背後にある数学については、以下を参照してください。 DeepAR: 自動回帰反復ネットワークによる確率的予測コーネル大学図書館のウェブサイト

69

https://arxiv.org/abs/1704.04110

https://arxiv.org/abs/1704.04110


DeepAR+ ハイパーパラメータ次の表は、DeepAR+ アルゴリズムで使用できるハイパーパラメータのリストです。太字のパラメータは、ハイパーパラメータ最適化 (HPO) に関与します。

パラメータ名説明:

context_length 予測を生成する前にモデルが読み込む時間ポイントの数。このパラメータの値は、 ForecastHorizon。このモデルは、ターゲットから遅れた入力を受け取るため、 context_length 典型的な季節性よりもはるかに小さくなります。たとえば、毎日の時系列が年次的な季節性を持つ場合があります。このモデルには 1 年間の遅延が自動的に含まれるため、コンテキストの長さは 1 年よりも短くなります。モデルが選択する遅延値は、時系列の頻度によって異なります。たとえば、毎日の頻度の遅延値は、前の週、2 週間、3 週間、4 週間、および 1 年です。

有効な値


ceil(0.1 * ForecastHorizon) to min(200, 10 * ForecastHorizon)デフォルト値

2 * ForecastHorizon

epochs トレーニングデータへのパスの最大数。最適な値は、データサイズと学習レートによって異なります。データセットが小さく、学習率が低くなると、いずれもエポック数が多くなり、良好な結果が得られます。

有効な値



500**

learning_rate トレーニングで使用する学習レート。

有効な値

正の浮動小数点数一般的な値

0.0001～0.1デフォルト値

0.001

learning_rate_decay学習率が低下するレート。学習レートは多くてもmax_learning_rate_decays 回減少し、その後はトレーニングが停止します。このパラメータが使用されるのは、max_learning_rate_decays が 0より大きい場合のみです。

70


パラメータ名説明:有効な値

正の浮動小数点数一般的な値

0.5～0.8デフォルト値

0.5

likelihood モデルは確率予測を生成し、分散の変位値を提供してサンプルを返すことができます。データによっては、不確実性予測に使用される適切な尤度 (ノイズモデル) を選択します。

有効な値

• beta: : 0 ～ 1 の範囲内 (0 と 1 を含む) の実数値ターゲットに使用します。• deterministic-L1: : 不確実性を予測せず、ポイント予測のみ学習する損失

関数。• gaussian: : 実数値のデータに使用します。• negative-binomial: : データ (負ではない整数) の合計に使用します。• piecewise-linear: : 柔軟なディストリビューションに使用します。• student-T: : バースト性データの実数値データにこの方法を使用します。

デフォルト値

student-T

max_learning_rate_decays学習レートの減少が起きた場合のその最大回数。

有効な値


0〜10デフォルト値

0

num_averaged_modelsDeepAR+ では、トレーニングの軌跡に複数のモデルが含まれる可能性があります。各モデルの予測の長所と短所は異なる場合があります。DeepAR+ は、すべてのモデルの長所を活用するために、モデルの動作を平均化できます。

有効な値



1

71

Amazon Forecast 開発者ガイドモデルの調整


num_cells RNN の非表示のレイヤーごとに使用するセルの数。

有効な値



40

num_layers RNN の非表示レイヤーの数。

有効な値



2.

DeepAR+ モデルを調整するAmazon Forecast DeepAR+ モデルを調整するには、以下の推奨事項に従って、トレーニングプロセスとハードウェア構成を最適化してください。

プロセス最適化のためのベストプラクティス最良の結果を得るためには、以下の推奨事項に従ってください。

• トレーニングとテストのデータセットを分割する場合を除き、トレーニングとテストのため、および推論のためにモデルを呼び出す際には、常に時系列全体を提供します。context_length の設定方法にかかわらず、時系列を分割したり、その一部だけを指定したりしないでください。モデルは、遅延値の特徴には、context_length より後ろのデータポイントを使用します。

• モデルを調整するために、データセットをトレーニングデータセットとテストデータセットに分割することができます。典型的な評価シナリオでは、トレーニングで使用したのと同じ時系列でモデルをテストする必要がありますが、トレーニング中に表示される最後の時間ポイントの直後に発生するForecastHorizon 時間ポイントでモデルをテストします。これらの基準を満たすトレーニングデータセットとテストデータセットを作成するには、データセット全体 (すべての時系列) をテストデータセットとして使用し、トレーニング用の各時系列から最後の ForecastHorizon ポイントを削除します。このようにトレーニング中には、モデルはテスト時に評価される時間ポイントのターゲット値を確認しません。テストフェーズでは、テストデータセット内の各時系列の最後の ForecastHorizon ポイントが保留され、予測が生成されます。その後、予測が最後の ForecastHorizon ポイントの実際の値と比較されます。より複雑な評価を作成するには、テストデータセット内で時系列を複数回繰り返しますが、それぞれ異なる終了ポイントで切り捨てます。これにより、さまざまな時間ポイントからの複数の予測で平均化された精度メトリクスが生成されます。

• ForecastHorizon に非常に大きい値 (> 400) を使用することは避けてください。このような値を設定すると、モデルの速度が遅くなり、精度が低下します。未来の予測をさらに生成するには、より高い頻度で情報を集約することを検討してください。たとえば、1min ではなく 5min を使用します。

72

Amazon Forecast 開発者ガイドETS

• 遅れがあるため、このモデルは context_length。したがって、このパラメータを大きな値に設定する必要はありません。このパラメータの開始点として推奨されるのは、ForecastHorizon と同じ値です。

• 可能な限り多くの時系列で DeepAR+ モデルをトレーニングします。単一の時系列でトレーニングされた DeepAR+ モデルも問題なく機能する可能性はありますが、ARIMA や ETS などの標準的な予測方法を使用すると、正確性が増し、そのユースケースへの適合性が高まるように調整される可能性があります。データセットに何百もの特徴の時系列データが含まれている場合、DeepAR+ は標準の方法より優れた性能を発揮するようになります。DeepAR+ では現在、すべてのトレーニング時系列にわたって利用可能な観測の総数が 300 以上であることが要求されます。

• DeepAR+ は、目標の時系列、関連する時系列、およびアイテムのメタデータを学習し、コールドスタートのシナリオに適しています。DeepAR+は、履歴データを使用して、他の品目と類似した特性を共有する新しい品目およびSKUの需要を予測できます。これに従うノートブックの例始めましょう

指数平滑法 (ETS) のアルゴリズム指数平滑法 (ETS) は、時系列予測に一般的に使用される局所統計アルゴリズムです。Amazon ForecastETS のアルゴリズムでは、Comprehensive R Archive Network (CRAN) の Package 'forecast' の ets関数を呼び出します。

ETS の仕組みETS アルゴリズムは、季節性およびデータに関する他の事前の仮定を含むデータセットに特に役立ちます。ETS では、予測として、入力時系列データセットにおけるすべての観測値の加重平均を計算します。単純移動平均法では、重みは一定はなく、時間の経過とともに指数関数的に減少します。重みは、定数パラメータ (平滑化パラメータとも呼ばれる) に依存します。

ETS のハイパーパラメータおよびチューニングETS のハイパーパラメータおよびチューニングについては、「CRANのPackage 'forecast'」の ets 関数のドキュメントを参照してください。

Amazon Forecast は、次の表を使用して、CreateDataset (p. 129) オペレーションで指定したDataFrequency パラメータを R の ts 関数の frequency パラメータに変換します。

DataFrequency (文字列) R ts frequency (整数)

Y 1

M 12

W 52

D 7

H 24

30 分 2

15 分 4

10 分 6

5 分 12

1 min 60

73

https://github.com/aws-samples/amazon-forecast-samples/tree/master/notebooks/advanced/Forecast with Cold Start Items

https://en.wikipedia.org/wiki/Exponential_smoothing

https://cran.r-project.org/web/packages/forecast/forecast.pdf#Rfn.ets.1

https://cran.r-project.org/web/packages/forecast/forecast.pdf#Rfn.ets.1


https://cran.r-project.org/web/packages/forecast/forecast.pdf

https://www.rdocumentation.org/packages/stats/versions/3.6.1/topics/ts

Amazon Forecast 開発者ガイドNPTS

表にないサポートされているデータ頻度のデフォルト値は、ts 頻度 1 に設定されます。

ノンパラメトリック時系列 (NPTS) のアルゴリズムAmazon Forecast ノンパラメトリック時系列 (NPTS) のアルゴリズムは、スケーラブルで確率的なベースライン予測機能です。過去の観測からサンプリングすることにより、特定の時系列の未来の価値分布を予測します。予測は観測値によって制限されます。時系列が断続的 (またはスパース、多くの 0 を含む) かつバースト的であり場合、NPTS は特に便利です。たとえば、時系列に多数の低カウントがある個々のアイテムの需要の予測などです。Amazon Forecast は、過去の観測のどれをサンプリングするかが異なり、かつどのようにサンプリングされるかが異なる、NPTS のバリアントを提供します。NPTS バリアントを使用するには、ハイパーパラメータ設定を選択します。

NPTS の仕組み指数平滑法 (ETS) や自己回帰和分移動平均 (ARIMA) などの古典的な予測方法と同様に、NPTS は各時系列の予測を個別に生成します。データセットの時系列は長さが異なっていて構いません。観察が利用可能である時間ポイントはトレーニング範囲と呼ばれ、予測が望まれる時間ポイントは予測範囲と呼ばれます。

Amazon Forecast NPTS予測には、次の種類があります。NPTS、季節性NPTS、気候予測、季節性気候予測。

トピック• NPTS (p. 74)• 季節性 NPTS (p. 74)• 気候学的予測機能 (p. 74)• 季節性気候学的予測機能 (p. 75)• 季節性の特徴 (p. 75)• ベストプラクティス (p. 75)

NPTSこのバリアントで、予測は、時系列のトレーニング範囲内のすべての観測値からサンプリングすることによって生成されます。ただし、すべての観測値から一様にサンプリングするのではなく、このバリアントでは、予測が必要な現在の時間ステップからどれほど離れているかに応じて、過去の各観測値に重みを割り当てます。特に、過去の観測値がどれほど離れているかに応じて指数関数的に減衰する重みを使用します。このように、最近の過去からの観測値は、遠い過去からの観測値よりもはるかに高い確率でサンプリングされます。これは、近い過去が遠い過去より未来のためにより指標的であるということを前提としています。重みの減衰量を制御するには、exp_kernel_weights ハイパーパラメータを使用します。

Amazon Forecast でこの NPTS バリアントを使用するには、use_seasonal_model ハイパーパラメータを False に設定し、他のすべてのデフォルト設定を受け入れます。

季節性 NPTS季節性 NPTS のバリアントは、NPTS と似ていますが、すべての観測からサンプリングするのではなく、過去の季節の観測のみを使用する点が異なります。デフォルトでは、季節は時系列の詳細度によって決まります。たとえば、1 時間ごとの時系列で時間 t の予測を生成するには、このバリアントは前日の時間 t に対応する観測値からサンプリングします。NPTS と同様に、前日の t 時の観測値は、それより前の日の t 時の観測値よりも重要度が高くなります。時系列の詳細度に基づいて季節性を判断する方法について詳しくは、the section called “季節性の特徴” (p. 75)を参照してください。

気候学的予測機能気候学的予測機能のバリアントは、過去の観測すべてを一様な確率でサンプリングします。

74


気候予測機能を使用するには、 kernel_type ハイパーパラメータから uniform およびuse_seasonal_model ハイパーパラメータから False。他のすべてのハイパーパラメータのデフォルト設定を受け入れます。

季節性気候学的予測機能季節性 NPTS と同様に、季節性気候学的予測機能は、過去の季節からの観測値をサンプリングしますが、それらを一様な確率でサンプリングします。

季節的な気候予測機能を使用するには、 kernel_type ハイパーパラメータから uniform。その他のすべてのハイパーパラメータのデフォルト設定をすべて受け入れます。

季節性の特徴季節性 NPTS と季節性気候学的予測機能の季節に対応するものを判断するには、次の表にリストされている特徴を使用します。この表には、詳細度に基づいて、サポートされている基本的な時間頻度で派生する特徴をリストします。Amazon Forecast にはこれらの特徴の時系列が含まれているのため、それらを提供する必要はありません。

時系列の頻度季節性を判断する特徴

分時間あたりの分

時間日あたりの時間

日 day of week

週月あたりの日


ベストプラクティスAmazon Forecast NPTS のアルゴリズムを使用する際には、データを準備して最適な結果を得るために、次のベストプラクティスを考慮してください。

• NPTS は各時系列の予測を個別に生成するため、予測のためにモデルを呼び出すときには時系列全体を指定します。また、context_length ハイパーパラメータのデフォルト値を受け入れます。これにより、アルゴリズムで時系列全体が使用されます。

• トレーニングデータが長すぎるために context_length を変更する場合は、十分な大きさであり、過去の複数の季節をカバーできることを確認してください。たとえば、毎日の時系列の場合、この値は365 日以上でなければなりません (ただし、その量のデータがある場合)。

NPTS のハイパーパラメータ次の表は、NPTS アルゴリズムで使用できるハイパーパラメータのリストです。


context_length モデルが予測を生成するために使用する過去の時間ポイントの数。デフォルトでは、トレーニング範囲内のすべての時点ポイントが使用されます。通常、このハイパーパラメータの値は大きくなければならず、過去の複数の季節をカ

75

Amazon Forecast 開発者ガイドProphet

パラメータ名説明:バーする必要があります。たとえば、毎日の時系列の場合、この値は 365 日以上である必要があります。

有効な値

正の整数デフォルト値

トレーニング時系列の長さ

kernel_type 過去の観測値のサンプリングに使用する重みを定義するためのカーネル。

有効な値

exponential または uniformデフォルト値

exponential

exp_kernel_weights kernel_type が exponential の場合にのみ有効です。

カーネルのスケーリングパラメータ。遠い過去の観測に割り当てられた重みをより速く (指数関数的に) 減衰させるためには、大きい値を使用してください。

有効な値

正の浮動小数点数デフォルト値

0.01

use_seasonal_model 季節性のバリアントを使用するかどうか。

有効な値

True または Falseデフォルト値

True

use_default_time_features季節性 NPTS および季節性気候学的予測機能のバリアントにのみ有効です。

季節性を判断するために時系列の詳細度に基づいて季節性の特徴を使用するかどうか。

有効な値

True または Falseデフォルト値

True

Prophet アルゴリズムProphet は、人気のある局所的なベイズ構造時系列モデルです。Amazon Forecast Prophet のアルゴリズムでは、Prophet の Python 実装の Prophet クラスを使用します。

76

https://facebook.github.io/prophet/

https://facebook.github.io/prophet/docs/quick_start.html#python-ap

Amazon Forecast 開発者ガイド仕組み

Prophet の仕組みProphet は、以下のようなデータセットに特に役立ちます。

• 長期 (月次、年次) にわたる詳細な履歴観測 (毎時、日次、週次) を含む• 複数の強い季節性を持つ• 以前に認識されていた、重要だが不規則なイベントを含む• データポイントがないか、大きな外れ値がある• 限界に近づいている非線形成長トレンドがある

Prophet は、区分線形またはロジスティック成長曲線の傾向を持つ加法回帰モデルです。このモデルには、フーリエ級数を使用してモデル化された季節性 (年) コンポーネントと、ダミー変数を使用してモデル化された季節性 (週) コンポーネントがあります。

詳細については、「Prophet: スケールに応じた予測」を参照してください。

Prophet のハイパーパラメータと関連する時系列Amazon Forecast は、デフォルトの Prophet のハイパーパラメータを使用します。Prophet は、関連する時系列もサポートしています。この機能は、関連する時系列 CSV ファイルで Amazon Forecast に提供されています。

77

https://research.fb.com/prophet-forecasting-at-scale/

https://facebook.github.io/prophet/docs/quick_start.html#python-ap


予測精度の評価さまざまな予測シナリオのアルゴリズムの精度を評価し、予測子を調整するには、予測子メトリクスを使用します。Amazon Forecast は、バックテストを使用してメトリクスを生成します。

Forecast は、以下の図のように、入力データをトレーニングデータセットとテストデータセットの 2 つのデータセットに自動的に分割します。また、Forecast は、CreatePredictor (p. 146) オペレーションで指定した BackTestWindowOffset パラメータを使用するか、指定しない場合は、ForecastHorizonパラメータのデフォルト値を使用して、入力データを分割する方法を決定します。詳細については、「EvaluationParameters (p. 231)」を参照してください。

次の図に示すように、仮想予測の開始日が異なる複数のバックテストシナリオでメトリクスを評価するには、CreatePredictor オペレーションで NumberOfBacktestWindows パラメータを使用します。NumberOfBacktestWindows パラメータのデフォルト値は 1 です。デフォルトを使用する場合、Forecast は、前述の単純な分割方法を使用します。数字です。

トレーニング後、Amazon Forecast は二乗平均平方根誤差 (RMSE) と重み付き分位点損失を計算して、各バックテストウィンドウのテストデータとすべてのバックテストウィンドウの平均値をモデルが予測する度合いを決定します。これらのメトリクスでは、モデルによって予測された値とテストデータセット内の実測値との差を測定します。メトリクスを取得するには、 GetAccuracyMetrics (p. 188) オペレーションを使用します。

二乗平均平方根誤差

78

https://en.wikipedia.org/wiki/Backtesting


RMSE は、誤差項の 2 乗です。これは、実際のターゲット値 yi,t と予測 (予測) 値 ŷi,t の差です。iは、1 から項目の合計数 n までの項目インデックスを表します。 t は、1 から評価期間の最終時刻 T までの範囲の時系列の時間インデックスを示します。

RMSE メトリクスでは、誤差の変動が大きいと RMSE が高くなるため、個々の誤差の大きさが一定のモデルに適しています。二乗誤差のため、それ以外の点では適切な予測に不適切な予測値があると RMSE が上昇する可能性があります。

予測量およびWAPE

予測分位 (間隔) は、予測の不確実性を表します。予測分位を計算することで、各予測にどれだけの不確実性が関連付けられているかをモデルで示すことができます。付随する予測分位がない場合、ポイント予測の価値は限られています。

過小予測と過大予測のコストが異なる場合は、異なる分位点で予測を推測する方法が特に便利です。Amazon Forecast では、10％、50％、および 90％の 3 つの異なる分位数で確率的予測を行い、各分位数で関連する損失 (エラー) を計算します。重み付けされた分位損失 (wQuantileLoss) は、予測がどちらの方向の実際の需要からどれだけ離れているかを計算します。これは、各分位点の平均需要に対する割合として計算されます。このメトリクスは、各分位点に固有のバイアスを捕捉するのに役立ち、これは、重みが等しいWAPE(Weighted Absolute Percentage Error)のような計算では捕捉できない。WAPEおよびRMSEと同様に、 wQuantileLoss エラーは、全体的な予測精度が高いことを示します。

重み付けされた分位損失は次のように計算されます。

qi,t(τ) は τ-モデルが予測する定量性 τ はセット{0.1、0.2、...、0.9}内にあります。

Amazon Forecast は、重み付き P10、P50、および P90 分位損失を計算します。ここで、τ はそれぞれセット {0.1, 0.5, 0.9} に含まれます。これは、標準の 80％信頼区間をカバーしています。RMSE の場合、Amazon Forecast は P50 予測を使用して予測値 (例: ŷi,t = qi,t(0.5)) を表します。

指定のバックテスト期間では、すべての項目とすべての時間の正確なターゲットの合計がほぼゼロの場合、加重分位損失式は未定義になります。この場合、 Amazon Forecast は、上記の分子である非加重分位点損失を出力します。 wQuantileLoss 式。

w数量損失[0.1]: P10予測については、実際の値は予測値の10%よりも低いことが予測されます。

たとえば、小売業者で、秋と冬にのみ売上が高くなる冬用手袋の製品需要を予測するとします。保管スペースがあまりなく、投資資本のコストが高い場合、または冬用手袋の在庫過剰の価格が懸念される場合は、P10 分位点を使用して、比較的少数の冬用手袋を注文できます。P10 予測では、冬用手袋の需要を10% のみ多めに見積もっているため、冬用手袋は 90％が売り切れになります。

w数量損失[0.5]: P50予測については、実際の値は予測値の50%よりも低いことが予想される。通常、内部、または他の予測ツールを使用して生成したポイント予測は、P50 予測と一致します。次の場合:τ = 0.5、両方の重みは等しく、 wQuantileLoss[0.5]は一般的に使用されるWAPE(Weighted AbsolutePercentage Error)に減少します。

79


ここで、ŷi,t = qi,t(0.5) とします。

Forecast では、スケール係数2を使用します。 wQuantileLoss 正確なWAPE式を求めるために0.5ファクターを逆算する式。

冬用手袋の例を続けると、手袋の需要が中程度であり、在庫が過剰になることを懸念していない場合は、P50 分位点を使用して手袋を注文することができます。

w数量損失[0.9]: P90予測については、実際の値は、予測値の90%よりも低いと予想される。

手袋の在庫が不足すると、たとえば莫大な収益の損失につながると判断した場合、手袋を販売しないコストが非常に高いか、投資資本のコストが低い場合、P90 分位点を使用して手袋を注文することを選択できます。

ガウス分布を含む予測の次の図は、予測を等確率の 4 つの領域に分割する分位数を示しています。分布の分位については、Wikipedia の「分位」を参照してください。

80

https://en.wikipedia.org/wiki/Quantile


データの更新新しいデータを収集するときに、そのデータを使用して新しい予測を生成することができます。Forecastは、更新されたデータセットをインポートするときに予想子を自動的に再トレーニングすることはしませんが、既存の予想子を使用して、更新されたデータで予測を生成できます。たとえば、毎日の売上データを収集し、予測に新しいデータポイントを含める場合、更新されたデータをインポートし、それを使用して予測を生成できます。新しい予想子をトレーニングする必要はありません。ただし、新しいデータから予想子をトレーニングする場合は、新しい予想子を作成する必要があります。

新しいデータから予測を生成する手順は、次のとおりです。

1. 更新された CSV ファイルを Amazon S3 バケットにアップロードします。更新された CSV には、既存のデータがすべて含まれているはずです。

2. 新しいデータを使用してデータセットのインポートジョブを作成します。最新のインポートジョブは、予測の生成元となるジョブです。

3. 既存の予想子を使用して新しい予測を作成します。4. 通常どおり予測を取得します。

81

Amazon Forecast 開発者ガイドタグの管理

Amazon Forecast リソースのタグ付け

タグは、特定のタイプの Amazon Forecast リソースなど、AWS リソースをオプションで定義および関連付けるラベルです。タグを使用することで、目的、所有者、環境、その他の条件など、さまざまな方法でリソースを分類および管理できます。たとえば、タグを使用してポリシーや自動化を適用したり、特定のコンプライアンス要件の対象となるリソースを識別したりできます。以下のタイプの Forecast リソースにタグを追加できます。

• データセットグループ• データセット• データセットインポートジョブ• 予測子• 予測• エクスポートジョブの予測

リソースには、最大 50 個のタグを含めることができます。

タグの管理タグはそれぞれ、1 つの必須タグキーとオプションの 1 つのタグ値で構成されており、どちらもお客様側が定義します。タグキーは、より具体的なタグ値のカテゴリのように動作する、一般的なラベルです。タグ値は、タグキーの記述子として機能します。たとえば、 Forecast データセットインポートジョブ(1つは内部テスト用、もう1つは実稼働用)、 Environment タグキーを両方のプロジェクトに割り当て。値Environment タグキーは Test データセットインポートジョブの 1 つのバージョンと Production 他のバージョン用。

タグキーには最大 128 文字を含めることができます。タグ値は最大 256 文字を含めることができます。Unicode 文字、数字、空白、または次の記号のいずれか 1 つを使用できます。_ . : / = + - さらに、タグには以下のような制限が追加されます。

• タグのキーと値では大文字と小文字が区別されます。• タグキーは、関連付けられたリソースごとにそれぞれ一意である必要があります。また、設定できる値

は 1 つのみです。• 使用しない aws:、 AWS:、またはキーのプレフィックスなどの大文字と小文字の組み合わせ。キーは、

AWS 使用。このプレフィックスのタグキーを編集または削除することはできません。値はこのプレフィックスを持つことができます。タグ値に aws キーは接頭語ではなく、 Forecast は、これをユーザータグとみなし、50 のタグの制限に対してカウントします。のキープレフィックスのみを持つタグaws リソース制限ごとにタグにカウントしません。

• タグのみに基づいて、リソースを更新または削除することはできません。使用する操作に応じて、Amazon リソースネーム (ARN) またはリソース ID も指定する必要があります。

• パブリックリソースまたは共有リソースにタグを関連付けることができます。ただし、タグは AWSアカウントでのみ使用でき、リソースを共有する他のアカウントでは使用できません。また、タグは、AWS アカウントに対して指定された AWS 地域にあるリソースでのみ利用できます。

82

Amazon Forecast 開発者ガイドIAM ポリシーでのタグの使用

タグキーおよび値を追加、表示、更新、および削除するには Forecast リソースは、 AWS Command LineInterface (AWS CLI)、 Forecast API、またはAWS SDK。

IAM ポリシーでのタグの使用タグの実装を開始した後、タグベースのリソースレベルのアクセス許可を AWS Identity and AccessManagement (IAM) ポリシーと API オペレーションに適用できます。これには、リソースの作成時にリソースへのタグの追加をサポートするオペレーションが含まれます。このようにタグを使用することで、AWS アカウントのどのグループとユーザーにリソースの作成とタグ付けのアクセス許可があって、どのグループとユーザーにタグの作成、更新、削除のアクセス許可があるかを、広範囲にきめ細かく制御できます。

たとえば、ユーザーがすべての Forecast リソースの名前が Owner リソースのタグ。

{ "Version": "2012-10-17", "Statement": [ { "Sid": "ModifyResourceIfOwner", "Effect": "Allow", "Action": "forecast:*", "Resource": "*", "Condition": { "StringEqualsIgnoreCase": { "aws:ResourceTag/Owner": "${aws:username}" } } } ]}

次の例は、データセットの作成および削除を許可するポリシーを作成する方法を示したものです。これらの操作は、ユーザー名が johndoe.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "forecast:CreateDataset", "forecast:DeleteDataset" ], "Resource": "arn:aws:forecast:*:*:dataset/*", "Condition": { "StringEquals": {"aws:username" : "johndoe"} } }, { "Effect": "Allow", "Action": "forecast:DescribeDataset", "Resource": "*" } ]}

タグをベースにしてリソースレベルでアクセス許可を定義した場合、そのアクセス許可は即座に反映されます。つまり、リソースが作成されるとすぐにリソースの安全性が増し、新しいリソースにタグの使用をすぐに強制できるようになります。リソースレベルのアクセス許可を使用して、新しいリソースと既存の

83

Amazon Forecast 開発者ガイドリソースにタグを追加する

リソースに、どのタグキーと値を関連付けるかを制御することもできます。詳細については、以下を参照してください。タグを使用したアクセスの制御の AWS IAM ユーザーガイド.

リソースにタグを追加する次の例は、 Forecast リソースは、 AWS CLI および AWS マネジメントコンソール.

AWS CLI

AWS CLI を使用して新しいリソースを作成し、タグを追加するには、そのリソースに適切なcreate コマンドを使用します。tags パラメータと値を含めます。たとえば、次のコマンドでは、myDataSet そして Environment タグキーと Test タグ値をデータセットに指定します。この例では、 schema は、schema.json コマンドを実行しているディレクトリと同じディレクトリにあります。

C:\> aws forecast create-dataset --dataset-name=myDataSet --dataset-type=RELATED_TIME_SERIES --domain=RETAIL --schema=file://schema.json --tags={Environment=Test}

を使用して、 Forecast リソースについては、 Forecast AWS CLI コマンドリファレンス.

既存のリソースにタグを追加するには、tag-resource コマンドを使用して、必須のパラメータに適切な値を指定します。

C:\> aws forecast tag-resource --resource-arn resource-arn --tags-model tags={key=value}

各パラメータの意味は次のとおりです。

• resource-arn タグを追加するリソースの Amazon リソース名 (ARN) です。• key は、リソースに追加するタグキーです。key 引数が必要です。• value は、指定したタグキー(key)。value 引数が必要です。リソースに特定のタグ値を含めない

場合、value 引数の値を指定しないでください。Forecast が空の文字列に値を設定します。

AWS マネジメントコンソール

作成時リソースin Forecastオプションのタグを追加できます。次の例では、データセットグループにタグを追加します。

タグを新規データセットグループ

1. Sign in to the AWS マネジメントコンソール and open the Amazon Forecast console at https://console.aws.amazon.com/forecast/.

2. [データセットグループの作成] を選択します。3. 対象: データセットグループ名、名前を入力してください。4. 対象: 予測領域、ドメインを選択します。5. 選択新しいタグを追加.6. 対象: キーおよび値、適切な値を入力します。

たとえば、それぞれ Environment および Test などです。7. タグを追加するには、新しいタグを追加.

リソースには最大 50 個のタグを追加できます。

84

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html

https://docs.aws.amazon.com/cli/latest/userguide/

https://docs.aws.amazon.com/cli/latest/reference/forecast/



Amazon Forecast 開発者ガイド追加情報

8. 選択次へリソースの作成を続行します。

追加情報タグ付けの詳細については、次のリソースを参照してください。

• AWSタギングの原則の AWS 一般参照• AWSタギング戦略 (ダウンロード可能なPDF)• AWSアクセス制御の AWS IAM ユーザーガイド• AWSタギングポリシーの AWS Organizations ユーザーガイド

85

https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html

https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html

Amazon Forecast 開発者ガイドデータ保護

Amazon Forecast でのセキュリティAWS では、クラウドのセキュリティが最優先事項です。AWS のお客様は、セキュリティを最も重視する組織の要件を満たすように構築されたデータセンターとネットワークアーキテクチャから利点を得られます。

セキュリティは、AWS とお客様の間の共有責任です。責任共有モデルでは、これをクラウドのセキュリティおよびクラウド内のセキュリティと説明しています。

• クラウドのセキュリティ – AWS は、AWS クラウド内で AWS サービスを実行するインフラストラクチャを保護する責任を担います。また、AWS は、使用するサービスを安全に提供します。AWSコンプライアンスプログラムの一環として、サードパーティーの監査が定期的にセキュリティの有効性をテストおよび検証しています。Amazon Forecast に適用するコンプライアンスプログラムの詳細については、「コンプライアンスプログラムによる AWS 対象範囲内サービス」を参照してください。

• クラウド内のセキュリティ – お客様の責任はお客様が使用する AWS のサービスによって決まります。また、お客様は、お客様のデータの機密性、企業の要件、および適用可能な法律および規制などの他の要因についても責任を担います。

このドキュメントは、Forecast を使用する際に共有責任モデルを適用する方法を理解するのに役立ちます。以下のトピックでは、セキュリティおよびコンプライアンスの目的を達成するために Forecast を設定する方法を示します。また、Forecast リソースのモニタリングや保護に役立つ他の AWS サービスの使用方法についても説明します。

トピック• Amazon Forecast でのデータ保護 (p. 86)• Amazon Forecast の Identity and access management (p. 87)• Amazon Forecast のログ記録とモニタリング (p. 100)• Amazon Forecast のコンプライアンス検証 (p. 103)• Amazon Forecast の耐障害性 (p. 103)• Amazon Forecast のインフラストラクチャセキュリティ (p. 104)

Amazon Forecast でのデータ保護Amazon Forecast は、データ保護の規制やガイドラインを含む AWS 責任共有モデルに準拠しています。AWS は、AWS のすべてのサービスを実行するグローバルなインフラストラクチャを保護する責任を担います。また、AWS は、カスタマーコンテンツおよび個人データを取り扱うためのセキュリティ構成の統制など、このインフラストラクチャ上でホストされるデータ管理を維持します。データコントローラーまたはデータプロセッサーとして機能する、AWS のお客様および APN パートナーは、AWS クラウドに保存された個人データに対する責任を担います。

データ保護目的の場合、AWS アカウント認証情報を保護して IAM (AWS Identity and AccessManagement) で個々のユーザーアカウントをセットアップし、そのユーザーに各自の職務を果たすために必要なアクセス許可のみが付与されるようにすることをお勧めします。また、以下の方法でデータを保護することをお勧めします。

• 各アカウントで多要素認証 (MFA) を使用します。

86

http://aws.amazon.com/compliance/shared-responsibility-model/

http://aws.amazon.com/compliance/programs/


http://aws.amazon.com/compliance/services-in-scope/

http://aws.amazon.com/compliance/shared-responsibility-model/

Amazon Forecast 開発者ガイド保管時の暗号化

• SSL/TLS を使用して AWS リソースと通信します。

• AWS CloudTrail で API とユーザーアクティビティログをセットアップします。• AWS 暗号化ソリューションを、AWS サービス内のすべてのデフォルトのセキュリティ管理と一緒に使

用します。• Amazon Macie などの高度なマネージドセキュリティサービスを使用します。これにより、Amazon

Simple Storage Service (Amazon S3) に保存される個人データの検出と保護が支援されます。

顧客のアカウント番号などの機密の識別情報は、[名前] フィールドなどの自由形式のフィールドに配置しないことを強くお勧めします。これは、コンソール、API、AWS CLI、または AWS で Forecast または他の AWS サービスを使用する場合も同様です。Forecast または他のサービスに入力したデータはすべて、診断ログの内容として取得される可能性があります。外部サーバーへの URL を指定するときは、そのサーバーへのリクエストを検証するための認証情報を URL に含めないでください。

データ保護の詳細については、AWS セキュリティブログのブログ投稿「AWS の責任共有モデルとGDPR」を参照してください。

保管時の暗号化独自の AWS キー管理サービス (AWS KMS) 対称キーのいずれかを使用して、Amazon S3 バケット内のForecast データを暗号化します。

転送中の暗号化Amazon Forecast は、アカウントからデータをコピーし、内部 AWS システムで処理します。AmazonForecast では、TLS 1.2 を AWS 証明書で使用して、他の AWS サービスに送信されるデータを暗号化します。

キーの管理デフォルトの Amazon S3 キーは AWS によって管理されます。お客様が提供する AWS Key ManagementService (AWS KMS) キーを管理するのは、お客様の責任です。

Amazon Forecast の Identity and accessmanagement

AWS Identity and Access Management (IAM) は、管理者が AWS リソースへのアクセスを安全にコントロールするために役立つ AWS のサービスです。IAM 管理者は、Forecast リソースを使用するために認証(サインイン) および承認 (アクセス許可を持つ) される者を制御します。IAM は、追加料金なしで使用できる AWS のサービスです。

トピック• Audience (p. 88)• アイデンティティを使用した認証 (p. 88)• ポリシーを使用したアクセスの管理 (p. 90)• Amazon Forecast と IAM の連携 (p. 91)• Amazon Forecast アイデンティティベースのポリシーの例 (p. 93)

87

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

https://docs.aws.amazon.com/kms/latest/developerguide/overview.html

https://docs.aws.amazon.com/kms/latest/developerguide/overview.html

Amazon Forecast 開発者ガイドAudience

• Amazon Forecast でのアイデンティティとアクセスに関するトラブルシューティング (p. 98)

AudienceAWS Identity and Access Management (IAM) の用途は、Forecast で行う作業によって異なります。

サービスユーザー – ジョブを実行するために Forecast サービスを使用する場合は、管理者が必要なアクセス許可と認証情報を用意します。作業を実行するためにさらに多くの Forecast 機能を使用するとき、追加のアクセス許可が必要になる場合があります。アクセスの管理方法を理解すると、管理者から適切なアクセス許可をリクエストするのに役に立ちます。Forecast の機能にアクセスできない場合は、「AmazonForecast でのアイデンティティとアクセスに関するトラブルシューティング (p. 98)」を参照してください。

サービス管理者 – 社内の Forecast リソースを担当している場合は、おそらく Forecast へのフルアクセスがあります。従業員がどの Forecast 機能とリソースアクセスする必要があるかを決定するのは管理者の仕事です。その後で、サービスユーザーのアクセス許可を変更するために、IAM 管理者にリクエストを送信する必要があります。IAM の基本概念については、このページの情報を確認します。お客様の会社でForecast の IAM を利用する方法の詳細については、「Amazon Forecast と IAM の連携 (p. 91)」を参照してください。

IAM 管理者 – IAM 管理者は、Forecast へのアクセスを管理するポリシーの作成方法の詳細について確認する場合があります。IAM で使用できる Forecast アイデンティティベースのポリシーの例を表示するには、「Amazon Forecast アイデンティティベースのポリシーの例 (p. 93)」を参照してください。

アイデンティティを使用した認証認証は、アイデンティティ認証情報を使用して AWS にサインインする方法です。AWS マネジメントコンソールを使用するサインインの詳細については、IAM ユーザーガイドの「IAM コンソールとサインインページ」を参照してください。

AWS アカウントのルートユーザー、IAM ユーザーとして、または IAM ロールを引き受けて、認証されている (AWS にサインインしている) 必要があります。会社のシングルサインオン認証を使用することも、Google や Facebook を使用してサインインすることもできます。このような場合、管理者は以前にIAM ロールを使用して ID フェデレーションを設定しました。他の会社の認証情報を使用して AWS にアクセスした場合、ロールを間接的に割り当てられています。

AWS マネジメントコンソールへ直接サインインするには、ルートユーザー E メールまたは IAM ユーザー名とパスワードを使用します。ルートユーザーまたは IAM を使用して AWS にプログラム的にアクセスできます。AWS では、SDK とコマンドラインツールを提供して、お客様の認証情報を使用して、リクエストに暗号で署名できます。AWS ツールを使用しない場合は、リクエストに自分で署名する必要があります。これには、インバウンド API リクエストを認証するためのプロトコル、署名バージョン 4 を使用します。リクエストの認証の詳細については、AWS General Referenceの「署名バージョン 4 の署名プロセス」を参照してください。

使用する認証方法を問わず、追加のセキュリティ情報の提供を要求される場合もあります。たとえば、AWS では多要素認証 (MFA) を使用してアカウントのセキュリティを高めることを推奨しています。詳細については、IAM ユーザーガイドの「AWS のデバイスに多要素認証 (MFA) を使用」を参照してください。

AWS アカウントのルートユーザーAWS アカウントを初めて作成する場合は、このアカウントのすべての AWS サービスとリソースに対して完全なアクセス権限を持つシングルサインインアイデンティティで始めます。このアイデンティティはAWS アカウントルートユーザーと呼ばれ、アカウントの作成に使用した E メールアドレスとパスワードでのサインインによりアクセスします。強くお勧めしているのは、日常的なタスクには、それが管理者タスクであっても、ルートユーザーを使用しないことです。代わりに、最初の IAM ユーザーを作成するため

88

https://docs.aws.amazon.com/IAM/latest/UserGuide/console.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/console.html

https://console.aws.amazon.com/

https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users

Amazon Forecast 開発者ガイドアイデンティティを使用した認証

だけにルートユーザーを使用するというベストプラクティスに従います。その後、ルートユーザー認証情報を安全な場所に保管し、それらを使用して少数のアカウントおよびサービス管理タスクのみを実行します。

IAM ユーザーとグループIAM ユーザーは、単一のユーザーまたはアプリケーションに特定のアクセス許可がある AWS アカウント内のアイデンティティです。IAM ユーザーは、ユーザー名とパスワード、アクセスキーのセットなど、長期的な認証情報を持つことができます。アクセスキーを生成する方法の詳細については、IAM ユーザーガイドの「IAM ユーザーのアクセスキーの管理」を参照してください。IAM ユーザーにアクセスキーを生成するとき、必ずキーペアを表示して安全に保存してください。後になって、シークレットアクセスキーを回復することはできません。新しいアクセスキーペアを生成する必要があります。

IAM グループは、IAM ユーザーのコレクションを指定するアイデンティティです。グループとしてサインインすることはできません。グループを使用して、一度に複数のユーザーに対してアクセス許可を指定できます。多数の組のユーザーがある場合、グループを使用すると管理が容易になります。たとえば、IAMAdmin という名前のグループを設定して、そのグループに IAM リソースを管理するアクセス許可を与えることができます。

ユーザーは、ロールとは異なります。ユーザーは 1 人の特定の人またはアプリケーションに一意に関連付けられますが、ロールはそれを必要とする任意の人が引き受けるようになっています。ユーザーには永続的な長期の認証情報がありますが、ロールでは一時的な認証情報が利用できます。詳細については、IAMユーザーガイドの「IAM ユーザーの作成が適している場合 (ロールではなく)」を参照してください。

IAM ロールIAM ロールは、特定のアクセス許可を持つ、AWS アカウント内のアイデンティティです。これは IAMユーザーに似ていますが、特定のユーザーに関連付けられていません。ロールを切り替えて、AWS マネジメントコンソールで IAM ロールを一時的に引き受けることができます。ロールを引き受けるには、AWSCLI または AWS API オペレーションを呼び出すか、カスタム URL を使用します。ロールを使用する方法の詳細については、IAM ユーザーガイドの「IAM ロールの使用」を参照してください。

IAM ロールと一時的な認証情報は、次の状況で役立ちます。

• 一時的な IAM ユーザーアクセス許可 – IAM ユーザーは、特定のタスクに対して複数の異なるアクセス許可を一時的に IAM ロールで引き受けることができます。

• フェデレーティッドユーザーアクセス – IAM ユーザーを作成する代わりに、AWS Directory Service、エンタープライズユーザーディレクトリ、またはウェブ ID プロバイダーに既存のアイデンティティを使用できます。このようなユーザーはフェデレーティッドユーザーと呼ばれます。AWS では、ID プロバイダーを通じてアクセスがリクエストされたとき、フェデレーティッドユーザーにロールを割り当てます。フェデレーティッドユーザーの詳細については、IAM ユーザーガイドの「フェデレーティッドユーザーとロール」を参照してください。

• クロスアカウントアクセス – IAM ロールを使用して、自分のアカウントのリソースにアクセスすることを別のアカウントの信頼済みプリンシパルに許可できます。ロールは、クロスアカウントアクセスを許可する主な方法です。ただし、一部の AWS のサービスでは、(ロールをプロキシとして使用する代わりに) リソースにポリシーを直接アタッチできます。クロスアカウントアクセスでのロールとリソースベースのポリシーの違いの詳細については、IAM ユーザーガイドの「IAM ロールとリソースベースのポリシーとの相違点」を参照してください。

• AWS サービスアクセス – サービスロールは、サービスがお客様に代わってお客様のアカウントでアクションを実行するために引き受ける IAM ロールです。一部の AWS のサービス環境を設定するときに、サービスが引き受けるロールを定義する必要があります。このサービスロールには、サービスが必要とする AWS のリソースにサービスがアクセスするために必要なすべてのアクセス権限を含める必要があります。サービスロールはサービスによって異なりますが、多くのサービスロールでは、そのサービスの文書化された要件を満たしている限り、アクセス権限を選択することができます。サービスロールは、お客様のアカウント内のみでアクセスを提供します。他のアカウントのサービスへのアクセス権を付与するためにサービスロールを使用することはできません。IAM 内部からロールを作成、修正、削除できます。たとえば、Amazon Redshift がお客様に代わって Amazon S3 バケットにアクセスし、バケッ

89

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose


https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-console.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_access-management.html#intro-access-roles

https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_access-management.html#intro-access-roles

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html


Amazon Forecast 開発者ガイドポリシーを使用したアクセスの管理

トからデータを Amazon Redshift クラスターにロードすることを許可するロールを作成できます。詳細については、IAM ユーザーガイドのAWS サービスにアクセス権限を委任するロールの作成を参照してください。

• Amazon EC2で実行されているアプリケーション – IAM ロールを使用して、EC2 インスタンスで実行され、AWS CLI または AWS API リクエストを作成しているアプリケーションの一時的な認証情報を管理できます。これは、EC2 インスタンス内でのアクセスキーの保存に推奨されます。AWS ロールを EC2インスタンスに割り当て、そのすべてのアプリケーションで使用できるようにするには、インスタンスにアタッチされたインスタンスプロファイルを作成します。インスタンスプロファイルにはロールが含まれ、EC2 インスタンスで実行されるプログラムは一時認証情報を取得することができます。詳細については、IAM ユーザーガイドの「Amazon EC2 インスタンスで実行されるアプリケーションに IAM ロールを使用してアクセス権限を付与する」を参照してください。

IAM ロールを使用するべきかどうかについては、IAM ユーザーガイドの「IAM ロール (ユーザーではない)の作成が適している場合」を参照してください。

ポリシーを使用したアクセスの管理AWS でアクセスをコントロールするには、ポリシーを作成して IAM アイデンティティや AWS リソースにアタッチします。ポリシーは AWS のオブジェクトであり、アイデンティティやリソースに関連付けて、これらのアクセス許可を定義します。AWS は、エンティティ (ルートユーザー、IAM ユーザーまたはIAM ロール) によってリクエストが行われると、それらのポリシーを評価します。ポリシーでのアクセス許可により、リクエストが許可されるか拒否されるかが決まります。大半のポリシーは JSON ドキュメントとして AWS に保存されます。JSON ポリシードキュメントの構造と内容の詳細については、IAM ユーザーガイドの「JSON ポリシー概要」を参照してください。

IAM 管理者は、ポリシーを使用して、AWS リソースへのアクセスを許可するユーザーと、これらのリソースで実行できるアクションを指定できます。すべての IAM エンティティ (ユーザーまたはロール) は、アクセス許可のない状態からスタートします。言い換えると、デフォルト設定では、ユーザーは何もできず、自分のパスワードを変更することすらできません。何かを実行するアクセス許可をユーザーに付与するには、管理者がユーザーにアクセス許可ポリシーをアタッチする必要があります。また、管理者は、必要なアクセス許可があるグループにユーザーを追加できます。管理者がグループにアクセス許可を付与すると、そのグループ内のすべてのユーザーにこれらのアクセス許可が付与されます。

IAM ポリシーは、オペレーションの実行方法を問わず、アクションのアクセス許可を定義します。たとえば、iam:GetRole アクションを許可するポリシーがあるとします。このポリシーがあるユーザーは、AWS マネジメントコンソール、AWS CLI、または AWS API からロールの情報を取得できます。

アイデンティティベースのポリシーアイデンティティベースのポリシーは、IAM ユーザー、ロール、グループなどのアイデンティティにJSON ドキュメントとしてアタッチできるアクセス許可ポリシーです。これらのポリシーは、アイデンティティが実行できるアクション、リソース、および条件を制御します。アイデンティティベースのポリシーを作成する方法については、IAM ユーザーガイドの「IAM ポリシーの作成」を参照してください。

アイデンティティベースのポリシーは、さらにインラインポリシーまたは管理ポリシーに分類できます。インラインポリシーは、単一のユーザー、グループ、またはロールに直接埋め込まれています。管理ポリシーは、AWS アカウント内の複数のユーザー、グループ、およびロールにアタッチできるスタンドアロンポリシーです。管理ポリシーには、AWS 管理ポリシーとカスタマー管理ポリシーが含まれます。管理ポリシーまたはインラインポリシーのいずれかを選択する方法については、IAM ユーザーガイドの「管理ポリシーとインラインポリシーの比較」を参照してください。

リソースベースのポリシーリソースベースのポリシーは、Amazon S3 バケットなどのリソースにアタッチする JSON ポリシードキュメントです。サービス管理者は、これらのポリシーを使用して、特定のプリンシパル (アカウントメンバー、ユーザー、またはロール) がそのリソースに対して実行する条件およびアクションを定義するこ

90

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose_role

https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose_role

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#choosing-managed-or-inline

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#choosing-managed-or-inline

Amazon Forecast 開発者ガイドAmazon Forecast と IAM の連携

とができます。リソースベースのポリシーはインラインポリシーです。マネージド型のリソースベースのポリシーはありません。

アクセスコントロールリスト (ACL)アクセスコントロールリスト (ACL) は、どのプリンシパル (アカウントメンバー、ユーザー、またはロール) にリソースへのアクセス許可を付与するかを制御する一種のポリシーです。ACL は、リソースベースのポリシーと似ていますが、JSON ポリシードキュメント形式を使用しません。ACL をサポートするサービスとして Amazon S3、AWS WAF、Amazon VPC などがあります。ACL の詳細については、『AmazonSimple Storage Service 開発者ガイド』の「アクセスコントロールリスト (ACL) の概要」を参照してください。

その他のポリシータイプAWS では、別のあまり一般的ではないポリシータイプもサポートしています。これらのポリシータイプでは、より一般的なポリシータイプで付与された最大のアクセス許可を設定できます。

• アクセス許可の境界 – アクセス許可の境界は、アイデンティティベースのポリシーが IAM エンティティ(IAM ユーザーまたはロール) に付与できるアクセス許可の上限を設定する高度な機能です。エンティティのアクセス許可の境界を設定できます。結果として得られるアクセス許可は、エンティティの IDベースのポリシーとそのアクセス許可の境界の共通部分です。Principal フィールドでユーザーまたはロールを指定するリソースベースのポリシーは、アクセス許可の境界では制限されません。これらのポリシーのいずれかを明示的に拒否した場合、その許可は無効になります。アクセス許可の境界の詳細については、IAM ユーザーガイドの「IAM エンティティのアクセス許可の境界」を参照してください。

• サービスコントロールポリシー (SCP) – SCP は、AWS Organizations で組織や組織単位 (OU) に最大権限を指定する JSON ポリシーです。AWS Organizations は、お客様のビジネスが所有する複数の AWSアカウントをグループ化し、一元的に管理するサービスです。組織内のすべての機能を有効にすると、サービス制御ポリシー (SCP) を一部またはすべてのアカウントに適用できます。SCP はメンバーアカウントのエンティティに対するアクセス許可を制限します (各 AWS アカウントのルートユーザーなど)。Organizations および SCP の詳細については、AWS Organizations ユーザーガイドの「SCP の動作」を参照してください。

• セッションポリシー – セッションポリシーは、ロールまたはフェデレーティッドユーザーの一時セッションをプログラムで作成する際にパラメータとして渡す高度なポリシーです。結果として得られるセッションのアクセス許可は、ユーザーまたはロールの ID ベースのポリシーとセッションポリシーの共通部分です。また、リソースベースのポリシーからアクセス許可が派生する場合もあります。これらのポリシーのいずれかを明示的に拒否した場合、その許可は無効になります。詳細については、IAM ユーザーガイドの「セッションポリシー」を参照してください。

複数のポリシータイプ1 つのリクエストに複数のタイプのポリシーが適用されると、結果として作成されるアクセス許可を理解するのがさらに複雑になります。複数のポリシータイプが関連するとき、リクエストを許可するかどうかを AWS が決定する方法の詳細については、IAM ユーザーガイドの「ポリシーの評価ロジック」を参照してください。

Amazon Forecast と IAM の連携IAM を使用して、Amazon Forecast へのアクセスを管理するには、Forecast で使用できる IAM の機能を理解しておく必要があります。どのように Forecast およびその他 AWS サービスはIAMと連携する。参照AWS 連携するサービス IAM の IAM ユーザーガイド.

トピック• Forecast アイデンティティベースのポリシー (p. 92)• ForecastIAM ロール (p. 93)

91

https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

Amazon Forecast 開発者ガイドAmazon Forecast と IAM の連携

Forecast アイデンティティベースのポリシーIAM アイデンティティベースのポリシーでは、許可または拒否されたアクションやリソースを指定でき、さらにアクションが許可または拒否された条件を指定できます。Forecast は、特定のアクション、リソース、条件キーをサポートします。JSON ポリシーで使用するすべての要素については、以下を参照してください。 IAM JSON ポリシー要素参照の IAM ユーザーガイド.

ActionsIAM アイデンティティベースのポリシーの Action エレメントは、そのポリシーにより許可または拒否される特定のアクションについて説明します。ポリシーアクションの名前は通常、関連する AWS API オペレーションと同じです。このアクションは、関連付けられたオペレーションを実行するためのアクセス許可を付与するポリシーで使用されます。

ポリシーアクション Forecast アクションの前に次のプレフィックスを使用します。forecast:。たとえば、 CreateDatasetGroup API 操作では、 forecast:CreateDatasetGroup 行動に取り組めます。ポリシーステートメントには、Action または NotAction 要素を含める必要があります。Forecast は、このサービスで実行できるタスクを説明する独自の一連のアクションを定義します。

単一のステートメントに複数のアクションを指定するには、次のようにコンマで区切ります。

"Action": [ "forecast:action1", "forecast:action2"

ワイルドカード (*) を使用して複数のアクションを指定できます。たとえば、Describe という単語で始まるすべてのアクションを指定するには、以下のアクションを含めます。

"Action": "forecast:Describe*"

Forecast のアクションを一覧表示するには、IAM ユーザーガイドの「Actions Defined by AmazonForecast」を参照してください。

ResourcesResource エレメントは、アクションが適用されるオブジェクトを指定します。ステートメントには、Resource または NotResource エレメントを含める必要があります。ARN を使用して、またはステートメントがすべてのリソースに適用されることを示すワイルドカード (*) を使用して、リソースを指定します。

Amazon Forecast データセットリソースには、次の ARN があります。

arn:${Partition}:forecast:${Region}:${Account}:dataset/${DatasetName}

ARN の形式の詳細については、「Amazon リソースネーム (ARN) と AWS サービスの名前空間」を参照してください。

たとえば、ステートメントで MyDataset というデータセットを指定するには、次の ARN を使用します。

"Resource": "arn:aws:forecast:us-east-1:123456789012:dataset/MyDataset"

特定のアカウントに属するすべてのデータセットを指定するには、ワイルドカード (*) を使用します。

"Resource": "arn:aws:forecast:us-east-1:123456789012:dataset/*"

92

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awskeymanagementservice.html#amazonforecast-actions-as-permissions


https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Amazon Forecast 開発者ガイドアイデンティティベースのポリシーの例

リソースの作成など、一部の Forecast アクションは、特定のリソースで実行できません。このような場合は、ワイルドカード (*) を使用する必要があります。

"Resource": "*"

Forecast リソースタイプおよびその ARN のリストを表示するには、IAM ユーザーガイドの「ResourcesDefined by Amazon Forecast」を参照してください。どのアクションで、各リソースの ARN を指定することができるかについては、「Actions Defined by Amazon Forecast」を参照してください。

条件キー

Forecast は、サービス固有の条件キーを提供しません。

Examples

Forecast アイデンティティベースのポリシーの例を表示するには、「Amazon Forecast アイデンティティベースのポリシーの例 (p. 93)」を参照してください。

ForecastIAM ロールIAM ロールは、特定のアクセス許可を持つ、AWS アカウント内のエンティティです。

Forecast を使用した一時的な認証情報の使用

一時的な認証情報を使用して、フェデレーションでサインイン、IAM ロールを引き受ける、またはクロスアカウントロールを引き受けることができます。一時的なセキュリティ認証情報を取得するには、AssumeRole または GetFederationToken などの AWS STS API オペレーションを呼び出します。

Forecast では、一時認証情報の使用をサポートしています。

サービスにリンクされたロール

サービスにリンクされたロールによって、AWS サービスが他のサービスのリソースにアクセスして自動的にアクションを完了できます。サービスにリンクされたロールは、IAM アカウント内に表示され、サービスによって所有されます。IAM 管理者は、サービスにリンクされたロールのアクセス許可を表示できますが、編集することはできません。

Forecast ではサービスにリンクされたロールをサポートしていません。

サービスロール

この機能では、サービスのロールをユーザーに代わって引き受けることをサービスに許可します。このロールにより、サービスはお客様に代わって他のサービスのリソースにアクセスし、アクションを実行できます。サービスロールは、IAM アカウントに表示され、サービスによって所有されます。つまり、IAM管理者は、このロールのアクセス許可を変更できます。ただし、これを行うことにより、サービスの機能が損なわれる場合があります。

Forecast ではサービスロールがサポートされています。

Amazon Forecast アイデンティティベースのポリシーの例デフォルトでは、IAM ユーザーおよびロールには、Forecast リソースを作成または変更するアクセス許可はありません。また、AWS マネジメントコンソールや AWS CLI、AWS API を使用してタスクを実行す

93

https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awskeymanagementservice.html#amazonforecast-resources-for-iam-policies

https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awskeymanagementservice.html#amazonforecast-resources-for-iam-policies



https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html

https://docs.aws.amazon.com/STS/latest/APIReference/API_GetFederationToken.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-role


ることもできません。IAM 管理者は、ユーザーとロールに必要な、指定されたリソースで特定の API オペレーションを実行するアクセス許可をユーザーとロールに付与する IAM ポリシーを作成する必要があります。続いて、管理者はそれらのアクセス許可が必要な IAM ユーザーまたはグループにそのポリシーをアタッチします。

作成方法を学ぶには IAM JSONポリシードキュメントの例を使用するIDベースのポリシーについては、を参照してください。 [JSON]タブでのポリシーの作成の IAM ユーザーガイド.

トピック• ポリシーのベストプラクティス (p. 94)• Forecast コンソールの使用 (p. 94)• ユーザーに自分のアクセス許可の表示を許可 (p. 95)• Amazon Forecast の AWS 管理 (事前定義) ポリシー (p. 96)• お客様が管理するポリシーの例 (p. 96)

ポリシーのベストプラクティスアイデンティティベースのポリシーは非常に強力です。アカウント内で、Forecast リソースを作成、アクセス、または削除できるかどうかを決定します。これらのアクションを実行すると、AWS アカウントに追加料金が発生する可能性があります。アイデンティティベースのポリシーを作成または編集するときは、以下のガイドラインと推奨事項に従います。

• AWS 管理ポリシーの使用を開始する – Forecast の使用をすばやく開始するには、AWS 管理ポリシーを使用して、従業員に必要なアクセス許可を付与します。これらのポリシーはアカウントですでに有効になっており、AWS によって管理および更新されています。詳細については、IAM ユーザーガイドの「AWS 管理ポリシーを使用したアクセス許可の使用開始」を参照してください。

• 最小権限を付与する – カスタムポリシーを作成するときは、タスクを実行するために必要なアクセス許可のみを付与します。最小限のアクセス権限から開始し、必要に応じて追加のアクセス権限を付与します。この方法は、寛容なアクセス権限で始め、後でそれらを強化しようとするよりも安全です。詳細については、IAM ユーザーガイドの「最小権限を付与する」を参照してください。

• 機密性の高いオペレーションに MFA を有効にする – 追加セキュリティとして、機密性の高リソースまたは API オペレーションにアクセスするために IAM ユーザーに対して、多要素認証 (MFA) の使用を要求します。詳細については、IAM ユーザーガイドの「AWS のデバイスに多要素認証 (MFA) を使用」を参照してください。

• 追加セキュリティに対するポリシー条件を使用する – 実行可能な範囲内で、アイデンティティベースのポリシーがリソースにアクセスできる条件を定義します。たとえば、要求が発生しなければならない許容 IP アドレスの範囲を指定するための条件を記述できます。指定された日付または時間範囲内でのみリクエストを許可する条件を書くことも、SSL や MFA の使用を要求することもできます。ポリシー要素の詳細については、IAM ユーザーガイドの「IAM JSON ポリシー要素: 条件」を参照してください。

Forecast コンソールの使用Amazon Forecast コンソールにアクセスするには、一連の最小限のアクセス許可が必要です。これらのアクセス許可により、AWS アカウントの Forecast リソースの詳細をリストおよび表示できます。最小限必要なアクセス許可よりも制限されたアイデンティティベースのポリシーを作成すると、そのポリシーをアタッチしたエンティティ (IAM ユーザーまたはロール) に対してはコンソールが意図したとおりに機能しません。

これらのエンティティが Forecast コンソールを使用できるように、エンティティに次の AWS 管理対象ポリシーもアタッチします。詳細については、以下を参照してください。ユーザーへの権限の追加の IAMユーザーガイド:

AWSForecastFullAccess

94

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-json-editor

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-use-aws-defined-policies

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console


次のポリシーは、コンソールを使用するときにすべての Amazon Forecast アクションへのフルアクセスを許可します。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "forecast:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringEquals": { "iam:PassedToService": "forecast.amazonaws.com" } } } ]}

AWS CLI または AWS API のみを呼び出すユーザーには、最小限のコンソールアクセス許可を付与する必要はありません。代わりに、実行しようとしている API オペレーションに一致するアクションのみへのアクセスが許可されます。

ユーザーに自分のアクセス許可の表示を許可この例では、ユーザー ID にアタッチされたインラインおよび管理ポリシーの表示を IAM ユーザーに許可するポリシーを作成する方法を示します。このポリシーには、コンソールで、または AWS CLI か AWSAPI を使用してプログラム的に、このアクションを完了するアクセス許可が含まれています。

{ "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies",

95


"iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ]}

Amazon Forecast の AWS 管理 (事前定義) ポリシーAWS は、AWS によって作成および管理されるスタンドアロンの IAM ポリシーが提供する多くの一般的ユースケースに対応します。これらの AWS 管理ポリシーは、一般的ユースケースに必要なアクセス許可を付与することで、どのアクセス許可が必要なのかをユーザーが調査する必要をなくすことができます。詳細については、IAM ユーザーガイドの「AWS 管理ポリシー」を参照してください。

アカウントのユーザーにアタッチ可能な以下の AWS 管理ポリシーは、Amazon Forecast に固有のものです。

• AmazonForecastFullAccess – Amazon Forecast のリソースおよびサポートされているすべてのオペレーションにフルアクセスできます。

これらのアクセス許可ポリシーについては、IAM コンソールにサインインしてそれらを検索することで確認できます。

独自のカスタム IAM ポリシーを作成して、Amazon Forecast のアクションとリソースに対するアクセス許可を付与することもできます。これらのカスタムポリシーは、それらを必要とする IAM ユーザーにアタッチできます。

お客様が管理するポリシーの例このセクションでは、さまざまな Amazon Forecast アクションのアクセス権限を付与するユーザーポリシー例を示しています。これらのポリシーは、AWS SDK、または AWS CLI を使用しているときに適用できます。コンソールを使用している場合は、「Forecast コンソールの使用 (p. 94)」を参照してください。

例• 例 1 アカウント管理者の権限付与 (p. 96)• 例 2 すべてを許可 Amazon Forecast アクション (p. 97)• 例 3 アクションベースのポリシー: Amazon Forecast 読み取り専用アクセス (p. 97)

例 1 アカウント管理者の権限付与

アカウントを設定した後で (「AWS にサインアップする (p. 18)」を参照)、管理者ユーザーを作成し、アカウントを管理します。管理者ユーザーは、ユーザーを作成してそのアクセス許可を管理できます。

アカウントで使用可能なすべてのアクセス許可を管理者ユーザーに付与するには、そのユーザーに次のアクセス許可ポリシーをアタッチします

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "*",

96

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies


"Resource": "*" } ]}

例 2 すべてを許可 Amazon Forecast アクション

すべての Amazon Forecast アクションに対するアクセス許可を持ち、他のサービスに対するアクセス許可を持たないユーザーを作成することを選択できます (このユーザーをサービス固有の管理者と見なします)。このユーザーに以下のアクセス許可ポリシーをアタッチします。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "forecast:*" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "*", "Condition": { "StringEquals": { "iam:PassedToService": "forecast.amazonaws.com" } } } ]}

例 3 アクションベースのポリシー: Amazon Forecast 読み取り専用アクセス

以下のポリシーでは、リソースを一覧表示して説明する Amazon Forecast アクションを実行するためのアクセス権限をユーザーに付与します。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "forecast:DescribeDataset", "forecast:DescribeDatasetGroup", "forecast:DescribeDatasetImportJob", "forecast:DescribeForecast", "forecast:DescribeForecastExportJob", "forecast:DescribePredictor", "forecast:ListDatasetGroups", "forecast:ListDatasetImportJobs", "forecast:ListDatasets", "forecast:ListDatasetExportJobs", "forecast:ListForecasts", "forecast:ListPredictors" ], "Resource": "*" }

97

Amazon Forecast 開発者ガイドトラブルシューティング

]}

Amazon Forecast でのアイデンティティとアクセスに関するトラブルシューティング次の情報は、Forecast と IAM の使用に伴って発生する可能性がある一般的な問題の診断や修復に役立ちます。

トピック• Forecast でのアクションの実行を承認されていない (p. 98)• iam:PassRole を実行する権限がない (p. 98)• マイアクセスキーを表示したい (p. 99)• 管理者として Forecast へのアクセスを他のユーザーに許可したい (p. 99)• 自分の AWS アカウント以外のユーザーに Forecast リソースへのアクセスを許可したい (p. 99)

Forecast でのアクションの実行を承認されていないAWS マネジメントコンソールから、アクションを実行する権限がないと通知された場合、管理者に問い合わせ、サポートを依頼する必要があります。お客様のユーザー名とパスワードを発行したのが、担当の管理者です。

次の例は、 mateojackson IAM ユーザーはコンソールを使用して、widget ですが、forecast:GetWidget 許可。

User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: forecast:GetWidget on resource: my-example-widget

この場合、Mateo は管理者に依頼し、forecast:GetWidget アクションを使用して my-example-widget リソースにアクセスできるようにポリシーを更新してもらいます。

iam:PassRole を実行する権限がないiam:PassRole アクションを実行する権限がないというエラーが表示された場合、管理者に問い合わせ、サポートを依頼する必要があります。お客様のユーザー名とパスワードを発行したのが、担当の管理者です。Forecast にロールを渡すことができるようにポリシーを更新するよう、管理者に依頼します。

一部の AWS サービスでは、新しいサービスロールまたはサービスにリンクされたロールを作成せずに、既存のロールをサービスに渡すことができます。そのためには、サービスにロールを渡すアクセス許可が必要です。

以下の例のエラーは、marymajor という IAM ユーザーがコンソールを使用して Forecast でアクションを実行しようする場合に発生します。ただし、アクションでは、サービスロールによって付与されたアクセス許可がサービスにある必要があります。メアリーには、ロールをサービスに渡すアクセス許可がありません。

User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole

この場合、メアリーは担当の管理者に iam:PassRole アクションを実行できるようにポリシーの更新を依頼します。

98

Amazon Forecast 開発者ガイドトラブルシューティング

マイアクセスキーを表示したいIAM ユーザーアクセスキーを作成した後は、いつでもアクセスキー ID を表示できます。ただし、シークレットアクセスキーをもう一度表示することはできません。シークレットアクセスキーを紛失した場合は、新しいキーペアを作成する必要があります。

アクセスキーは、アクセスキー ID (例: AKIAIOSFODNN7EXAMPLE) とシークレットアクセスキー (例:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY) の 2 つの部分から構成されます。ユーザー名とパスワードと同様に、リクエストを認証するために、アクセスキー ID とシークレットアクセスキーの両方を使用する必要があります。ユーザー名とパスワードと同様に、アクセスキーをしっかり管理してください。

Important

正規ユーザー ID を確認するためであっても、アクセスキーをサードパーティーに提供しないでください。提供すると、第三者がアカウントへの永続的アクセスを取得する場合があります。

アクセスキーペアを作成する場合、アクセスキー ID とシークレットアクセスキーを安全な場所に保存するように求めるプロンプトが表示されます。このシークレットアクセスキーは、作成時にのみ使用できます。シークレットアクセスキーを紛失した場合、新しいアクセスキーを IAM ユーザーに追加する必要があります。最大 2 つのアクセスキーを持つことができます。すでに 2 つある場合は、新しいキーペアを作成する前に、いずれかを削除する必要があります。手順を表示するには、IAM ユーザーガイドの「アクセスキーの管理」を参照してください。

管理者として Forecast へのアクセスを他のユーザーに許可したいForecast へのアクセスを他のユーザーに許可するには、アクセスを必要とする人またはアプリケーションの IAM エンティティ (ユーザーまたはロール) を作成する必要があります。ユーザーは、このエンティティの認証情報を使用して AWS にアクセスします。次に、Forecast の適切なアクセス許可を付与するポリシーを、そのエンティティにアタッチする必要があります。

すぐに開始するには、IAM ユーザーガイドの「IAM が委任した最初のユーザーおよびグループの作成」を参照してください。

自分の AWS アカウント以外のユーザーに Forecast リソースへのアクセスを許可したい他のアカウントのユーザーや組織外のユーザーが、リソースへのアクセスに使用できるロールを作成できます。ロールを引き受けるように信頼されたユーザーを指定することができます。リソースベースのポリシーまたはアクセスコントロールリスト (ACL) をサポートするサービスの場合、それらのポリシーを使用して、リソースへのアクセスを付与できます。

詳細については、以下を参照してください。

• Forecast でこれらの機能がサポートされるかどうかを確認するには、「Amazon Forecast と IAM の連携 (p. 91)」を参照してください。

• 所有している AWS アカウント間でリソースへのアクセスを付与する方法については、IAM ユーザーガイドの「所有している別の AWS アカウントへのアクセスを IAM ユーザーに許可」を参照してください。

• サードパーティーの AWS アカウントにリソースへのアクセスを提供する方法については、IAM ユーザーガイドの「第三者が所有する AWS アカウントへのアクセス権を付与する」を参照してください。

• ID フェデレーションを介してアクセスを提供する方法については、IAM ユーザーガイドの「外部で認証されたユーザー (ID フェデレーション) へのアクセスの許可」を参照してください。

99

https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey

https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-delegated-user.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_aws-accounts.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_federated-users.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_federated-users.html

Amazon Forecast 開発者ガイドログ記録とモニタリング

• クロスアカウントアクセスでのロールとリソースベースのポリシーの使用の違いの詳細については、IAM ユーザーガイドの「IAM ロールとリソースベースのポリシーとの相違点」を参照してください。

Amazon Forecast のログ記録とモニタリングモニタリングは、Amazon Forecast アプリケーションの信頼性、可用性、パフォーマンスを維持する上で重要な部分です。Amazon Forecast API コールをモニタリングするには、AWS CloudTrail を使用できます。Forecast アセットとプロセスのステータスをモニタリングするには、Amazon CloudWatch を使用します。

トピック• AWS CloudTrail を使用した Forecast API コールのログ作成 (p. 100)• Amazon Forecast の CloudWatch メトリクス (p. 102)

AWS CloudTrail を使用した Forecast API コールのログ作成Amazon Forecast は、Forecast のユーザー、ロール、または AWS のサービスによって実行されたアクションを記録するサービスである AWS CloudTrail と統合されています。CloudTrail は、Forecast のすべての API コールをイベントとしてキャプチャします。キャプチャされた呼び出しには、Forecast コンソールの呼び出しと、Forecast API オペレーションへのコード呼び出しが含まれます。証跡を作成する場合は、Forecast のイベントなど、Amazon Simple Storage Service (Amazon S3) バケットへの CloudTrail イベントの継続的デリバリーを有効にすることができます。証跡を設定しない場合でも、CloudTrail コンソールの [Event history (イベント履歴)] で最新のイベントを表示できます。CloudTrail によって収集された情報を使用して、リクエストの作成元の IP アドレス、リクエストの実行者、リクエストの実行日時などの詳細を調べて、Forecast に対してどのようなリクエストが行われたかを判断できます。

CloudTrail の詳細については、「AWS CloudTrail User Guide」を参照してください。

CloudTrail 内の Forecast 情報CloudTrail は、アカウント作成時に AWS アカウントで有効になります。Forecast でアクティビティが発生すると、そのアクティビティは [Event history (イベント履歴)] の AWS の他のサービスのイベントとともに CloudTrail イベントに記録されます。最近のイベントは、AWS アカウントで表示、検索、ダウンロードできます。詳細については、「CloudTrail イベント履歴でのイベントの表示」を参照してください。

Forecastのイベントなど、AWS アカウントのイベントの継続的な記録については、証跡を作成します。証跡により、CloudTrail はログファイルを Amazon S3 バケットに配信できます。デフォルトでは、コンソールで作成した証跡がすべての AWS リージョンに適用されます。証跡では、AWS パーティションのすべてのリージョンからのイベントがログに記録され、指定した Amazon S3 バケットにログファイルが配信されます。さらに、より詳細な分析と AWS ログで収集されたデータに基づいた行動のためにその他のCloudTrail サービスを設定できます。詳細については、以下を参照してください。

• 証跡を作成するための概要• CloudTrail でサポートされるサービスと統合• CloudTrail の Amazon SNS 通知の設定• 「複数のリージョンから CloudTrail ログファイルを受け取る」と「複数のアカウントから CloudTrail ロ

グファイルを受け取る」

100


https://docs.aws.amazon.com/awscloudtrail/latest/userguide/

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html

Amazon Forecast 開発者ガイドAWS CloudTrail を使用した Forecast API コールのログ作成

Forecast アクションはすべて CloudTrail によって記録されます。また、これらのアクションは AmazonForecast Developer Guideで説明されています。たとえば、CreateDataset と CreateForecast の各アクションを呼び出すと、CloudTrail ログファイルにエントリが生成されます。

各イベントまたはログエントリには、リクエストの生成者に関する情報が含まれます。この ID 情報は以下のことを確認するのに役立ちます。

• リクエストが、ルートまたは AWS Identity and Access Management (IAM) ユーザー認証情報のどちらを使用して送信されたかどうか。

• リクエストが、ロールとフェデレーティッドユーザーのどちらの一時的なセキュリティ認証情報を使用して送信されたか.

• リクエストが、別の AWS サービスによって送信されたかどうか。

詳細については、「CloudTrail userIdentity 要素」を参照してください。

Forecast ログファイルエントリの概要証跡は、指定した Amazon S3 バケットにイベントをログファイルとして配信できる設定です。CloudTrailログファイルには、1 つ以上のログエントリが含まれます。イベントは任意の送信元からの単一のリクエストを表し、リクエストされたアクション、アクションの日時、リクエストのパラメータなどに関する情報が含まれます。CloudTrail ログファイルは、パブリック API コールの順序付けられたスタックトレースではないため、特定の順序では表示されません。

次の例は、CreateDataset アクションを表す CloudTrail ログエントリの例です。

{ "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "AIDAIQ4PAJSMEEPNEXAMPLE", "arn": "arn:aws:iam::acct-id:user/userxyz", "accountId": "111111111111", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "userxyz" }, "eventTime": "2018-11-21T23:53:06Z", "eventSource": "forecast.amazonaws.com", "eventName": "CreateDataset", "awsRegion": "us-west-2", "sourceIPAddress": "192.168.0.1", "userAgent": "Boto3/1.7.82 Python/3.6.5 Linux/4.14.72-68.55.amzn1.x86_64 Botocore/1.10.84", "requestParameters": { "domain": "CUSTOM", "datasetType": "TARGET_TIME_SERIES", "dataFormat": "CSV", "datasetName": "forecast_test_script_ds", "dataFrequency": "D", "timeStampFormat": "yyyy-MM-dd", "schema": { "attributes": [ { "attributeName": "item_id", "attributeType": "string" }, { "attributeName": "timestamp", "attributeType": "timestamp" },

101

https://docs.aws.amazon.com/forecast/latest/dg/

https://docs.aws.amazon.com/forecast/latest/dg/

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html

Amazon Forecast 開発者ガイドAmazon Forecast の CloudWatch メトリクス

{ "attributeName": "target_value", "attributeType": "float" }, { "attributeName": "visits", "attributeType": "float" }, { "attributeName": "was_open", "attributeType": "float" }, { "attributeName": "promotion_applied", "attributeType": "float" } ] } }, "responseElements": { "datasetName": "forecast_test_script_ds", "datasetArn": "arn:aws:forecast:us-west-2:acct-id:ds/forecast_test_script_ds" }, "requestID": "EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE", "eventID": "EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE", "eventType": "AwsApiCall", "recipientAccountId": "111111111111"}

Amazon Forecast の CloudWatch メトリクスこのセクションでは Amazon Forecast で使用できる Amazon CloudWatch メトリクスについて説明します。

次のテーブルには、Amazon Forecast メトリクスが一覧表示されています。

メトリクスディメンション

単位統計説明

DatasetSize Kilobytes Average、Sum、Min、MaxAmazon Forecast によってお客様のアカウントにインポートされたデータセットの合計サイズ。

DatasetSize DatasetArn

DatasetImportJobArn

Kilobytes Average、SumCreateDatasetImportJob (p. 136) オペレーションによってインポートされたデータセットのサイズ。

CreatePredictorExecutionTimePredictorArn Seconds Average、Sum特定の予測子のトレーニング、推論、およびメトリクスにかかる時間。 AmazonForecast は、トレーニングジョブで消費される時間数に到達するように、計算コストを c5.xlarge インスタンスに正規化します。

CreateForecastExecutionTimeForecastArn Seconds Average、Sum予測生成中のトレーニングと推論にかかった時間。 Amazon Forecast は、トレーニングジョブで消費される時間数に到達するように、計算コストを c5.xlarge インスタンスに正規化します。

102

Amazon Forecast 開発者ガイドコンプライアンス検証

メトリクスディメンション

単位統計説明

TimeSeriesForecastsGenerated カウント Average、Sum、Min、Maxアカウント内のすべての予測子にわたって分位ごとに生成された一意の時系列予測の数。予測は最も近い 1,000 に切り上げられ、1,000 ごとに請求されます。

TimeSeriesForecastsGeneratedPredictorArn カウント Average、Sum、Min、Maxアカウント内のすべての予測子にわたって分位ごとに生成された一意の時系列予測の数。予測は最も近い 1,000 に切り上げられ、1,000 ごとに請求されます。

TimeSeriesForecastsGeneratedPredictorArn

ForecastArn

カウント Average、Sum、Min、Maxアカウント内のすべての予測子にわたって分位ごとに生成された一意の時系列予測の数。予測は最も近い 1,000 に切り上げられ、1,000 ごとに請求されます。

Amazon Forecast のコンプライアンス検証サードパーティーの監査者は、複数の Amazon Forecast コンプライアンスプログラムの一環として AWSのセキュリティとコンプライアンスを評価します。このプログラムには、SOC、PCI、HIPAA などがあります。

特定のコンプライアンスプログラムの対象となる AWS サービスのリストについては、「コンプライアンスプログラムによる AWS 対象範囲内のサービス」を参照してください。一般的な情報については、「AWS コンプライアンスプログラム」を参照してください。

サードパーティーの監査レポートをダウンロードするには、AWS Artifact を使用します。詳細については、「AWS Artifact でレポートをダウンロードする」を参照してください。

Forecast サービスを使用する際のお客様のコンプライアンス責任は、データの機密性、貴社のコンプライアンス目的、および適用法規や規則によって決まります。AWS ではコンプライアンスに役立つ以下のリソースを用意しています。

• セキュリティおよびコンプライアンスのクイックスタートガイド – これらのデプロイガイドでは、アーキテクチャ上の考慮事項について説明し、セキュリティとコンプライアンスに重点を置いたベースライン環境を AWS でデプロイするための手順を説明します。

• HIPAA のセキュリティとコンプライアンスに関するホワイトペーパーを作成する – このホワイトペーパーでは、企業が AWS を使用して HIPAA 準拠のアプリケーションを作成する方法について説明します。

• AWS コンプライアンスのリソース – このワークブックおよびガイドのコレクションは、お客様の業界や場所に適用される場合があります。

• AWS Config 開発者ガイドの「ルールでのリソースの評価」– AWS Config サービスでは、リソース設定が社内のプラクティス、業界のガイドライン、規制にどの程度適合しているかを評価します。

• AWS Security Hub – この AWS サービスでは、AWS 内のセキュリティ状態を包括的に表示しており、セキュリティ業界の標準およびベストプラクティスへの準拠を確認するのに役立ちます。

Amazon Forecast の耐障害性AWS のグローバルインフラストラクチャは AWS リージョンとアベイラビリティーゾーンを中心として構築されます。AWS リージョンには、低レイテンシー、高いスループット、そして高度の冗長ネットワークで接続されている複数の物理的に独立・隔離されたアベイラビリティーゾーンがあります。アベイラビリ

103




https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html

http://aws.amazon.com/quickstart/?awsf.quickstart-homepage-filter=categories%23security-identity-compliance

https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf

http://aws.amazon.com/compliance/resources/

https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html

https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html

Amazon Forecast 開発者ガイドインフラストラクチャセキュリティ

ティーゾーンでは、ゾーン間で中断することなく自動的にフェイルオーバーするアプリケーションとデータベースを設計および運用することができます。アベイラビリティーゾーンは、従来の単一または複数のデータセンターインフラストラクチャよりも可用性、耐障害性、および拡張性が優れています。

AWS リージョンとアベイラビリティーゾーンの詳細については、「AWS グローバルインフラストラクチャ」を参照してください。

Amazon Forecast のインフラストラクチャセキュリティ

マネージド型サービスとして、Amazon Forecast は、ホワイトペーパー「Amazon Web Services: AWS セキュリティプロセスの概要」に記載されているAWS グローバルネットワークセキュリティの手順で保護されています。

AWS が公開した API コールを使用して、ネットワーク経由で Forecast にアクセスします。クライアントで Transport Layer Security (TLS) 1.0 以降がサポートされている必要があります。TLS 1.2 以降が推奨されています。また、Ephemeral Diffie-Hellman (DHE) や Elliptic Curve Ephemeral Diffie-Hellman (ECDHE)などの Perfect Forward Secrecy (PFS) を使用した暗号スイートもクライアントでサポートされている必要があります。これらのモードは、Java 7 以降など、最近のほとんどのシステムでサポートされています。

また、リクエストは、アクセスキー ID と、IAM プリンシパルに関連付けられているシークレットのアクセスキーを使用して署名する必要があります。または、AWS Security Token Service (AWS STS) を使用して、一時的なセキュリティ認証情報を生成し、リクエストに署名することもできます。

104

http://aws.amazon.com/about-aws/global-infrastructure/

http://aws.amazon.com/about-aws/global-infrastructure/

https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf

https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf

https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html

Amazon Forecast 開発者ガイドAWS でサポートされているリージョン

ガイドラインとクォータ次のセクションでは、 Amazon Forecast ガイドラインとクォータです。

トピック• AWS でサポートされているリージョン (p. 105)• Compliance (p. 105)• サービスクォータ (p. 105)

AWS でサポートされているリージョン一覧については、 AWS サポートする地域 Forecast、を参照 AWS 領域とエンドポイントの Amazon WebServices 一般リファレンス.

ComplianceForecast コンプライアンスプログラムの詳細については、「AWS コンプライアンス」、「AWS コンプライアンスプログラム」、および「コンプライアンスプログラムによる AWS 対象範囲内のサービス」を参照してください。

サービスクォータForecast には、次のサービスクォータがあります。

クォータは、 CreateDatasetImportJob (p. 136) API

Resource デフォルトの制限

Amazon S3 バケットのファイルの最大数 10,000

Amazon S3 バケット内のすべてのファイルの最大累積サイズ

30 GB

データセットグループのデータセットの最大数 3 (タイプごとに 1)

データセットの行の最大数 10 億

ターゲット時系列データセットの列の最大数

(必須列 + 追加の予測ディメンション)

13 (3 + 10)

関連する時系列データセットの列の最大数

(必須列 + 追加の予測ディメンション + 関連する特徴)

25 (2 + 10 + 13)

項目メタデータデータセットの列の最大数 10*

105

https://docs.aws.amazon.com/general/latest/gr/rande.html#forecast_region

https://aws.amazon.com/compliance/

https://aws.amazon.com/compliance/programs/

https://aws.amazon.com/compliance/programs/

https://aws.amazon.com/compliance/services-in-scope

Amazon Forecast 開発者ガイドサービスクォータ

クォータは、 CreatePredictor (p. 146) API


最大 NumberOfBacktestWindows(EvaluationParameters (p. 231))

5*

予測子ごとの予測の最大数

(項目数 X ターゲット時系列データセットの予測ディメンションの固有値の数)

すべてのターゲット時系列項目とディメンションで 1.000.000。

(たとえば、1.000.000 のアイテム、10.000 の場所に 100 のアイテム、100 の都市の 100 の倉庫に100 のアイテムを置くことができます。)

100.000個を超えると Forecast は、より詳細な頻度(時間単位など)ではなく、年単位、月単位、週単位、日単位の頻度をサポートします。

予測期間 500 データポイントまたはターゲット時系列データセットの長さの 1/3 の小さい方

一般リソースクォータ


CreateDatasetImportJob タスクの最大同時実行数

3.

CreatePredictor タスクの最大同時実行数 3.

CreateForecast (p. 140) タスクの最大同時実行数 3.

データセットインポートジョブの最大数 1000*

データセットグループの最大数 500**

最大データセット数 1,500

予測子の最大数 500**

予測の最大数 10*

予測エクスポートジョブの最大数 1000*

並列予測エクスポートジョブの最大数 3.

予測をクエリできる最大時間 (コンソールまたはQueryForecast (p. 215) API)

30 日間

リソースに追加できるタグの最大数 $50

予測の最大数クエリーできるQueryForecast (p. 215) API

大規模データセットで作成される5件を含む10件の同時予測(20 GBまたは100.000品目を超えるもの)。

大規模なデータセットを使用して作成された予測が 5 つ以上ある場合は、 QueryForecast は、最新の5つの大規模データセット予測のみにアクセスできます。

106


予約フィールド名Amazon Forecast では次の名前が予約されています。スキーマフィールドまたはデータセットヘッダーにこれらの名前を使用することはできません。

A

• A

• ABORT

• ABS

• ABSOLUTE

• ACCESS

• ACTION

• ADA

• ADD

• ADMIN

• AFTER

• AGGREGATE

• ALIAS

• ALL

• ALLOCATE

• ALSO

• ALTER

• ALWAYS

• ANALYSE

• ANALYZE

• AND

• ANY

• ARE

• ARRAY

• AS

• ASC

• ASENSITIVE

• ASSERTION

• ASSIGNMENT

• ASYMMETRIC

• AT

• ATOMIC

• ATTRIBUTE

• ATTRIBUTES

• AUDIT

• AUTHORIZATION

• AUTO_INCREMENT

• AVG

107


• AVG_ROW_LENGTH

B

• BACKUP

• BACKWARD

• BEFORE

• BEGIN

• BERNOULLI

• BETWEEN

• BIGINT

• BINARY

• BIT

• BIT_LENGTH

• BITVAR

• BLOB

• BOOL

• BOOLEAN

• BOTH

• BREADTH

• BREAK

• BROWSE

• BULK

• BY

C

• C

• CACHE

• CALL

• CALLED

• CARDINALITY

• CASCADE

• CASCADED

• CASE

• CAST

• CATALOG

• CATALOG_NAME

• CEIL

• CEILING

• CHAIN

• CHANGE

• CHAR

• CHAR_LENGTH

• CHARACTER

• CHARACTER_LENGTH

108


• CHARACTER_SET_CATALOG

• CHARACTER_SET_NAME

• CHARACTER_SET_SCHEMA

• CHARACTERISTICS

• CHARACTERS

• CHECK

• CHECKED

• CHECKPOINT

• CHECKSUM

• CLASS

• CLASS_ORIGIN

• CLOB

• CLOSE

• CLUSTER

• CLUSTERED

• COALESCE

• COBOL

• COLLATE

• COLLATION

• COLLATION_CATALOG

• COLLATION_NAME

• COLLATION_SCHEMA

• COLLECT

• COLUMN

• COLUMN_NAME

• COLUMNS

• COMMAND_FUNCTION

• COMMAND_FUNCTION_CODE

• COMMENT

• COMMIT

• COMMITTED

• COMPLETION

• COMPRESS

• COMPUTE

• CONDITION

• CONDITION_NUMBER

• CONNECT

• CONNECTION

• CONNECTION_NAME

• CONSTRAINT

• CONSTRAINT_CATALOG

• CONSTRAINT_NAME

• CONSTRAINT_SCHEMA

• CONSTRAINTS

• CONSTRUCTOR

109


• CONTAINS

• CONTAINSTABLE

• CONTINUE

• CONVERSION

• CONVERT

• COPY

• CORR

• CORRESPONDING

• COUNT

• COVAR_POP

• COVAR_SAMP

• CREATE

• CREATEDB

• CREATEROLE

• CREATEUSER

• CROSS

• CSV

• CUBE

• CUME_DIST

• CURRENT

• CURRENT_DATE

• CURRENT_DEFAULT_TRANSFORM_GROUP

• CURRENT_PATH

• CURRENT_ROLE

• CURRENT_TIME

• CURRENT_TIMESTAMP

• CURRENT_TRANSFORM_GROUP_FOR_TYPE

• CURRENT_USER

• CURSOR

• CURSOR_NAME

• CYCLE

D

• DATA

• DATABASE

• DATABASES

• DATETIME

• DATETIME_INTERVAL_CODE

• DATETIME_INTERVAL_PRECISION

• DAY

• DAY_HOUR

• DAY_MICROSECOND

• DAY_MINUTE

• DAY_SECOND

• DAYOFMONTH

110


• DAYOFWEEK

• DAYOFYEAR

• DBCC

• DEALLOCATE

• DEC

• DECIMAL

• DECLARE

• DEFAULT

• DEFAULTS

• DEFERRABLE

• DEFERRED

• DEFINED

• DEFINER

• DEGREE

• DELAY_KEY_WRITE

• DELAYED

• DELETE

• DELIMITER

• DELIMITERS

• DENSE_RANK

• DENY

• DEPTH

• DEREF

• DERIVED

• DESC

• DESCRIBE

• DESCRIPTOR

• DESTROY

• DESTRUCTOR

• DETERMINISTIC

• DIAGNOSTICS

• DICTIONARY

• DISABLE

• DISCONNECT

• DISK

• DISPATCH

• DISTINCT

• DISTINCTROW

• DISTRIBUTED

• DIV

• DO

• DOMAIN

• DOUBLE

• DROP

• DUAL

• DUMMY

111


• DUMP

• DYNAMIC

• DYNAMIC_FUNCTION

• DYNAMIC_FUNCTION_CODE

E

• EACH

• ELEMENT

• ELSE

• ELSEIF

• ENABLE

• ENCLOSED

• ENCODING

• ENCRYPTED

• END

• END-EXEC

• ENUM

• EQUALS

• ERRLVL

• ESCAPE

• ESCAPED

• EVERY

• EXCEPT

• EXCEPTION

• EXCLUDE

• EXCLUDING

• EXCLUSIVE

• EXEC

• EXECUTE

• EXISTING

• EXISTS

• EXIT

• EXP

• EXPLAIN

• EXTERNAL

• EXTRACT

F

• FALSE

• FETCH

• FIELDS

• FILE

• FILLFACTOR

• FILTER

112


• FINAL

• FIRST

• FLOAT

• FLOAT4

• FLOAT8

• FLOOR

• FLUSH

• FOLLOWING

• FOR

• FORCE

• FOREIGN

• FORTRAN

• FORWARD

• FOUND

• FREE

• FREETEXT

• FREETEXTTABLE

• FREEZE

• FROM

• FULL

• FULLTEXT

• FUNCTION

• FUSION

G

• G

• GENERAL

• GENERATED

• GET

• GLOBAL

• GO

• GOTO

• GRANT

• GRANTED

• GRANTS

• GREATEST

• GROUP

• GROUPING

H

• HANDLER

• HAVING

• HEADER

• HEAP

113


• HIERARCHY

• HIGH_PRIORITY

• HOLD

• HOLDLOCK

• HOST

• HOSTS

• HOUR

• HOUR_MICROSECOND

• HOUR_MINUTE

• HOUR_SECOND

I

• IDENTIFIED

• IDENTITY

• IDENTITY_INSERT

• IDENTITYCOL

• IF

• IGNORE

• ILIKE

• IMMEDIATE

• IMMUTABLE

• IMPLEMENTATION

• IMPLICIT

• IN

• INCLUDE

• INCLUDING

• INCREMENT

• INDEX

• INDICATOR

• INFILE

• INFIX

• INHERIT

• INHERITS

• INITIAL

• INITIALIZE

• INITIALLY

• INNER

• INOUT

• INPUT

• INSENSITIVE

• INSERT

• INSERT_ID

• INSTANCE

• INSTANTIABLE

• INSTEAD

114


• INT

• INT1

• INT2

• INT3

• INT4

• INT8

• INTEGER

• INTERSECT

• INTERSECTION

• INTERVAL

• INTO

• INVOKER

• IS

• ISAM

• ISNULL

• ISOLATION

• ITERATE

J

• JOIN

K USD

• K

• KEY

• KEY_MEMBER

• KEY_TYPE

• KEYS

• KILL

L

• LANCOMPILER

• LANGUAGE

• LARGE

• LAST

• LAST_INSERT_ID

• LATERAL

• LEADING

• LEAST

• LEAVE

• LEFT

• LENGTH

• LESS

• LEVEL

• LIKE

115


• LIMIT

• LINENO

• LINES

• LISTEN

• LN

• LOAD

• LOCAL

• LOCALTIME

• LOCALTIMESTAMP

• LOCATOR

• LOCK

• LOGIN

• LOGS

• LONG

• LONGBLOB

• LONGTEXT

• LOOP

• LOW_PRIORITY

• LOWER

M

• M

• MAP

• MATCH

• MATCHED

• MAX

• MAX_ROWS

• MAXEXTENTS

• MAXVALUE

• MEDIUMBLOB

• MEDIUMINT

• MEDIUMTEXT

• MEMBER

• MERGE

• MESSAGE_LENGTH

• MESSAGE_OCTET_LENGTH

• MESSAGE_TEXT

• METHOD

• MIDDLEINT

• MIN

• MIN_ROWS

• MINUS

• MINUTE

• MINUTE_MICROSECOND

• MINUTE_SECOND

116


• MINVALUE

• MLSLABEL

• MOD

• MODE

• MODIFIES

• MODIFY

• MODULE

• MONTH

• MONTHNAME

• MORE

• MOVE

• MULTISET

• MUMPS

• MYISAM

N

• NAME

• NAMES

• NATIONAL

• NATURAL

• NCHAR

• NCLOB

• NESTING

• NEW

• NEXT

• NO

• NO_WRITE_TO_BINLOG

• NOAUDIT

• NOCHECK

• NOCOMPRESS

• NOCREATEDB

• NOCREATEROLE

• NOCREATEUSER

• NOINHERIT

• NOLOGIN

• NONCLUSTERED

• NONE

• NORMALIZE

• NORMALIZED

• NOSUPERUSER

• NOT

• NOTHING

• NOTIFY

• NOTNULL

• NOWAIT

117


• NULL

• NULLABLE

• NULLIF

• NULLS

• NUMBER

• NUMERIC

O

• OBJECT

• OCTET_LENGTH

• OCTETS

• OF

• OFF

• OFFLINE

• OFFSET

• OFFSETS

• OIDS

• OLD

• ON

• ONLINE

• ONLY

• OPEN

• OPENDATASOURCE

• OPENQUERY

• OPENROWSET

• OPENXML

• OPERATION

• OPERATOR

• OPTIMIZE

• OPTION

• OPTIONALLY

• OPTIONS

• OR

• ORDER

• ORDERING

• ORDINALITY

• OTHERS

• OUT

• OUTER

• OUTFILE

• OUTPUT

• OVER

• OVERLAPS

• OVERLAY

• OVERRIDING

118


• OWNER

P

• PACK_KEYS

• PAD

• PARAMETER

• PARAMETER_MODE

• PARAMETER_NAME

• PARAMETER_ORDINAL_POSITION

• PARAMETER_SPECIFIC_CATALOG

• PARAMETER_SPECIFIC_NAME

• PARAMETER_SPECIFIC_SCHEMA

• PARAMETERS

• PARTIAL

• PARTITION

• PASCAL

• PASSWORD

• PATH

• PCTFREE

• PERCENT

• PERCENT_RANK

• PERCENTILE_CONT

• PERCENTILE_DISC

• PLACING

• PLAN

• PLI

• POSITION

• POSTFIX

• POWER

• PRECEDING

• PRECISION

• PREFIX

• PREORDER

• PREPARE

• PREPARED

• PRESERVE

• PRIMARY

• PRINT

• PRIOR

• PRIVILEGES

• PROC

• PROCEDURAL

• PROCEDURE

• PROCESS

• PROCESSLIST

119


• PUBLIC

• PURGE

Q

• QUOTE

R

• RAID0

• RAISERROR

• RANGE

• RANK

• RAW

• READ

• READS

• READTEXT

• REAL

• RECHECK

• RECONFIGURE

• RECURSIVE

• REF

• REFERENCES

• REFERENCING

• REGEXP

• REGR_AVGX

• REGR_AVGY

• REGR_COUNT

• REGR_INTERCEPT

• REGR_R2

• REGR_SLOPE

• REGR_SXX

• REGR_SXY

• REGR_SYY

• REINDEX

• RELATIVE

• RELEASE

• RELOAD

• RENAME

• REPEAT

• REPEATABLE

• REPLACE

• REPLICATION

• REQUIRE

• RESET

• RESIGNAL

120


• RESOURCE

• RESTART

• RESTORE

• RESTRICT

• RESULT

• RETURN

• RETURNED_CARDINALITY

• RETURNED_LENGTH

• RETURNED_OCTET_LENGTH

• RETURNED_SQLSTATE

• RETURNS

• REVOKE

• RIGHT

• RLIKE

• ROLE

• ROLLBACK

• ROLLUP

• ROUTINE

• ROUTINE_CATALOG

• ROUTINE_NAME

• ROUTINE_SCHEMA

• ROW

• ROW_COUNT

• ROW_NUMBER

• ROWCOUNT

• ROWGUIDCOL

• ROWID

• ROWNUM

• ROWS

• RULE

S

• SAVE

• SAVEPOINT

• SCALE

• SCHEMA

• SCHEMA_NAME

• SCHEMAS

• SCOPE

• SCOPE_CATALOG

• SCOPE_NAME

• SCOPE_SCHEMA

• SCROLL

• SEARCH

• SECOND

121


• SECOND_MICROSECOND

• SECTION

• SECURITY

• SELECT

• SELF

• SENSITIVE

• SEPARATOR

• SEQUENCE

• SERIALIZABLE

• SERVER_NAME

• SESSION

• SESSION_USER

• SET

• SETOF

• SETS

• SETUSER

• SHARE

• SHOW

• SHUTDOWN

• SIGNAL

• SIMILAR

• SIMPLE

• SIZE

• SMALLINT

• SOME

• SONAME

• SOURCE

• SPACE

• SPATIAL

• SPECIFIC

• SPECIFIC_NAME

• SPECIFICTYPE

• SQL

• SQL_BIG_RESULT

• SQL_BIG_SELECTS

• SQL_BIG_TABLES

• SQL_CALC_FOUND_ROWS

• SQL_LOG_OFF

• SQL_LOG_UPDATE

• SQL_LOW_PRIORITY_UPDATES

• SQL_SELECT_LIMIT

• SQL_SMALL_RESULT

• SQL_WARNINGS

• SQLCA

• SQLCODE

• SQLERROR

122


• SQLEXCEPTION

• SQLSTATE

• SQLWARNING

• SQRT

• SSL

• STABLE

• START

• STARTING

• STATE

• STATEMENT

• STATIC

• STATISTICS

• STATUS

• STDDEV_POP

• STDDEV_SAMP

• STDIN

• STDOUT

• STORAGE

• STRAIGHT_JOIN

• STRICT

• STRING

• STRUCTURE

• STYLE

• SUBCLASS_ORIGIN

• SUBLIST

• SUBMULTISET

• SUBSTRING

• SUCCESSFUL

• SUM

• SUPERUSER

• SYMMETRIC

• SYNONYM

• SYSDATE

• SYSID

• SYSTEM

• SYSTEM_USER

T

• TABLE

• TABLE_NAME

• TABLES

• TABLESAMPLE

• TABLESPACE

• TEMP

• TEMPLATE

123


• TEMPORARY

• TERMINATE

• TERMINATED

• TEXT

• TEXTSIZE

• THAN

• THEN

• TIES

• TIME

• TIMEZONE_HOUR

• TIMEZONE_MINUTE

• TINYBLOB

• TINYINT

• TINYTEXT

• TO

• TOAST

• TOP

• TOP_LEVEL_COUNT

• TRAILING

• TRAN

• TRANSACTION

• TRANSACTION_ACTIVE

• TRANSACTIONS_COMMITTED

• TRANSACTIONS_ROLLED_BACK

• TRANSFORM

• TRANSFORMS

• TRANSLATE

• TRANSLATION

• TREAT

• TRIGGER

• TRIGGER_CATALOG

• TRIGGER_NAME

• TRIGGER_SCHEMA

• TRIM

• TRUE

• TRUNCATE

• TRUSTED

• TSEQUAL

• TYPE

U

• UESCAPE

• UID

• UNBOUNDED

• UNCOMMITTED

124


• UNDER

• UNDO

• UNENCRYPTED

• UNION

• UNIQUE

• UNKNOWN

• UNLISTEN

• UNLOCK

• UNNAMED

• UNNEST

• UNSIGNED

• UNTIL

• UPDATE

• UPDATETEXT

• UPPER

• USAGE

• USE

• USER

• USER_DEFINED_TYPE_CATALOG

• USER_DEFINED_TYPE_CODE

• USER_DEFINED_TYPE_NAME

• USER_DEFINED_TYPE_SCHEMA

• USING

• UTC_DATE

• UTC_TIME

• UTC_TIMESTAMP

V

• VACUUM

• VALID

• VALIDATE

• VALIDATOR

• VALUE

• VALUES

• VAR_POP

• VAR_SAMP

• VARBINARY

• VARCHAR

• VARCHAR2

• VARCHARACTER

• VARIABLE

• VARIABLES

• VARYING

• VERBOSE

• VIEW

125


• VOLATILE

W

• WAITFOR

• WHEN

• WHENEVER

• WHERE

• WHILE

• WIDTH_BUCKET

• WINDOW

• WITH

• WITHIN

• WITHOUT

• WORK

• WRITE

• WRITETEXT

X

• X509

• XOR

Y

• YEAR

• YEAR_MONTH

Z

• ZEROFILL

• ZONE

126

Amazon Forecast 開発者ガイドActions

API リファレンスこのセクションでは、Amazon Forecast API オペレーションについて説明します。

トピック• Actions (p. 127)• Data Types (p. 217)• Common Errors (p. 269)• Common Parameters (p. 271)

ActionsThe following actions are supported by Amazon Forecast Service:

• CreateDataset (p. 129)• CreateDatasetGroup (p. 133)• CreateDatasetImportJob (p. 136)• CreateForecast (p. 140)• CreateForecastExportJob (p. 143)• CreatePredictor (p. 146)• DeleteDataset (p. 153)• DeleteDatasetGroup (p. 155)• DeleteDatasetImportJob (p. 157)• DeleteForecast (p. 159)• DeleteForecastExportJob (p. 161)• DeletePredictor (p. 163)• DescribeDataset (p. 165)• DescribeDatasetGroup (p. 169)• DescribeDatasetImportJob (p. 172)• DescribeForecast (p. 176)• DescribeForecastExportJob (p. 179)• DescribePredictor (p. 182)• GetAccuracyMetrics (p. 188)• ListDatasetGroups (p. 191)• ListDatasetImportJobs (p. 193)• ListDatasets (p. 196)• ListForecastExportJobs (p. 198)• ListForecasts (p. 201)• ListPredictors (p. 204)• ListTagsForResource (p. 207)• TagResource (p. 209)• UntagResource (p. 211)• UpdateDatasetGroup (p. 213)

127

Amazon Forecast 開発者ガイドAmazon Forecast Service

The following actions are supported by Amazon Forecast Query Service:

• QueryForecast (p. 215)

Amazon Forecast ServiceThe following actions are supported by Amazon Forecast Service:

• CreateDataset (p. 129)• CreateDatasetGroup (p. 133)• CreateDatasetImportJob (p. 136)• CreateForecast (p. 140)• CreateForecastExportJob (p. 143)• CreatePredictor (p. 146)• DeleteDataset (p. 153)• DeleteDatasetGroup (p. 155)• DeleteDatasetImportJob (p. 157)• DeleteForecast (p. 159)• DeleteForecastExportJob (p. 161)• DeletePredictor (p. 163)• DescribeDataset (p. 165)• DescribeDatasetGroup (p. 169)• DescribeDatasetImportJob (p. 172)• DescribeForecast (p. 176)• DescribeForecastExportJob (p. 179)• DescribePredictor (p. 182)• GetAccuracyMetrics (p. 188)• ListDatasetGroups (p. 191)• ListDatasetImportJobs (p. 193)• ListDatasets (p. 196)• ListForecastExportJobs (p. 198)• ListForecasts (p. 201)• ListPredictors (p. 204)• ListTagsForResource (p. 207)• TagResource (p. 209)• UntagResource (p. 211)• UpdateDatasetGroup (p. 213)

128


CreateDatasetService: Amazon Forecast Service

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecastunderstand how to consume the data for model training. This includes the following:

• DataFrequency - How frequently your historical time-series data is collected.• Domain and DatasetType - Each dataset has an associated dataset domain and a type within the

domain. Amazon Forecast provides a list of predefined domains and types within each domain. For eachunique dataset domain and type within the domain, Amazon Forecast requires your data to include aminimum set of predefined fields.

• Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. Youuse the dataset group to create a predictor. For more information, see データセットおよびデータセットグループ (p. 2).

To get a list of all your datasets, use the ListDatasets (p. 196) operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.Note

The Status of a dataset must be ACTIVE before you can import training data. Use theDescribeDataset (p. 165) operation to get the status.

Request Syntax

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

Request ParametersThe request accepts the following data in JSON format.

DataFrequency (p. 129)

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

129



Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates everyday and "15min" indicates every 15 minutes.

Type: String

Pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

Required: NoDatasetName (p. 129)

A name for the dataset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

Required: YesDatasetType (p. 129)

The dataset type. Valid values depend on the chosen Domain.

Type: String

Valid Values: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Required: YesDomain (p. 129)

The domain associated with the dataset. When you add a dataset to a dataset group, this value andthe value specified for the Domain parameter of the CreateDatasetGroup (p. 133) operation mustmatch.

The Domain and DatasetType that you choose determine the fields that must be present in thetraining data that you import to the dataset. For example, if you choose the RETAIL domain andTARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, anddemand fields to be present in your data. For more information, see データセットおよびデータセットグループ (p. 2).

Type: String

Valid Values: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE| WEB_TRAFFIC | METRICS

Required: YesEncryptionConfig (p. 129)

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM)role that Amazon Forecast can assume to access the key.

Type: EncryptionConfig (p. 230) object

Required: NoSchema (p. 129)

The schema for the dataset. The schema attributes and their order must match the fields in your data.The dataset Domain and DatasetType that you choose determine the minimum required fields inyour training data. For information about the required fields for a specific dataset domain and type, see事前定義済みのデータセットドメインとデータセットタイプ (p. 50).

130


Type: Schema (p. 255) object

Required: YesTags (p. 129)

The optional metadata that you apply to the dataset to help you categorize and organize them. Eachtag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:• Maximum number of tags per resource - 50.• For each resource, each tag key must be unique, and each tag key can have only one value.• Maximum key length - 128 Unicode characters in UTF-8.• Maximum value length - 256 Unicode characters in UTF-8.• If your tagging schema is used across multiple services and resources, remember that other services

may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, andspaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case sensitive.• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it

is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have thisprefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be auser tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not countagainst your tags per resource limit.

Type: Array of Tag (p. 262) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

{ "DatasetArn": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DatasetArn (p. 131)

The Amazon Resource Name (ARN) of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors

InvalidInputException

We can't process the request because it includes an invalid value or a value that exceeds the validrange.

131


HTTP Status Code: 400LimitExceededException

The limit on the number of resources per account has been exceeded.

HTTP Status Code: 400ResourceAlreadyExistsException

There is already a resource with this name. Try again with a different name.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

132

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDataset


CreateDatasetGroupService: Amazon Forecast Service

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the datasetgroup when you create the dataset group, or later by using the UpdateDatasetGroup (p. 213) operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor.For more information, see データセットおよびデータセットグループ (p. 2).

To get a list of all your datasets groups, use the ListDatasetGroups (p. 191) operation.Note

The Status of a dataset group must be ACTIVE before you can use the dataset group to create apredictor. To get the status, use the DescribeDatasetGroup (p. 169) operation.

Request Syntax

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


DatasetArns (p. 133)

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the datasetgroup.

Type: Array of strings


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoDatasetGroupName (p. 133)

A name for the dataset group.

Type: String



Required: YesDomain (p. 133)

The domain associated with the dataset group. When you add a dataset to a dataset group, this valueand the value specified for the Domain parameter of the CreateDataset (p. 129) operation must match.

133


The Domain and DatasetType that you choose determine the fields that must be present intraining data that you import to a dataset. For example, if you choose the RETAIL domain andTARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp,and demand fields are present in your data. For more information, see データセットおよびデータセットグループ (p. 2).

Type: String



The optional metadata that you apply to the dataset group to help you categorize and organize them.Each tag consists of a key and an optional value, both of which you define.







Required: No

Response Syntax

{ "DatasetGroupArn": "string"}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.


DatasetGroupArn (p. 134)

The Amazon Resource Name (ARN) of the dataset group.

Type: String

134



Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors







HTTP Status Code: 400ResourceInUseException

The specified resource is in use.

HTTP Status Code: 400ResourceNotFoundException

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.


See Also



135

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup


CreateDatasetImportJobService: Amazon Forecast Service

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data inan Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of thedataset that you want to import the data to.

You must specify a DataSource (p. 229) object that includes an AWS Identity and Access Management(IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy ofyour data and processes it in an internal AWS system. For more information, see Amazon Forecast のアクセス許可を設定する (p. 19).

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the lattertwo cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used whentraining a predictor or generating a forecast. Make sure that your most recent dataset import contains all ofthe data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use theListDatasetImportJobs (p. 193) operation.

Request Syntax

{ "DatasetArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ], "TimestampFormat": "string"}

Request Parameters

The request accepts the following data in JSON format.

DatasetArn (p. 136)

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

136


DatasetImportJobName (p. 136)

The name for the dataset import job. We recommend including the current timestamp inthe name, for example, 20190721DatasetImport. This can help you avoid getting aResourceAlreadyExistsException exception.

Type: String



Required: YesDataSource (p. 136)

The location of the training data to import and an AWS Identity and Access Management (IAM) rolethat Amazon Forecast can assume to access the data. The training data must be stored in an AmazonS3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and theIAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role mustmatch those specified in the EncryptionConfig parameter of the CreateDataset (p. 129) operation.

Type: DataSource (p. 229) object


The optional metadata that you apply to the dataset import job to help you categorize and organizethem. Each tag consists of a key and an optional value, both of which you define.







Required: NoTimestampFormat (p. 136)

The format of timestamps in the dataset. The format that you specify depends on the DataFrequencyspecified when the dataset was created. The following formats are supported• "yyyy-MM-dd"

For the following data frequencies: Y, M, W, and D

137


• "yyyy-MM-dd HH:mm:ss"

For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Type: String


Pattern: ^[a-zA-Z0-9\-\:\.\,\'\s]+$

Required: No

Response Syntax

{ "DatasetImportJobArn": "string"}

Response Elements



DatasetImportJobArn (p. 138)

The Amazon Resource Name (ARN) of the dataset import job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors









138





See Also



139

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob


CreateForecastService: Amazon Forecast Service

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train thepredictor. This is known as inference. To retrieve the forecast for a single item at low latency, use theQueryForecast (p. 215) operation. To export the complete forecast into your Amazon Simple StorageService (Amazon S3) bucket, use the CreateForecastExportJob (p. 143) operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in theCreatePredictor (p. 146) request. When you query a forecast, you can request a specific date rangewithin the forecast.

To get a list of all your forecasts, use the ListForecasts (p. 201) operation.

Note

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that wasused to create the predictor.

For more information, see 予測 (p. 17).

Note

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use theDescribeForecast (p. 176) operation to get the status.

Request Syntax

{ "ForecastName": "string", "ForecastTypes": [ "string" ], "PredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

Request Parameters


ForecastName (p. 140)

A name for the forecast.

Type: String



Required: YesForecastTypes (p. 140)

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.

140


The mean forecast is different from the median (0.50) when the distribution is not symmetric (forexample, Beta and Negative Binomial). The default value is ["0.1", "0.5", "0.9"].


Array Members: Minimum number of 1 item. Maximum number of 20 items.

Pattern: (^0?\.\d\d?$|^mean$)

Required: NoPredictorArn (p. 140)

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$


The optional metadata that you apply to the forecast to help you categorize and organize them. Eachtag consists of a key and an optional value, both of which you define.







Required: No

Response Syntax

{ "ForecastArn": "string"}

Response Elements


141



ForecastArn (p. 141)

The Amazon Resource Name (ARN) of the forecast.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors












See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:


142

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast


CreateForecastExportJobService: Amazon Forecast Service

Exports a forecast created by the CreateForecast (p. 140) operation to your Amazon Simple StorageService (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination (p. 223) object that includes an AWS Identity and AccessManagement (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For moreinformation, see Amazon Forecast のアクセス許可を設定する (p. 19).

For more information, see 予測 (p. 17).

To get a list of all your forecast export jobs, use the ListForecastExportJobs (p. 198) operation.

Note

The Status of the forecast export job must be ACTIVE before you can access the forecast in yourAmazon S3 bucket. To get the status, use the DescribeForecastExportJob (p. 179) operation.

Request Syntax

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

Request Parameters


Destination (p. 143)

The location where you want to save the forecast and an AWS Identity and Access Management (IAM)role that Amazon Forecast can assume to access the location. The forecast must be exported to anAmazon S3 bucket.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. TheIAM role must allow Amazon Forecast permission to access the key.

Type: DataDestination (p. 223) object

Required: Yes

143



The Amazon Resource Name (ARN) of the forecast that you want to export.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: YesForecastExportJobName (p. 143)

The name for the forecast export job.

Type: String




The optional metadata that you apply to the forecast export job to help you categorize and organizethem. Each tag consists of a key and an optional value, both of which you define.







Required: No

Response Syntax

{ "ForecastExportJobArn": "string"}


144



ForecastExportJobArn (p. 144)

The Amazon Resource Name (ARN) of the export job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors














145

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob


CreatePredictorService: Amazon Forecast Service

Creates an Amazon Forecast predictor.

In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choosethe algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specifichyperparameters.

Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasetsin the specified dataset group. The result is called a predictor. You then generate a forecast using theCreateForecast (p. 140) operation.

After training a model, the CreatePredictor operation also evaluates it. To see the evaluation metrics,use the GetAccuracyMetrics (p. 188) operation. Always review the evaluation metrics before deciding touse the predictor to generate a forecast.

Optionally, you can specify a featurization configuration to fill and aggregate the data fieldsin the TARGET_TIME_SERIES dataset to improve model training. For more information, seeFeaturizationConfig (p. 234).

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specifiedwhen the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasetsdon't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For moreinformation, see データセットおよびデータセットグループ (p. 2).

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizesthe objective function, set PerformAutoML to true. The objective function isdefined as the mean of the weighted p10, p50, and p90 quantile losses. For more information, seeEvaluationResult (p. 232).

When AutoML is enabled, the following properties are disallowed:

• AlgorithmArn

• HPOConfig

• PerformHPO

• TrainingParameters

To get a list of all of your predictors, use the ListPredictors (p. 204) operation.

Note

Before you can use the predictor to create a forecast, the Status of the predictormust be ACTIVE, signifying that training has completed. To get the status, use theDescribePredictor (p. 182) operation.

Request Syntax

{ "AlgorithmArn": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EvaluationParameters": {

146


"BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "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" } ] }, "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingParameters": {

147


"string" : "string" }}

Request Parameters


AlgorithmArn (p. 146)

The Amazon Resource Name (ARN) of the algorithm to use for model training. Required ifPerformAutoML is not set to true.

Supported algorithms:

• 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

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoEncryptionConfig (p. 146)


Type: EncryptionConfig (p. 230) object

Required: NoEvaluationParameters (p. 146)

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecastevaluates a predictor by splitting a dataset into training data and testing data. The evaluationparameters define how to perform the split and the number of iterations.

Type: EvaluationParameters (p. 231) object

Required: NoFeaturizationConfig (p. 146)

The featurization configuration.

Type: FeaturizationConfig (p. 234) object

Required: YesForecastHorizon (p. 146)

Specifies the number of time-steps that the model is trained to predict. The forecast horizon is alsocalled the prediction length.

148


For example, if you configure a dataset for daily data collection (using the DataFrequency parameterof the CreateDataset (p. 129) operation) and set the forecast horizon to 10, the model returnspredictions for 10 days.

The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIESdataset length.

Type: Integer

Required: YesHPOConfig (p. 146)

Provides hyperparameter override values for the algorithm. If you don't provide this parameter, AmazonForecast uses default values. The individual algorithms specify which hyperparameters supporthyperparameter optimization (HPO). For more information, see Amazon Forecast アルゴリズムを選択する (p. 60).

If you included the HPOConfig object, you must set PerformHPO to true.

Type: HyperParameterTuningJobConfig (p. 243) object

Required: NoInputDataConfig (p. 146)

Describes the dataset group that contains the data to use to train the predictor.

Type: InputDataConfig (p. 244) object

Required: YesPerformAutoML (p. 146)

Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms itprovides and chooses the best algorithm and configuration for your training dataset.

The default value is false. In this case, you are required to specify an algorithm.

Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a good option if youaren't sure which algorithm is suitable for your training data. In this case, PerformHPO must be false.

Type: Boolean

Required: NoPerformHPO (p. 146)

Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values foryour training data. The process of performing HPO is known as running a hyperparameter tuning job.

The default value is false. In this case, Amazon Forecast uses default hyperparameter values fromthe chosen algorithm.

To override the default values, set PerformHPO to true and, optionally, supply theHyperParameterTuningJobConfig (p. 243) object. The tuning job specifies a metric to optimize, whichhyperparameters participate in tuning, and the valid range for each tunable hyperparameter. In thiscase, you are required to specify an algorithm and PerformAutoML must be false.

The following algorithms support HPO:• DeepAR+• CNN-QR

149


Type: Boolean

Required: NoPredictorName (p. 146)

A name for the predictor.

Type: String




The optional metadata that you apply to the predictor to help you categorize and organize them. Eachtag consists of a key and an optional value, both of which you define.







Required: NoTrainingParameters (p. 146)

The hyperparameters to override for model training. The hyperparameters that you can override arelisted in the individual algorithms. For the list of supported algorithms, see Amazon Forecast アルゴリズムを選択する (p. 60).

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

Required: No

150


Response Syntax

{ "PredictorArn": "string"}



PredictorArn (p. 151)

The Amazon Resource Name (ARN) of the predictor.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Errors













• AWS Command Line Interface• AWS SDK for .NET

151

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/CreatePredictor


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

152

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor


DeleteDatasetService: Amazon Forecast Service

Deletes an Amazon Forecast dataset that was created using the CreateDataset (p. 129) operation. Youcan only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use theDescribeDataset (p. 165) operation.

Note

Forecast does not automatically update any dataset groups that contain the deleted dataset. Inorder to update the dataset group, use the UpdateDatasetGroup (p. 213) operation, omitting thedeleted dataset's ARN.

Request Syntax


Request Parameters


DatasetArn (p. 153)

The Amazon Resource Name (ARN) of the dataset to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors








153


See Also



154

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset


DeleteDatasetGroupService: Amazon Forecast Service

Deletes a dataset group created using the CreateDatasetGroup (p. 133) operation. You can only deletedataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status,use the DescribeDatasetGroup (p. 169) operation.

This operation deletes only the dataset group, not the datasets in the group.

Request Syntax




The Amazon Resource Name (ARN) of the dataset group to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors









155



156

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup


DeleteDatasetImportJobService: Amazon Forecast Service

Deletes a dataset import job created using the CreateDatasetImportJob (p. 136) operation. You can deleteonly dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use theDescribeDatasetImportJob (p. 172) operation.

Request Syntax




The Amazon Resource Name (ARN) of the dataset import job to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes


Errors









• AWS Command Line Interface

157

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeleteDatasetImportJob


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

158

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob


DeleteForecastService: Amazon Forecast Service

Deletes a forecast created using the CreateForecast (p. 140) operation. You can delete only forecaststhat have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast (p. 176)operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer querythe forecast.

Request Syntax




The Amazon Resource Name (ARN) of the forecast to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes


Errors









159



160

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast


DeleteForecastExportJobService: Amazon Forecast Service

Deletes a forecast export job created using the CreateForecastExportJob (p. 143) operation. You candelete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use theDescribeForecastExportJob (p. 179) operation.

Request Syntax




The Amazon Resource Name (ARN) of the forecast export job to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes


Errors










161

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeleteForecastExportJob



162

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob


DeletePredictorService: Amazon Forecast Service

Deletes a predictor created using the CreatePredictor (p. 146) operation. You can delete only predictorthat have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor (p. 182)operation.

Request Syntax




The Amazon Resource Name (ARN) of the predictor to delete.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes


Errors










163

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DeletePredictor



164

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor


DescribeDatasetService: Amazon Forecast Service

Describes an Amazon Forecast dataset created using the CreateDataset (p. 129) operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes thefollowing dataset properties:

• CreationTime

• LastModificationTime

• Status

Request Syntax



DatasetArn (p. 165)


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "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"}

165


Response Elements



CreationTime (p. 165)

When the dataset was created.

Type: TimestampDataFrequency (p. 165)

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates everymonth and "30min" indicates every 30 minutes.

Type: String

Pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$DatasetArn (p. 165)


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$DatasetName (p. 165)

The name of the dataset.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*DatasetType (p. 165)

The dataset type.

Type: String

Valid Values: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATADomain (p. 165)

The domain associated with the dataset.

Type: String


EncryptionConfig (p. 165)

The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM)role that Amazon Forecast can assume to access the key.

166


Type: EncryptionConfig (p. 230) objectLastModificationTime (p. 165)

When you create a dataset, LastModificationTime is the same as CreationTime. Whiledata is being imported to the dataset, LastModificationTime is the current time of theDescribeDataset call. After a CreateDatasetImportJob (p. 136) operation has finished,LastModificationTime is when the import job completed or failed.

Type: TimestampSchema (p. 165)

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttributespecifies the name and data type of a field.

Type: Schema (p. 255) objectStatus (p. 165)

The status of the dataset. States include:• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply while data is imported to the dataset from a call to theCreateDatasetImportJob (p. 136) operation and reflect the status of the dataset import job. Forexample, when the import job status is CREATE_IN_PROGRESS, the status of the dataset isUPDATE_IN_PROGRESS.

Note

The Status of the dataset must be ACTIVE before you can import training data.

Type: String


Errors






See Also


• AWS Command Line Interface• AWS SDK for .NET

167

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribeDataset


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

168

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset


DescribeDatasetGroupService: Amazon Forecast Service

Describes a dataset group created using the CreateDatasetGroup (p. 133) operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includesthe following properties:

• DatasetArns - The datasets belonging to the group.• CreationTime


• Status

Request Syntax


Request Parameters




Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

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

Response Elements




When the dataset group was created.

169


Type: TimestampDatasetArns (p. 169)

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.



Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$DatasetGroupArn (p. 169)

The ARN of the dataset group.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$DatasetGroupName (p. 169)

The name of the dataset group.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*Domain (p. 169)

The domain associated with the dataset group.

Type: String


LastModificationTime (p. 169)

When the dataset group was created or last updated from a call to the UpdateDatasetGroup (p. 213)operation. While the dataset group is being updated, LastModificationTime is the current time ofthe DescribeDatasetGroup call.

Type: TimestampStatus (p. 169)

The status of the dataset group. States include:• ACTIVE


The UPDATE states apply when you call the UpdateDatasetGroup (p. 213) operation.

Note

The Status of the dataset group must be ACTIVE before you can use the dataset group tocreate a predictor.

Type: String

170



Errors






See Also



171

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetGroup


DescribeDatasetImportJobService: Amazon Forecast Service

Describes a dataset import job created using the CreateDatasetImportJob (p. 136) operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operationincludes the following properties:

• CreationTime


• DataSize

• FieldStatistics

• Status

• Message - If an error occurred, information about the error.

Request Syntax





Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "CreationTime": number, "DatasetArn": "string", "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSize": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "FieldStatistics": { "string" : { "Avg": number, "Count": number, "CountDistinct": number,

172


"CountNan": number, "CountNull": number, "Max": "string", "Min": "string", "Stddev": number } }, "LastModificationTime": number, "Message": "string", "Status": "string", "TimestampFormat": "string"}




When the dataset import job was created.

Type: TimestampDatasetArn (p. 172)

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$DatasetImportJobArn (p. 172)

The ARN of the dataset import job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$DatasetImportJobName (p. 172)

The name of the dataset import job.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*DataSize (p. 172)

The size of the dataset in gigabytes (GB) after the import job has finished.

Type: DoubleDataSource (p. 172)

The location of the training data to import and an AWS Identity and Access Management (IAM) rolethat Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

173


Type: DataSource (p. 229) objectFieldStatistics (p. 172)

Statistical information about each field in the input data.

Type: String to Statistics (p. 257) object map


Key Pattern: ^[a-zA-Z0-9\_]+$LastModificationTime (p. 172)

The last time that the dataset was modified. The time depends on the status of the job, as follows:• CREATE_PENDING - The same time as CreationTime.• CREATE_IN_PROGRESS - The current timestamp.• ACTIVE or CREATE_FAILED - When the job finished or failed.

Type: TimestampMessage (p. 172)

If an error occurred, an informational message about the error.

Type: StringStatus (p. 172)

The status of the dataset import job. The status is reflected in the status of the dataset. Forexample, when the import job status is CREATE_IN_PROGRESS, the status of the dataset isUPDATE_IN_PROGRESS. States include:• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Type: String

Length Constraints: Maximum length of 256.TimestampFormat (p. 172)

The format of timestamps in the dataset. The format that you specify depends on the DataFrequencyspecified when the dataset was created. The following formats are supported• "yyyy-MM-dd"

For the following data frequencies: Y, M, W, and D• "yyyy-MM-dd HH:mm:ss"

For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

Type: String


Pattern: ^[a-zA-Z0-9\-\:\.\,\'\s]+$

Errors



174





See Also



175

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob


DescribeForecastService: Amazon Forecast Service

Describes a forecast created using the CreateForecast (p. 140) operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists thefollowing properties:

• DatasetGroupArn - The dataset group that provided the training data.• CreationTime


• Status


Request Syntax


Request Parameters



The Amazon Resource Name (ARN) of the forecast.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string"}

Response Elements



176



When the forecast creation task was created.

Type: TimestampDatasetGroupArn (p. 176)

The ARN of the dataset group that provided the data used to train the predictor.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ForecastArn (p. 176)

The forecast ARN as specified in the request.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ForecastName (p. 176)

The name of the forecast.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*ForecastTypes (p. 176)

The quantiles at which probabilistic forecasts were generated.



Pattern: (^0?\.\d\d?$|^mean$)LastModificationTime (p. 176)

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creatingthe forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete(status changed to ACTIVE) or fails (status changed to CREATE_FAILED).



Type: StringPredictorArn (p. 176)

The ARN of the predictor used to generate the forecast.

Type: String


177


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$Status (p. 176)

The status of the forecast. States include:• ACTIVE


Note

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Type: String


Pattern: ^[a-zA-Z0-9\_]+$

Errors






See Also



178

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecast


DescribeForecastExportJobService: Amazon Forecast Service

Describes a forecast export job created using the CreateForecastExportJob (p. 143) operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, thisoperation lists the following properties:

• CreationTime


• Status


Request Syntax




The Amazon Resource Name (ARN) of the forecast export job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

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


179




When the forecast export job was created.

Type: TimestampDestination (p. 179)

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Type: DataDestination (p. 223) objectForecastArn (p. 179)

The Amazon Resource Name (ARN) of the exported forecast.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ForecastExportJobArn (p. 179)

The ARN of the forecast export job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ForecastExportJobName (p. 179)

The name of the forecast export job.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*LastModificationTime (p. 179)

When the last successful export job finished.



Type: StringStatus (p. 179)

The status of the forecast export job. States include:• ACTIVE


Note

The Status of the forecast export job must be ACTIVE before you can access the forecast inyour S3 bucket.

180


Type: String


Errors






See Also



181

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecastExportJob


DescribePredictorService: Amazon Forecast Service

Describes a predictor created using the CreatePredictor (p. 146) operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists thefollowing properties:

• DatasetImportJobArns - The dataset import jobs used to import training data.• AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.• CreationTime


• Status


Request Syntax


Request Parameters



The Amazon Resource Name (ARN) of the predictor that you want information about.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "AlgorithmArn": "string", "AutoMLAlgorithmArns": [ "string" ], "CreationTime": number, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string",

182


"FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "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" } ] }, "LastModificationTime": number, "Message": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorArn": "string", "PredictorExecutionDetails": { "PredictorExecutions": [ { "AlgorithmArn": "string", "TestWindows": [ { "Message": "string", "Status": "string", "TestWindowEnd": number, "TestWindowStart": number } ]

183


} ] }, "PredictorName": "string", "Status": "string", "TrainingParameters": { "string" : "string" }}

Response Elements



AlgorithmArn (p. 182)

The Amazon Resource Name (ARN) of the algorithm used for model training.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$AutoMLAlgorithmArns (p. 182)

When PerformAutoML is specified, the ARN of the chosen algorithm.



Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$CreationTime (p. 182)

When the model training task was created.

Type: TimestampDatasetImportJobArns (p. 182)

An array of the ARNs of the dataset import jobs used to import training data for the predictor.



Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$EncryptionConfig (p. 182)


Type: EncryptionConfig (p. 230) objectEvaluationParameters (p. 182)

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecastevaluates a predictor by splitting a dataset into training data and testing data. The evaluationparameters define how to perform the split and the number of iterations.

184


Type: EvaluationParameters (p. 231) objectFeaturizationConfig (p. 182)

The featurization configuration.

Type: FeaturizationConfig (p. 234) objectForecastHorizon (p. 182)

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Type: IntegerHPOConfig (p. 182)

The hyperparameter override values for the algorithm.

Type: HyperParameterTuningJobConfig (p. 243) objectInputDataConfig (p. 182)

Describes the dataset group that contains the data to use to train the predictor.

Type: InputDataConfig (p. 244) objectLastModificationTime (p. 182)

Initially, the same as CreationTime (when the status is CREATE_PENDING). This value isupdated when training starts (when the status changes to CREATE_IN_PROGRESS), and whentraining has completed (when the status changes to ACTIVE) or fails (when the status changes toCREATE_FAILED).



Type: StringPerformAutoML (p. 182)

Whether the predictor is set to perform AutoML.

Type: BooleanPerformHPO (p. 182)

Whether the predictor is set to perform hyperparameter optimization (HPO).

Type: BooleanPredictorArn (p. 182)

The ARN of the predictor.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*PredictorExecutionDetails (p. 182)

Details on the the status and results of the backtests performed to evaluate the accuracy of thepredictor. You specify the number of backtests to perform when you call the CreatePredictor (p. 146)operation.

185


Type: PredictorExecutionDetails (p. 250) objectPredictorName (p. 182)

The name of the predictor.

Type: String


Pattern: ^[a-zA-Z][a-zA-Z0-9_]*Status (p. 182)

The status of the predictor. States include:• ACTIVE


Note

The Status of the predictor must be ACTIVE before you can use the predictor to create aforecast.

Type: String

Length Constraints: Maximum length of 256.TrainingParameters (p. 182)

The default training parameters or overrides selected during model training. When running AutoML orchoosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters arereturned. For more information, see Amazon Forecast アルゴリズムを選択する (p. 60).


Map Entries: Minimum number of 0 items. Maximum number of 100 items.


Key Pattern: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$



Errors






186


See Also



187

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor


GetAccuracyMetricsService: Amazon Forecast Service

Provides metrics on the accuracy of the models that were trained by the CreatePredictor (p. 146) operation.Use metrics to see how well the model performed and to decide whether to use the predictor to generate aforecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtestwindows (NumberOfBacktestWindows) is specified using the EvaluationParameters (p. 231) object,which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn'tspecified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want allitems to contribute, specify zero. If you want only those items that have complete data in the range beingevaluated to contribute, specify nan. For more information, see FeaturizationMethod (p. 236).

Note

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying thattraining has completed. To get the status, use the DescribePredictor (p. 182) operation.

Request Syntax


Request Parameters



The Amazon Resource Name (ARN) of the predictor to get metrics for.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "PredictorEvaluationResults": [ { "AlgorithmArn": "string", "TestWindows": [ { "EvaluationType": "string", "ItemCount": number, "Metrics": { "RMSE": number, "WeightedQuantileLosses": [ { "LossValue": number,

188

https://docs.aws.amazon.com/forecast/latest/dg/metrics.html


"Quantile": number } ] }, "TestWindowEnd": number, "TestWindowStart": number } ] } ]}

Response Elements



PredictorEvaluationResults (p. 188)

An array of results from evaluating the predictor.

Type: Array of EvaluationResult (p. 232) objects

Errors








See Also



189

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics


190


ListDatasetGroupsService: Amazon Forecast Service

Returns a list of dataset groups created using the CreateDatasetGroup (p. 133) operation. For eachdataset group, this operation returns a summary of its properties, including its Amazon ResourceName (ARN). You can retrieve the complete set of properties by using the dataset group ARN with theDescribeDatasetGroup (p. 169) operation.

Request Syntax

{ "MaxResults": number, "NextToken": "string"}


MaxResults (p. 191)

The number of items to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: NoNextToken (p. 191)

If the result of the previous request was truncated, the response includes a NextToken. To retrievethe next set of results, use the token in the next request. Tokens expire after 24 hours.

Type: String


Required: No

Response Syntax

{ "DatasetGroups": [ { "CreationTime": number, "DatasetGroupArn": "string", "DatasetGroupName": "string", "LastModificationTime": number } ], "NextToken": "string"}



191


DatasetGroups (p. 191)

An array of objects that summarize each dataset group's properties.

Type: Array of DatasetGroupSummary (p. 224) objectsNextToken (p. 191)

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, usethe token in the next request.

Type: String


Errors

InvalidNextTokenException

The token is not valid. Tokens expire after 24 hours.


See Also



192

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetGroups


ListDatasetImportJobsService: Amazon Forecast Service

Returns a list of dataset import jobs created using the CreateDatasetImportJob (p. 136) operation.For each import job, this operation returns a summary of its properties, including its AmazonResource Name (ARN). You can retrieve the complete set of properties by using the ARN with theDescribeDatasetImportJob (p. 172) operation. You can filter the list by providing an array of Filter (p. 238)objects.

Request Syntax

{ "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string"}


Filters (p. 193)

An array of filters. For each filter, you provide a condition and a match statement. The conditionis either IS or IS_NOT, which specifies whether to include or exclude the datasets that match thestatement from the list, respectively. The match statement consists of a key and a value.

Filter properties• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the datasets that

match the statement, specify IS. To exclude matching datasets, specify IS_NOT.• Key - The name of the parameter to filter on. Valid values are DatasetArn and Status.• Value - The value to match.

For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Type: Array of Filter (p. 238) objects

Required: NoMaxResults (p. 193)


Type: Integer




193


Type: String


Required: No

Response Syntax

{ "DatasetImportJobs": [ { "CreationTime": number, "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string"}



DatasetImportJobs (p. 194)

An array of objects that summarize each dataset import job's properties.

Type: Array of DatasetImportJobSummary (p. 225) objectsNextToken (p. 194)


Type: String


Errors



HTTP Status Code: 400InvalidNextTokenException


194



See Also



195

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetImportJobs


ListDatasetsService: Amazon Forecast Service

Returns a list of datasets created using the CreateDataset (p. 129) operation. For each dataset, a summaryof its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set ofproperties, use the ARN with the DescribeDataset (p. 165) operation.

Request Syntax

{ "MaxResults": number, "NextToken": "string"}

Request Parameters


MaxResults (p. 196)


Type: Integer




Type: String


Required: No

Response Syntax

{ "Datasets": [ { "CreationTime": number, "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "LastModificationTime": number } ], "NextToken": "string"}

Response Elements


196



Datasets (p. 196)

An array of objects that summarize each dataset's properties.

Type: Array of DatasetSummary (p. 227) objectsNextToken (p. 196)


Type: String


Errors

InvalidNextTokenException



See Also



197

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets


ListForecastExportJobsService: Amazon Forecast Service

Returns a list of forecast export jobs created using the CreateForecastExportJob (p. 143) operation.For each forecast export job, this operation returns a summary of its properties, including itsAmazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with theDescribeForecastExportJob (p. 179) operation. You can filter the list using an array of Filter (p. 238)objects.

Request Syntax


Request Parameters


Filters (p. 198)

An array of filters. For each filter, you provide a condition and a match statement. The condition iseither IS or IS_NOT, which specifies whether to include or exclude the forecast export jobs that matchthe statement from the list, respectively. The match statement consists of a key and a value.

Filter properties• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast

export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specifyIS_NOT.

• Key - The name of the parameter to filter on. Valid values are ForecastArn and Status.• Value - The value to match.

For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:

"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value":"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]




Type: Integer


Required: No

198


NextToken (p. 198)


Type: String


Required: No

Response Syntax

{ "ForecastExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string"}



ForecastExportJobs (p. 199)

An array of objects that summarize each export job's properties.

Type: Array of ForecastExportJobSummary (p. 239) objectsNextToken (p. 199)


Type: String


Errors



199





See Also



200

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs


ListForecastsService: Amazon Forecast Service

Returns a list of forecasts created using the CreateForecast (p. 140) operation. For each forecast, thisoperation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve thecomplete set of properties, specify the ARN with the DescribeForecast (p. 176) operation. You can filter thelist using an array of Filter (p. 238) objects.

Request Syntax



Filters (p. 201)

An array of filters. For each filter, you provide a condition and a match statement. The condition iseither IS or IS_NOT, which specifies whether to include or exclude the forecasts that match thestatement from the list, respectively. The match statement consists of a key and a value.

Filter properties• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that

match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.• Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn,

and Status.• Value - The value to match.

For example, to list all forecasts whose status is not ACTIVE, you would specify:

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]




Type: Integer




201


Type: String


Required: No

Response Syntax

{ "Forecasts": [ { "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string" } ], "NextToken": "string"}

Response Elements



Forecasts (p. 202)

An array of objects that summarize each forecast's properties.

Type: Array of ForecastSummary (p. 241) objectsNextToken (p. 202)


Type: String


Errors






202


See Also



203

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecasts


ListPredictorsService: Amazon Forecast Service

Returns a list of predictors created using the CreatePredictor (p. 146) operation. For each predictor, thisoperation returns a summary of its properties, including its Amazon Resource Name (ARN). You canretrieve the complete set of properties by using the ARN with the DescribePredictor (p. 182) operation. Youcan filter the list using an array of Filter (p. 238) objects.

Request Syntax



Filters (p. 204)

An array of filters. For each filter, you provide a condition and a match statement. The condition iseither IS or IS_NOT, which specifies whether to include or exclude the predictors that match thestatement from the list, respectively. The match statement consists of a key and a value.

Filter properties• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that

match the statement, specify IS. To exclude matching predictors, specify IS_NOT.• Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.• Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]




Type: Integer




Type: String

204



Required: No

Response Syntax

{ "NextToken": "string", "Predictors": [ { "CreationTime": number, "DatasetGroupArn": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "Status": "string" } ]}



NextToken (p. 205)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 3000.Predictors (p. 205)

An array of objects that summarize each predictor's properties.

Type: Array of PredictorSummary (p. 251) objects

Errors







205



206

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictors


ListTagsForResourceService: Amazon Forecast Service

Lists the tags for an Amazon Forecast resource.

Request Syntax

{ "ResourceArn": "string"}

Request Parameters


ResourceArn (p. 207)

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, thesupported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts,and forecast export jobs.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "Tags": [ { "Key": "string", "Value": "string" } ]}

Response Elements



Tags (p. 207)

The tags for the resource.



207


Errors






See Also



208

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource


TagResourceService: Amazon Forecast Service

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resourceare not specified in the request parameters, they are not changed. When a resource is deleted, the tagsassociated with that resource are also deleted.

Request Syntax

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

Request Parameters



The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, thesupported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts,and forecast export jobs.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$


The tags to add to the resource. A tag is an array of key-value pairs.






209



Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors








See Also



210

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource


UntagResourceService: Amazon Forecast Service

Deletes the specified tags from a resource.

Request Syntax

{ "ResourceArn": "string", "TagKeys": [ "string" ]}



The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, thesupported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts,and forecast exports.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: YesTagKeys (p. 211)

The keys of the tags to be removed.




Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes


Errors





211



See Also



212

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UntagResource


UpdateDatasetGroupService: Amazon Forecast Service

Replaces the datasets in a dataset group with the specified datasets.Note

The Status of the dataset group must be ACTIVE before you can use the dataset group to createa predictor. Use the DescribeDatasetGroup (p. 169) operation to get the status.

Request Syntax

{ "DatasetArns": [ "string" ], "DatasetGroupArn": "string"}


DatasetArns (p. 213)

An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.



Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: YesDatasetGroupArn (p. 213)

The ARN of the dataset group.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes


Errors





213

Amazon Forecast 開発者ガイドAmazon Forecast Query Service




See Also



Amazon Forecast Query ServiceThe following actions are supported by Amazon Forecast Query Service:

• QueryForecast (p. 215)

214

https://docs.aws.amazon.com/goto/aws-cli/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup


QueryForecastService: Amazon Forecast Query Service

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-targetfield) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of theFeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request aspecific date range.

To get the full forecast, use the CreateForecastExportJob operation.

Note

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that wasused to create the predictor.

Request Syntax

{ "EndDate": "string", "Filters": { "string" : "string" }, "ForecastArn": "string", "NextToken": "string", "StartDate": "string"}

Request Parameters


EndDate (p. 215)

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601format). For example, 2015-01-01T20:00:00.

Type: String

Required: NoFilters (p. 215)

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast forclient_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full forecast, use the CreateForecastExportJob operation.


Map Entries: Maximum number of 50 items.


Key Pattern: ^[a-zA-Z0-9\_\-]+$

215

https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html

https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html



Required: YesForecastArn (p. 215)

The Amazon Resource Name (ARN) of the forecast to query.

Type: String


Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

Required: YesNextToken (p. 215)


Type: String


Required: NoStartDate (p. 215)

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601format). For example, 2015-01-01T08:00:00.

Type: String

Required: No

Response Syntax

{ "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } }}

Response Elements



Forecast (p. 216)

The forecast.

Type: Forecast (p. 269) object

216

Amazon Forecast 開発者ガイドData Types

Errors


The value is invalid or is too long.




The limit on the number of requests per second has been exceeded.




We can't find that resource. Check the information that you've provided and try again.


See Also



Data TypesThe following data types are supported by Amazon Forecast Service:

• CategoricalParameterRange (p. 220)• ContinuousParameterRange (p. 221)• DataDestination (p. 223)• DatasetGroupSummary (p. 224)• DatasetImportJobSummary (p. 225)• DatasetSummary (p. 227)

217

https://docs.aws.amazon.com/goto/aws-cli/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/DotNetSDKV3/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/SdkForGoV1/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/SdkForJava/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryForecast

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryForecast


• DataSource (p. 229)• EncryptionConfig (p. 230)• EvaluationParameters (p. 231)• EvaluationResult (p. 232)• Featurization (p. 233)• FeaturizationConfig (p. 234)• FeaturizationMethod (p. 236)• Filter (p. 238)• ForecastExportJobSummary (p. 239)• ForecastSummary (p. 241)• HyperParameterTuningJobConfig (p. 243)• InputDataConfig (p. 244)• IntegerParameterRange (p. 245)• Metrics (p. 247)• ParameterRanges (p. 248)• PredictorExecution (p. 249)• PredictorExecutionDetails (p. 250)• PredictorSummary (p. 251)• S3Config (p. 253)• Schema (p. 255)• SchemaAttribute (p. 256)• Statistics (p. 257)• SupplementaryFeature (p. 259)• Tag (p. 262)• TestWindowSummary (p. 264)• WeightedQuantileLoss (p. 265)• WindowSummary (p. 266)

The following data types are supported by Amazon Forecast Query Service:

• DataPoint (p. 268)• Forecast (p. 269)

Amazon Forecast ServiceThe following data types are supported by Amazon Forecast Service:

• CategoricalParameterRange (p. 220)• ContinuousParameterRange (p. 221)• DataDestination (p. 223)• DatasetGroupSummary (p. 224)• DatasetImportJobSummary (p. 225)• DatasetSummary (p. 227)• DataSource (p. 229)• EncryptionConfig (p. 230)• EvaluationParameters (p. 231)

218


• EvaluationResult (p. 232)• Featurization (p. 233)• FeaturizationConfig (p. 234)• FeaturizationMethod (p. 236)• Filter (p. 238)• ForecastExportJobSummary (p. 239)• ForecastSummary (p. 241)• HyperParameterTuningJobConfig (p. 243)• InputDataConfig (p. 244)• IntegerParameterRange (p. 245)• Metrics (p. 247)• ParameterRanges (p. 248)• PredictorExecution (p. 249)• PredictorExecutionDetails (p. 250)• PredictorSummary (p. 251)• S3Config (p. 253)• Schema (p. 255)• SchemaAttribute (p. 256)• Statistics (p. 257)• SupplementaryFeature (p. 259)• Tag (p. 262)• TestWindowSummary (p. 264)• WeightedQuantileLoss (p. 265)• WindowSummary (p. 266)

219


CategoricalParameterRangeService: Amazon Forecast Service

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of theParameterRanges (p. 248) object.

Contents

Name

The name of the categorical hyperparameter to tune.

Type: String



Required: YesValues

A list of the tunable categories for the hyperparameter.




Pattern: ^[a-zA-Z0-9\_\-]+$

Required: Yes

See Also


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

220

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CategoricalParameterRange

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/CategoricalParameterRange

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/CategoricalParameterRange

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CategoricalParameterRange


ContinuousParameterRangeService: Amazon Forecast Service

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of theParameterRanges (p. 248) object.

Contents

MaxValue

The maximum tunable value of the hyperparameter.

Type: Double

Required: YesMinValue

The minimum tunable value of the hyperparameter.

Type: Double

Required: YesName

The name of the hyperparameter to tune.

Type: String



Required: YesScalingType

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmicscale.

Logarithmic scaling works only for ranges that have values greater than 0.ReverseLogarithmic

hyperparameter tuning searches the values in the hyperparameter range by using a reverselogarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of thefollowing values:

Type: String

221

http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type


Valid Values: Auto | Linear | Logarithmic | ReverseLogarithmic

Required: No

See Also



222

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ContinuousParameterRange

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ContinuousParameterRange

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ContinuousParameterRange

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ContinuousParameterRange


DataDestinationService: Amazon Forecast Service

The destination for an exported forecast, an AWS Identity and Access Management (IAM) role that allowsAmazon Forecast to access the location and, optionally, an AWS Key Management Service (KMS) key.This object is submitted in the CreateForecastExportJob (p. 143) request.

Contents

S3Config

The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials toaccess the bucket.

Type: S3Config (p. 253) object

Required: Yes

See Also



223

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataDestination

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DataDestination

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DataDestination

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataDestination


DatasetGroupSummaryService: Amazon Forecast Service

Provides a summary of the dataset group properties used in the ListDatasetGroups (p. 191) operation.To get the complete set of properties, call the DescribeDatasetGroup (p. 169) operation, and provide theDatasetGroupArn.

Contents

CreationTime

When the dataset group was created.

Type: Timestamp

Required: NoDatasetGroupArn


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoDatasetGroupName

The name of the dataset group.

Type: String



Required: NoLastModificationTime

When the dataset group was created or last updated from a call to the UpdateDatasetGroup (p. 213)operation. While the dataset group is being updated, LastModificationTime is the current time ofthe ListDatasetGroups call.

Type: Timestamp

Required: No



224

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetGroupSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DatasetGroupSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DatasetGroupSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetGroupSummary


DatasetImportJobSummaryService: Amazon Forecast Service

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs (p. 193)operation. To get the complete set of properties, call the DescribeDatasetImportJob (p. 172) operation, andprovide the DatasetImportJobArn.

Contents

CreationTime

When the dataset import job was created.

Type: Timestamp

Required: NoDatasetImportJobArn


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoDatasetImportJobName

The name of the dataset import job.

Type: String



Required: NoDataSource

The location of the training data to import and an AWS Identity and Access Management (IAM) rolethat Amazon Forecast can assume to access the data. The training data must be stored in an AmazonS3 bucket.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Type: DataSource (p. 229) object


The last time that the dataset was modified. The time depends on the status of the job, as follows:• CREATE_PENDING - The same time as CreationTime.• CREATE_IN_PROGRESS - The current timestamp.• ACTIVE or CREATE_FAILED - When the job finished or failed.

Type: Timestamp

Required: No

225


Message


Type: String

Required: NoStatus

The status of the dataset import job. The status is reflected in the status of the dataset. Forexample, when the import job status is CREATE_IN_PROGRESS, the status of the dataset isUPDATE_IN_PROGRESS. States include:• ACTIVE


Type: String


Required: No

See Also



226

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetImportJobSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DatasetImportJobSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DatasetImportJobSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetImportJobSummary


DatasetSummaryService: Amazon Forecast Service

Provides a summary of the dataset properties used in the ListDatasets (p. 196) operation. To get thecomplete set of properties, call the DescribeDataset (p. 165) operation, and provide the DatasetArn.

Contents

CreationTime

When the dataset was created.

Type: Timestamp

Required: NoDatasetArn


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoDatasetName

The name of the dataset.

Type: String



Required: NoDatasetType

The dataset type.

Type: String

Valid Values: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Required: NoDomain

The domain associated with the dataset.

Type: String



When you create a dataset, LastModificationTime is the same as CreationTime. While datais being imported to the dataset, LastModificationTime is the current time of the ListDatasets

227


call. After a CreateDatasetImportJob (p. 136) operation has finished, LastModificationTime iswhen the import job completed or failed.

Type: Timestamp

Required: No

See Also



228

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetSummary


DataSourceService: Amazon Forecast Service

The source of your training data, an AWS Identity and Access Management (IAM) role that allows AmazonForecast to access the data and, optionally, an AWS Key Management Service (KMS) key. This object issubmitted in the CreateDatasetImportJob (p. 136) request.

Contents

S3Config

The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket alongwith the credentials to access the data.

Type: S3Config (p. 253) object

Required: Yes

See Also



229

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/DataSource

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/DataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataSource


EncryptionConfigService: Amazon Forecast Service

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM)role that Amazon Forecast can assume to access the key. You can specify this optional object in theCreateDataset (p. 129) and CreatePredictor (p. 146) requests.

Contents

KMSKeyArn

The Amazon Resource Name (ARN) of the KMS key.

Type: String


Pattern: arn:aws:kms:.*:key/.*

Required: YesRoleArn

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, youget an InvalidInputException error.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

See Also



230

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EncryptionConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/EncryptionConfig

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/EncryptionConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EncryptionConfig


EvaluationParametersService: Amazon Forecast Service

Parameters that define how to split a dataset into training data and testing data, and the number ofiterations to perform. These parameters are specified in the predefined algorithms but you can overridethem in the CreatePredictor (p. 146) request.

Contents

BackTestWindowOffset

The point from the end of the dataset where you want to split the data for model training and testing(evaluation). Specify the value as the number of data points. The default is the value of the forecasthorizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This valuemust be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIESdataset length.

ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

Type: Integer

Required: NoNumberOfBacktestWindows

The number of times to split the input data. The default is 1. Valid values are 1 through 5.

Type: Integer

Required: No

See Also



231

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationParameters

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/EvaluationParameters

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/EvaluationParameters

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationParameters


EvaluationResultService: Amazon Forecast Service

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics (p. 188) response.

Contents

AlgorithmArn

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoTestWindows

The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows fromthe EvaluationParameters (p. 231) object determines the number of windows in the array.

Type: Array of WindowSummary (p. 266) objects

Required: No

See Also



232

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationResult

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/EvaluationResult

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/EvaluationResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationResult


FeaturizationService: Amazon Forecast Service

Provides featurization (transformation) information for a dataset field. This object is part of theFeaturizationConfig (p. 234) object.

For example:

{

"AttributeName": "demand",

FeaturizationPipeline [ {

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}

} ]

}

Contents

AttributeName

The name of the schema attribute that specifies the data field to be featurized. Amazon Forecastsupports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets.For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target istarget_value. For more information, see 欠落した値の処理 (p. 12).

Type: String



Required: YesFeaturizationPipeline

An array of one FeaturizationMethod object that specifies the feature transformation method.

Type: Array of FeaturizationMethod (p. 236) objects

Array Members: Fixed number of 1 item.

Required: No

See Also



233

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Featurization

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Featurization

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Featurization

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Featurization


FeaturizationConfigService: Amazon Forecast Service

In a CreatePredictor (p. 146) operation, the specified algorithm trains a model using the specifieddataset group. You can optionally tell the operation to modify data fields prior to training a model. Thesemodifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an arrayof transformations, one for each field that you want to featurize. You then include theFeaturizationConfig object in your CreatePredictor request. Amazon Forecast applies thefeaturization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictoroperation twice by specifying different featurization configurations.

Contents

Featurizations

An array of featurization (transformation) information for the fields of a dataset.

Type: Array of Featurization (p. 233) objects


Required: NoForecastDimensions

An array of dimension (field) names that specify how to group the generated forecast.

For example, suppose that you are generating a forecast for item sales across all of your stores, andyour dataset contains a store_id field. If you want the sales forecast for each item by store, youwould specify store_id as the dimension.

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified inthe CreatePredictor request. All forecast dimensions specified in the RELATED_TIME_SERIESdataset must be specified in the CreatePredictor request.





Required: NoForecastFrequency

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates everyyear and "5min" indicates every five minutes.

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to theRELATED_TIME_SERIES dataset frequency.

234


Type: String

Pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

Required: Yes

See Also



235

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/FeaturizationConfig

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/FeaturizationConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationConfig


FeaturizationMethodService: Amazon Forecast Service

Provides information about the method that featurizes (transforms) a dataset field. The method is part of theFeaturizationPipeline of the Featurization (p. 233) object.

The following is an example of how you specify a FeaturizationMethod object.

{

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero","backfill": "zero"}

}

Contents

FeaturizationMethodName

The name of the method. The "filling" method is the only supported method.

Type: String

Valid Values: filling

Required: YesFeaturizationMethodParameters

The method parameters (key-value pairs), which are a map of override parameters. Specify theseparameters to override the default values. Related Time Series attributes do not accept aggregationparameters.

The following list shows the parameters and their valid values for the "filling" featurization method for aTarget Time Series dataset. Bold signifies the default value.• aggregation: sum, avg, first, min, max• frontfill: none• middlefill: zero, nan (not a number), value, median, mean, min, max• backfill: zero, nan, value, median, mean, min, max

The following list shows the parameters and their valid values for a Related Time Series featurizationmethod (there are no defaults):• middlefill: zero, value, median, mean, min, max• backfill: zero, value, median, mean, min, max• futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to value and define the value in acorresponding _value parameter. For example, to set backfilling to a value of 2, include the following:"backfill": "value" and "backfill_value":"2".


Map Entries: Maximum number of 20 items.


Key Pattern: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

236




Required: No

See Also



237

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationMethod

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/FeaturizationMethod

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/FeaturizationMethod

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationMethod


FilterService: Amazon Forecast Service

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement.The condition is either IS or IS_NOT, which specifies whether to include or exclude the objects that matchthe statement, respectively. The match statement consists of a key and a value.

Contents

Condition

The condition to apply. To include the objects that match the statement, specify IS. To excludematching objects, specify IS_NOT.

Type: String

Valid Values: IS | IS_NOT

Required: YesKey

The name of the parameter to filter on.

Type: String



Required: YesValue

The value to match.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

See Also



238

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Filter

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Filter

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Filter

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Filter


ForecastExportJobSummaryService: Amazon Forecast Service

Provides a summary of the forecast export job properties used in the ListForecastExportJobs (p. 198)operation. To get the complete set of properties, call the DescribeForecastExportJob (p. 179) operation,and provide the listed ForecastExportJobArn.

Contents

CreationTime

When the forecast export job was created.

Type: Timestamp

Required: NoDestination

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Type: DataDestination (p. 223) object

Required: NoForecastExportJobArn

The Amazon Resource Name (ARN) of the forecast export job.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoForecastExportJobName

The name of the forecast export job.

Type: String




When the last successful export job finished.

Type: Timestamp

Required: NoMessage


Type: String

Required: No

239


Status

The status of the forecast export job. States include:• ACTIVE


Note

The Status of the forecast export job must be ACTIVE before you can access the forecast inyour S3 bucket.

Type: String


Required: No

See Also



240

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastExportJobSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ForecastExportJobSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ForecastExportJobSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastExportJobSummary


ForecastSummaryService: Amazon Forecast Service

Provides a summary of the forecast properties used in the ListForecasts (p. 201) operation. To get thecomplete set of properties, call the DescribeForecast (p. 176) operation, and provide the ForecastArnthat is listed in the summary.

Contents

CreationTime

When the forecast creation task was created.

Type: Timestamp


The Amazon Resource Name (ARN) of the dataset group that provided the data used to train thepredictor.

Type: String



Required: NoForecastArn

The ARN of the forecast.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoForecastName

The name of the forecast.

Type: String




Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creatingthe forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete(status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Type: Timestamp

Required: No

241


Message


Type: String

Required: NoPredictorArn

The ARN of the predictor used to generate the forecast.

Type: String



Required: NoStatus

The status of the forecast. States include:• ACTIVE


Note

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Type: String


Required: No

See Also



242

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ForecastSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ForecastSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastSummary


HyperParameterTuningJobConfigService: Amazon Forecast Service

Configuration information for a hyperparameter tuning job. You specify this object in theCreatePredictor (p. 146) request.

A hyperparameter is a parameter that governs the model training process. You set hyperparametersbefore training starts, unlike model parameters, which are determined during training. The values of thehyperparameters effect which values are chosen for the model parameters.

In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values thatoptimize a specified metric. Forecast accomplishes this by running many training jobs over a range ofhyperparameter values. The optimum set of values depends on the algorithm, the training data, and thespecified metric objective.

Contents

ParameterRanges

Specifies the ranges of valid values for the hyperparameters.

Type: ParameterRanges (p. 248) object

Required: No

See Also



243

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/HyperParameterTuningJobConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/HyperParameterTuningJobConfig

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/HyperParameterTuningJobConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/HyperParameterTuningJobConfig


InputDataConfigService: Amazon Forecast Service

The data used to train a predictor. The data includes a dataset group and any supplementary features. Youspecify this object in the CreatePredictor (p. 146) request.

Contents

DatasetGroupArn


Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: YesSupplementaryFeatures

An array of supplementary features. The only supported feature is a holiday calendar.

Type: Array of SupplementaryFeature (p. 259) objects

Array Members: Fixed number of 1 item.

Required: No

See Also



244

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/InputDataConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/InputDataConfig

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/InputDataConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/InputDataConfig


IntegerParameterRangeService: Amazon Forecast Service

Specifies an integer hyperparameter and it's range of tunable values. This object is part of theParameterRanges (p. 248) object.

Contents

MaxValue

The maximum tunable value of the hyperparameter.

Type: Integer

Required: YesMinValue

The minimum tunable value of the hyperparameter.

Type: Integer

Required: YesName

The name of the hyperparameter to tune.

Type: String



Required: YesScalingType

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmicscale.

Logarithmic scaling works only for ranges that have values greater than 0.ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of thefollowing values:

Type: String

245

http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type


Valid Values: Auto | Linear | Logarithmic | ReverseLogarithmic

Required: No

See Also



246

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/IntegerParameterRange

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/IntegerParameterRange

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/IntegerParameterRange

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/IntegerParameterRange


MetricsService: Amazon Forecast Service

Provides metrics that are used to evaluate the performance of a predictor. This object is part of theWindowSummary (p. 266) object.

Contents

RMSE

The root mean square error (RMSE).

Type: Double

Required: NoWeightedQuantileLosses

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equalprobability. The distribution in this case is the loss function.

Type: Array of WeightedQuantileLoss (p. 265) objects

Required: No

See Also



247

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Metrics

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Metrics

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Metrics

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Metrics


ParameterRangesService: Amazon Forecast Service

Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values.The range of tunable values determines which values that a hyperparameter tuning job can choose for thespecified hyperparameter. This object is part of the HyperParameterTuningJobConfig (p. 243) object.

Contents

CategoricalParameterRanges

Specifies the tunable range for each categorical hyperparameter.

Type: Array of CategoricalParameterRange (p. 220) objects


Required: NoContinuousParameterRanges

Specifies the tunable range for each continuous hyperparameter.

Type: Array of ContinuousParameterRange (p. 221) objects


Required: NoIntegerParameterRanges

Specifies the tunable range for each integer hyperparameter.

Type: Array of IntegerParameterRange (p. 245) objects


Required: No

See Also



248

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ParameterRanges

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/ParameterRanges

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/ParameterRanges

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ParameterRanges


PredictorExecutionService: Amazon Forecast Service

The algorithm used to perform a backtest and the status of those tests.

Contents

AlgorithmArn

The ARN of the algorithm used to test the predictor.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoTestWindows

An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows from theEvaluationParameters (p. 231) object determines the number of windows in the array.

Type: Array of TestWindowSummary (p. 264) objects

Required: No

See Also



249

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecution

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/PredictorExecution

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/PredictorExecution

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecution


PredictorExecutionDetailsService: Amazon Forecast Service

Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests arereturned in descending order of accuracy, with the most accurate backtest appearing first. You specify thenumber of backtests to perform when you call the CreatePredictor (p. 146) operation.

Contents

PredictorExecutions

An array of the backtests performed to evaluate the accuracy of the predictor against a particularalgorithm. The NumberOfBacktestWindows from the EvaluationParameters (p. 231) objectdetermines the number of windows in the array.

Type: Array of PredictorExecution (p. 249) objects


Required: No

See Also



250

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecutionDetails

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/PredictorExecutionDetails

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/PredictorExecutionDetails

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecutionDetails


PredictorSummaryService: Amazon Forecast Service

Provides a summary of the predictor properties that are used in the ListPredictors (p. 204) operation. Toget the complete set of properties, call the DescribePredictor (p. 182) operation, and provide the listedPredictorArn.

Contents

CreationTime

When the model training task was created.

Type: Timestamp


The Amazon Resource Name (ARN) of the dataset group that contains the data used to train thepredictor.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$


Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts(status changed to CREATE_IN_PROGRESS), and when training is complete (status changed toACTIVE) or fails (status changed to CREATE_FAILED).

Type: Timestamp

Required: NoMessage


Type: String

Required: NoPredictorArn

The ARN of the predictor.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: NoPredictorName

The name of the predictor.

Type: String

251




Required: NoStatus

The status of the predictor. States include:• ACTIVE


Note

The Status of the predictor must be ACTIVE before you can use the predictor to create aforecast.

Type: String


Required: No

See Also



252

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/PredictorSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/PredictorSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorSummary


S3ConfigService: Amazon Forecast Service

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWSIdentity and Access Management (IAM) role that Amazon Forecast can assume to access thefile(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of theDataSource (p. 229) object that is submitted in the CreateDatasetImportJob (p. 136) request, and part ofthe DataDestination (p. 223) object that is submitted in the CreateForecastExportJob (p. 143) request.

Contents

KMSKeyArn

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Type: String


Pattern: arn:aws:kms:.*:key/.*

Required: NoPath

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3bucket.

Type: String

Pattern: ^s3://[a-z0-9].+$

Required: YesRoleArn

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assumeto access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role mustallow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, youget an InvalidInputException error.

Type: String


Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

See Also



253

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/S3Config

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/S3Config

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/S3Config

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/S3Config


254


SchemaService: Amazon Forecast Service

Defines the fields of a dataset. You specify this object in the CreateDataset (p. 129) request.

Contents

Attributes

An array of attributes specifying the name and type of each field in a dataset.

Type: Array of SchemaAttribute (p. 256) objects


Required: No

See Also



255

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Schema

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Schema

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Schema

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Schema


SchemaAttributeService: Amazon Forecast Service

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in adataset. The Schema (p. 255) object contains an array of SchemaAttribute objects.

Contents

AttributeName

The name of the dataset field.

Type: String



Required: NoAttributeType

The data type of the field.

Type: String

Valid Values: string | integer | float | timestamp

Required: No

See Also



256

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SchemaAttribute

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/SchemaAttribute

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/SchemaAttribute

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SchemaAttribute


StatisticsService: Amazon Forecast Service

Provides statistics for each data field imported into to an Amazon Forecast dataset with theCreateDatasetImportJob (p. 136) operation.

Contents

Avg

For a numeric field, the average value in the field.

Type: Double

Required: NoCount

The number of values in the field.

Type: Integer

Required: NoCountDistinct

The number of distinct values in the field.

Type: Integer

Required: NoCountNan

The number of NAN (not a number) values in the field.

Type: Integer

Required: NoCountNull

The number of null values in the field.

Type: Integer

Required: NoMax

For a numeric field, the maximum value in the field.

Type: String



Required: NoMin

For a numeric field, the minimum value in the field.

Type: String

257




Required: NoStddev

For a numeric field, the standard deviation.

Type: Double

Required: No

See Also



258

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Statistics

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Statistics

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Statistics

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Statistics


SupplementaryFeatureService: Amazon Forecast Service

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig (p. 244)object.

The only supported feature is Holidays. If you use the calendar, all data in the datasets should belong to thesame country as the calendar. For the holiday calendar data, see the Jollyday website.

Contents

Name

The name of the feature. This must be "holiday".

Type: String



Required: YesValue

One of the following 2 letter country codes:• "AL" - ALBANIA• "AR" - ARGENTINA• "AT" - AUSTRIA• "AU" - AUSTRALIA• "BA" - BOSNIA HERZEGOVINA• "BE" - BELGIUM• "BG" - BULGARIA• "BO" - BOLIVIA• "BR" - BRAZIL• "BY" - BELARUS• "CA" - CANADA• "CL" - CHILE• "CO" - COLOMBIA• "CR" - COSTA RICA• "HR" - CROATIA• "CZ" - CZECH REPUBLIC• "DK" - DENMARK• "EC" - ECUADOR• "EE" - ESTONIA• "ET" - ETHIOPIA• "FI" - FINLAND• "FR" - FRANCE• "DE" - GERMANY• "GR" - GREECE• "HU" - HUNGARY• "IS" - ICELAND

259

http://jollyday.sourceforge.net/data.html


• "IN" - INDIA• "IE" - IRELAND• "IT" - ITALY• "JP" - JAPAN• "KZ" - KAZAKHSTAN• "KR" - KOREA• "LV" - LATVIA• "LI" - LIECHTENSTEIN• "LT" - LITHUANIA• "LU" - LUXEMBOURG• "MK" - MACEDONIA• "MT" - MALTA• "MX" - MEXICO• "MD" - MOLDOVA• "ME" - MONTENEGRO• "NL" - NETHERLANDS• "NZ" - NEW ZEALAND• "NI" - NICARAGUA• "NG" - NIGERIA• "NO" - NORWAY• "PA" - PANAMA• "PY" - PARAGUAY• "PE" - PERU• "PL" - POLAND• "PT" - PORTUGAL• "RO" - ROMANIA• "RU" - RUSSIA• "RS" - SERBIA• "SK" - SLOVAKIA• "SI" - SLOVENIA• "ZA" - SOUTH AFRICA• "ES" - SPAIN• "SE" - SWEDEN• "CH" - SWITZERLAND• "UA" - UKRAINE• "AE" - UNITED ARAB EMIRATES• "US" - UNITED STATES• "UK" - UNITED KINGDOM• "UY" - URUGUAY• "VE" - VENEZUELA

Type: String


Pattern: ^[a-zA-Z0-9\_\-]+$

Required: Yes

260


See Also



261

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SupplementaryFeature

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/SupplementaryFeature

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/SupplementaryFeature

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SupplementaryFeature


TagService: Amazon Forecast Service

The optional metadata that you apply to a resource to help you categorize and organize them. Each tagconsists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.• For each resource, each tag key must be unique, and each tag key can have only one value.• Maximum key length - 128 Unicode characters in UTF-8.• Maximum value length - 256 Unicode characters in UTF-8.• If your tagging schema is used across multiple services and resources, remember that other services


• Tag keys and values are case sensitive.• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is

reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. Ifa tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and willcount against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags perresource limit.

Contents

Key

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category formore specific tag values.

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: YesValue

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tagcategory (key).

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

See Also


• AWS SDK for C++• AWS SDK for Go

262

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/Tag


• AWS SDK for Java• AWS SDK for Ruby V3

263

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Tag


TestWindowSummaryService: Amazon Forecast Service

The status, start time, and end time of a backtest, as well as a failure reason if applicable.

Contents

Message

If the test failed, the reason why it failed.

Type: String

Required: NoStatus

The status of the test. Possible status values are:• ACTIVE

• CREATE_IN_PROGRESS

• CREATE_FAILED

Type: String


Required: NoTestWindowEnd

The time at which the test ended.

Type: Timestamp

Required: NoTestWindowStart

The time at which the test began.

Type: Timestamp

Required: No

See Also



264

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TestWindowSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/TestWindowSummary

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/TestWindowSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TestWindowSummary


WeightedQuantileLossService: Amazon Forecast Service

The weighted loss value for a quantile. This object is part of the Metrics (p. 247) object.

Contents

LossValue

The difference between the predicted value and the actual value over the quantile, weighted(normalized) by dividing by the sum over all quantiles.

Type: Double

Required: NoQuantile

The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, ifthe distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and0.8.

Type: Double

Required: No

See Also



265

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WeightedQuantileLoss

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/WeightedQuantileLoss

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/WeightedQuantileLoss

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WeightedQuantileLoss


WindowSummaryService: Amazon Forecast Service

The metrics for a time range within the evaluation portion of a dataset. This object is part of theEvaluationResult (p. 232) object.

The TestWindowStart and TestWindowEnd parameters are determined by theBackTestWindowOffset parameter of the EvaluationParameters (p. 231) object.

Contents

EvaluationType

The type of evaluation.• SUMMARY - The average metrics across all windows.• COMPUTED - The metrics for the specified window.

Type: String

Valid Values: SUMMARY | COMPUTED

Required: NoItemCount

The number of data points within the window.

Type: Integer

Required: NoMetrics

Provides metrics used to evaluate the performance of a predictor.

Type: Metrics (p. 247) object

Required: NoTestWindowEnd

The timestamp that defines the end of the window.

Type: Timestamp

Required: NoTestWindowStart

The timestamp that defines the start of the window.

Type: Timestamp

Required: No

See Also


• AWS SDK for C++• AWS SDK for Go

266

https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WindowSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/forecast-2018-06-26/WindowSummary


• AWS SDK for Java• AWS SDK for Ruby V3

Amazon Forecast Query ServiceThe following data types are supported by Amazon Forecast Query Service:

• DataPoint (p. 268)• Forecast (p. 269)

267

https://docs.aws.amazon.com/goto/SdkForJava/forecast-2018-06-26/WindowSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WindowSummary


DataPointService: Amazon Forecast Query Service

The forecast value for a specific date. Part of the Forecast (p. 269) object.

Contents

Timestamp

The timestamp of the specific forecast.

Type: String

Required: NoValue

The forecast value.

Type: Double

Required: No

See Also



268

https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/DataPoint

https://docs.aws.amazon.com/goto/SdkForGoV1/forecastquery-2018-06-26/DataPoint

https://docs.aws.amazon.com/goto/SdkForJava/forecastquery-2018-06-26/DataPoint

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/DataPoint

Amazon Forecast 開発者ガイドCommon Errors

ForecastService: Amazon Forecast Query Service

Provides information about a forecast. Returned as part of the QueryForecast (p. 215) response.

Contents

Predictions

The forecast.

The string of the string-to-array map is one of the following values:• p10• p50• p90

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of theCreateForecast operation to change the values. The values will vary depending on how this is set, witha minimum of 1 and a maximum of 5.

Type: String to array of DataPoint (p. 268) objects map


Required: No



Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.


269


https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/Forecast

https://docs.aws.amazon.com/goto/SdkForGoV1/forecastquery-2018-06-26/Forecast

https://docs.aws.amazon.com/goto/SdkForJava/forecastquery-2018-06-26/Forecast

https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/Forecast

Amazon Forecast 開発者ガイドCommon Errors

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp onthe request is more than 15 minutes in the future.


270

Amazon Forecast 開発者ガイドCommon Parameters

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requests witha query string. Any action-specific parameters are listed in the topic for that action. For more informationabout Signature Version 4, see Signature Version 4 Signing Process in the Amazon Web Services GeneralReference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query string insteadof in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.

271

http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html

Amazon Forecast 開発者ガイドCommon Parameters


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signingrequests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required.When X-Amz-Date is used, it always overrides the value of the Date header. For more information, seeHandling Dates in Signature Version 4 in the Amazon Web Services General Reference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derived signingkey.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional

272

http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Amazon Forecast のドキュメント履歴

次の表は、Amazon Forecast 開発者ガイドの重要な変更点をまとめたものです。ドキュメントの更新に関する通知については、RSS フィードにサブスクライブできます。

• ドキュメント最新更新日 2020年9月1日

update-history-change update-history-description update-history-date

新機能 (p. 273) Amazon Forecast CNN-QRアルゴリズムをサポートするようになりました。詳細については、以下を参照してください。 CNN-QR.

August 10, 2020

新機能 (p. 273) Amazon Forecast では、データセットグループ、データセット、データセットインポートジョブ、予測者、予測、および予測エクスポートジョブなどのリソースのタグ付けがサポートされるようになりました。詳細については、以下を参照してください。タグ付け Amazon Forecastリソース.

July 9, 2020

新機能 (p. 273) Amazon Forecast では、関連する時系列データセットの欠落した値の入力がサポートされるようになりました。詳細については、「欠落した値の処理」を参照してください。

May 14, 2020

新しいリージョン (p. 273) Amazon Forecast で、アジアパシフィック (ソウル)、アジアパシフィック (ムンバイ)、および欧州 (フランクフルト) の各リージョンのサポートが追加されました。によってサポートされるAWS地域の完全なリストについては、 Amazon Forecast、を参照してください。 AWS領域テーブルまたは AWS地域とエンドポイントの Amazon Web Services一般リファレンス.

March 17, 2020

新しいリージョン (p. 273) Amazon Forecast で、アジアパシフィック (ソウル) リージョンのサポートが追加されました。によってサポートされるAWS地域の完全なリストについては、

January 27, 2020

273

https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-algo-cnnqr.html

https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html

https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html

https://docs.aws.amazon.com/forecast/latest/dg/howitworks-missing-values.html

https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/


https://docs.aws.amazon.com/general/latest/gr/forecast.html



Amazon Forecast、を参照してください。 AWS領域テーブルまたは AWS地域とエンドポイントの Amazon Web Services 一般リファレンス.

新機能 (p. 273) Forecast で、予測分位を指定する機能が追加されました。詳細については、Forecast API ガイドの「CreateForecast」を参照してください。

November 22, 2019

Amazon Forecast の一般的な可用性 (p. 273)

Amazon Forecast が一般的に利用できるようになりました。

August 21, 2019

Amazon Forecast プレビューリリース (p. 273)

本書は Amazon Forecast ドキュメントのプレビュー版の初版リリースです。

November 28, 2018

274





AWS の用語集最新の AWS の用語については、『AWS General Reference』の「AWS の用語集」を参照してください。

275

https://docs.aws.amazon.com/general/latest/gr/glos-chap.html


英語の翻訳が提供されている場合で、内容が矛盾する場合には、英語版がオリジナルとして取り扱われます。翻訳は機械翻訳により提供されています。

cclxxvi

amazon forecast - 開発者ガイド...amazon forecast 開発者ガイド amazon forecast...

Documents