NeptuneData / Client / get_ml_data_processing_job

get_ml_data_processing_job#

NeptuneData.Client.get_ml_data_processing_job(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_ml_data_processing_job(
    id='string',
    neptuneIamRoleArn='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The unique identifier of the data-processing job to be retrieved.

  • neptuneIamRoleArn (string) – The 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.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'id': 'string',
    'processingJob': {
        'name': 'string',
        'arn': 'string',
        'status': 'string',
        'outputLocation': 'string',
        'failureReason': 'string',
        'cloudwatchLogUrl': 'string'
    }
}

Response Structure

  • (dict) –

    • status (string) –

      Status of the data processing job.

    • id (string) –

      The unique identifier of this data-processing job.

    • processingJob (dict) –

      Definition of the data processing job.

      • name (string) –

        The resource name.

      • arn (string) –

        The resource ARN.

      • status (string) –

        The resource status.

      • outputLocation (string) –

        The output location.

      • failureReason (string) –

        The failure reason, in case of a failure.

      • cloudwatchLogUrl (string) –

        The CloudWatch log URL for the resource.

Exceptions