com.amazonaws.services.sagemakerruntime

Class AmazonSageMakerRuntimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeClient

All Implemented Interfaces:

AmazonSageMakerRuntime

Direct Known Subclasses:

AmazonSageMakerRuntimeAsyncClient

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

Client for accessing Amazon SageMaker Runtime. All service calls made using this client are blocking, and will not return until the service call completes.

The Amazon SageMaker runtime API.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSageMakerRuntimeClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
InvokeEndpointResult	invokeEndpoint(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.
InvokeEndpointAsyncResult	invokeEndpointAsync(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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AmazonSageMakerRuntimeClientBuilder builder()

invokeEndpoint

public InvokeEndpointResult invokeEndpoint(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.

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:

invokeEndpoint in interface AmazonSageMakerRuntime

Parameters:

invokeEndpointRequest -

Returns:

Result of the InvokeEndpoint operation returned by the service.

Throws:

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is unavailable. Try your call again.

ValidationErrorException - Inspect your request and try again.

ModelErrorException - Model (owned by the customer in the container) returned 4xx or 5xx error code.

InternalDependencyException - Your request caused an exception with an internal dependency. Contact customer support.

ModelNotReadyException - Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.

See Also:

AWS API Documentation

invokeEndpointAsync

public InvokeEndpointAsyncResult invokeEndpointAsync(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.

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:

invokeEndpointAsync in interface AmazonSageMakerRuntime

Parameters:

invokeEndpointAsyncRequest -

Returns:

Result of the InvokeEndpointAsync operation returned by the service.

Throws:

InternalFailureException - An internal failure occurred.

ServiceUnavailableException - The service is unavailable. Try your call again.

ValidationErrorException - Inspect your request and try again.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonSageMakerRuntime

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonSageMakerRuntime

Overrides:

shutdown in class AmazonWebServiceClient