リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

CreateDataset

Amazon Forecast データセットを作成します。

重要

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

提供するデータセットに関する情報は、Forecast がモデルトレーニングのためにデータを使用する方法を理解するのに役立ちます。これには以下が含まれます。

DataFrequency - 履歴時系列データが収集される頻度。
Domain および DatasetType - 各データセットには、関連付けられたデータセットドメインとドメイン内のタイプがあります。Amazon Forecast は、各ドメイン内の事前定義されたドメインとタイプのリストを提供します。一意の各データセットドメインとそのドメイン内のタイプについて、Amazon Forecast では、最小限の事前設定されたフィールドセットがデータに含まれている必要があります。
Schema - スキーマは、フィールド名やデータ型など、データセット内のフィールドを指定します。

データセットを作成したら、それにトレーニングデータをインポートし、そのデータセットをデータセットグループに追加します。データセットグループを使用して予測子を作成します。詳細については、「データセットのインポート」を参照してください。

すべてのデータセットのリストを取得するには、 ListDatasetsオペレーションを使用します。

Forecast データセットの例については、「Amazon Forecast サンプル GitHubリポジトリ」を参照してください。

注記

データセットの Status は、トレーニングデータをインポートする前に ACTIVE である必要があります。DescribeDataset オペレーションを使用してステータスを取得します。

リクエストの構文


{
   "DataFrequency": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

リクエストパラメータ

リクエストは、 JSON形式の次のデータを受け入れます。

DataFrequency

データ収集の頻度。このパラメータは RELATED_TIME_SERIES データセットに必要です。

有効な間隔は、整数の後に Y (年)、M (月)、W (週)、D (日)、H (時)、min (分) をつけたものです。例えば、「1D」は毎日を示し、「15min」は 15 分ごとを示します。次に多頻度で重複するような値は指定できません。つまり、たとえば 60 分の間隔は 1 時間に相当するため、指定することはできません。各頻度の有効な値は以下のとおりです。

分 - 1～59
時間 - 1～23
日 - 1～6
週 - 1～4
月 - 1～11
年 - 1

したがって、隔週の予測が必要な場合は、「2W」と指定します。または、四半期ごとの予測が必要な場合は、「3M」と指定します。

型: 文字列

長さの制限：最小長は 1 です。最大長は 5 です。

パターン: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

必須: いいえ

DatasetName

データセットの名前。

型: 文字列

長さの制限：最小長は 1 です。最大長は 63 です。

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

必須：はい

DatasetType

データセットのタイプ。有効な値は、選択した Domain によって異なります。

型: 文字列

有効な値: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

必須：はい

Domain

データセットに関連付けられているドメイン。データセットをデータセットグループに追加する場合、この値と CreateDatasetGroup オペレーションの Domainパラメータに指定された値が一致する必要があります。

Domain と DatasetType を選択すると、データセットにインポートするトレーニングデータに存在しなければならないフィールドが決まります。例えば、RETAIL ドメインを選択し、DatasetType として TARGET_TIME_SERIES を指定した場合、Amazon Forecast では、item_id、timestamp、および demand フィールドがデータに存在している必要があります。詳細については、「データセットのインポート」を参照してください。

型: 文字列

必須：はい

EncryptionConfig

Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service （KMS) キーと AWS Identity and Access Management （IAM) ロール。

型: EncryptionConfig オブジェクト

必須：いいえ

Schema

データセットのスキーマ。スキーマ属性とその順序は、データのフィールドと一致する必要があります。データセット Domain と選択した DatasetType によって、トレーニングデータの最小必須フィールドが決まります。特定のデータセットドメインとタイプの必須フィールドについては、「データセットドメインとデータセットタイプ」を参照してください。

型: Schema オブジェクト

必須：はい

Tags

サービスに適用し、データセットの分類と整理に役立つオプションのメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。

タグには以下のベーシックな制限があります。

リソースあたりのタグの最大数は 50 です。
タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
最大キー長 - -8 で 12UTF8 Unicode 文字。
値の最大長 - UTF-8 で 256 Unicode 文字。
複数ののサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に許可される文字は、文字、数字、スペースで UTF-8 で表され、+ - = . _ : / @ です。
タグのキーと値では、大文字と小文字が区別されます。
aws:、AWS:、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には aws がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。aws のキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。

型: Tag オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

必須：いいえ

レスポンスの構文


{
   "DatasetArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを返します。

次のデータは、サービスによって JSON 形式で返されます。

DatasetArn

データセットの Amazon リソースネーム (ARN）。

型: 文字列

長さの制限：最大長は 256 です。

パターン: arn:([a-z\d-]+):forecast:.*:.*:.+

エラー

InvalidInputException

無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。

HTTP ステータスコード: 400

LimitExceededException

アカウントあたりのリソース数の制限を超えました。

HTTP ステータスコード: 400

ResourceAlreadyExistsException

この名前のリソースは既に存在します。別の名前で再試行してください。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有ののいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CreateAutoPredictor

CreateDatasetGroup