

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

# Neptune ML 推論エンドポイント API
<a name="data-api-dp-inference"></a>

**推論エンドポイントアクション:**
+ [CreateMLEndpoint (アクション)](#CreateMLEndpoint)
+ [ListMLEndpoints (アクション)](#ListMLEndpoints)
+ [GetMLEndpoint (アクション)](#GetMLEndpoint)
+ [DeleteMLEndpoint (アクション)](#DeleteMLEndpoint)

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

         この API の AWS CLI 名は `create-ml-endpoint` です。

モデルトレーニングプロセスによって構築された 1 つの特定のモデルをクエリできる新しい Neptune ML 推論エンドポイントを作成します。「[エンドポイントコマンドを使用して推論エンドポイントを管理する](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)」を参照してください。

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

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

  新しい推論エンドポイントの一意識別子。デフォルト値は、自動生成されたタイムスタンプ付きの名前です。
+ **instanceCount** (CLI では: `--instance-count`) — タイプ `integer` の整数 (符号付き 32 ビット整数)。

  予測のためにエンドポイントにデプロイする Amazon EC2 インスタンスの最小数。デフォルトは 1 です。
+ **instanceType** (CLI では: `--instance-type`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  オンラインサービスに使用される Neptune ML インスタンスのタイプ。デフォルトは `ml.m5.xlarge` です。推論エンドポイントの ML インスタンスの選択は、タスクタイプ、グラフサイズ、および予算によって異なります。
+ **mlModelTrainingJobId** (CLI では: `--ml-model-training-job-id`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  推論エンドポイントが指すモデルを作成した、完了したモデルトレーニングジョブのジョブ ID。`mlModelTrainingJobId` または `mlModelTransformJobId` のいずれかを指定する必要があります。
+ **mlModelTransformJobId** (CLI では: `--ml-model-transform-job-id`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  完了したモデル変換ジョブのジョブ ID。`mlModelTrainingJobId` または `mlModelTransformJobId` のいずれかを指定する必要があります。
+ **modelName** (CLI では: `--model-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  トレーニング用のモデルタイプ。デフォルトでは、Neptune ML モデルは、データ処理に使用される `modelType` に自動的に基づきますが、ここで別のモデルタイプを指定することができます。デフォルトは、異種グラフについては `rgcn` であり、ナレッジグラフについては `kge` です。異種グラフの唯一有効な値は `rgcn` です。ナレッジグラフの有効値は、`kge`、`transe`、`distmult`、および `rotate` です。
+ **neptuneIamRoleArn** (CLI では: `--neptune-iam-role-arn`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合、エラーがスローされます。
+ **update** (CLI では: `--update`) — タイプ `boolean` のブール値 (ブール値 (真または偽) の値)。

  `true` に設定された場合、`update` は、これが更新リクエストであることを示します。デフォルトは `false` です。`mlModelTrainingJobId` または `mlModelTransformJobId` のいずれかを指定する必要があります。
+ **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)

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

         この API の AWS CLI 名は `list-ml-endpoints` です。

既存の推論エンドポイントを一覧表示します。「[エンドポイントコマンドを使用して推論エンドポイントを管理する](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)」を参照してください。

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

**[リクエスト**]
+ **maxItems** (CLI では: `--max-items`) — ListMLEndpointsInputMaxItemsInteger、タイプ `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)

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

         この API の AWS CLI 名は `get-ml-endpoint` です。

推論エンドポイントに関する詳細を取得します。「[エンドポイントコマンドを使用して推論エンドポイントを管理する](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)」を参照してください。

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

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

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

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

**レスポンス**
+ **endpoint** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) オブジェクト。

  エンドポイント定義。
+ **endpointConfig** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) オブジェクト。

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

  推論エンドポイントの一意識別子。
+ **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)

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

         この API の AWS CLI 名は `delete-ml-endpoint` です。

Neptune ML 推論エンドポイントの作成をキャンセルします。「[エンドポイントコマンドを使用して推論エンドポイントを管理する](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで [neptune-db:DeleteMLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint) 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)