software.amazon.awssdk.services.sagemakerruntime

Interface SageMakerRuntimeClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

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

Method Summary

Modifier and Type	Method and Description
static SageMakerRuntimeClientBuilder	builder() Create a builder that can be used to configure and create a SageMakerRuntimeClient.
static SageMakerRuntimeClient	create() Create a SageMakerRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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 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.
static ServiceMetadata	serviceMetadata()

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

Method Detail

create

static SageMakerRuntimeClient create()

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

builder

static SageMakerRuntimeClientBuilder builder()

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

invokeEndpoint

default InvokeEndpointResponse invokeEndpoint(InvokeEndpointRequest invokeEndpointRequest)
                                       throws InternalFailureException,
                                              ServiceUnavailableException,
                                              ValidationErrorException,
                                              ModelErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SageMakerRuntimeException

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.

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 an error 500.

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.

AwsServiceException

See Also:

AWS API Documentation

invokeEndpoint

default InvokeEndpointResponse invokeEndpoint(Consumer<InvokeEndpointRequest.Builder> invokeEndpointRequest)
                                       throws InternalFailureException,
                                              ServiceUnavailableException,
                                              ValidationErrorException,
                                              ModelErrorException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SageMakerRuntimeException

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.

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:

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 an error 500.

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()