Package software.amazon.awssdk.services.sagemakermetrics

Interface SageMakerMetricsAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing SageMaker Metrics asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 CompletableFuture<BatchPutMetricsResponse>	batchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest)	Used to ingest training metrics into SageMaker.
default CompletableFuture<BatchPutMetricsResponse>	batchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest)	Used to ingest training metrics into SageMaker.
static SageMakerMetricsAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a SageMakerMetricsAsyncClient.
static SageMakerMetricsAsyncClient	create()	Create a SageMakerMetricsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default SageMakerMetricsServiceClientConfiguration	serviceClientConfiguration()

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 CompletableFuture<BatchPutMetricsResponse> batchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest)

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

Parameters:

batchPutMetricsRequest -

Returns:

A Java Future containing the result of the BatchPutMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.

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

See Also:

AWS API Documentation

batchPutMetrics

default CompletableFuture<BatchPutMetricsResponse> batchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest)

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:

A Java Future containing the result of the BatchPutMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.

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

See Also:

AWS API Documentation

serviceClientConfiguration

default SageMakerMetricsServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static SageMakerMetricsAsyncClient create()

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

builder

static SageMakerMetricsAsyncClientBuilder builder()

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