software.amazon.awssdk.services.sagemakerruntime

Interface SageMakerRuntimeAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface SageMakerRuntimeAsyncClient
extends SdkClient

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

The Amazon SageMaker runtime API.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
static SageMakerRuntimeAsyncClientBuilder	builder() Create a builder that can be used to configure and create a SageMakerRuntimeAsyncClient.
static SageMakerRuntimeAsyncClient	create() Create a SageMakerRuntimeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<InvokeEndpointResponse>	invokeEndpoint(Consumer<InvokeEndpointRequest.Builder> invokeEndpointRequest) 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.
default CompletableFuture<InvokeEndpointResponse>	invokeEndpoint(InvokeEndpointRequest invokeEndpointRequest) 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.
default CompletableFuture<InvokeEndpointAsyncResponse>	invokeEndpointAsync(Consumer<InvokeEndpointAsyncRequest.Builder> invokeEndpointAsyncRequest) 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.
default CompletableFuture<InvokeEndpointAsyncResponse>	invokeEndpointAsync(InvokeEndpointAsyncRequest invokeEndpointAsyncRequest) 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.

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

serviceName

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

close

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

create

static SageMakerRuntimeAsyncClient create()

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

builder

static SageMakerRuntimeAsyncClientBuilder builder()

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

invokeEndpoint

default CompletableFuture<InvokeEndpointResponse> invokeEndpoint(InvokeEndpointRequest invokeEndpointRequest)

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.

Parameters:

invokeEndpointRequest -

Returns:

A Java Future containing the result of the InvokeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• 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.
• SageMakerRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeEndpoint

default CompletableFuture<InvokeEndpointResponse> invokeEndpoint(Consumer<InvokeEndpointRequest.Builder> invokeEndpointRequest)

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.

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

Parameters:

invokeEndpointRequest - A Consumer that will call methods on InvokeEndpointInput.Builder to create a request.

Returns:

A Java Future containing the result of the InvokeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• 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.
• SageMakerRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeEndpointAsync

default CompletableFuture<InvokeEndpointAsyncResponse> invokeEndpointAsync(InvokeEndpointAsyncRequest invokeEndpointAsyncRequest)

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.

Parameters:

invokeEndpointAsyncRequest -

Returns:

A Java Future containing the result of the InvokeEndpointAsync operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalFailureException An internal failure occurred.
• ServiceUnavailableException The service is unavailable. Try your call again.
• ValidationErrorException Inspect your request and try again.
• 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.
• SageMakerRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeEndpointAsync

default CompletableFuture<InvokeEndpointAsyncResponse> invokeEndpointAsync(Consumer<InvokeEndpointAsyncRequest.Builder> invokeEndpointAsyncRequest)

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.

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

Parameters:

invokeEndpointAsyncRequest - A Consumer that will call methods on InvokeEndpointAsyncInput.Builder to create a request.

Returns:

A Java Future containing the result of the InvokeEndpointAsync operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalFailureException An internal failure occurred.
• ServiceUnavailableException The service is unavailable. Try your call again.
• ValidationErrorException Inspect your request and try again.
• 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.
• SageMakerRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation