Amazon SageMaker Feature Store Runtime 2020-07-01
- Client: Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
- Service ID: sagemaker-featurestore-runtime
- Version: 2020-07-01
This page describes the parameters and results for the operations of the Amazon SageMaker Feature Store Runtime (2020-07-01), and shows how to use the Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient object to call the described operations. This documentation is specific to the 2020-07-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- DeleteRecord ( array $params = [] )
Deletes a Record from a FeatureGroup.
- GetRecord ( array $params = [] )
Use for OnlineStore serving from a FeatureStore.
- PutRecord ( array $params = [] )
Used for data ingestion into the FeatureStore.
Operations
DeleteRecord
$result = $client->deleteRecord
([/* ... */]); $promise = $client->deleteRecordAsync
([/* ... */]);
Deletes a Record
from a FeatureGroup
. A new record will show up in the OfflineStore
when the DeleteRecord
API is called. This record will have a value of True
in the is_deleted
column.
Parameter Syntax
$result = $client->deleteRecord([ 'EventTime' => '<string>', // REQUIRED 'FeatureGroupName' => '<string>', // REQUIRED 'RecordIdentifierValueAsString' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EventTime
-
- Required: Yes
- Type: string
Timestamp indicating when the deletion event occurred.
EventTime
can be used to query data at a certain point in time. - FeatureGroupName
-
- Required: Yes
- Type: string
The name of the feature group to delete the record from.
- RecordIdentifierValueAsString
-
- Required: Yes
- Type: string
The value for the
RecordIdentifier
that uniquely identifies the record, in string format.
Result Syntax
[]
Result Details
Errors
-
There was an error validating your request.
-
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
-
The service is currently unavailable.
-
You do not have permission to perform an action.
GetRecord
$result = $client->getRecord
([/* ... */]); $promise = $client->getRecordAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getRecord([ 'FeatureGroupName' => '<string>', // REQUIRED 'FeatureNames' => ['<string>', ...], 'RecordIdentifierValueAsString' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FeatureGroupName
-
- Required: Yes
- Type: string
The name of the feature group in which you want to put the records.
- FeatureNames
-
- Type: Array of strings
List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.
- RecordIdentifierValueAsString
-
- Required: Yes
- Type: string
The value that corresponds to
RecordIdentifier
type and uniquely identifies the record in theFeatureGroup
.
Result Syntax
[ 'Record' => [ [ 'FeatureName' => '<string>', 'ValueAsString' => '<string>', ], // ... ], ]
Result Details
Members
- Record
-
- Type: Array of FeatureValue structures
The record you requested. A list of
FeatureValues
.
Errors
-
There was an error validating your request.
-
A resource that is required to perform an action was not found.
-
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
-
The service is currently unavailable.
-
You do not have permission to perform an action.
PutRecord
$result = $client->putRecord
([/* ... */]); $promise = $client->putRecordAsync
([/* ... */]);
Used for data ingestion into the FeatureStore
. The PutRecord
API writes to both the OnlineStore
and OfflineStore
. If the record is the latest record for the recordIdentifier
, the record is written to both the OnlineStore
and OfflineStore
. If the record is a historic record, it is written only to the OfflineStore
.
Parameter Syntax
$result = $client->putRecord([ 'FeatureGroupName' => '<string>', // REQUIRED 'Record' => [ // REQUIRED [ 'FeatureName' => '<string>', // REQUIRED 'ValueAsString' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- FeatureGroupName
-
- Required: Yes
- Type: string
The name of the feature group that you want to insert the record into.
- Record
-
- Required: Yes
- Type: Array of FeatureValue structures
List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following:
-
Use
GetRecord
to retrieve the latest record. -
Update the record returned from
GetRecord
. -
Use
PutRecord
to update feature values.
Result Syntax
[]
Result Details
Errors
-
There was an error validating your request.
-
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
-
The service is currently unavailable.
-
You do not have permission to perform an action.
Shapes
AccessForbidden
FeatureValue
Description
The value associated with a feature.
Members
- FeatureName
-
- Required: Yes
- Type: string
The name of a feature that a feature value corresponds to.
- ValueAsString
-
- Required: Yes
- Type: string
The value associated with a feature, in string format. Note that features types can be String, Integral, or Fractional. This value represents all three types as a string.
InternalFailure
Description
An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
Members
ResourceNotFound
Description
A resource that is required to perform an action was not found.