AWS.Tools.SageMakerFeatureStoreRuntime.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SageMakerFeatureStoreRuntime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet"> <summary> Use for <c>OnlineStore</c> serving from a <c>FeatureStore</c>. Only the latest records stored in the <c>OnlineStore</c> can be retrieved. If no Record with <c>RecordIdentifierValue</c> is found, then an empty result is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet.ExpirationTimeResponse"> <summary> <para> <para>Parameter to request <c>ExpiresAt</c> in response. If <c>Enabled</c>, <c>GetRecord</c> will return the value of <c>ExpiresAt</c>, if it is not null. If <c>Disabled</c> and null, <c>GetRecord</c> will return null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet.FeatureName"> <summary> <para> <para>List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet.RecordIdentifierValueAsString"> <summary> <para> <para>The value that corresponds to <c>RecordIdentifier</c> type and uniquely identifies the record in the <c>FeatureGroup</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Record'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerFeatureStoreRuntime.Model.GetRecordResponse). Specifying the name of a property of type Amazon.SageMakerFeatureStoreRuntime.Model.GetRecordResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet"> <summary> Retrieves a batch of <c>Records</c> from a <c>FeatureGroup</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet.ExpirationTimeResponse"> <summary> <para> <para>Parameter to request <c>ExpiresAt</c> in response. If <c>Enabled</c>, <c>BatchGetRecord</c> will return the value of <c>ExpiresAt</c>, if it is not null. If <c>Disabled</c> and null, <c>BatchGetRecord</c> will return null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet.Identifier"> <summary> <para> <para>A list containing the name or Amazon Resource Name (ARN) of the <c>FeatureGroup</c>, the list of names of <c>Feature</c>s to be retrieved, and the corresponding <c>RecordIdentifier</c> values as strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerFeatureStoreRuntime.Model.BatchGetRecordResponse). Specifying the name of a property of type Amazon.SageMakerFeatureStoreRuntime.Model.BatchGetRecordResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet"> <summary> Deletes a <c>Record</c> from a <c>FeatureGroup</c> in the <c>OnlineStore</c>. Feature Store supports both <c>SoftDelete</c> and <c>HardDelete</c>. For <c>SoftDelete</c> (default), feature columns are set to <c>null</c> and the record is no longer retrievable by <c>GetRecord</c> or <c>BatchGetRecord</c>. For <c>HardDelete</c>, the complete <c>Record</c> is removed from the <c>OnlineStore</c>. In both cases, Feature Store appends the deleted record marker to the <c>OfflineStore</c>. The deleted record marker is a record with the same <c>RecordIdentifer</c> as the original, but with <c>is_deleted</c> value set to <c>True</c>, <c>EventTime</c> set to the delete input <c>EventTime</c>, and other feature values set to <c>null</c>. <para> Note that the <c>EventTime</c> specified in <c>DeleteRecord</c> should be set later than the <c>EventTime</c> of the existing record in the <c>OnlineStore</c> for that <c>RecordIdentifer</c>. If it is not, the deletion does not occur: </para><ul><li><para> For <c>SoftDelete</c>, the existing (not deleted) record remains in the <c>OnlineStore</c>, though the delete record marker is still written to the <c>OfflineStore</c>. </para></li><li><para><c>HardDelete</c> returns <c>EventTime</c>: <c>400 ValidationException</c> to indicate that the delete operation failed. No delete record marker is written to the <c>OfflineStore</c>. </para></li></ul><para> When a record is deleted from the <c>OnlineStore</c>, the deleted record marker is appended to the <c>OfflineStore</c>. If you have the Iceberg table format enabled for your <c>OfflineStore</c>, you can remove all history of a record from the <c>OfflineStore</c> using Amazon Athena or Apache Spark. For information on how to hard delete a record from the <c>OfflineStore</c> with the Iceberg table format enabled, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records-offline-store.html#feature-store-delete-records-offline-store">Delete records from the offline store</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.DeletionMode"> <summary> <para> <para>The name of the deletion mode for deleting the record. By default, the deletion mode is set to <c>SoftDelete</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.EventTime"> <summary> <para> <para>Timestamp indicating when the deletion event occurred. <c>EventTime</c> can be used to query data at a certain point in time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group to delete the record from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.RecordIdentifierValueAsString"> <summary> <para> <para>The value for the <c>RecordIdentifier</c> that uniquely identifies the record, in string format. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.TargetStore"> <summary> <para> <para>A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the <c>FeatureGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerFeatureStoreRuntime.Model.DeleteRecordResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet"> <summary> The <c>PutRecord</c> API is used to ingest a list of <c>Records</c> into your feature group. <para> If a new record’s <c>EventTime</c> is greater, the new record is written to both the <c>OnlineStore</c> and <c>OfflineStore</c>. Otherwise, the record is a historic record and it is written only to the <c>OfflineStore</c>. </para><para> You can specify the ingestion to be applied to the <c>OnlineStore</c>, <c>OfflineStore</c>, or both by using the <c>TargetStores</c> request parameter. </para><para> You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, <c>ExpiresAt</c> = <c>EventTime</c> + <c>TtlDuration</c>, by specifying the <c>TtlDuration</c> parameter. A record level <c>TtlDuration</c> is set when specifying the <c>TtlDuration</c> parameter using the <c>PutRecord</c> API call. If the input <c>TtlDuration</c> is <c>null</c> or unspecified, <c>TtlDuration</c> is set to the default feature group level <c>TtlDuration</c>. A record level <c>TtlDuration</c> supersedes the group level <c>TtlDuration</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.Record"> <summary> <para> <para>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:</para><ul><li><para>Use <c>GetRecord</c> to retrieve the latest record.</para></li><li><para>Update the record returned from <c>GetRecord</c>. </para></li><li><para>Use <c>PutRecord</c> to update feature values.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.TargetStore"> <summary> <para> <para>A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the <c>FeatureGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.TtlDuration_Unit"> <summary> <para> <para><c>TtlDuration</c> time unit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.TtlDuration_Value"> <summary> <para> <para><c>TtlDuration</c> time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMakerFeatureStoreRuntime.Model.PutRecordResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |