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

public class AmazonSageMakerRuntimeClient
extends AmazonWebServiceClient
implements AmazonSageMakerRuntime

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

Constructor Summary

Constructors

Constructor and Description
AmazonSageMakerRuntimeClient() Deprecated.
AmazonSageMakerRuntimeClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials.
AmazonSageMakerRuntimeClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials and client configuration options.
AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider.
AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider and client configuration options.
AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonSageMakerRuntimeClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
InvokeEndpointResult	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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonSageMakerRuntimeClient

@Deprecated
public AmazonSageMakerRuntimeClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonSageMakerRuntime. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonSageMakerRuntimeClient

@Deprecated
public AmazonSageMakerRuntimeClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonSageMakerRuntime. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonSageMakerRuntime (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonSageMakerRuntimeClient

public AmazonSageMakerRuntimeClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 {@code
 AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback() {

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSageMakerRuntimeClient

public AmazonSageMakerRuntimeClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 {@code
 AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback() {

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSageMakerRuntime (ex: proxy settings, retry counts, etc.).

AmazonSageMakerRuntimeClient

public AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 {@code
 AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback() {

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonSageMakerRuntimeClient

public AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 {@code
 AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback() {

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSageMakerRuntime (ex: proxy settings, retry counts, etc.).

AmazonSageMakerRuntimeClient

@Deprecated
public AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                                                ClientConfiguration clientConfiguration,
                                                com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSageMakerRuntime (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonSageMakerRuntimeClient

public AmazonSageMakerRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonSageMakerRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 {@code
 AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback() {

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSageMakerRuntime (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

invokeEndpoint

public InvokeEndpointResult invokeEndpoint(InvokeEndpointRequest invokeEndpointRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

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

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:

invokeEndpointResult The response from the InvokeEndpoint service method, as returned by Amazon SageMaker Runtime Service.

Throws:

InternalFailureException

ServiceUnavailableException

ValidationErrorException

ModelErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon SageMaker Runtime Service indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.