Skip to content

CreateMLEndpointInput

Source code in docs_src/capo_neptunedata/types/create_ml_endpoint_input.py
class CreateMLEndpointInput(TypedDict, closed=True):
    id: NotRequired["str"]
    """<p>A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.</p>"""
    ml_model_training_job_id: NotRequired["str"]
    """<p>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 <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>"""
    ml_model_transform_job_id: NotRequired["str"]
    """<p>The job Id of the completed model-transform job. You must supply either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>"""
    update: NotRequired["bool"]
    """<p>If set to <code>true</code>, <code>update</code> indicates that this is an update request. The default is <code>false</code>. You must supply either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>"""
    neptune_iam_role_arn: NotRequired["str"]
    """<p>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.</p>"""
    model_name: NotRequired["str"]
    """<p>Model type for training. By default the Neptune ML model is automatically based on the <code>modelType</code> used in data processing, but you can specify a different model type here. The default is <code>rgcn</code> for heterogeneous graphs and <code>kge</code> for knowledge graphs. The only valid value for heterogeneous graphs is <code>rgcn</code>. Valid values for knowledge graphs are: <code>kge</code>, <code>transe</code>, <code>distmult</code>, and <code>rotate</code>.</p>"""
    instance_type: NotRequired["str"]
    """<p>The type of Neptune ML instance to use for online servicing. The default is <code>ml.m5.xlarge</code>. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.</p>"""
    instance_count: NotRequired["int"]
    """<p>The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1</p>"""
    volume_encryption_kms_key: NotRequired["str"]
    """<p>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.</p>"""

id instance-attribute

id: NotRequired[str]

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

instance_count instance-attribute

instance_count: NotRequired[int]

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

instance_type instance-attribute

instance_type: NotRequired[str]

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.

ml_model_training_job_id instance-attribute

ml_model_training_job_id: NotRequired[str]

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.

ml_model_transform_job_id instance-attribute

ml_model_transform_job_id: NotRequired[str]

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

model_name instance-attribute

model_name: NotRequired[str]

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.

neptune_iam_role_arn instance-attribute

neptune_iam_role_arn: NotRequired[str]

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.

update instance-attribute

update: NotRequired[bool]

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.

volume_encryption_kms_key instance-attribute

volume_encryption_kms_key: NotRequired[str]

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.