Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . neptunedata ]

get-ml-model-training-job

Description

Retrieves information about a Neptune ML model training job. See Model training using the ``modeltraining` command <https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html>`__ .

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:GetMLModelTrainingJobStatus IAM action in that cluster.

See also: AWS API Documentation

Synopsis

  get-ml-model-training-job
--id <value>
[--neptune-iam-role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--id (string)

The unique identifier of the model-training job to retrieve.

--neptune-iam-role-arn (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

status -> (string)

The status of the model training job.

id -> (string)

The unique identifier of this model-training job.

processingJob -> (structure)

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.

hpoJob -> (structure)

The HPO 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.

modelTransformJob -> (structure)

The model transform 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.

mlModels -> (list)

A list of the configurations of the ML models being used.

(structure)

Contains a Neptune ML configuration.

name -> (string)

The configuration name.

arn -> (string)

The ARN for the configuration.