Interface SageMakerFeatureStoreRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.

Use the following operations to configure your OnlineStore and OfflineStore features, and to create and manage feature groups:

• CreateFeatureGroup

• DeleteFeatureGroup

• DescribeFeatureGroup

• ListFeatureGroups

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
default BatchGetRecordResponse	batchGetRecord(Consumer<BatchGetRecordRequest.Builder> batchGetRecordRequest)	Retrieves a batch of Records from a FeatureGroup.
default BatchGetRecordResponse	batchGetRecord(BatchGetRecordRequest batchGetRecordRequest)	Retrieves a batch of Records from a FeatureGroup.
default BatchWriteRecordResponse	batchWriteRecord(Consumer<BatchWriteRecordRequest.Builder> batchWriteRecordRequest)	Writes a batch of Records to one or more FeatureGroups.
default BatchWriteRecordResponse	batchWriteRecord(BatchWriteRecordRequest batchWriteRecordRequest)	Writes a batch of Records to one or more FeatureGroups.
static SageMakerFeatureStoreRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a SageMakerFeatureStoreRuntimeClient.
static SageMakerFeatureStoreRuntimeClient	create()	Create a SageMakerFeatureStoreRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteRecordResponse	deleteRecord(Consumer<DeleteRecordRequest.Builder> deleteRecordRequest)	Deletes a Record from a FeatureGroup in the OnlineStore.
default DeleteRecordResponse	deleteRecord(DeleteRecordRequest deleteRecordRequest)	Deletes a Record from a FeatureGroup in the OnlineStore.
default GetRecordResponse	getRecord(Consumer<GetRecordRequest.Builder> getRecordRequest)	Use for OnlineStore serving from a FeatureStore.
default GetRecordResponse	getRecord(GetRecordRequest getRecordRequest)	Use for OnlineStore serving from a FeatureStore.
default ListRecordsResponse	listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest)	Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore.
default ListRecordsResponse	listRecords(ListRecordsRequest listRecordsRequest)	Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore.
default ListRecordsIterable	listRecordsPaginator(Consumer<ListRecordsRequest.Builder> listRecordsRequest)	This is a variant of listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation.
default ListRecordsIterable	listRecordsPaginator(ListRecordsRequest listRecordsRequest)	This is a variant of listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation.
default PutRecordResponse	putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest)	The PutRecord API is used to ingest a list of Records into your feature group.
default PutRecordResponse	putRecord(PutRecordRequest putRecordRequest)	The PutRecord API is used to ingest a list of Records into your feature group.
default SageMakerFeatureStoreRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

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

batchGetRecord

default BatchGetRecordResponse batchGetRecord(BatchGetRecordRequest batchGetRecordRequest)
                                       throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Retrieves a batch of Records from a FeatureGroup.

Parameters:

batchGetRecordRequest -

Returns:

Result of the BatchGetRecord operation returned by the service.

See Also:

• AWS API Documentation

batchGetRecord

default BatchGetRecordResponse batchGetRecord(Consumer<BatchGetRecordRequest.Builder> batchGetRecordRequest)
                                       throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Retrieves a batch of Records from a FeatureGroup.

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

Parameters:

batchGetRecordRequest - A Consumer that will call methods on BatchGetRecordRequest.Builder to create a request.

Returns:

Result of the BatchGetRecord operation returned by the service.

See Also:

• AWS API Documentation

batchWriteRecord

default BatchWriteRecordResponse batchWriteRecord(BatchWriteRecordRequest batchWriteRecordRequest)
                                           throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Writes a batch of Records to one or more FeatureGroups. Use this API for bulk ingestion of records into the OnlineStore and OfflineStore.

You can set the ingested records to expire at a given time to live (TTL) duration after the record's event time by specifying the TtlDuration parameter. A request level TtlDuration applies to all entries that do not specify their own TtlDuration.

Parameters:

batchWriteRecordRequest -

Returns:

Result of the BatchWriteRecord operation returned by the service.

See Also:

• AWS API Documentation

batchWriteRecord

default BatchWriteRecordResponse batchWriteRecord(Consumer<BatchWriteRecordRequest.Builder> batchWriteRecordRequest)
                                           throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Writes a batch of Records to one or more FeatureGroups. Use this API for bulk ingestion of records into the OnlineStore and OfflineStore.

You can set the ingested records to expire at a given time to live (TTL) duration after the record's event time by specifying the TtlDuration parameter. A request level TtlDuration applies to all entries that do not specify their own TtlDuration.

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

Parameters:

batchWriteRecordRequest - A Consumer that will call methods on BatchWriteRecordRequest.Builder to create a request.

Returns:

Result of the BatchWriteRecord operation returned by the service.

See Also:

• AWS API Documentation

deleteRecord

default DeleteRecordResponse deleteRecord(DeleteRecordRequest deleteRecordRequest)
                                   throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore. The deleted record marker is a record with the same RecordIdentifer as the original, but with is_deleted value set to True, EventTime set to the delete input EventTime, and other feature values set to null.

Note that the EventTime specified in DeleteRecord should be set later than the EventTime of the existing record in the OnlineStore for that RecordIdentifer. If it is not, the deletion does not occur:

• For SoftDelete, the existing (not deleted) record remains in the OnlineStore, though the delete record marker is still written to the OfflineStore.

• HardDelete returns EventTime: 400 ValidationException to indicate that the delete operation failed. No delete record marker is written to the OfflineStore.

When a record is deleted from the OnlineStore, the deleted record marker is appended to the OfflineStore. If you have the Iceberg table format enabled for your OfflineStore, you can remove all history of a record from the OfflineStore using Amazon Athena or Apache Spark. For information on how to hard delete a record from the OfflineStore with the Iceberg table format enabled, see Delete records from the offline store.

Parameters:

deleteRecordRequest -

Returns:

Result of the DeleteRecord operation returned by the service.

See Also:

• AWS API Documentation

deleteRecord

default DeleteRecordResponse deleteRecord(Consumer<DeleteRecordRequest.Builder> deleteRecordRequest)
                                   throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore. The deleted record marker is a record with the same RecordIdentifer as the original, but with is_deleted value set to True, EventTime set to the delete input EventTime, and other feature values set to null.

Note that the EventTime specified in DeleteRecord should be set later than the EventTime of the existing record in the OnlineStore for that RecordIdentifer. If it is not, the deletion does not occur:

• For SoftDelete, the existing (not deleted) record remains in the OnlineStore, though the delete record marker is still written to the OfflineStore.

• HardDelete returns EventTime: 400 ValidationException to indicate that the delete operation failed. No delete record marker is written to the OfflineStore.

When a record is deleted from the OnlineStore, the deleted record marker is appended to the OfflineStore. If you have the Iceberg table format enabled for your OfflineStore, you can remove all history of a record from the OfflineStore using Amazon Athena or Apache Spark. For information on how to hard delete a record from the OfflineStore with the Iceberg table format enabled, see Delete records from the offline store.

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

Parameters:

deleteRecordRequest - A Consumer that will call methods on DeleteRecordRequest.Builder to create a request.

Returns:

Result of the DeleteRecord operation returned by the service.

See Also:

• AWS API Documentation

getRecord

default GetRecordResponse getRecord(GetRecordRequest getRecordRequest)
                             throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an empty result is returned.

Parameters:

getRecordRequest -

Returns:

Result of the GetRecord operation returned by the service.

See Also:

• AWS API Documentation

getRecord

default GetRecordResponse getRecord(Consumer<GetRecordRequest.Builder> getRecordRequest)
                             throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an empty result is returned.

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

Parameters:

getRecordRequest - A Consumer that will call methods on GetRecordRequest.Builder to create a request.

Returns:

Result of the GetRecord operation returned by the service.

See Also:

• AWS API Documentation

listRecords

default ListRecordsResponse listRecords(ListRecordsRequest listRecordsRequest)
                                 throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore. This enables you to discover which records exist without retrieving the full record data.

Parameters:

listRecordsRequest -

Returns:

Result of the ListRecords operation returned by the service.

See Also:

• AWS API Documentation

listRecords

default ListRecordsResponse listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest)
                                 throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

Lists the RecordIdentifier values of all records stored in a FeatureGroup's OnlineStore. This enables you to discover which records exist without retrieving the full record data.

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

Parameters:

listRecordsRequest - A Consumer that will call methods on ListRecordsRequest.Builder to create a request.

Returns:

Result of the ListRecords operation returned by the service.

See Also:

• AWS API Documentation

listRecordsPaginator

default ListRecordsIterable listRecordsPaginator(ListRecordsRequest listRecordsRequest)
                                          throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

This is a variant of listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client.listRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client
             .listRecordsPaginator(request);
     for (software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client.listRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation.

Parameters:

listRecordsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRecordsPaginator

default ListRecordsIterable listRecordsPaginator(Consumer<ListRecordsRequest.Builder> listRecordsRequest)
                                          throws ValidationErrorException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

This is a variant of listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client.listRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client
             .listRecordsPaginator(request);
     for (software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsIterable responses = client.listRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest) operation.

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

Parameters:

listRecordsRequest - A Consumer that will call methods on ListRecordsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putRecord

default PutRecordResponse putRecord(PutRecordRequest putRecordRequest)
                             throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

The PutRecord API is used to ingest a list of Records into your feature group.

If a new record’s EventTime is greater, the new record is written to both the OnlineStore and OfflineStore. Otherwise, the record is a historic record and it is written only to the OfflineStore.

You can specify the ingestion to be applied to the OnlineStore, OfflineStore, or both by using the TargetStores request parameter.

You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, ExpiresAt = EventTime + TtlDuration, by specifying the TtlDuration parameter. A record level TtlDuration is set when specifying the TtlDuration parameter using the PutRecord API call. If the input TtlDuration is null or unspecified, TtlDuration is set to the default feature group level TtlDuration. A record level TtlDuration supersedes the group level TtlDuration.

Parameters:

putRecordRequest -

Returns:

Result of the PutRecord operation returned by the service.

See Also:

• AWS API Documentation

putRecord

default PutRecordResponse putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest)
                             throws ValidationErrorException,
InternalFailureException,
ServiceUnavailableException,
AccessForbiddenException,
AwsServiceException,
SdkClientException,
SageMakerFeatureStoreRuntimeException

The PutRecord API is used to ingest a list of Records into your feature group.

If a new record’s EventTime is greater, the new record is written to both the OnlineStore and OfflineStore. Otherwise, the record is a historic record and it is written only to the OfflineStore.

You can specify the ingestion to be applied to the OnlineStore, OfflineStore, or both by using the TargetStores request parameter.

You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, ExpiresAt = EventTime + TtlDuration, by specifying the TtlDuration parameter. A record level TtlDuration is set when specifying the TtlDuration parameter using the PutRecord API call. If the input TtlDuration is null or unspecified, TtlDuration is set to the default feature group level TtlDuration. A record level TtlDuration supersedes the group level TtlDuration.

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

Parameters:

putRecordRequest - A Consumer that will call methods on PutRecordRequest.Builder to create a request.

Returns:

Result of the PutRecord operation returned by the service.

See Also:

• AWS API Documentation

create

static SageMakerFeatureStoreRuntimeClient create()

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

builder

static SageMakerFeatureStoreRuntimeClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SageMakerFeatureStoreRuntimeServiceClientConfiguration 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