com.amazonaws.services.sagemakerfeaturestoreruntime

Interface AmazonSageMakerFeatureStoreRuntimeAsync

All Superinterfaces:

AmazonSageMakerFeatureStoreRuntime

All Known Implementing Classes:

AbstractAmazonSageMakerFeatureStoreRuntimeAsync, AmazonSageMakerFeatureStoreRuntimeAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMakerFeatureStoreRuntimeAsync
extends AmazonSageMakerFeatureStoreRuntime

Interface for accessing Amazon SageMaker Feature Store Runtime asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSageMakerFeatureStoreRuntimeAsync instead.

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 inherited from interface com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<BatchGetRecordResult>	batchGetRecordAsync(BatchGetRecordRequest batchGetRecordRequest) Retrieves a batch of Records from a FeatureGroup.
Future<BatchGetRecordResult>	batchGetRecordAsync(BatchGetRecordRequest batchGetRecordRequest, AsyncHandler<BatchGetRecordRequest,BatchGetRecordResult> asyncHandler) Retrieves a batch of Records from a FeatureGroup.
Future<DeleteRecordResult>	deleteRecordAsync(DeleteRecordRequest deleteRecordRequest) Deletes a Record from a FeatureGroup in the OnlineStore.
Future<DeleteRecordResult>	deleteRecordAsync(DeleteRecordRequest deleteRecordRequest, AsyncHandler<DeleteRecordRequest,DeleteRecordResult> asyncHandler) Deletes a Record from a FeatureGroup in the OnlineStore.
Future<GetRecordResult>	getRecordAsync(GetRecordRequest getRecordRequest) Use for OnlineStore serving from a FeatureStore.
Future<GetRecordResult>	getRecordAsync(GetRecordRequest getRecordRequest, AsyncHandler<GetRecordRequest,GetRecordResult> asyncHandler) Use for OnlineStore serving from a FeatureStore.
Future<PutRecordResult>	putRecordAsync(PutRecordRequest putRecordRequest) The PutRecord API is used to ingest a list of Records into your feature group.
Future<PutRecordResult>	putRecordAsync(PutRecordRequest putRecordRequest, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler) The PutRecord API is used to ingest a list of Records into your feature group.

Methods inherited from interface com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntime

batchGetRecord, deleteRecord, getCachedResponseMetadata, getRecord, putRecord, shutdown

Method Detail

batchGetRecordAsync

Future<BatchGetRecordResult> batchGetRecordAsync(BatchGetRecordRequest batchGetRecordRequest)

Retrieves a batch of Records from a FeatureGroup.

Parameters:

batchGetRecordRequest -

Returns:

A Java Future containing the result of the BatchGetRecord operation returned by the service.

See Also:

AWS API Documentation

batchGetRecordAsync

Future<BatchGetRecordResult> batchGetRecordAsync(BatchGetRecordRequest batchGetRecordRequest,
                                                 AsyncHandler<BatchGetRecordRequest,BatchGetRecordResult> asyncHandler)

Retrieves a batch of Records from a FeatureGroup.

Parameters:

batchGetRecordRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetRecord operation returned by the service.

See Also:

AWS API Documentation

deleteRecordAsync

Future<DeleteRecordResult> deleteRecordAsync(DeleteRecordRequest deleteRecordRequest)

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:

A Java Future containing the result of the DeleteRecord operation returned by the service.

See Also:

AWS API Documentation

deleteRecordAsync

Future<DeleteRecordResult> deleteRecordAsync(DeleteRecordRequest deleteRecordRequest,
                                             AsyncHandler<DeleteRecordRequest,DeleteRecordResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteRecord operation returned by the service.

See Also:

AWS API Documentation

getRecordAsync

Future<GetRecordResult> getRecordAsync(GetRecordRequest getRecordRequest)

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:

A Java Future containing the result of the GetRecord operation returned by the service.

See Also:

AWS API Documentation

getRecordAsync

Future<GetRecordResult> getRecordAsync(GetRecordRequest getRecordRequest,
                                       AsyncHandler<GetRecordRequest,GetRecordResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetRecord operation returned by the service.

See Also:

AWS API Documentation

putRecordAsync

Future<PutRecordResult> putRecordAsync(PutRecordRequest putRecordRequest)

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:

A Java Future containing the result of the PutRecord operation returned by the service.

See Also:

AWS API Documentation

putRecordAsync

Future<PutRecordResult> putRecordAsync(PutRecordRequest putRecordRequest,
                                       AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutRecord operation returned by the service.

See Also:

AWS API Documentation