リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラーその他の参照資料

CreateDatasetImportJob

トレーニングデータを Amazon Forecast のデータセットにインポートします。Amazon Simple Storage Service (Amazon S3) バケット内のトレーニングデータの場所と、データのインポート先とするデータセットの Amazon リソースネーム (ARN) を指定します。

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

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

特定のファイル、S3 バケット、または S3 バケット内のフォルダへのパスを指定できます。後者の 2 つのケースでは、Amazon Forecast は、上限である 10,000 個まですべてのファイルをインポートします。

データセットのインポートは集計されないため、最新のデータセットインポートは、予想子のトレーニング時や予測の生成時に使用されるものです。最新のデータセットインポートに、前回のインポート以降に収集された新しいデータだけでなく、モデル化するすべてのデータが含まれていることを確認します。

指定された基準でフィルタリングされたすべてのデータセットのインポートジョブのリストを取得するには、 ListDatasetImportJobsオペレーションを使用します。

リクエストの構文


{
   "DatasetArn": "string",
   "DatasetImportJobName": "string",
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "Format": "string",
   "GeolocationFormat": "string",
   "ImportMode": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimestampFormat": "string",
   "TimeZone": "string",
   "UseGeolocationForTimeZone": boolean
}

リクエストパラメータ

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

DatasetArn

データをインポートする Amazon Forecast データセットの Amazon リソースネーム (ARN)。

型: 文字列

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

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

必須：はい

DatasetImportJobName

データセットのインポートジョブの名前。名前に現在のタイムスタンプを含めることをお勧めします (例: 20190721DatasetImport)。これは、ResourceAlreadyExistsException 例外の発生を回避するのに役立ちます。

型: 文字列

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

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

必須：はい

DataSource

インポートするトレーニングデータの場所と、Amazon Forecast がデータにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。トレーニングデータは Amazon S3 バケットに保存されている必要があります。

暗号化を使用する場合は、に AWS Key Management Service (KMS) キーを含めるDataSource必要があり、IAM ロールは Amazon Forecast にキーへのアクセス許可を付与する必要があります。KMS キーと IAM ロールは、 CreateDatasetオペレーションの EncryptionConfigパラメータで指定されたものと一致する必要があります。

型: DataSource オブジェクト

必須: はい

Format

インポートされたデータの形式は CSV または PARQUETのいずれかです。デフォルト値は「CSV」です。

型: 文字列

長さの制限: 最大長は 7 です。

Pattern: ^CSV|PARQUET$

必須: いいえ

GeolocationFormat

geolocation 属性の形式。geolocation 属性は、次の 2 つの方法のいずれかでフォーマットできます。

LAT_LONG - 10 進数のフォーマットの緯度と経度 (例: 47.61_-122.33)。
CC_POSTALCODE (米国のみ) - 国コード (US) の後に 5 桁の郵便番号が続きます (例: US_98121)。

型: 文字列

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

パターン: ^[a-zA-Z0-9_]+$

必須: いいえ

ImportMode

データセットのインポートジョブが FULL インポートか INCREMENTAL インポートかを指定します。FULL データセットのインポートは、既存のデータをすべて新しくインポートされたデータに置き換えます。INCREMENTAL インポートでは、インポートされたデータが既存のデータに追加されます。

型: 文字列

有効な値：FULL | INCREMENTAL

必須：いいえ

Tags

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

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

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

タイプ：Tag オブジェクトの配列

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

必須: いいえ

TimestampFormat

データセット内のタイムスタンプの形式。指定する形式は、データセットが作成されたときに指定された DataFrequency によって異なります。以下の形式がサポートされています

「yyyy-MM-dd」

次のデータ周波数の場合: Y、M、W、D
「yyyy-MM-dd HH:mm:ss」

次のデータ頻度の場合: H、30min、15min、および 1min。オプションで、Y、M、W、および D

フォーマットが指定されていない場合、Amazon Forecast はフォーマットが「yyyy-MM-dd HH:mm:ss」であると想定します。

型: 文字列

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

パターン: ^[a-zA-Z0-9\-\:\.\,\'\s]+$

必須: いいえ

TimeZone

データセット内のすべての項目についての単一のタイムゾーン。このオプションは、すべてのタイムスタンプが単一のタイムゾーン内にあるデータセット、またはすべてのタイムスタンプが単一のタイムゾーンに正規化されているデータセットに最適です。

有効なタイムゾーン名の完全なリストについては、「Joda-Time API」を参照してください。

型: 文字列

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

パターン: ^[a-zA-Z0-9\/\+\-\_]+$

必須: いいえ

UseGeolocationForTimeZone

geolocation 属性からタイムゾーンの情報を自動的に取得します。このオプションは、複数のタイムゾーンのタイムスタンプを含み、それらのタイムスタンプが現地時間で表されるデータセットに最適です。

型: ブール値

必須: いいえ

レスポンスの構文


{
   "DatasetImportJobArn": "string"
}

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

DatasetImportJobArn

データセットのインポートジョブの Amazon リソースネーム (ARN)。

型: 文字列

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

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

エラー

InvalidInputException

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

HTTP ステータスコード：400

LimitExceededException

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

HTTP ステータスコード：400

ResourceAlreadyExistsException

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

HTTP ステータスコード：400

ResourceInUseException

指定されたリソースは使用中です。

HTTP ステータスコード：400

ResourceNotFoundException

その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。

HTTP ステータスコード：400

その他の参照資料

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

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

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

ドキュメントの表記規則

CreateDatasetGroup

CreateExplainability