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

BatchGetMetrics

Used to retrieve training metrics from SageMaker.

Request Syntax

POST /BatchGetMetrics HTTP/1.1 Content-type: application/json { "MetricQueries": [ { "End": number, "MetricName": "string", "MetricStat": "string", "Period": "string", "ResourceArn": "string", "Start": number, "XAxisType": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MetricQueries

Queries made to retrieve training metrics from SageMaker.

Type: Array of MetricQuery objects

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MetricQueryResults": [ { "Message": "string", "MetricValues": [ number ], "Status": "string", "XAxisValues": [ 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.

MetricQueryResults

The results of a query to retrieve training metrics from SageMaker.

Type: Array of MetricQueryResult objects

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

Errors

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: