com.amazonaws.services.sagemakerruntime

Class AmazonSageMakerRuntimeAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeClient

com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeAsyncClient

All Implemented Interfaces:

AmazonSageMakerRuntime, AmazonSageMakerRuntimeAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSageMakerRuntimeAsyncClient
extends AmazonSageMakerRuntimeClient
implements AmazonSageMakerRuntimeAsync

Client for accessing Amazon SageMaker Runtime 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.

The Amazon SageMaker runtime API.

Field Summary

Fields inherited from class com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeClient

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.sagemakerruntime.AmazonSageMakerRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSageMakerRuntimeAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<InvokeEndpointResult>	invokeEndpointAsync(InvokeEndpointRequest request) After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.
Future<InvokeEndpointResult>	invokeEndpointAsync(InvokeEndpointRequest request, AsyncHandler<InvokeEndpointRequest,InvokeEndpointResult> asyncHandler) After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.
Future<InvokeEndpointAsyncResult>	invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest request) After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.
Future<InvokeEndpointAsyncResult>	invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest request, AsyncHandler<InvokeEndpointAsyncRequest,InvokeEndpointAsyncResult> asyncHandler) After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeClient

builder, getCachedResponseMetadata, invokeEndpoint, invokeEndpointAsync

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.sagemakerruntime.AmazonSageMakerRuntime

getCachedResponseMetadata, invokeEndpoint, invokeEndpointAsync

Method Detail

asyncBuilder

public static AmazonSageMakerRuntimeAsyncClientBuilder 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.

invokeEndpointAsync

public Future<InvokeEndpointResult> invokeEndpointAsync(InvokeEndpointRequest request)

Description copied from interface: AmazonSageMakerRuntimeAsync

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

Specified by:

invokeEndpointAsync in interface AmazonSageMakerRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

invokeEndpointAsync

public Future<InvokeEndpointResult> invokeEndpointAsync(InvokeEndpointRequest request,
                                                        AsyncHandler<InvokeEndpointRequest,InvokeEndpointResult> asyncHandler)

Description copied from interface: AmazonSageMakerRuntimeAsync

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpoint are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

Specified by:

invokeEndpointAsync in interface AmazonSageMakerRuntimeAsync

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 InvokeEndpoint operation returned by the service.

See Also:

AWS API Documentation

invokeEndpointAsyncAsync

public Future<InvokeEndpointAsyncResult> invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest request)

Description copied from interface: AmazonSageMakerRuntimeAsync

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

Specified by:

invokeEndpointAsyncAsync in interface AmazonSageMakerRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

invokeEndpointAsyncAsync

public Future<InvokeEndpointAsyncResult> invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest request,
                                                                  AsyncHandler<InvokeEndpointAsyncRequest,InvokeEndpointAsyncResult> asyncHandler)

Description copied from interface: AmazonSageMakerRuntimeAsync

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

Specified by:

invokeEndpointAsyncAsync in interface AmazonSageMakerRuntimeAsync

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 InvokeEndpointAsync 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 AmazonSageMakerRuntime

Overrides:

shutdown in class AmazonSageMakerRuntimeClient