Client: Aws\SageMakerMetrics\SageMakerMetricsClient

Service ID: sagemaker-metrics

Version: 2022-09-30

This page describes the parameters and results for the operations of the Amazon SageMaker Metrics Service (2022-09-30), and shows how to use the Aws\SageMakerMetrics\SageMakerMetricsClient object to call the described operations. This documentation is specific to the 2022-09-30 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchGetMetrics ( array $params = [] )

Used to retrieve training metrics from SageMaker.

BatchPutMetrics ( array $params = [] )

Used to ingest training metrics into SageMaker.

$result = $client->batchGetMetrics([/* ... */]);
$promise = $client->batchGetMetricsAsync([/* ... */]);

$result = $client->batchGetMetrics([
    'MetricQueries' => [ // REQUIRED
        [
            'End' => <integer>,
            'MetricName' => '<string>', // REQUIRED
            'MetricStat' => 'Min|Max|Avg|Count|StdDev|Last', // REQUIRED
            'Period' => 'OneMinute|FiveMinute|OneHour|IterationNumber', // REQUIRED
            'ResourceArn' => '<string>', // REQUIRED
            'Start' => <integer>,
            'XAxisType' => 'IterationNumber|Timestamp', // REQUIRED
        ],
        // ...
    ],
]);

[
    'MetricQueryResults' => [
        [
            'Message' => '<string>',
            'MetricValues' => [<float>, ...],
            'Status' => 'Complete|Truncated|InternalError|ValidationError',
            'XAxisValues' => [<integer>, ...],
        ],
        // ...
    ],
]

$result = $client->batchPutMetrics([/* ... */]);
$promise = $client->batchPutMetricsAsync([/* ... */]);

$result = $client->batchPutMetrics([
    'MetricData' => [ // REQUIRED
        [
            'MetricName' => '<string>', // REQUIRED
            'Step' => <integer>,
            'Timestamp' => <integer || string || DateTime>, // REQUIRED
            'Value' => <float>, // REQUIRED
        ],
        // ...
    ],
    'TrialComponentName' => '<string>', // REQUIRED
]);

[
    'Errors' => [
        [
            'Code' => 'METRIC_LIMIT_EXCEEDED|INTERNAL_ERROR|VALIDATION_ERROR|CONFLICT_ERROR',
            'MetricIndex' => <integer>,
        ],
        // ...
    ],
]