com.amazonaws.services.sagemakerfeaturestoreruntime

Class AmazonSageMakerFeatureStoreRuntimeAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntimeClient

com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntimeAsyncClient

All Implemented Interfaces:

AmazonSageMakerFeatureStoreRuntime, AmazonSageMakerFeatureStoreRuntimeAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSageMakerFeatureStoreRuntimeAsyncClient
extends AmazonSageMakerFeatureStoreRuntimeClient
implements AmazonSageMakerFeatureStoreRuntimeAsync

Client 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.

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 class com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntimeClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSageMakerFeatureStoreRuntimeAsyncClientBuilder	asyncBuilder()
Future<BatchGetRecordResult>	batchGetRecordAsync(BatchGetRecordRequest request) Retrieves a batch of Records from a FeatureGroup.
Future<BatchGetRecordResult>	batchGetRecordAsync(BatchGetRecordRequest request, AsyncHandler<BatchGetRecordRequest,BatchGetRecordResult> asyncHandler) Retrieves a batch of Records from a FeatureGroup.
Future<DeleteRecordResult>	deleteRecordAsync(DeleteRecordRequest request) Deletes a Record from a FeatureGroup in the OnlineStore.
Future<DeleteRecordResult>	deleteRecordAsync(DeleteRecordRequest request, AsyncHandler<DeleteRecordRequest,DeleteRecordResult> asyncHandler) Deletes a Record from a FeatureGroup in the OnlineStore.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetRecordResult>	getRecordAsync(GetRecordRequest request) Use for OnlineStore serving from a FeatureStore.
Future<GetRecordResult>	getRecordAsync(GetRecordRequest request, AsyncHandler<GetRecordRequest,GetRecordResult> asyncHandler) Use for OnlineStore serving from a FeatureStore.
Future<PutRecordResult>	putRecordAsync(PutRecordRequest request) The PutRecord API is used to ingest a list of Records into your feature group.
Future<PutRecordResult>	putRecordAsync(PutRecordRequest request, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler) The PutRecord API is used to ingest a list of Records into your feature group.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.sagemakerfeaturestoreruntime.AmazonSageMakerFeatureStoreRuntimeClient

batchGetRecord, builder, deleteRecord, getCachedResponseMetadata, getRecord, putRecord

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

batchGetRecord, deleteRecord, getCachedResponseMetadata, getRecord, putRecord

Method Detail

asyncBuilder

public static AmazonSageMakerFeatureStoreRuntimeAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchGetRecordAsync

public Future<BatchGetRecordResult> batchGetRecordAsync(BatchGetRecordRequest request)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

Retrieves a batch of Records from a FeatureGroup.

Specified by:

batchGetRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

batchGetRecordAsync

public Future<BatchGetRecordResult> batchGetRecordAsync(BatchGetRecordRequest request,
                                                        AsyncHandler<BatchGetRecordRequest,BatchGetRecordResult> asyncHandler)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

Retrieves a batch of Records from a FeatureGroup.

Specified by:

batchGetRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

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

public Future<DeleteRecordResult> deleteRecordAsync(DeleteRecordRequest request)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

deleteRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

deleteRecordAsync

public Future<DeleteRecordResult> deleteRecordAsync(DeleteRecordRequest request,
                                                    AsyncHandler<DeleteRecordRequest,DeleteRecordResult> asyncHandler)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

deleteRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

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

public Future<GetRecordResult> getRecordAsync(GetRecordRequest request)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

getRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

getRecordAsync

public Future<GetRecordResult> getRecordAsync(GetRecordRequest request,
                                              AsyncHandler<GetRecordRequest,GetRecordResult> asyncHandler)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

getRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

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

public Future<PutRecordResult> putRecordAsync(PutRecordRequest request)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

putRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

Returns:

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

See Also:

AWS API Documentation

putRecordAsync

public Future<PutRecordResult> putRecordAsync(PutRecordRequest request,
                                              AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)

Description copied from interface: AmazonSageMakerFeatureStoreRuntimeAsync

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.

Specified by:

putRecordAsync in interface AmazonSageMakerFeatureStoreRuntimeAsync

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

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonSageMakerFeatureStoreRuntime

Overrides:

shutdown in class AmazonSageMakerFeatureStoreRuntimeClient