Interface SageMakerFeatureStoreRuntimeAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture<BatchGetRecordResponse> batchGetRecord(Consumer<BatchGetRecordRequest.Builder> batchGetRecordRequest) Retrieves a batch ofRecordsfrom aFeatureGroup.default CompletableFuture<BatchGetRecordResponse> batchGetRecord(BatchGetRecordRequest batchGetRecordRequest) Retrieves a batch ofRecordsfrom aFeatureGroup.batchWriteRecord(Consumer<BatchWriteRecordRequest.Builder> batchWriteRecordRequest) Writes a batch ofRecordsto one or moreFeatureGroups.batchWriteRecord(BatchWriteRecordRequest batchWriteRecordRequest) Writes a batch ofRecordsto one or moreFeatureGroups.builder()Create a builder that can be used to configure and create aSageMakerFeatureStoreRuntimeAsyncClient.create()Create aSageMakerFeatureStoreRuntimeAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<DeleteRecordResponse> deleteRecord(Consumer<DeleteRecordRequest.Builder> deleteRecordRequest) Deletes aRecordfrom aFeatureGroupin theOnlineStore.default CompletableFuture<DeleteRecordResponse> deleteRecord(DeleteRecordRequest deleteRecordRequest) Deletes aRecordfrom aFeatureGroupin theOnlineStore.default CompletableFuture<GetRecordResponse> getRecord(Consumer<GetRecordRequest.Builder> getRecordRequest) Use forOnlineStoreserving from aFeatureStore.default CompletableFuture<GetRecordResponse> getRecord(GetRecordRequest getRecordRequest) Use forOnlineStoreserving from aFeatureStore.default CompletableFuture<ListRecordsResponse> listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest) Lists theRecordIdentifiervalues of all records stored in aFeatureGroup'sOnlineStore.default CompletableFuture<ListRecordsResponse> listRecords(ListRecordsRequest listRecordsRequest) Lists theRecordIdentifiervalues of all records stored in aFeatureGroup'sOnlineStore.default ListRecordsPublisherlistRecordsPaginator(Consumer<ListRecordsRequest.Builder> listRecordsRequest) This is a variant oflistRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest)operation.default ListRecordsPublisherlistRecordsPaginator(ListRecordsRequest listRecordsRequest) This is a variant oflistRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest)operation.default CompletableFuture<PutRecordResponse> putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest) ThePutRecordAPI is used to ingest a list ofRecordsinto your feature group.default CompletableFuture<PutRecordResponse> putRecord(PutRecordRequest putRecordRequest) ThePutRecordAPI is used to ingest a list ofRecordsinto your feature group.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchGetRecord
default CompletableFuture<BatchGetRecordResponse> batchGetRecord(BatchGetRecordRequest batchGetRecordRequest) Retrieves a batch of
Recordsfrom aFeatureGroup.- Parameters:
batchGetRecordRequest-- Returns:
- A Java Future containing the result of the BatchGetRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetRecord
default CompletableFuture<BatchGetRecordResponse> batchGetRecord(Consumer<BatchGetRecordRequest.Builder> batchGetRecordRequest) Retrieves a batch of
Recordsfrom aFeatureGroup.
This is a convenience which creates an instance of the
BatchGetRecordRequest.Builderavoiding the need to create one manually viaBatchGetRecordRequest.builder()- Parameters:
batchGetRecordRequest- AConsumerthat will call methods onBatchGetRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchWriteRecord
default CompletableFuture<BatchWriteRecordResponse> batchWriteRecord(BatchWriteRecordRequest batchWriteRecordRequest) Writes a batch of
Recordsto one or moreFeatureGroups. Use this API for bulk ingestion of records into theOnlineStoreandOfflineStore.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
TtlDurationparameter. A request levelTtlDurationapplies to all entries that do not specify their ownTtlDuration.- Parameters:
batchWriteRecordRequest-- Returns:
- A Java Future containing the result of the BatchWriteRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchWriteRecord
default CompletableFuture<BatchWriteRecordResponse> batchWriteRecord(Consumer<BatchWriteRecordRequest.Builder> batchWriteRecordRequest) Writes a batch of
Recordsto one or moreFeatureGroups. Use this API for bulk ingestion of records into theOnlineStoreandOfflineStore.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
TtlDurationparameter. A request levelTtlDurationapplies to all entries that do not specify their ownTtlDuration.
This is a convenience which creates an instance of the
BatchWriteRecordRequest.Builderavoiding the need to create one manually viaBatchWriteRecordRequest.builder()- Parameters:
batchWriteRecordRequest- AConsumerthat will call methods onBatchWriteRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchWriteRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRecord
default CompletableFuture<DeleteRecordResponse> deleteRecord(DeleteRecordRequest deleteRecordRequest) Deletes a
Recordfrom aFeatureGroupin theOnlineStore. Feature Store supports bothSoftDeleteandHardDelete. ForSoftDelete(default), feature columns are set tonulland the record is no longer retrievable byGetRecordorBatchGetRecord. ForHardDelete, the completeRecordis removed from theOnlineStore. In both cases, Feature Store appends the deleted record marker to theOfflineStore. The deleted record marker is a record with the sameRecordIdentiferas the original, but withis_deletedvalue set toTrue,EventTimeset to the delete inputEventTime, and other feature values set tonull.Note that the
EventTimespecified inDeleteRecordshould be set later than theEventTimeof the existing record in theOnlineStorefor thatRecordIdentifer. If it is not, the deletion does not occur:-
For
SoftDelete, the existing (not deleted) record remains in theOnlineStore, though the delete record marker is still written to theOfflineStore. -
HardDeletereturnsEventTime:400 ValidationExceptionto indicate that the delete operation failed. No delete record marker is written to theOfflineStore.
When a record is deleted from the
OnlineStore, the deleted record marker is appended to theOfflineStore. If you have the Iceberg table format enabled for yourOfflineStore, you can remove all history of a record from theOfflineStoreusing Amazon Athena or Apache Spark. For information on how to hard delete a record from theOfflineStorewith 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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteRecord
default CompletableFuture<DeleteRecordResponse> deleteRecord(Consumer<DeleteRecordRequest.Builder> deleteRecordRequest) Deletes a
Recordfrom aFeatureGroupin theOnlineStore. Feature Store supports bothSoftDeleteandHardDelete. ForSoftDelete(default), feature columns are set tonulland the record is no longer retrievable byGetRecordorBatchGetRecord. ForHardDelete, the completeRecordis removed from theOnlineStore. In both cases, Feature Store appends the deleted record marker to theOfflineStore. The deleted record marker is a record with the sameRecordIdentiferas the original, but withis_deletedvalue set toTrue,EventTimeset to the delete inputEventTime, and other feature values set tonull.Note that the
EventTimespecified inDeleteRecordshould be set later than theEventTimeof the existing record in theOnlineStorefor thatRecordIdentifer. If it is not, the deletion does not occur:-
For
SoftDelete, the existing (not deleted) record remains in theOnlineStore, though the delete record marker is still written to theOfflineStore. -
HardDeletereturnsEventTime:400 ValidationExceptionto indicate that the delete operation failed. No delete record marker is written to theOfflineStore.
When a record is deleted from the
OnlineStore, the deleted record marker is appended to theOfflineStore. If you have the Iceberg table format enabled for yourOfflineStore, you can remove all history of a record from theOfflineStoreusing Amazon Athena or Apache Spark. For information on how to hard delete a record from theOfflineStorewith the Iceberg table format enabled, see Delete records from the offline store.
This is a convenience which creates an instance of the
DeleteRecordRequest.Builderavoiding the need to create one manually viaDeleteRecordRequest.builder()- Parameters:
deleteRecordRequest- AConsumerthat will call methods onDeleteRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getRecord
Use for
OnlineStoreserving from aFeatureStore. Only the latest records stored in theOnlineStorecan be retrieved. If no Record withRecordIdentifierValueis found, then an empty result is returned.- Parameters:
getRecordRequest-- Returns:
- A Java Future containing the result of the GetRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecord
default CompletableFuture<GetRecordResponse> getRecord(Consumer<GetRecordRequest.Builder> getRecordRequest) Use for
OnlineStoreserving from aFeatureStore. Only the latest records stored in theOnlineStorecan be retrieved. If no Record withRecordIdentifierValueis found, then an empty result is returned.
This is a convenience which creates an instance of the
GetRecordRequest.Builderavoiding the need to create one manually viaGetRecordRequest.builder()- Parameters:
getRecordRequest- AConsumerthat will call methods onGetRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecords
Lists the
RecordIdentifiervalues of all records stored in aFeatureGroup'sOnlineStore. This enables you to discover which records exist without retrieving the full record data.- Parameters:
listRecordsRequest-- Returns:
- A Java Future containing the result of the ListRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecords
default CompletableFuture<ListRecordsResponse> listRecords(Consumer<ListRecordsRequest.Builder> listRecordsRequest) Lists the
RecordIdentifiervalues of all records stored in aFeatureGroup'sOnlineStore. 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.Builderavoiding the need to create one manually viaListRecordsRequest.builder()- Parameters:
listRecordsRequest- AConsumerthat will call methods onListRecordsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordsPaginator
This is a variant of
listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsPublisher publisher = client.listRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsPublisher publisher = client.listRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordsPaginator
default ListRecordsPublisher listRecordsPaginator(Consumer<ListRecordsRequest.Builder> listRecordsRequest) This is a variant of
listRecords(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsPublisher publisher = client.listRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.sagemakerfeaturestoreruntime.paginators.ListRecordsPublisher publisher = client.listRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.ListRecordsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListRecordsRequest.builder()- Parameters:
listRecordsRequest- AConsumerthat will call methods onListRecordsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- ResourceNotFoundException A resource that is required to perform an action was not found.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRecord
The
PutRecordAPI is used to ingest a list ofRecordsinto your feature group.If a new record’s
EventTimeis greater, the new record is written to both theOnlineStoreandOfflineStore. Otherwise, the record is a historic record and it is written only to theOfflineStore.You can specify the ingestion to be applied to the
OnlineStore,OfflineStore, or both by using theTargetStoresrequest 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 theTtlDurationparameter. A record levelTtlDurationis set when specifying theTtlDurationparameter using thePutRecordAPI call. If the inputTtlDurationisnullor unspecified,TtlDurationis set to the default feature group levelTtlDuration. A record levelTtlDurationsupersedes the group levelTtlDuration.- Parameters:
putRecordRequest-- Returns:
- A Java Future containing the result of the PutRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRecord
default CompletableFuture<PutRecordResponse> putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest) The
PutRecordAPI is used to ingest a list ofRecordsinto your feature group.If a new record’s
EventTimeis greater, the new record is written to both theOnlineStoreandOfflineStore. Otherwise, the record is a historic record and it is written only to theOfflineStore.You can specify the ingestion to be applied to the
OnlineStore,OfflineStore, or both by using theTargetStoresrequest 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 theTtlDurationparameter. A record levelTtlDurationis set when specifying theTtlDurationparameter using thePutRecordAPI call. If the inputTtlDurationisnullor unspecified,TtlDurationis set to the default feature group levelTtlDuration. A record levelTtlDurationsupersedes the group levelTtlDuration.
This is a convenience which creates an instance of the
PutRecordRequest.Builderavoiding the need to create one manually viaPutRecordRequest.builder()- Parameters:
putRecordRequest- AConsumerthat will call methods onPutRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationErrorException There was an error validating your request.
- InternalFailureException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
- ServiceUnavailableException The service is currently unavailable.
- AccessForbiddenException You do not have permission to perform an action.
- 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.
- SageMakerFeatureStoreRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aSageMakerFeatureStoreRuntimeAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSageMakerFeatureStoreRuntimeAsyncClient.
-