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

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

CreateDatasetExportJob

データセットから Amazon S3 バケットにデータをエクスポートするジョブを作成します。Amazon Personalize がトレーニングデータをエクスポートできるようにするには、Amazon S3 バケットについての PutObject の許可を Amazon Personalize に付与する、サービスにリンクされた IAM ロールを指定する必要があります。詳細については、Amazon Personalize デベロッパーガイドの「データセットのエクスポート」を参照してください。

[ステータス]

データセットのエクスポートジョブは、次のいずれかの状態になります。

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -または- CREATE FAILED

エクスポートジョブのステータスを取得するには、を呼び出しDescribeDatasetExportJob、データセットエクスポートジョブの Amazon リソースネーム (ARN) を指定します。ステータスが ACTIVE と表示されると、データセットのエクスポートが完了します。ステータスが CREATE FAILED と表示されている場合、レスポンスには、ジョブが失敗した理由を記述する failureReason キーが含まれています。

リクエストの構文

{
   "datasetArn": "string",
   "ingestionMode": "string",
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}

リクエストパラメータ

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

datasetArn

エクスポートするデータを含むデータセットの Amazon リソースネーム (ARN)。

型: 文字列

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

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

必須：はい

ingestionMode

エクスポートするデータ (データをインポートした方法に基づく)。BULKデータセットのインポートジョブを使用してインポートしたデータのみをエクスポートするか、(コンソール、、 PutItems オペレーションを使用して) PUT 段階的にインポートしたデータのみをエクスポートするか PutEvents、 PutUsers ALLまたは両方のタイプをエクスポートするかを選択できます。デフォルト値は PUT です。

型: 文字列

有効な値：BULK | PUT | ALL

必須：いいえ

jobName

データセットのエクスポートジョブの名前。

型: 文字列

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

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

必須：はい

jobOutput

ジョブの出力が保存される Amazon S3 バケットへのパス。

型: DatasetExportJobOutput オブジェクト

必須: はい

roleArn

出力 Amazon S3 バケットにデータを追加するための許可を持つ IAM サービスロールの Amazon リソースネーム (ARN)。

型: 文字列

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

パターン：arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

必須：はい

tags

データセットのエクスポートジョブに適用するタグのリスト。

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

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

必須: いいえ

レスポンスの構文

{
   "datasetExportJobArn": "string"
}

レスポンス要素

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

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

datasetExportJobArn

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

型: 文字列

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

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

エラー

InvalidInputException

フィールドまたはパラメータに有効な値を指定します。

HTTP ステータスコード：400

LimitExceededException

1 秒あたりのリクエスト数の上限を超えています。

HTTP ステータスコード：400

ResourceAlreadyExistsException

指定したリソースはすでに存在しています。

HTTP ステータスコード：400

ResourceInUseException

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

HTTP ステータスコード：400

ResourceNotFoundException

指定されたリソースが見つかりませんでした。

HTTP ステータスコード：400

TooManyTagsException

このリソースに適用できるタグの最大数を超過しています。

HTTP ステータスコード：400

その他の参照資料

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