@aws-sdk/client-sagemaker-featurestore-runtime 3.370.0 → 3.374.0

package/dist-types/commands/DeleteRecordCommand.d.ts

@@ -25,9 +25,9 @@ export interface DeleteRecordCommandOutput extends __MetadataBearer {
  * @public
  * <p>Deletes a <code>Record</code> from a <code>FeatureGroup</code> in the
  *             <code>OnlineStore</code>. Feature Store supports both <code>SoftDelete</code> and
- *             <code>HardDelete</code>. For <code>SoftDelete</code> (default), feature columns are
- *          set to <code>null</code> and the record is no longer retrievable by <code>GetRecord</code>
- *          or <code>BatchGetRecord</code>. For <code>HardDelete</code>, the complete
+ *             <code>HardDelete</code>. For <code>SoftDelete</code> (default), feature columns are set
+ *          to <code>null</code> and the record is no longer retrievable by <code>GetRecord</code> or
+ *             <code>BatchGetRecord</code>. For <code>HardDelete</code>, the complete
  *             <code>Record</code> is removed from the <code>OnlineStore</code>. In both cases, Feature
  *          Store appends the deleted record marker to the <code>OfflineStore</code> with feature
  *          values set to <code>null</code>, <code>is_deleted</code> value set to <code>True</code>,

package/dist-types/commands/PutRecordCommand.d.ts

@@ -23,11 +23,22 @@ export interface PutRecordCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Used for data ingestion into the <code>FeatureStore</code>. The <code>PutRecord</code>
- *          API writes to both the <code>OnlineStore</code> and <code>OfflineStore</code>. If the
- *          record is the latest record for the <code>recordIdentifier</code>, the record is written to
- *          both the <code>OnlineStore</code> and <code>OfflineStore</code>. If the record is a
- *          historic record, it is written only to the <code>OfflineStore</code>.</p>
+ * <p>The <code>PutRecord</code> API is used to ingest a list of <code>Records</code> into
+ *          your feature group. </p>
+ *          <p>If a new record’s <code>EventTime</code> is greater, the new record is written to both
+ *          the <code>OnlineStore</code> and <code>OfflineStore</code>. Otherwise, the record is a
+ *          historic record and it is written only to the <code>OfflineStore</code>. </p>
+ *          <p>You can specify the ingestion to be applied to the <code>OnlineStore</code>,
+ *             <code>OfflineStore</code>, or both by using the <code>TargetStores</code> request
+ *          parameter. </p>
+ *          <p>You can set the ingested record to expire at a given time to live (TTL) duration after
+ *          the record’s event time, <code>ExpiresAt</code> = <code>EventTime</code> +
+ *             <code>TtlDuration</code>, by specifying the <code>TtlDuration</code> parameter. A record
+ *          level <code>TtlDuration</code> is set when specifying the <code>TtlDuration</code>
+ *          parameter using the <code>PutRecord</code> API call. If the input <code>TtlDuration</code>
+ *          is <code>null</code> or unspecified, <code>TtlDuration</code> is set to the default feature
+ *          group level <code>TtlDuration</code>. A record level <code>TtlDuration</code> supersedes
+ *          the group level <code>TtlDuration</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/models/models_0.d.ts

@@ -32,7 +32,8 @@ export type ExpirationTimeResponse = (typeof ExpirationTimeResponse)[keyof typeo
  */
 export interface BatchGetRecordIdentifier {
     /**
-     * <p>A <code>FeatureGroupName</code> containing Records you are retrieving in a batch.</p>
+     * <p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> containing the
+     *          records you are retrieving in a batch.</p>
      */
     FeatureGroupName: string | undefined;
     /**
@@ -50,14 +51,14 @@ export interface BatchGetRecordIdentifier {
  */
 export interface BatchGetRecordRequest {
     /**
-     * <p>A list of <code>FeatureGroup</code> names, with their corresponding
-     *             <code>RecordIdentifier</code> value, and Feature name that have been requested to be
-     *          retrieved in batch.</p>
+     * <p>A list containing the name or Amazon Resource Name (ARN) of the
+     *             <code>FeatureGroup</code>, the list of names of <code>Feature</code>s to be retrieved,
+     *          and the corresponding <code>RecordIdentifier</code> values as strings.</p>
      */
     Identifiers: BatchGetRecordIdentifier[] | undefined;
     /**
      * <p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>,
-     *          <code>BatchGetRecord</code> will return the value of <code>ExpiresAt</code>, if it is
+     *             <code>BatchGetRecord</code> will return the value of <code>ExpiresAt</code>, if it is
      *          not null. If <code>Disabled</code> and null, <code>BatchGetRecord</code> will return
      *          null.</p>
      */
@@ -106,7 +107,7 @@ export interface FeatureValue {
 }
 /**
  * @public
- * <p>The output of Records that have been retrieved in a batch.</p>
+ * <p>The output of records that have been retrieved in a batch.</p>
  */
 export interface BatchGetRecordResultDetail {
     /**
@@ -213,7 +214,8 @@ export type TargetStore = (typeof TargetStore)[keyof typeof TargetStore];
  */
 export interface DeleteRecordRequest {
     /**
-     * <p>The name of the feature group to delete the record from. </p>
+     * <p>The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
+     *       </p>
      */
     FeatureGroupName: string | undefined;
     /**
@@ -243,7 +245,8 @@ export interface DeleteRecordRequest {
  */
 export interface GetRecordRequest {
     /**
-     * <p>The name of the feature group from which you want to retrieve a record.</p>
+     * <p>The name or Amazon Resource Name (ARN) of the feature group from which you want to
+     *          retrieve a record.</p>
      */
     FeatureGroupName: string | undefined;
     /**
@@ -258,9 +261,8 @@ export interface GetRecordRequest {
     FeatureNames?: string[];
     /**
      * <p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>,
-     *          <code>BatchGetRecord</code> will return the value of <code>ExpiresAt</code>, if it is
-     *          not null. If <code>Disabled</code> and null, <code>BatchGetRecord</code> will return
-     *          null.</p>
+     *             <code>GetRecord</code> will return the value of <code>ExpiresAt</code>, if it is not
+     *          null. If <code>Disabled</code> and null, <code>GetRecord</code> will return null.</p>
      */
     ExpirationTimeResponse?: ExpirationTimeResponse | string;
 }
@@ -328,7 +330,8 @@ export interface TtlDuration {
  */
 export interface PutRecordRequest {
     /**
-     * <p>The name of the feature group that you want to insert the record into.</p>
+     * <p>The name or Amazon Resource Name (ARN) of the feature group that you want to insert the
+     *          record into.</p>
      */
     FeatureGroupName: string | undefined;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sagemaker-featurestore-runtime",
   "description": "AWS SDK for JavaScript Sagemaker Featurestore Runtime Client for Node.js, Browser and React Native",
-  "version": "3.370.0",
+  "version": "3.374.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",