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 <code>OnlineStore</code> serving from a <code>FeatureStore</code>. Only the
            latest records stored in the <code>OnlineStore</code> can be retrieved. If no Record
            with <code>RecordIdentifierValue</code> 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 <code>ExpiresAt</code> in response. If <code>Enabled</code>,
            <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.</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 <code>RecordIdentifier</code> type and uniquely identifies
            the record in the <code>FeatureGroup</code>. </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 <code>Records</code> from a <code>FeatureGroup</code>.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet.ExpirationTimeResponse">
            <summary>
            <para>
            <para>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.</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 <code>FeatureGroup</code>,
            the list of names of <code>Feature</code>s to be retrieved, and the corresponding
            <code>RecordIdentifier</code> 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="P:Amazon.PowerShell.Cmdlets.SMFS.GetSMFSRecordBatchCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ExpirationTimeResponse parameter.
            The -PassThru parameter is deprecated, use -Select '^ExpirationTimeResponse' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet">
            <summary>
            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>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>, and <code>EventTime</code>
            set to the delete input <code>EventTime</code>.
             
              
            <para>
            Note that the <code>EventTime</code> specified in <code>DeleteRecord</code> should
            be set later than the <code>EventTime</code> of the existing record in the <code>OnlineStore</code>
            for that <code>RecordIdentifer</code>. If it is not, the deletion does not occur:
            </para><ul><li><para>
            For <code>SoftDelete</code>, the existing (undeleted) record remains in the <code>OnlineStore</code>,
            though the delete record marker is still written to the <code>OfflineStore</code>.
            </para></li><li><para><code>HardDelete</code> returns <code>EventTime</code>: <code>400 ValidationException</code>
            to indicate that the delete operation failed. No delete record marker is written to
            the <code>OfflineStore</code>.
            </para></li></ul>
            </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 <code>SoftDelete</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.SMFS.RemoveSMFSRecordCmdlet.EventTime">
            <summary>
            <para>
            <para>Timestamp indicating when the deletion event occurred. <code>EventTime</code> 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 <code>RecordIdentifier</code> 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 <code>FeatureGroup</code>.</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 <code>PutRecord</code> API is used to ingest a list of <code>Records</code> into
            your feature group.
             
              
            <para>
            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>.
            </para><para>
            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.
            </para><para>
            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>.
            </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 <code>GetRecord</code> to retrieve the latest record.</para></li><li><para>Update the record returned from <code>GetRecord</code>. </para></li><li><para>Use <code>PutRecord</code> 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 <code>FeatureGroup</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.TtlDuration_Unit">
            <summary>
            <para>
            <para><code>TtlDuration</code> time unit.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.SMFS.WriteSMFSRecordCmdlet.TtlDuration_Value">
            <summary>
            <para>
            <para><code>TtlDuration</code> 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>