AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateMLEndpoint operation. Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference endpoints using the endpoints command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CreateMLEndpoint IAM action in that cluster.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptunedata.AmazonNeptunedataRequest
      Amazon.Neptunedata.Model.CreateMLEndpointRequest

Namespace: Amazon.Neptunedata.Model
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateMLEndpointRequest : AmazonNeptunedataRequest
         IAmazonWebServiceRequest

The CreateMLEndpointRequest type exposes the following members

Constructors

NameDescription
Public Method CreateMLEndpointRequest()

Properties

NameTypeDescription
Public Property Id System.String

Gets and sets the property Id.

A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.

Public Property InstanceCount System.Int32

Gets and sets the property InstanceCount.

The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The type of Neptune ML instance to use for online servicing. The default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.

Public Property MlModelTrainingJobId System.String

Gets and sets the property MlModelTrainingJobId.

The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Public Property MlModelTransformJobId System.String

Gets and sets the property MlModelTransformJobId.

The job Id of the completed model-transform job. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Public Property ModelName System.String

Gets and sets the property ModelName.

Model type for training. By default the Neptune ML model is automatically based on the modelType used in data processing, but you can specify a different model type here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge, transe, distmult, and rotate.

Public Property NeptuneIamRoleArn System.String

Gets and sets the property NeptuneIamRoleArn.

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

Public Property Update System.Boolean

Gets and sets the property Update.

If set to true, update indicates that this is an update request. The default is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Public Property VolumeEncryptionKMSKey System.String

Gets and sets the property VolumeEncryptionKMSKey.

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5