Skip to main content

ml_data_processing_jobs

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

Overview

Nameml_data_processing_jobs
TypeResource
Idaws.neptunedata.ml_data_processing_jobs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe unique identifier of this data-processing job.
processing_jobobjectDefinition of the data processing job.
statusstringStatus of the data processing job.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_ml_data_processing_jobselectid, regionneptuneIamRoleArnRetrieves information about a specified data processing job. See The dataprocessing 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:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.
list_ml_data_processing_jobsselectregionmaxItems, neptuneIamRoleArnReturns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing 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:ListMLDataProcessingJobs 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.

NameDatatypeDescription
idstringThe unique identifier of the data-processing job to be retrieved.
regionstringAWS region (default: us-east-1)
maxItemsintegerThe maximum number of items to return (from 1 to 1024; the default is 10).
neptuneIamRoleArnstringThe ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

SELECT examples

Retrieves information about a specified data processing job. See The dataprocessing 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:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.

SELECT
id,
processing_job,
status
FROM aws.neptunedata.ml_data_processing_jobs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND neptuneIamRoleArn = '{{ neptuneIamRoleArn }}'
;