@aws-sdk/client-sagemaker-featurestore-runtime 3.422.1 → 3.423.0

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

@@ -1,410 +1,115 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { SageMakerFeatureStoreRuntimeServiceException as __BaseException } from "./SageMakerFeatureStoreRuntimeServiceException";
-/**
- * @public
- * <p>You do not have permission to perform an action.</p>
- */
-export declare class AccessForbidden extends __BaseException {
-    readonly name: "AccessForbidden";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<AccessForbidden, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-export declare const ExpirationTimeResponse: {
-    readonly DISABLED: "Disabled";
-    readonly ENABLED: "Enabled";
-};
-/**
- * @public
- */
-export type ExpirationTimeResponse = (typeof ExpirationTimeResponse)[keyof typeof ExpirationTimeResponse];
-/**
- * @public
- * <p>The identifier that identifies the batch of Records you are retrieving in a
- *          batch.</p>
- */
-export interface BatchGetRecordIdentifier {
-    /**
-     * @public
-     * <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;
-    /**
-     * @public
-     * <p>The value for a list of record identifiers in string format.</p>
-     */
-    RecordIdentifiersValueAsString: string[] | undefined;
-    /**
-     * @public
-     * <p>List of names of Features to be retrieved. If not specified, the latest value for all
-     *          the Features are returned.</p>
-     */
-    FeatureNames?: string[];
-}
-/**
- * @public
- */
-export interface BatchGetRecordRequest {
-    /**
-     * @public
-     * <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;
-    /**
-     * @public
-     * <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>
-     */
-    ExpirationTimeResponse?: ExpirationTimeResponse | string;
-}
-/**
- * @public
- * <p>The error that has occurred when attempting to retrieve a batch of Records.</p>
- */
-export interface BatchGetRecordError {
-    /**
-     * @public
-     * <p>The name of the feature group that the record belongs to.</p>
-     */
-    FeatureGroupName: string | undefined;
-    /**
-     * @public
-     * <p>The value for the <code>RecordIdentifier</code> in string format of a Record from a
-     *             <code>FeatureGroup</code> that is causing an error when attempting to be
-     *          retrieved.</p>
-     */
-    RecordIdentifierValueAsString: string | undefined;
-    /**
-     * @public
-     * <p>The error code of an error that has occurred when attempting to retrieve a batch of
-     *          Records. For more information on errors, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors">Errors</a>.</p>
-     */
-    ErrorCode: string | undefined;
-    /**
-     * @public
-     * <p>The error message of an error that has occurred when attempting to retrieve a record in
-     *          the batch.</p>
-     */
-    ErrorMessage: string | undefined;
-}
-/**
- * @public
- * <p>The value associated with a feature.</p>
- */
-export interface FeatureValue {
-    /**
-     * @public
-     * <p>The name of a feature that a feature value corresponds to.</p>
-     */
-    FeatureName: string | undefined;
-    /**
-     * @public
-     * <p>The value in string format associated with a feature. Used when your
-     *             <code>CollectionType</code> is <code>None</code>. Note that features types can be
-     *             <code>String</code>, <code>Integral</code>, or <code>Fractional</code>. This value
-     *          represents all three types as a string.</p>
-     */
-    ValueAsString?: string;
-    /**
-     * @public
-     * <p>The list of values in string format associated with a feature. Used when your
-     *             <code>CollectionType</code> is a <code>List</code>, <code>Set</code>, or
-     *             <code>Vector</code>. Note that features types can be <code>String</code>,
-     *             <code>Integral</code>, or <code>Fractional</code>. These values represents all three
-     *          types as a string.</p>
-     */
-    ValueAsStringList?: string[];
-}
-/**
- * @public
- * <p>The output of records that have been retrieved in a batch.</p>
- */
-export interface BatchGetRecordResultDetail {
-    /**
-     * @public
-     * <p>The <code>FeatureGroupName</code> containing Records you retrieved in a batch.</p>
-     */
-    FeatureGroupName: string | undefined;
-    /**
-     * @public
-     * <p>The value of the record identifier in string format.</p>
-     */
-    RecordIdentifierValueAsString: string | undefined;
-    /**
-     * @public
-     * <p>The <code>Record</code> retrieved.</p>
-     */
-    Record: FeatureValue[] | undefined;
-    /**
-     * @public
-     * <p>The <code>ExpiresAt</code> ISO string of the requested record.</p>
-     */
-    ExpiresAt?: string;
-}
-/**
- * @public
- */
-export interface BatchGetRecordResponse {
-    /**
-     * @public
-     * <p>A list of Records you requested to be retrieved in batch.</p>
-     */
-    Records: BatchGetRecordResultDetail[] | undefined;
-    /**
-     * @public
-     * <p>A list of errors that have occurred when retrieving a batch of Records.</p>
-     */
-    Errors: BatchGetRecordError[] | undefined;
-    /**
-     * @public
-     * <p>A unprocessed list of <code>FeatureGroup</code> names, with their corresponding
-     *             <code>RecordIdentifier</code> value, and Feature name.</p>
-     */
-    UnprocessedIdentifiers: BatchGetRecordIdentifier[] | undefined;
-}
-/**
- * @public
- * <p>An internal failure occurred. Try your request again. If the problem persists, contact
- *             Amazon Web Services customer support.</p>
- */
-export declare class InternalFailure extends __BaseException {
-    readonly name: "InternalFailure";
-    readonly $fault: "server";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InternalFailure, __BaseException>);
-}
-/**
- * @public
- * <p>The service is currently unavailable.</p>
- */
-export declare class ServiceUnavailable extends __BaseException {
-    readonly name: "ServiceUnavailable";
-    readonly $fault: "server";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ServiceUnavailable, __BaseException>);
-}
-/**
- * @public
- * <p>There was an error validating your request.</p>
- */
-export declare class ValidationError extends __BaseException {
-    readonly name: "ValidationError";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ValidationError, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-export declare const DeletionMode: {
-    readonly HARD_DELETE: "HardDelete";
-    readonly SOFT_DELETE: "SoftDelete";
-};
-/**
- * @public
- */
-export type DeletionMode = (typeof DeletionMode)[keyof typeof DeletionMode];
-/**
- * @public
- * @enum
- */
-export declare const TargetStore: {
-    readonly OFFLINE_STORE: "OfflineStore";
-    readonly ONLINE_STORE: "OnlineStore";
-};
-/**
- * @public
- */
-export type TargetStore = (typeof TargetStore)[keyof typeof TargetStore];
-/**
- * @public
- */
-export interface DeleteRecordRequest {
-    /**
-     * @public
-     * <p>The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
-     *       </p>
-     */
-    FeatureGroupName: string | undefined;
-    /**
-     * @public
-     * <p>The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in
-     *          string format. </p>
-     */
-    RecordIdentifierValueAsString: string | undefined;
-    /**
-     * @public
-     * <p>Timestamp indicating when the deletion event occurred. <code>EventTime</code> can be
-     *          used to query data at a certain point in time.</p>
-     */
-    EventTime: string | undefined;
-    /**
-     * @public
-     * <p>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>.</p>
-     */
-    TargetStores?: (TargetStore | string)[];
-    /**
-     * @public
-     * <p>The name of the deletion mode for deleting the record. By default, the deletion mode is
-     *          set to <code>SoftDelete</code>.</p>
-     */
-    DeletionMode?: DeletionMode | string;
-}
-/**
- * @public
- */
-export interface GetRecordRequest {
-    /**
-     * @public
-     * <p>The name or Amazon Resource Name (ARN) of the feature group from which you want to
-     *          retrieve a record.</p>
-     */
-    FeatureGroupName: string | undefined;
-    /**
-     * @public
-     * <p>The value that corresponds to <code>RecordIdentifier</code> type and uniquely identifies
-     *          the record in the <code>FeatureGroup</code>. </p>
-     */
-    RecordIdentifierValueAsString: string | undefined;
-    /**
-     * @public
-     * <p>List of names of Features to be retrieved. If not specified, the latest value for all
-     *          the Features are returned.</p>
-     */
-    FeatureNames?: string[];
-    /**
-     * @public
-     * <p>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.</p>
-     */
-    ExpirationTimeResponse?: ExpirationTimeResponse | string;
-}
-/**
- * @public
- */
-export interface GetRecordResponse {
-    /**
-     * @public
-     * <p>The record you requested. A list of <code>FeatureValues</code>.</p>
-     */
-    Record?: FeatureValue[];
-    /**
-     * @public
-     * <p>The <code>ExpiresAt</code> ISO string of the requested record.</p>
-     */
-    ExpiresAt?: string;
-}
-/**
- * @public
- * <p>A resource that is required to perform an action was not found.</p>
- */
-export declare class ResourceNotFound extends __BaseException {
-    readonly name: "ResourceNotFound";
-    readonly $fault: "client";
-    Message?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-export declare const TtlDurationUnit: {
-    readonly DAYS: "Days";
-    readonly HOURS: "Hours";
-    readonly MINUTES: "Minutes";
-    readonly SECONDS: "Seconds";
-    readonly WEEKS: "Weeks";
-};
-/**
- * @public
- */
-export type TtlDurationUnit = (typeof TtlDurationUnit)[keyof typeof TtlDurationUnit];
-/**
- * @public
- * <p>Time to live duration, where the record is hard deleted after the expiration time is
- *          reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. For
- *          information on HardDelete, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html">DeleteRecord</a> API in the Amazon SageMaker API Reference guide.</p>
- */
-export interface TtlDuration {
-    /**
-     * @public
-     * <p>
-     *             <code>TtlDuration</code> time unit.</p>
-     */
-    Unit: TtlDurationUnit | string | undefined;
-    /**
-     * @public
-     * <p>
-     *             <code>TtlDuration</code> time value.</p>
-     */
-    Value: number | undefined;
-}
-/**
- * @public
- */
-export interface PutRecordRequest {
-    /**
-     * @public
-     * <p>The name or Amazon Resource Name (ARN) of the feature group that you want to insert the
-     *          record into.</p>
-     */
-    FeatureGroupName: string | undefined;
-    /**
-     * @public
-     * <p>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:</p>
-     *          <ul>
-     *             <li>
-     *                <p>Use <code>GetRecord</code> to retrieve the latest record.</p>
-     *             </li>
-     *             <li>
-     *                <p>Update the record returned from <code>GetRecord</code>. </p>
-     *             </li>
-     *             <li>
-     *                <p>Use <code>PutRecord</code> to update feature values.</p>
-     *             </li>
-     *          </ul>
-     */
-    Record: FeatureValue[] | undefined;
-    /**
-     * @public
-     * <p>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>.</p>
-     */
-    TargetStores?: (TargetStore | string)[];
-    /**
-     * @public
-     * <p>Time to live duration, where the record is hard deleted after the expiration time is
-     *          reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. For
-     *          information on HardDelete, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html">DeleteRecord</a> API in the Amazon SageMaker API Reference guide.</p>
-     */
-    TtlDuration?: TtlDuration;
-}
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { SageMakerFeatureStoreRuntimeServiceException as __BaseException } from "./SageMakerFeatureStoreRuntimeServiceException";
+export declare class AccessForbidden extends __BaseException {
+  readonly name: "AccessForbidden";
+  readonly $fault: "client";
+  Message?: string;
+  constructor(opts: __ExceptionOptionType<AccessForbidden, __BaseException>);
+}
+export declare const ExpirationTimeResponse: {
+  readonly DISABLED: "Disabled";
+  readonly ENABLED: "Enabled";
+};
+export type ExpirationTimeResponse =
+  (typeof ExpirationTimeResponse)[keyof typeof ExpirationTimeResponse];
+export interface BatchGetRecordIdentifier {
+  FeatureGroupName: string | undefined;
+  RecordIdentifiersValueAsString: string[] | undefined;
+  FeatureNames?: string[];
+}
+export interface BatchGetRecordRequest {
+  Identifiers: BatchGetRecordIdentifier[] | undefined;
+  ExpirationTimeResponse?: ExpirationTimeResponse | string;
+}
+export interface BatchGetRecordError {
+  FeatureGroupName: string | undefined;
+  RecordIdentifierValueAsString: string | undefined;
+  ErrorCode: string | undefined;
+  ErrorMessage: string | undefined;
+}
+export interface FeatureValue {
+  FeatureName: string | undefined;
+  ValueAsString?: string;
+  ValueAsStringList?: string[];
+}
+export interface BatchGetRecordResultDetail {
+  FeatureGroupName: string | undefined;
+  RecordIdentifierValueAsString: string | undefined;
+  Record: FeatureValue[] | undefined;
+  ExpiresAt?: string;
+}
+export interface BatchGetRecordResponse {
+  Records: BatchGetRecordResultDetail[] | undefined;
+  Errors: BatchGetRecordError[] | undefined;
+  UnprocessedIdentifiers: BatchGetRecordIdentifier[] | undefined;
+}
+export declare class InternalFailure extends __BaseException {
+  readonly name: "InternalFailure";
+  readonly $fault: "server";
+  Message?: string;
+  constructor(opts: __ExceptionOptionType<InternalFailure, __BaseException>);
+}
+export declare class ServiceUnavailable extends __BaseException {
+  readonly name: "ServiceUnavailable";
+  readonly $fault: "server";
+  Message?: string;
+  constructor(opts: __ExceptionOptionType<ServiceUnavailable, __BaseException>);
+}
+export declare class ValidationError extends __BaseException {
+  readonly name: "ValidationError";
+  readonly $fault: "client";
+  Message?: string;
+  constructor(opts: __ExceptionOptionType<ValidationError, __BaseException>);
+}
+export declare const DeletionMode: {
+  readonly HARD_DELETE: "HardDelete";
+  readonly SOFT_DELETE: "SoftDelete";
+};
+export type DeletionMode = (typeof DeletionMode)[keyof typeof DeletionMode];
+export declare const TargetStore: {
+  readonly OFFLINE_STORE: "OfflineStore";
+  readonly ONLINE_STORE: "OnlineStore";
+};
+export type TargetStore = (typeof TargetStore)[keyof typeof TargetStore];
+export interface DeleteRecordRequest {
+  FeatureGroupName: string | undefined;
+  RecordIdentifierValueAsString: string | undefined;
+  EventTime: string | undefined;
+  TargetStores?: (TargetStore | string)[];
+  DeletionMode?: DeletionMode | string;
+}
+export interface GetRecordRequest {
+  FeatureGroupName: string | undefined;
+  RecordIdentifierValueAsString: string | undefined;
+  FeatureNames?: string[];
+  ExpirationTimeResponse?: ExpirationTimeResponse | string;
+}
+export interface GetRecordResponse {
+  Record?: FeatureValue[];
+  ExpiresAt?: string;
+}
+export declare class ResourceNotFound extends __BaseException {
+  readonly name: "ResourceNotFound";
+  readonly $fault: "client";
+  Message?: string;
+  constructor(opts: __ExceptionOptionType<ResourceNotFound, __BaseException>);
+}
+export declare const TtlDurationUnit: {
+  readonly DAYS: "Days";
+  readonly HOURS: "Hours";
+  readonly MINUTES: "Minutes";
+  readonly SECONDS: "Seconds";
+  readonly WEEKS: "Weeks";
+};
+export type TtlDurationUnit =
+  (typeof TtlDurationUnit)[keyof typeof TtlDurationUnit];
+export interface TtlDuration {
+  Unit: TtlDurationUnit | string | undefined;
+  Value: number | undefined;
+}
+export interface PutRecordRequest {
+  FeatureGroupName: string | undefined;
+  Record: FeatureValue[] | undefined;
+  TargetStores?: (TargetStore | string)[];
+  TtlDuration?: TtlDuration;
+}

package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts

@@ -1,38 +1,53 @@
-import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
-import { SerdeContext as __SerdeContext } from "@smithy/types";
-import { BatchGetRecordCommandInput, BatchGetRecordCommandOutput } from "../commands/BatchGetRecordCommand";
-import { DeleteRecordCommandInput, DeleteRecordCommandOutput } from "../commands/DeleteRecordCommand";
-import { GetRecordCommandInput, GetRecordCommandOutput } from "../commands/GetRecordCommand";
-import { PutRecordCommandInput, PutRecordCommandOutput } from "../commands/PutRecordCommand";
-/**
- * serializeAws_restJson1BatchGetRecordCommand
- */
-export declare const se_BatchGetRecordCommand: (input: BatchGetRecordCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
-/**
- * serializeAws_restJson1DeleteRecordCommand
- */
-export declare const se_DeleteRecordCommand: (input: DeleteRecordCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
-/**
- * serializeAws_restJson1GetRecordCommand
- */
-export declare const se_GetRecordCommand: (input: GetRecordCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
-/**
- * serializeAws_restJson1PutRecordCommand
- */
-export declare const se_PutRecordCommand: (input: PutRecordCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
-/**
- * deserializeAws_restJson1BatchGetRecordCommand
- */
-export declare const de_BatchGetRecordCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchGetRecordCommandOutput>;
-/**
- * deserializeAws_restJson1DeleteRecordCommand
- */
-export declare const de_DeleteRecordCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteRecordCommandOutput>;
-/**
- * deserializeAws_restJson1GetRecordCommand
- */
-export declare const de_GetRecordCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetRecordCommandOutput>;
-/**
- * deserializeAws_restJson1PutRecordCommand
- */
-export declare const de_PutRecordCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutRecordCommandOutput>;
+import {
+  HttpRequest as __HttpRequest,
+  HttpResponse as __HttpResponse,
+} from "@smithy/protocol-http";
+import { SerdeContext as __SerdeContext } from "@smithy/types";
+import {
+  BatchGetRecordCommandInput,
+  BatchGetRecordCommandOutput,
+} from "../commands/BatchGetRecordCommand";
+import {
+  DeleteRecordCommandInput,
+  DeleteRecordCommandOutput,
+} from "../commands/DeleteRecordCommand";
+import {
+  GetRecordCommandInput,
+  GetRecordCommandOutput,
+} from "../commands/GetRecordCommand";
+import {
+  PutRecordCommandInput,
+  PutRecordCommandOutput,
+} from "../commands/PutRecordCommand";
+export declare const se_BatchGetRecordCommand: (
+  input: BatchGetRecordCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_DeleteRecordCommand: (
+  input: DeleteRecordCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_GetRecordCommand: (
+  input: GetRecordCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_PutRecordCommand: (
+  input: PutRecordCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const de_BatchGetRecordCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<BatchGetRecordCommandOutput>;
+export declare const de_DeleteRecordCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<DeleteRecordCommandOutput>;
+export declare const de_GetRecordCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<GetRecordCommandOutput>;
+export declare const de_PutRecordCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<PutRecordCommandOutput>;