Package software.amazon.awssdk.services.sagemakermetrics

Interface SageMakerMetricsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SageMakerMetricsClient
extends AwsClient

Service client for accessing SageMaker Metrics. This can be created using the static builder() method.

Contains all data plane API operations and data types for Amazon SageMaker Metrics. Use these APIs to put and retrieve (get) features related to your training run.

• BatchPutMetrics

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchPutMetricsResponse	batchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest)	Used to ingest training metrics into SageMaker.
default BatchPutMetricsResponse	batchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest)	Used to ingest training metrics into SageMaker.
static SageMakerMetricsClientBuilder	builder()	Create a builder that can be used to configure and create a SageMakerMetricsClient.
static SageMakerMetricsClient	create()	Create a SageMakerMetricsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default SageMakerMetricsServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

batchPutMetrics

default BatchPutMetricsResponse batchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest)
                                         throws AwsServiceException,
                                                SdkClientException,
                                                SageMakerMetricsException

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

Parameters:

batchPutMetricsRequest -

Returns:

Result of the BatchPutMetrics operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SageMakerMetricsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchPutMetrics

default BatchPutMetricsResponse batchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest)
                                         throws AwsServiceException,
                                                SdkClientException,
                                                SageMakerMetricsException

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

This is a convenience which creates an instance of the BatchPutMetricsRequest.Builder avoiding the need to create one manually via BatchPutMetricsRequest.builder()

Parameters:

batchPutMetricsRequest - A Consumer that will call methods on BatchPutMetricsRequest.Builder to create a request.

Returns:

Result of the BatchPutMetrics operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SageMakerMetricsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static SageMakerMetricsClient create()

Create a SageMakerMetricsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SageMakerMetricsClientBuilder builder()

Create a builder that can be used to configure and create a SageMakerMetricsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SageMakerMetricsServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient