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 . sagemaker-metrics ]

batch-put-metrics

Description

Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and retrieved with the GetMetrics API.

See also: AWS API Documentation

Synopsis

  batch-put-metrics
--trial-component-name <value>
--metric-data <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

--trial-component-name (string)

The name of the Trial Component to associate with the metrics.

--metric-data (list)

A list of raw metric values to put.

(structure)

The raw metric data to associate with the resource.

MetricName -> (string)

The name of the metric.

Timestamp -> (timestamp)

The time that the metric was recorded.

Step -> (integer)

The metric step (epoch).

Value -> (double)

The metric value.

Shorthand Syntax:

MetricName=string,Timestamp=timestamp,Step=integer,Value=double ...

JSON Syntax:

[
  {
    "MetricName": "string",
    "Timestamp": timestamp,
    "Step": integer,
    "Value": double
  }
  ...
]

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

--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

Errors -> (list)

Lists any errors that occur when inserting metric data.

(structure)

An error that occured when putting the metric data.

Code -> (string)

The error code of an error that occured when attempting to put metrics.

• METRIC_LIMIT_EXCEEDED : The maximum amount of metrics per resource is exceeded.
• INTERNAL_ERROR : An internal error occured.
• VALIDATION_ERROR : The metric data failed validation.
• CONFLICT_ERROR : Multiple requests attempted to modify the same data simultaneously.

MetricIndex -> (integer)

An index that corresponds to the metric in the request.