Interface SagemakerJobRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SagemakerJobRuntimeClient
extends AwsClient

Service client for accessing Sagemaker Job Runtime Service. This can be created using the static builder() method.

Agentic RFT Runtime Service - manages trajectory and transition data for reinforcement fine-tuning jobs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SagemakerJobRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a SagemakerJobRuntimeClient.
default CompleteRolloutResponse	completeRollout(Consumer<CompleteRolloutRequest.Builder> completeRolloutRequest)	Marks a rollout as complete, indicating that no further turns will be appended to the trajectory.
default CompleteRolloutResponse	completeRollout(CompleteRolloutRequest completeRolloutRequest)	Marks a rollout as complete, indicating that no further turns will be appended to the trajectory.
static SagemakerJobRuntimeClient	create()	Create a SagemakerJobRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default SampleResponse	sample(Consumer<SampleRequest.Builder> sampleRequest)	Sends an inference request to the model during a job execution.
default SampleResponse	sample(SampleRequest sampleRequest)	Sends an inference request to the model during a job execution.
default ResponseInputStream<SampleWithResponseStreamResponse>	sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest)	Sends a streaming inference request to the model during a job execution.
default SampleWithResponseStreamResponse	sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest, Path destinationPath)	Sends a streaming inference request to the model during a job execution.
default <ReturnT> ReturnT	sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest, ResponseTransformer<SampleWithResponseStreamResponse,ReturnT> responseTransformer)	Sends a streaming inference request to the model during a job execution.
default ResponseInputStream<SampleWithResponseStreamResponse>	sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest)	Sends a streaming inference request to the model during a job execution.
default SampleWithResponseStreamResponse	sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest, Path destinationPath)	Sends a streaming inference request to the model during a job execution.
default <ReturnT> ReturnT	sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest, ResponseTransformer<SampleWithResponseStreamResponse,ReturnT> responseTransformer)	Sends a streaming inference request to the model during a job execution.
default ResponseBytes<SampleWithResponseStreamResponse>	sampleWithResponseStreamAsBytes(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest)	Sends a streaming inference request to the model during a job execution.
default ResponseBytes<SampleWithResponseStreamResponse>	sampleWithResponseStreamAsBytes(SampleWithResponseStreamRequest sampleWithResponseStreamRequest)	Sends a streaming inference request to the model during a job execution.
default SagemakerJobRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateRewardResponse	updateReward(Consumer<UpdateRewardRequest.Builder> updateRewardRequest)	Updates the reward values for a trajectory and transitions it to reward-received status, signaling that it is eligible for processing.
default UpdateRewardResponse	updateReward(UpdateRewardRequest updateRewardRequest)	Updates the reward values for a trajectory and transitions it to reward-received status, signaling that it is eligible for processing.

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

close

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

serviceName

Field Details

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 Details

completeRollout

default CompleteRolloutResponse completeRollout(CompleteRolloutRequest completeRolloutRequest)
                                         throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Marks a rollout as complete, indicating that no further turns will be appended to the trajectory. After calling this operation, the trajectory is sealed and eligible for reward submission via the UpdateReward operation.

Parameters:

completeRolloutRequest -

Returns:

Result of the CompleteRollout operation returned by the service.

See Also:

• AWS API Documentation

completeRollout

default CompleteRolloutResponse completeRollout(Consumer<CompleteRolloutRequest.Builder> completeRolloutRequest)
                                         throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Marks a rollout as complete, indicating that no further turns will be appended to the trajectory. After calling this operation, the trajectory is sealed and eligible for reward submission via the UpdateReward operation.

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

Parameters:

completeRolloutRequest - A Consumer that will call methods on CompleteRolloutRequest.Builder to create a request.

Returns:

Result of the CompleteRollout operation returned by the service.

See Also:

• AWS API Documentation

sample

default SampleResponse sample(SampleRequest sampleRequest)
                       throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends an inference request to the model during a job execution. The request and response bodies are forwarded to and from the model without modification. Each turn (prompt and response) is captured for later use.

Parameters:

sampleRequest -

Returns:

Result of the Sample operation returned by the service.

See Also:

• AWS API Documentation

sample

default SampleResponse sample(Consumer<SampleRequest.Builder> sampleRequest)
                       throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends an inference request to the model during a job execution. The request and response bodies are forwarded to and from the model without modification. Each turn (prompt and response) is captured for later use.

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

Parameters:

sampleRequest - A Consumer that will call methods on SampleRequest.Builder to create a request.

Returns:

Result of the Sample operation returned by the service.

See Also:

• AWS API Documentation

sampleWithResponseStream

default <ReturnT> ReturnT sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest,
 ResponseTransformer<SampleWithResponseStreamResponse,ReturnT> responseTransformer)
                                            throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

Parameters:

sampleWithResponseStreamRequest -

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled SampleWithResponseStreamResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

sampleWithResponseStream

default <ReturnT> ReturnT sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest,
 ResponseTransformer<SampleWithResponseStreamResponse,ReturnT> responseTransformer)
                                            throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

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

Parameters:

sampleWithResponseStreamRequest - A Consumer that will call methods on SampleWithResponseStreamRequest.Builder to create a request.

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled SampleWithResponseStreamResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

sampleWithResponseStream

default SampleWithResponseStreamResponse sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest,
 Path destinationPath)
                                                           throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

Parameters:

sampleWithResponseStreamRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• sampleWithResponseStream(SampleWithResponseStreamRequest, ResponseTransformer)
• AWS API Documentation

sampleWithResponseStream

default SampleWithResponseStreamResponse sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest,
 Path destinationPath)
                                                           throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

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

Parameters:

sampleWithResponseStreamRequest - A Consumer that will call methods on SampleWithResponseStreamRequest.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• sampleWithResponseStream(SampleWithResponseStreamRequest, ResponseTransformer)
• AWS API Documentation

sampleWithResponseStream

default ResponseInputStream<SampleWithResponseStreamResponse> sampleWithResponseStream(SampleWithResponseStreamRequest sampleWithResponseStreamRequest)
                                                                                throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

Parameters:

sampleWithResponseStreamRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

See Also:

• invalid reference

  #getObject(sampleWithResponseStream, ResponseTransformer)

• AWS API Documentation

sampleWithResponseStream

default ResponseInputStream<SampleWithResponseStreamResponse> sampleWithResponseStream(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest)
                                                                                throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

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

Parameters:

sampleWithResponseStreamRequest - A Consumer that will call methods on SampleWithResponseStreamRequest.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

See Also:

• invalid reference

  #getObject(sampleWithResponseStream, ResponseTransformer)

• AWS API Documentation

sampleWithResponseStreamAsBytes

default ResponseBytes<SampleWithResponseStreamResponse> sampleWithResponseStreamAsBytes(SampleWithResponseStreamRequest sampleWithResponseStreamRequest)
                                                                                 throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

Parameters:

sampleWithResponseStreamRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

See Also:

• invalid reference

  #getObject(sampleWithResponseStream, ResponseTransformer)

• AWS API Documentation

sampleWithResponseStreamAsBytes

default ResponseBytes<SampleWithResponseStreamResponse> sampleWithResponseStreamAsBytes(Consumer<SampleWithResponseStreamRequest.Builder> sampleWithResponseStreamRequest)
                                                                                 throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Sends a streaming inference request to the model during a job execution. Returns the response as a stream of payload chunks. Each turn is captured for later use.

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

Parameters:

sampleWithResponseStreamRequest - A Consumer that will call methods on SampleWithResponseStreamRequest.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The streaming response body, delivered as a series of PayloadPart events.

'.

See Also:

• invalid reference

  #getObject(sampleWithResponseStream, ResponseTransformer)

• AWS API Documentation

updateReward

default UpdateRewardResponse updateReward(UpdateRewardRequest updateRewardRequest)
                                   throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Updates the reward values for a trajectory and transitions it to reward-received status, signaling that it is eligible for processing. Call this operation after CompleteRollout to provide the computed reward scores.

Parameters:

updateRewardRequest -

Returns:

Result of the UpdateReward operation returned by the service.

See Also:

• AWS API Documentation

updateReward

default UpdateRewardResponse updateReward(Consumer<UpdateRewardRequest.Builder> updateRewardRequest)
                                   throws ResourceNotFoundException,
InternalServiceErrorException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SagemakerJobRuntimeException

Updates the reward values for a trajectory and transitions it to reward-received status, signaling that it is eligible for processing. Call this operation after CompleteRollout to provide the computed reward scores.

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

Parameters:

updateRewardRequest - A Consumer that will call methods on UpdateRewardRequest.Builder to create a request.

Returns:

Result of the UpdateReward operation returned by the service.

See Also:

• AWS API Documentation

create

static SagemakerJobRuntimeClient create()

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

builder

static SagemakerJobRuntimeClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SagemakerJobRuntimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration