

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

# Neptune ML データ処理 API
<a name="data-api-dp-ml-data-processing"></a>

**データ処理アクション:**
+ [StartMLDataProcessingJob (アクション)](#StartMLDataProcessingJob)
+ [ListMLDataProcessingJobs (アクション)](#ListMLDataProcessingJobs)
+ [GetMLDataProcessingJob (アクション)](#GetMLDataProcessingJob)
+ [CancelMLDataProcessingJob (アクション)](#CancelMLDataProcessingJob)

**ML 汎用構造体:**
+ [MlResourceDefinition (構造)](#MlResourceDefinition)
+ [MLConfigDefinition (構造)](#MlConfigDefinition)

## StartMLDataProcessingJob (アクション)
<a name="StartMLDataProcessingJob"></a>

         この API の AWS CLI 名は `start-ml-data-processing-job` です。

Neptune からエクスポートされたグラフデータをトレーニング用に処理するための新しい Neptune ML データ処理ジョブを作成します。「[`dataprocessing` コマンド](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで [neptune-db:StartMLModelDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob) IAM アクションを許可するポリシーがアタッチされている必要があります。

**[リクエスト**]
+ **configFileName** (CLI では: `--config-file-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  トレーニング用にエクスポートされたグラフデータをロードする方法を説明するデータ仕様ファイル。ファイルは Neptune エクスポートツールキットによって自動的に生成されます。デフォルトは `training-data-configuration.json` です。
+ **id** (CLI では: `--id`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  新しいジョブの一意識別子。デフォルト値は、自動生成された UUID です。
+ **inputDataS3Location** (CLI では: `--input-data-s3-location`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  データ処理ジョブの実行に必要なデータを SageMaker がダウンロードする Amazon S3 ロケーションの URI。
+ **modelType** (CLI では: `--model-type`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  Neptune ML が現在サポートしている 2 つのモデルタイプ、異種グラフモデル (`heterogeneous`) とナレッジグラフ (`kge`) のうちの 1 つ。デフォルトは none です。指定されなかった場合、Neptune ML はデータに基づいてモデルタイプを自動的に選択します。
+ **neptuneIamRoleArn** (CLI では: `--neptune-iam-role-arn`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  SageMaker がユーザーに代わってタスクを実行するために引き受けることができる IAM ロールの Amazon リソースネーム (ARN)。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。
+ **previousDataProcessingJobId** (CLI では: `--previous-data-processing-job-id`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  以前のバージョンのデータに対して実行された完了したデータ処理ジョブのジョブ ID。
+ **processedDataS3Location** (CLI では: `--processed-data-s3-location`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  SageMaker がデータ処理ジョブの結果を保存する Amazon S3 ロケーションの URI。
+ **processingInstanceType** (CLI では: `--processing-instance-type`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  データ処理中に使用される ML インスタンスのタイプ。処理されたデータセットを保持できる十分なメモリ容量が必要です。デフォルト値は、ディスク上にエクスポートされたグラフデータのサイズの 10 倍のメモリを持つ最も小さい ml.r5 タイプです。
+ **processingInstanceVolumeSizeInGB** (CLI では: `--processing-instance-volume-size-in-gb`) — タイプ `integer` の整数 (符号付き 32 ビット整数)。

  処理インスタンスのディスクボリュームサイズ。入力データと処理されたデータの両方がディスクに保存されるため、ボリュームサイズは両方のデータセットを保持するのに十分な大きさでなければなりません。デフォルトは 0 です。指定されなかったか、0 の場合、Neptune ML はデータサイズに基づいてボリュームサイズを自動的に選択します。
+ **processingTimeOutInSeconds** (CLI では: `--processing-time-out-in-seconds`) — タイプ `integer` の整数 (符号付き 32 ビット整数)。

  データ処理ジョブのタイムアウト (秒単位)。デフォルトは 86,400 (1 日) です。
+ **s3OutputEncryptionKMSKey** (CLI では: `--s-3-output-encryption-kms-key`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  SageMaker が処理ジョブの出力を暗号化するために使用する Amazon キー管理サービス (Amazon KMS) キー。デフォルトは none です。
+ **sagemakerIamRoleArn** (CLI では: `--sagemaker-iam-role-arn`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  SageMaker 実行のための IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。
+ **securityGroupIds** (CLI では: `--security-group-ids`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  VPC セキュリティグループ ID。デフォルトは [なし] です。
+ **subnets** (CLI では: `--subnets`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  Neptune VPC 内のサブネットの ID。デフォルトは [なし] です。
+ **volumeEncryptionKMSKey** (CLI では: `--volume-encryption-kms-key`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  トレーニングジョブを実行する ML コンピューティングインスタンスにアタッチされたストレージボリュームのデータを暗号化するために SageMaker が使用する Amazon キー管理サービス (Amazon KMS) キー。デフォルトは [なし] です。

**レスポンス**
+ **arn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  データ処理ジョブの ARN。
+ **creationTimeInMillis** — タイプ `long` の長整数 (符号付き 64 ビット整数)。

  新しい処理ジョブの作成にかかった時間 (ミリ秒単位)。
+ **id** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  新しいデータ処理ジョブの一意 ID。

**エラー**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## ListMLDataProcessingJobs (アクション)
<a name="ListMLDataProcessingJobs"></a>

         この API の AWS CLI 名は `list-ml-data-processing-jobs` です。

Neptune ML データ処理ジョブのリストを返します。「[Neptune ML データ処理コマンドを使用したアクティブなデータ処理ジョブの一覧表示](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs)」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで [neptune-db:ListMLDataProcessingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs) IAM アクションを許可するポリシーがアタッチされている必要があります。

**[リクエスト**]
+ **maxItems** (CLI では: `--max-items`) — ListMLDataProcessingJobsInputMaxItemsInteger、タイプ `integer` (符号付き 32 ビット整数)、1 以上か 1024 以上？ st? s。

  返される項目の最大数 (1 ～ 1024、デフォルトは 10)。
+ **neptuneIamRoleArn** (CLI では: `--neptune-iam-role-arn`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。

**レスポンス**
+ **ids** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  データ処理ジョブ ID を一覧表示するページ。

**エラー**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## GetMLDataProcessingJob (アクション)
<a name="GetMLDataProcessingJob"></a>

         この API の AWS CLI 名は `get-ml-data-processing-job` です。

指定されたデータ処理ジョブに関する情報を取得します。「[`dataprocessing` コマンド](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで [neptune-db:neptune-db:GetMLDataProcessingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus) IAM アクションを許可するポリシーがアタッチされている必要があります。

**[リクエスト**]
+ **id** (CLI では: `--id`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  取得されるデータ処理ジョブの一意識別子。
+ **neptuneIamRoleArn** (CLI では: `--neptune-iam-role-arn`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。

**レスポンス**
+ **id** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このデータ処理ジョブの一意識別子。
+ **processingJob** – [MlResourceDefinition](#MlResourceDefinition) オブジェクト。

  データ処理ジョブの定義。
+ **status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  データ処理ジョブのステータス。

**エラー**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## CancelMLDataProcessingJob (アクション)
<a name="CancelMLDataProcessingJob"></a>

         この API の AWS CLI 名は `cancel-ml-data-processing-job` です。

Neptune ML データ処理ジョブをキャンセルします。「[`dataprocessing` コマンド](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで [neptune-db:CancelMLDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob) IAM アクションを許可するポリシーがアタッチされている必要があります。

**[リクエスト**]
+ **clean** (CLI では: `--clean`) — タイプ `boolean` のブール値 (ブール値 (真または偽) の値)。

  `TRUE` に設定された場合、このフラグは、ジョブが停止したときにすべての Neptune ML S3 アーティファクトが削除される必要があることを指定します。デフォルトは `FALSE` です。
+ **id** (CLI では: `--id`) — *必須:* `string` タイプの文字列 (UTF-8 でエンコードされた文字列)。

  データ処理ジョブの一意識別子。
+ **neptuneIamRoleArn** (CLI では: `--neptune-iam-role-arn`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。

**レスポンス**
+ **status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  キャンセルリクエストのステータス。

**エラー**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## *ML 汎用構造体:*
<a name="data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer"></a>

## MlResourceDefinition (構造)
<a name="MlResourceDefinition"></a>

Neptune ML リソースを定義します。

**フィールド**
+ **arn** - 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  リソース ARN。
+ **cloudwatchLogUrl** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  リソースの CloudWatch ログ URL。
+ **failureReason** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  障害が発生した場合の障害理由。
+ **name** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  リソース名。
+ **outputLocation** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  出力場所。
+ **status** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  リソースステータス。

## MLConfigDefinition (構造)
<a name="MlConfigDefinition"></a>

Neptune ML 構成を含みます。

**フィールド**
+ **arn** - 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  構成の ARN。
+ **name** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  設定名。