@aws-sdk/client-kendra-ranking 3.378.0 → 3.382.0

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -1,4 +1,7 @@
 import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
 export interface ClientInputEndpointParameters {
     region?: string | Provider<string>;
     useFipsEndpoint?: boolean | Provider<boolean>;

package/dist-types/index.d.ts

@@ -7,6 +7,7 @@
  */
 export * from "./KendraRankingClient";
 export * from "./KendraRanking";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";

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

@@ -39,6 +39,7 @@ export declare class ConflictException extends __BaseException {
  */
 export interface CapacityUnitsConfiguration {
     /**
+     * @public
      * <p>The amount of extra capacity for your rescore execution
      *             plan.</p>
      *          <p>A single extra capacity unit for a rescore execution
@@ -59,11 +60,13 @@ export interface CapacityUnitsConfiguration {
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key for the tag. Keys are not case sensitive and must
      *             be unique.</p>
      */
     Key: string | undefined;
     /**
+     * @public
      * <p>The value associated with the tag. The value can be an
      *             empty string but it can't be null.</p>
      */
@@ -74,14 +77,17 @@ export interface Tag {
  */
 export interface CreateRescoreExecutionPlanRequest {
     /**
+     * @public
      * <p>A name for the rescore execution plan.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>A description for the rescore execution plan.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>You can set additional capacity units to meet the
      *             needs of your rescore execution plan. You are given a single
      *             capacity unit by default. If you want to use the default
@@ -92,6 +98,7 @@ export interface CreateRescoreExecutionPlanRequest {
      */
     CapacityUnits?: CapacityUnitsConfiguration;
     /**
+     * @public
      * <p>A list of key-value pairs that identify or categorize your
      *             rescore execution plan. You can also use tags to help control
      *             access to the rescore execution plan. Tag keys and values can
@@ -100,6 +107,7 @@ export interface CreateRescoreExecutionPlanRequest {
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>A token that you provide to identify the request to create
      *             a rescore execution plan. Multiple calls to the
      *             <code>CreateRescoreExecutionPlanRequest</code> API with the
@@ -112,10 +120,12 @@ export interface CreateRescoreExecutionPlanRequest {
  */
 export interface CreateRescoreExecutionPlanResponse {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan.</p>
      */
     Id: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the rescore
      *             execution plan.</p>
      */
@@ -189,6 +199,7 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteRescoreExecutionPlanRequest {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan that you
      *             want to delete.</p>
      */
@@ -214,6 +225,7 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface DescribeRescoreExecutionPlanRequest {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan that you want
      *             to get information on.</p>
      */
@@ -239,23 +251,28 @@ export type RescoreExecutionPlanStatus = (typeof RescoreExecutionPlanStatus)[key
  */
 export interface DescribeRescoreExecutionPlanResponse {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the rescore execution
      *             plan.</p>
      */
     Arn?: string;
     /**
+     * @public
      * <p>The name for the rescore execution plan.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The description for the rescore execution plan.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The capacity units set for the rescore execution plan.
      *             A capacity of zero indicates that the rescore execution
      *             plan is using the default capacity. For more information on the
@@ -264,16 +281,19 @@ export interface DescribeRescoreExecutionPlanResponse {
      */
     CapacityUnits?: CapacityUnitsConfiguration;
     /**
+     * @public
      * <p>The Unix timestamp of when the rescore execution plan was
      *             created.</p>
      */
     CreatedAt?: Date;
     /**
+     * @public
      * <p>The Unix timestamp of when the rescore execution plan was
      *             last updated.</p>
      */
     UpdatedAt?: Date;
     /**
+     * @public
      * <p>The current status of the rescore execution plan. When the
      *             value is <code>ACTIVE</code>, the rescore execution plan is
      *             ready for use. If the <code>Status</code> field value is
@@ -282,6 +302,7 @@ export interface DescribeRescoreExecutionPlanResponse {
      */
     Status?: RescoreExecutionPlanStatus | string;
     /**
+     * @public
      * <p>When the <code>Status</code> field value is
      *             <code>FAILED</code>, the <code>ErrorMessage</code> field
      *             contains a message that explains why.</p>
@@ -293,6 +314,7 @@ export interface DescribeRescoreExecutionPlanResponse {
  */
 export interface ListRescoreExecutionPlansRequest {
     /**
+     * @public
      * <p>If the response is truncated, Amazon Kendra Intelligent
      *             Ranking returns a pagination token in the response. You can use
      *             this pagination token to retrieve the next set of rescore
@@ -300,6 +322,7 @@ export interface ListRescoreExecutionPlansRequest {
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The maximum number of rescore execution plans to return.</p>
      */
     MaxResults?: number;
@@ -312,24 +335,29 @@ export interface ListRescoreExecutionPlansRequest {
  */
 export interface RescoreExecutionPlanSummary {
     /**
+     * @public
      * <p>The name of the rescore execution plan.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>The identifier of the rescore execution plan.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The Unix timestamp when the rescore execution plan
      *             was created.</p>
      */
     CreatedAt?: Date;
     /**
+     * @public
      * <p>The Unix timestamp when the rescore execution plan
      *             was last updated.</p>
      */
     UpdatedAt?: Date;
     /**
+     * @public
      * <p>The current status of the rescore execution plan. When
      *             the value is <code>ACTIVE</code>, the rescore execution
      *             plan is ready for use.</p>
@@ -341,11 +369,13 @@ export interface RescoreExecutionPlanSummary {
  */
 export interface ListRescoreExecutionPlansResponse {
     /**
+     * @public
      * <p>An array of summary information for one or more rescore
      *             execution plans.</p>
      */
     SummaryItems?: RescoreExecutionPlanSummary[];
     /**
+     * @public
      * <p>If the response is truncated, Amazon Kendra Intelligent
      *             Ranking returns a pagination token in the response.</p>
      */
@@ -360,6 +390,7 @@ export interface ListRescoreExecutionPlansResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the rescore execution
      *             plan to get a list of tags for.</p>
      */
@@ -372,6 +403,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>A list of tags associated with the rescore execution
      *             plan.</p>
      */
@@ -400,24 +432,29 @@ export declare class ResourceUnavailableException extends __BaseException {
  */
 export interface Document {
     /**
+     * @public
      * <p>The identifier of the document from the search service.</p>
      */
     Id: string | undefined;
     /**
+     * @public
      * <p>The optional group identifier of the document from the search
      *             service. Documents with the same group identifier are grouped
      *             together and processed as one document within the service.</p>
      */
     GroupId?: string;
     /**
+     * @public
      * <p>The title of the search service's document.</p>
      */
     Title?: string;
     /**
+     * @public
      * <p>The body text of the search service's document.</p>
      */
     Body?: string;
     /**
+     * @public
      * <p>The title of the search service's document represented as
      *             a list of tokens or words. You must choose to provide
      *             <code>Title</code> or <code>TokenizedTitle</code>. You cannot
@@ -425,6 +462,7 @@ export interface Document {
      */
     TokenizedTitle?: string[];
     /**
+     * @public
      * <p>The body text of the search service's document represented
      *             as a list of tokens or words. You must choose to provide
      *             <code>Body</code> or <code>TokenizedBody</code>. You cannot
@@ -432,6 +470,7 @@ export interface Document {
      */
     TokenizedBody?: string[];
     /**
+     * @public
      * <p>The original document score or rank from the search service.
      *             Amazon Kendra Intelligent Ranking gives the document a new
      *             score or rank based on its intelligent search algorithms.</p>
@@ -443,16 +482,19 @@ export interface Document {
  */
 export interface RescoreRequest {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan. A rescore
      *             execution plan is an Amazon Kendra Intelligent Ranking
      *             resource used for provisioning the <code>Rescore</code> API.</p>
      */
     RescoreExecutionPlanId: string | undefined;
     /**
+     * @public
      * <p>The input query from the search service.</p>
      */
     SearchQuery: string | undefined;
     /**
+     * @public
      * <p>The list of documents for Amazon Kendra Intelligent
      *             Ranking to rescore or rank on.</p>
      */
@@ -464,10 +506,12 @@ export interface RescoreRequest {
  */
 export interface RescoreResultItem {
     /**
+     * @public
      * <p>The identifier of the document from the search service.</p>
      */
     DocumentId?: string;
     /**
+     * @public
      * <p>The relevancy score or rank that Amazon Kendra
      *             Intelligent Ranking gives to the result.</p>
      */
@@ -478,6 +522,7 @@ export interface RescoreResultItem {
  */
 export interface RescoreResult {
     /**
+     * @public
      * <p>The identifier associated with the scores that
      *             Amazon Kendra Intelligent Ranking gives to the
      *             results. Amazon Kendra Intelligent Ranking
@@ -485,6 +530,7 @@ export interface RescoreResult {
      */
     RescoreId?: string;
     /**
+     * @public
      * <p>A list of result items for documents with new relevancy
      *             scores. The results are in descending order.</p>
      */
@@ -499,11 +545,13 @@ export interface RescoreResult {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the rescore execution
      *             plan to tag.</p>
      */
     ResourceARN: string | undefined;
     /**
+     * @public
      * <p>A list of tag keys to add to a rescore execution plan.
      *             If a tag already exists, the existing value is replaced
      *             with the new value.</p>
@@ -526,11 +574,13 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the rescore execution
      *             plan to remove the tag.</p>
      */
     ResourceARN: string | undefined;
     /**
+     * @public
      * <p>A list of tag keys to remove from the rescore execution
      *             plan. If a tag key does not exist on the resource, it is
      *             ignored.</p>
@@ -549,19 +599,23 @@ export interface UntagResourceResponse {
  */
 export interface UpdateRescoreExecutionPlanRequest {
     /**
+     * @public
      * <p>The identifier of the rescore execution plan that you want
      *             to update.</p>
      */
     Id: string | undefined;
     /**
+     * @public
      * <p>A new name for the rescore execution plan.</p>
      */
     Name?: string;
     /**
+     * @public
      * <p>A new description for the rescore execution plan.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>You can set additional capacity units to meet the needs
      *             of your rescore execution plan. You are given a single capacity
      *             unit by default. If you want to use the default capacity, you

package/dist-types/ts3.4/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./KendraRankingClient";
 export * from "./KendraRanking";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kendra-ranking",
   "description": "AWS SDK for JavaScript Kendra Ranking Client for Node.js, Browser and React Native",
-  "version": "3.378.0",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.378.0",
-    "@aws-sdk/credential-provider-node": "3.378.0",
-    "@aws-sdk/middleware-host-header": "3.378.0",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
+    "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
-    "@aws-sdk/middleware-signing": "3.378.0",
-    "@aws-sdk/middleware-user-agent": "3.378.0",
+    "@aws-sdk/middleware-signing": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",