ml_endpoints

Creates, updates, deletes, gets or lists a ml_endpoints resource.

Overview

Name	ml_endpoints
Type	Resource
Id	aws.neptunedata.ml_endpoints

Fields

The following fields are returned by SELECT queries:

get_ml_endpoint

Name	Datatype	Description
id	string	The unique identifier of the inference endpoint.
endpoint	object	The endpoint definition.
endpoint_config	object	Contains a Neptune ML configuration.
status	string	The status of the inference endpoint.

list_ml_endpoints

Name	Datatype	Description
id	string	A page from the list of inference endpoint IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ml_endpoint	select	id, region	neptuneIamRoleArn	Retrieves details about an inference endpoint. 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:GetMLEndpointStatus IAM action in that cluster.
list_ml_endpoints	select	region	maxItems, neptuneIamRoleArn	Lists existing inference endpoints. 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:ListMLEndpoints IAM action in that cluster.
create_ml_endpoint	insert	region		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.
delete_ml_endpoint	delete	id, region	neptuneIamRoleArn, clean	Cancels the creation of a Neptune ML inference endpoint. 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:DeleteMLEndpoint IAM action in that cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier of the inference endpoint.
region	string	AWS region (default: us-east-1)
clean	boolean	If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.
maxItems	integer	The maximum number of items to return (from 1 to 1024; the default is 10.
neptuneIamRoleArn	string	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.

SELECT examples

get_ml_endpoint

Retrieves details about an inference endpoint. 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:GetMLEndpointStatus IAM action in that cluster.

SELECT
id,
endpoint,
endpoint_config,
status
FROM aws.neptunedata.ml_endpoints
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
;

list_ml_endpoints

Lists existing inference endpoints. 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:ListMLEndpoints IAM action in that cluster.

SELECT
id
FROM aws.neptunedata.ml_endpoints
WHERE region = '{{ region }}' -- required
AND maxItems = '{{ maxItems }}'
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
;

INSERT examples

create_ml_endpoint

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.

INSERT INTO aws.neptunedata.ml_endpoints (
id,
mlModelTrainingJobId,
mlModelTransformJobId,
update,
neptuneIamRoleArn,
modelName,
instanceType,
instanceCount,
volumeEncryptionKMSKey,
region
)
SELECT 
'{{ id }}',
'{{ mlModelTrainingJobId }}',
'{{ mlModelTransformJobId }}',
{{ update }},
'{{ neptuneIamRoleArn }}',
'{{ modelName }}',
'{{ instanceType }}',
{{ instanceCount }},
'{{ volumeEncryptionKMSKey }}',
'{{ region }}'
RETURNING
id,
arn,
creation_time_in_millis
;

Manifest

# Description fields are for documentation purposes
- name: ml_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ml_endpoints resource.
  - name: id
    value: "{{ id }}"
  - name: mlModelTrainingJobId
    value: "{{ mlModelTrainingJobId }}"
  - name: mlModelTransformJobId
    value: "{{ mlModelTransformJobId }}"
  - name: update
    value: {{ update }}
  - name: neptuneIamRoleArn
    value: "{{ neptuneIamRoleArn }}"
  - name: modelName
    value: "{{ modelName }}"
  - name: instanceType
    value: "{{ instanceType }}"
  - name: instanceCount
    value: {{ instanceCount }}
  - name: volumeEncryptionKMSKey
    value: "{{ volumeEncryptionKMSKey }}"

DELETE examples

delete_ml_endpoint

Cancels the creation of a Neptune ML inference endpoint. 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:DeleteMLEndpoint IAM action in that cluster.

DELETE FROM aws.neptunedata.ml_endpoints
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
AND clean = '{{ clean }}'
;