@aws-sdk/client-personalize-runtime 3.34.0 → 3.37.0

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

@@ -1,190 +0,0 @@
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-export interface GetPersonalizedRankingRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized
-     *       ranking.</p>
-     */
-    campaignArn: string | undefined;
-    /**
-     * <p>A list of items (by <code>itemId</code>) to rank. If an item was not included in the training dataset,
-     *       the item is appended to the end of the reranked list. The maximum is 500.</p>
-     */
-    inputList: string[] | undefined;
-    /**
-     * <p>The user for which you want the campaign to provide a personalized ranking.</p>
-     */
-    userId: string | undefined;
-    /**
-     * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
-     *       any interaction information that might be relevant when getting a user's recommendations, such
-     *       as the user's current location or device type.</p>
-     */
-    context?: {
-        [key: string]: string;
-    };
-    /**
-     * <p>The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
-     *       For more information, see
-     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-     */
-    filterArn?: string;
-    /**
-     * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
-     *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
-     *     </p>
-     *          <p>For filter expressions that use an <code>INCLUDE</code> element to include items,
-     *       you must provide values for all parameters that are defined in the expression. For
-     *       filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you
-     *       can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of
-     *       the expression to filter recommendations.</p>
-     *          <p>For more information, see
-     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-     */
-    filterValues?: {
-        [key: string]: string;
-    };
-}
-export declare namespace GetPersonalizedRankingRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: GetPersonalizedRankingRequest) => any;
-}
-/**
- * <p>An object that identifies an item.</p>
- *          <p>The  and  APIs return a list of
- *       <code>PredictedItem</code>s.</p>
- */
-export interface PredictedItem {
-    /**
-     * <p>The recommended item ID.</p>
-     */
-    itemId?: string;
-    /**
-     * <p>A numeric representation of the model's certainty that the item will be the next user
-     *       selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>
-     */
-    score?: number;
-}
-export declare namespace PredictedItem {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: PredictedItem) => any;
-}
-export interface GetPersonalizedRankingResponse {
-    /**
-     * <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
-     */
-    personalizedRanking?: PredictedItem[];
-    /**
-     * <p>The ID of the recommendation.</p>
-     */
-    recommendationId?: string;
-}
-export declare namespace GetPersonalizedRankingResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: GetPersonalizedRankingResponse) => any;
-}
-/**
- * <p>Provide a valid value for the field or parameter.</p>
- */
-export interface InvalidInputException extends __SmithyException, $MetadataBearer {
-    name: "InvalidInputException";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace InvalidInputException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InvalidInputException) => any;
-}
-/**
- * <p>The specified resource does not exist.</p>
- */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "ResourceNotFoundException";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace ResourceNotFoundException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
-}
-export interface GetRecommendationsRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
-     */
-    campaignArn: string | undefined;
-    /**
-     * <p>The item ID to provide recommendations for.</p>
-     *          <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
-     */
-    itemId?: string;
-    /**
-     * <p>The user ID to provide recommendations for.</p>
-     *          <p>Required for <code>USER_PERSONALIZATION</code> recipe type.</p>
-     */
-    userId?: string;
-    /**
-     * <p>The number of results to return. The default is 25. The maximum is 500.</p>
-     */
-    numResults?: number;
-    /**
-     * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
-     *       any interaction information that might be relevant when getting a user's recommendations, such
-     *       as the user's current location or device type.</p>
-     */
-    context?: {
-        [key: string]: string;
-    };
-    /**
-     * <p>The ARN of the filter to apply to the returned recommendations. For more information, see
-     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-     *          <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
-     */
-    filterArn?: string;
-    /**
-     * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
-     *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
-     *     </p>
-     *          <p>For filter expressions that use an <code>INCLUDE</code> element to include items,
-     *     you must provide values for all parameters that are defined in the expression. For
-     *     filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you
-     *       can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of
-     *     the expression to filter recommendations.</p>
-     *          <p>For more information, see
-     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-     */
-    filterValues?: {
-        [key: string]: string;
-    };
-}
-export declare namespace GetRecommendationsRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: GetRecommendationsRequest) => any;
-}
-export interface GetRecommendationsResponse {
-    /**
-     * <p>A list of recommendations sorted in ascending order by prediction score. There can be a
-     *       maximum of 500 items in the list.</p>
-     */
-    itemList?: PredictedItem[];
-    /**
-     * <p>The ID of the recommendation.</p>
-     */
-    recommendationId?: string;
-}
-export declare namespace GetRecommendationsResponse {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: GetRecommendationsResponse) => any;
-}

package/endpoints.ts

@@ -1,57 +0,0 @@
-import { PartitionHash, RegionHash, getRegionInfo } from "@aws-sdk/config-resolver";
-import { RegionInfoProvider } from "@aws-sdk/types";
-
-const regionHash: RegionHash = {};
-
-const partitionHash: PartitionHash = {
-  aws: {
-    regions: [
-      "af-south-1",
-      "ap-east-1",
-      "ap-northeast-1",
-      "ap-northeast-2",
-      "ap-northeast-3",
-      "ap-south-1",
-      "ap-southeast-1",
-      "ap-southeast-2",
-      "ca-central-1",
-      "eu-central-1",
-      "eu-north-1",
-      "eu-south-1",
-      "eu-west-1",
-      "eu-west-2",
-      "eu-west-3",
-      "me-south-1",
-      "sa-east-1",
-      "us-east-1",
-      "us-east-2",
-      "us-west-1",
-      "us-west-2",
-    ],
-    hostname: "personalize-runtime.{region}.amazonaws.com",
-  },
-  "aws-cn": {
-    regions: ["cn-north-1", "cn-northwest-1"],
-    hostname: "personalize-runtime.{region}.amazonaws.com.cn",
-  },
-  "aws-iso": {
-    regions: ["us-iso-east-1"],
-    hostname: "personalize-runtime.{region}.c2s.ic.gov",
-  },
-  "aws-iso-b": {
-    regions: ["us-isob-east-1"],
-    hostname: "personalize-runtime.{region}.sc2s.sgov.gov",
-  },
-  "aws-us-gov": {
-    regions: ["us-gov-east-1", "us-gov-west-1"],
-    hostname: "personalize-runtime.{region}.amazonaws.com",
-  },
-};
-
-export const defaultRegionInfoProvider: RegionInfoProvider = async (region: string, options?: any) =>
-  getRegionInfo(region, {
-    ...options,
-    signingService: "personalize",
-    regionHash,
-    partitionHash,
-  });

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  testMatch: ["**/*.spec.ts", "!**/*.browser.spec.ts", "!**/*.integ.spec.ts"],
-};

package/models/models_0.ts

@@ -1,229 +0,0 @@
-import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-
-export interface GetPersonalizedRankingRequest {
-  /**
-   * <p>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized
-   *       ranking.</p>
-   */
-  campaignArn: string | undefined;
-
-  /**
-   * <p>A list of items (by <code>itemId</code>) to rank. If an item was not included in the training dataset,
-   *       the item is appended to the end of the reranked list. The maximum is 500.</p>
-   */
-  inputList: string[] | undefined;
-
-  /**
-   * <p>The user for which you want the campaign to provide a personalized ranking.</p>
-   */
-  userId: string | undefined;
-
-  /**
-   * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
-   *       any interaction information that might be relevant when getting a user's recommendations, such
-   *       as the user's current location or device type.</p>
-   */
-  context?: { [key: string]: string };
-
-  /**
-   * <p>The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
-   *       For more information, see
-   *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-   */
-  filterArn?: string;
-
-  /**
-   * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
-   *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
-   *     </p>
-   *          <p>For filter expressions that use an <code>INCLUDE</code> element to include items,
-   *       you must provide values for all parameters that are defined in the expression. For
-   *       filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you
-   *       can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of
-   *       the expression to filter recommendations.</p>
-   *          <p>For more information, see
-   *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-   */
-  filterValues?: { [key: string]: string };
-}
-
-export namespace GetPersonalizedRankingRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: GetPersonalizedRankingRequest): any => ({
-    ...obj,
-    ...(obj.context && { context: SENSITIVE_STRING }),
-    ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
-  });
-}
-
-/**
- * <p>An object that identifies an item.</p>
- *          <p>The  and  APIs return a list of
- *       <code>PredictedItem</code>s.</p>
- */
-export interface PredictedItem {
-  /**
-   * <p>The recommended item ID.</p>
-   */
-  itemId?: string;
-
-  /**
-   * <p>A numeric representation of the model's certainty that the item will be the next user
-   *       selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>
-   */
-  score?: number;
-}
-
-export namespace PredictedItem {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: PredictedItem): any => ({
-    ...obj,
-  });
-}
-
-export interface GetPersonalizedRankingResponse {
-  /**
-   * <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
-   */
-  personalizedRanking?: PredictedItem[];
-
-  /**
-   * <p>The ID of the recommendation.</p>
-   */
-  recommendationId?: string;
-}
-
-export namespace GetPersonalizedRankingResponse {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: GetPersonalizedRankingResponse): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>Provide a valid value for the field or parameter.</p>
- */
-export interface InvalidInputException extends __SmithyException, $MetadataBearer {
-  name: "InvalidInputException";
-  $fault: "client";
-  message?: string;
-}
-
-export namespace InvalidInputException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: InvalidInputException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The specified resource does not exist.</p>
- */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-  name: "ResourceNotFoundException";
-  $fault: "client";
-  message?: string;
-}
-
-export namespace ResourceNotFoundException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
-    ...obj,
-  });
-}
-
-export interface GetRecommendationsRequest {
-  /**
-   * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
-   */
-  campaignArn: string | undefined;
-
-  /**
-   * <p>The item ID to provide recommendations for.</p>
-   *          <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
-   */
-  itemId?: string;
-
-  /**
-   * <p>The user ID to provide recommendations for.</p>
-   *          <p>Required for <code>USER_PERSONALIZATION</code> recipe type.</p>
-   */
-  userId?: string;
-
-  /**
-   * <p>The number of results to return. The default is 25. The maximum is 500.</p>
-   */
-  numResults?: number;
-
-  /**
-   * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
-   *       any interaction information that might be relevant when getting a user's recommendations, such
-   *       as the user's current location or device type.</p>
-   */
-  context?: { [key: string]: string };
-
-  /**
-   * <p>The ARN of the filter to apply to the returned recommendations. For more information, see
-   *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-   *          <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
-   */
-  filterArn?: string;
-
-  /**
-   * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
-   *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
-   *     </p>
-   *          <p>For filter expressions that use an <code>INCLUDE</code> element to include items,
-   *     you must provide values for all parameters that are defined in the expression. For
-   *     filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you
-   *       can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of
-   *     the expression to filter recommendations.</p>
-   *          <p>For more information, see
-   *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
-   */
-  filterValues?: { [key: string]: string };
-}
-
-export namespace GetRecommendationsRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: GetRecommendationsRequest): any => ({
-    ...obj,
-    ...(obj.context && { context: SENSITIVE_STRING }),
-    ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
-  });
-}
-
-export interface GetRecommendationsResponse {
-  /**
-   * <p>A list of recommendations sorted in ascending order by prediction score. There can be a
-   *       maximum of 500 items in the list.</p>
-   */
-  itemList?: PredictedItem[];
-
-  /**
-   * <p>The ID of the recommendation.</p>
-   */
-  recommendationId?: string;
-}
-
-export namespace GetRecommendationsResponse {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: GetRecommendationsResponse): any => ({
-    ...obj,
-  });
-}