com.amazonaws.services.sagemakermetrics

Class AmazonSageMakerMetricsAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetricsClient

com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetricsAsyncClient

All Implemented Interfaces:

AmazonSageMakerMetrics, AmazonSageMakerMetricsAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSageMakerMetricsAsyncClient
extends AmazonSageMakerMetricsClient
implements AmazonSageMakerMetricsAsync

Client for accessing SageMaker Metrics asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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 inherited from class com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetricsClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetrics

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSageMakerMetricsAsyncClientBuilder	asyncBuilder()
Future<BatchPutMetricsResult>	batchPutMetricsAsync(BatchPutMetricsRequest request) Used to ingest training metrics into SageMaker.
Future<BatchPutMetricsResult>	batchPutMetricsAsync(BatchPutMetricsRequest request, AsyncHandler<BatchPutMetricsRequest,BatchPutMetricsResult> asyncHandler) Used to ingest training metrics into SageMaker.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetricsClient

batchPutMetrics, builder, getCachedResponseMetadata

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.sagemakermetrics.AmazonSageMakerMetrics

batchPutMetrics, getCachedResponseMetadata

Method Detail

asyncBuilder

public static AmazonSageMakerMetricsAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchPutMetricsAsync

public Future<BatchPutMetricsResult> batchPutMetricsAsync(BatchPutMetricsRequest request)

Description copied from interface: AmazonSageMakerMetricsAsync

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

Specified by:

batchPutMetricsAsync in interface AmazonSageMakerMetricsAsync

Returns:

A Java Future containing the result of the BatchPutMetrics operation returned by the service.

See Also:

AWS API Documentation

batchPutMetricsAsync

public Future<BatchPutMetricsResult> batchPutMetricsAsync(BatchPutMetricsRequest request,
                                                          AsyncHandler<BatchPutMetricsRequest,BatchPutMetricsResult> asyncHandler)

Description copied from interface: AmazonSageMakerMetricsAsync

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

Specified by:

batchPutMetricsAsync in interface AmazonSageMakerMetricsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchPutMetrics operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonSageMakerMetrics

Overrides:

shutdown in class AmazonSageMakerMetricsClient