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
Modifier and TypeFieldDescriptionstatic final String
Value 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 ofRecords
from aFeatureGroup
.default CompletableFuture
<BatchGetRecordResponse> batchGetRecord
(BatchGetRecordRequest batchGetRecordRequest) Retrieves a batch ofRecords
from aFeatureGroup
.builder()
Create a builder that can be used to configure and create aSageMakerFeatureStoreRuntimeAsyncClient
.create()
Create aSageMakerFeatureStoreRuntimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<DeleteRecordResponse> deleteRecord
(Consumer<DeleteRecordRequest.Builder> deleteRecordRequest) Deletes aRecord
from aFeatureGroup
in theOnlineStore
.default CompletableFuture
<DeleteRecordResponse> deleteRecord
(DeleteRecordRequest deleteRecordRequest) Deletes aRecord
from aFeatureGroup
in theOnlineStore
.default CompletableFuture
<GetRecordResponse> getRecord
(Consumer<GetRecordRequest.Builder> getRecordRequest) Use forOnlineStore
serving from aFeatureStore
.default CompletableFuture
<GetRecordResponse> getRecord
(GetRecordRequest getRecordRequest) Use forOnlineStore
serving from aFeatureStore
.default CompletableFuture
<PutRecordResponse> putRecord
(Consumer<PutRecordRequest.Builder> putRecordRequest) ThePutRecord
API is used to ingest a list ofRecords
into your feature group.default CompletableFuture
<PutRecordResponse> putRecord
(PutRecordRequest putRecordRequest) ThePutRecord
API is used to ingest a list ofRecords
into 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
close
Methods 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
Records
from 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
Records
from aFeatureGroup
.
This is a convenience which creates an instance of the
BatchGetRecordRequest.Builder
avoiding the need to create one manually viaBatchGetRecordRequest.builder()
- Parameters:
batchGetRecordRequest
- AConsumer
that will call methods onBatchGetRecordRequest.Builder
to 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:
-
deleteRecord
default CompletableFuture<DeleteRecordResponse> deleteRecord(DeleteRecordRequest deleteRecordRequest) Deletes a
Record
from aFeatureGroup
in theOnlineStore
. Feature Store supports bothSoftDelete
andHardDelete
. ForSoftDelete
(default), feature columns are set tonull
and the record is no longer retrievable byGetRecord
orBatchGetRecord
. ForHardDelete
, the completeRecord
is removed from theOnlineStore
. In both cases, Feature Store appends the deleted record marker to theOfflineStore
. The deleted record marker is a record with the sameRecordIdentifer
as the original, but withis_deleted
value set toTrue
,EventTime
set to the delete inputEventTime
, and other feature values set tonull
.Note that the
EventTime
specified inDeleteRecord
should be set later than theEventTime
of the existing record in theOnlineStore
for 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
. -
HardDelete
returnsEventTime
:400 ValidationException
to 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 theOfflineStore
using Amazon Athena or Apache Spark. For information on how to hard delete a record from theOfflineStore
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.
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
Record
from aFeatureGroup
in theOnlineStore
. Feature Store supports bothSoftDelete
andHardDelete
. ForSoftDelete
(default), feature columns are set tonull
and the record is no longer retrievable byGetRecord
orBatchGetRecord
. ForHardDelete
, the completeRecord
is removed from theOnlineStore
. In both cases, Feature Store appends the deleted record marker to theOfflineStore
. The deleted record marker is a record with the sameRecordIdentifer
as the original, but withis_deleted
value set toTrue
,EventTime
set to the delete inputEventTime
, and other feature values set tonull
.Note that the
EventTime
specified inDeleteRecord
should be set later than theEventTime
of the existing record in theOnlineStore
for 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
. -
HardDelete
returnsEventTime
:400 ValidationException
to 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 theOfflineStore
using Amazon Athena or Apache Spark. For information on how to hard delete a record from theOfflineStore
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 viaDeleteRecordRequest.builder()
- Parameters:
deleteRecordRequest
- AConsumer
that will call methods onDeleteRecordRequest.Builder
to 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
OnlineStore
serving from aFeatureStore
. Only the latest records stored in theOnlineStore
can be retrieved. If no Record withRecordIdentifierValue
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.
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
OnlineStore
serving from aFeatureStore
. Only the latest records stored in theOnlineStore
can be retrieved. If no Record withRecordIdentifierValue
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 viaGetRecordRequest.builder()
- Parameters:
getRecordRequest
- AConsumer
that will call methods onGetRecordRequest.Builder
to 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:
-
putRecord
The
PutRecord
API is used to ingest a list ofRecords
into your feature group.If a new record’s
EventTime
is greater, the new record is written to both theOnlineStore
andOfflineStore
. 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 theTargetStores
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 theTtlDuration
parameter. A record levelTtlDuration
is set when specifying theTtlDuration
parameter using thePutRecord
API call. If the inputTtlDuration
isnull
or unspecified,TtlDuration
is set to the default feature group levelTtlDuration
. A record levelTtlDuration
supersedes 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
PutRecord
API is used to ingest a list ofRecords
into your feature group.If a new record’s
EventTime
is greater, the new record is written to both theOnlineStore
andOfflineStore
. 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 theTargetStores
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 theTtlDuration
parameter. A record levelTtlDuration
is set when specifying theTtlDuration
parameter using thePutRecord
API call. If the inputTtlDuration
isnull
or unspecified,TtlDuration
is set to the default feature group levelTtlDuration
. A record levelTtlDuration
supersedes the group levelTtlDuration
.
This is a convenience which creates an instance of the
PutRecordRequest.Builder
avoiding the need to create one manually viaPutRecordRequest.builder()
- Parameters:
putRecordRequest
- AConsumer
that will call methods onPutRecordRequest.Builder
to 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:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSageMakerFeatureStoreRuntimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSageMakerFeatureStoreRuntimeAsyncClient
.
-