BatchPutMetrics - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.

Request Syntax

PUT /BatchPutMetrics HTTP/1.1 Content-type: application/json { "MetricData": [ { "MetricName": "string", "Step": number, "Timestamp": number, "Value": number } ], "TrialComponentName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


A list of raw metric values to put.

Type: Array of RawMetricData objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes


The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Code": "string", "MetricIndex": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Lists any errors that occur when inserting metric data.

Type: Array of BatchPutMetricsError objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.


For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: