@aws-sdk/client-kendra-ranking 3.296.0 → 3.297.0

package/dist-types/KendraRanking.d.ts

@@ -10,12 +10,14 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput } from "./commands/UpdateRescoreExecutionPlanCommand";
 import { KendraRankingClient } from "./KendraRankingClient";
 /**
+ * @public
  * <p>Amazon Kendra Intelligent Ranking uses Amazon Kendra
  *             semantic search capabilities to intelligently re-rank a search
  *             service's results.</p>
  */
 export declare class KendraRanking extends KendraRankingClient {
     /**
+     * @public
      * <p>Creates a rescore execution plan. A rescore execution
      *             plan is an Amazon Kendra Intelligent Ranking resource
      *             used for provisioning the <code>Rescore</code> API. You set
@@ -31,6 +33,7 @@ export declare class KendraRanking extends KendraRankingClient {
     createRescoreExecutionPlan(args: CreateRescoreExecutionPlanCommandInput, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void): void;
     createRescoreExecutionPlan(args: CreateRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a rescore execution plan. A rescore execution
      *             plan is an Amazon Kendra Intelligent Ranking resource
      *             used for provisioning the <code>Rescore</code> API.</p>
@@ -39,6 +42,7 @@ export declare class KendraRanking extends KendraRankingClient {
     deleteRescoreExecutionPlan(args: DeleteRescoreExecutionPlanCommandInput, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void): void;
     deleteRescoreExecutionPlan(args: DeleteRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about a rescore execution plan. A rescore
      *             execution plan is an Amazon Kendra Intelligent Ranking
      *             resource used for provisioning the <code>Rescore</code> API.</p>
@@ -47,6 +51,7 @@ export declare class KendraRanking extends KendraRankingClient {
     describeRescoreExecutionPlan(args: DescribeRescoreExecutionPlanCommandInput, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void): void;
     describeRescoreExecutionPlan(args: DescribeRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists your rescore execution plans. A rescore execution plan
      *             is an Amazon Kendra Intelligent Ranking resource used for
      *             provisioning the <code>Rescore</code> API.</p>
@@ -55,6 +60,7 @@ export declare class KendraRanking extends KendraRankingClient {
     listRescoreExecutionPlans(args: ListRescoreExecutionPlansCommandInput, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void): void;
     listRescoreExecutionPlans(args: ListRescoreExecutionPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets a list of tags associated with a specified resource.
      *             A rescore execution plan is an example of a resource that
      *             can have tags associated with it.</p>
@@ -63,6 +69,7 @@ export declare class KendraRanking extends KendraRankingClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Rescores or re-ranks search results from a search service
      *             such as OpenSearch (self managed). You use the semantic search
      *             capabilities of Amazon Kendra Intelligent Ranking to
@@ -72,6 +79,7 @@ export declare class KendraRanking extends KendraRankingClient {
     rescore(args: RescoreCommandInput, cb: (err: any, data?: RescoreCommandOutput) => void): void;
     rescore(args: RescoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RescoreCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds a specified tag to a specified rescore execution
      *             plan. A rescore execution plan is an Amazon Kendra
      *             Intelligent Ranking resource used for provisioning the
@@ -82,6 +90,7 @@ export declare class KendraRanking extends KendraRankingClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes a tag from a rescore execution plan. A rescore
      *             execution plan is an Amazon Kendra Intelligent
      *             Ranking resource used for provisioning the
@@ -91,6 +100,7 @@ export declare class KendraRanking extends KendraRankingClient {
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates a rescore execution plan. A rescore execution plan
      *             is an Amazon Kendra Intelligent Ranking resource used for
      *             provisioning the <code>Rescore</code> API. You can update the

package/dist-types/KendraRankingClient.d.ts

@@ -17,15 +17,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput } from "./commands/UpdateRescoreExecutionPlanCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateRescoreExecutionPlanCommandInput | DeleteRescoreExecutionPlanCommandInput | DescribeRescoreExecutionPlanCommandInput | ListRescoreExecutionPlansCommandInput | ListTagsForResourceCommandInput | RescoreCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateRescoreExecutionPlanCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateRescoreExecutionPlanCommandOutput | DeleteRescoreExecutionPlanCommandOutput | DescribeRescoreExecutionPlanCommandOutput | ListRescoreExecutionPlansCommandOutput | ListTagsForResourceCommandOutput | RescoreCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateRescoreExecutionPlanCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -115,23 +124,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type KendraRankingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of KendraRankingClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of KendraRankingClient class constructor that set the region, credentials and other options.
  */
 export interface KendraRankingClientConfig extends KendraRankingClientConfigType {
 }
+/**
+ * @public
+ */
 type KendraRankingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of KendraRankingClient class. This is resolved and normalized from the {@link KendraRankingClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of KendraRankingClient class. This is resolved and normalized from the {@link KendraRankingClientConfig | constructor configuration interface}.
  */
 export interface KendraRankingClientResolvedConfig extends KendraRankingClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Amazon Kendra Intelligent Ranking uses Amazon Kendra
  *             semantic search capabilities to intelligently re-rank a search
  *             service's results.</p>

package/dist-types/commands/CreateRescoreExecutionPlanCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { CreateRescoreExecutionPlanRequest, CreateRescoreExecutionPlanResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateRescoreExecutionPlanCommand}.
  */
 export interface CreateRescoreExecutionPlanCommandInput extends CreateRescoreExecutionPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateRescoreExecutionPlanCommand}.
  */
 export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreExecutionPlanResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a rescore execution plan. A rescore execution
  *             plan is an Amazon Kendra Intelligent Ranking resource
  *             used for provisioning the <code>Rescore</code> API. You set
@@ -34,6 +39,8 @@ export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreEx
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateRescoreExecutionPlanCommandInput - {@link CreateRescoreExecutionPlanCommandInput}
+ * @returns {@link CreateRescoreExecutionPlanCommandOutput}
  * @see {@link CreateRescoreExecutionPlanCommandInput} for command's `input` shape.
  * @see {@link CreateRescoreExecutionPlanCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -75,11 +82,20 @@ export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreEx
 export declare class CreateRescoreExecutionPlanCommand extends $Command<CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: CreateRescoreExecutionPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateRescoreExecutionPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DeleteRescoreExecutionPlanCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { DeleteRescoreExecutionPlanRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteRescoreExecutionPlanCommand}.
  */
 export interface DeleteRescoreExecutionPlanCommandInput extends DeleteRescoreExecutionPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteRescoreExecutionPlanCommand}.
  */
 export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a rescore execution plan. A rescore execution
  *             plan is an Amazon Kendra Intelligent Ranking resource
  *             used for provisioning the <code>Rescore</code> API.</p>
@@ -27,6 +32,8 @@ export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteRescoreExecutionPlanCommandInput - {@link DeleteRescoreExecutionPlanCommandInput}
+ * @returns {@link DeleteRescoreExecutionPlanCommandOutput}
  * @see {@link DeleteRescoreExecutionPlanCommandInput} for command's `input` shape.
  * @see {@link DeleteRescoreExecutionPlanCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBeare
 export declare class DeleteRescoreExecutionPlanCommand extends $Command<DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: DeleteRescoreExecutionPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteRescoreExecutionPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeRescoreExecutionPlanCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { DescribeRescoreExecutionPlanRequest, DescribeRescoreExecutionPlanResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeRescoreExecutionPlanCommand}.
  */
 export interface DescribeRescoreExecutionPlanCommandInput extends DescribeRescoreExecutionPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeRescoreExecutionPlanCommand}.
  */
 export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeRescoreExecutionPlanResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets information about a rescore execution plan. A rescore
  *             execution plan is an Amazon Kendra Intelligent Ranking
  *             resource used for provisioning the <code>Rescore</code> API.</p>
@@ -27,6 +32,8 @@ export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeResco
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeRescoreExecutionPlanCommandInput - {@link DescribeRescoreExecutionPlanCommandInput}
+ * @returns {@link DescribeRescoreExecutionPlanCommandOutput}
  * @see {@link DescribeRescoreExecutionPlanCommandInput} for command's `input` shape.
  * @see {@link DescribeRescoreExecutionPlanCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -62,11 +69,20 @@ export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeResco
 export declare class DescribeRescoreExecutionPlanCommand extends $Command<DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: DescribeRescoreExecutionPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeRescoreExecutionPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListRescoreExecutionPlansCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { ListRescoreExecutionPlansRequest, ListRescoreExecutionPlansResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListRescoreExecutionPlansCommand}.
  */
 export interface ListRescoreExecutionPlansCommandInput extends ListRescoreExecutionPlansRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListRescoreExecutionPlansCommand}.
  */
 export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecutionPlansResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists your rescore execution plans. A rescore execution plan
  *             is an Amazon Kendra Intelligent Ranking resource used for
  *             provisioning the <code>Rescore</code> API.</p>
@@ -27,6 +32,8 @@ export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecu
  * const response = await client.send(command);
  * ```
  *
+ * @param ListRescoreExecutionPlansCommandInput - {@link ListRescoreExecutionPlansCommandInput}
+ * @returns {@link ListRescoreExecutionPlansCommandOutput}
  * @see {@link ListRescoreExecutionPlansCommandInput} for command's `input` shape.
  * @see {@link ListRescoreExecutionPlansCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecu
 export declare class ListRescoreExecutionPlansCommand extends $Command<ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: ListRescoreExecutionPlansCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListRescoreExecutionPlansCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets a list of tags associated with a specified resource.
  *             A rescore execution plan is an example of a resource that
  *             can have tags associated with it.</p>
@@ -27,6 +32,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -62,11 +69,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RescoreCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { RescoreRequest, RescoreResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RescoreCommand}.
  */
 export interface RescoreCommandInput extends RescoreRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RescoreCommand}.
  */
 export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Rescores or re-ranks search results from a search service
  *             such as OpenSearch (self managed). You use the semantic search
  *             capabilities of Amazon Kendra Intelligent Ranking to
@@ -28,6 +33,8 @@ export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param RescoreCommandInput - {@link RescoreCommandInput}
+ * @returns {@link RescoreCommandOutput}
  * @see {@link RescoreCommandInput} for command's `input` shape.
  * @see {@link RescoreCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -67,11 +74,20 @@ export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
 export declare class RescoreCommand extends $Command<RescoreCommandInput, RescoreCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: RescoreCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RescoreCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RescoreCommandInput, RescoreCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a specified tag to a specified rescore execution
  *             plan. A rescore execution plan is an Amazon Kendra
  *             Intelligent Ranking resource used for provisioning the
@@ -29,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -64,11 +71,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a tag from a rescore execution plan. A rescore
  *             execution plan is an Amazon Kendra Intelligent
  *             Ranking resource used for provisioning the
@@ -28,6 +33,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateRescoreExecutionPlanCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
 import { UpdateRescoreExecutionPlanRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateRescoreExecutionPlanCommand}.
  */
 export interface UpdateRescoreExecutionPlanCommandInput extends UpdateRescoreExecutionPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRescoreExecutionPlanCommand}.
  */
 export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a rescore execution plan. A rescore execution plan
  *             is an Amazon Kendra Intelligent Ranking resource used for
  *             provisioning the <code>Rescore</code> API. You can update the
@@ -30,6 +35,8 @@ export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRescoreExecutionPlanCommandInput - {@link UpdateRescoreExecutionPlanCommandInput}
+ * @returns {@link UpdateRescoreExecutionPlanCommandOutput}
  * @see {@link UpdateRescoreExecutionPlanCommandInput} for command's `input` shape.
  * @see {@link UpdateRescoreExecutionPlanCommandOutput} for command's `response` shape.
  * @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
@@ -76,11 +83,20 @@ export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBeare
 export declare class UpdateRescoreExecutionPlanCommand extends $Command<UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
     readonly input: UpdateRescoreExecutionPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRescoreExecutionPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from KendraRanking service.
  */
 export declare class KendraRankingServiceException extends __ServiceException {

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KendraRankingServiceException as __BaseException } from "./KendraRankingServiceException";
 /**
+ * @public
  * <p>You don’t have sufficient access to perform this action.
  *             Please ensure you have the required permission policies
  *             and user accounts and try again.</p>
@@ -15,6 +16,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>A conflict occurred with the request. Please fix any
  *             inconsistencies with your resources and try again.</p>
  */
@@ -28,6 +30,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>Sets additional capacity units configured for your
  *             rescore execution plan. A rescore execution plan is an
  *             Amazon Kendra Intelligent Ranking resource used for
@@ -45,6 +48,7 @@ export interface CapacityUnitsConfiguration {
     RescoreCapacityUnits: number | undefined;
 }
 /**
+ * @public
  * <p>A key-value pair that identifies or categorizes a rescore
  *             execution plan. A rescore execution plan is an
  *             Amazon Kendra Intelligent Ranking resource used for
@@ -65,6 +69,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateRescoreExecutionPlanRequest {
     /**
      * <p>A name for the rescore execution plan.</p>
@@ -100,6 +107,9 @@ export interface CreateRescoreExecutionPlanRequest {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateRescoreExecutionPlanResponse {
     /**
      * <p>The identifier of the rescore execution plan.</p>
@@ -112,6 +122,7 @@ export interface CreateRescoreExecutionPlanResponse {
     Arn: string | undefined;
 }
 /**
+ * @public
  * <p>An issue occurred with the internal server used for
  *             your Amazon Kendra Intelligent Ranking service.
  *             Please wait a few minutes and try again, or contact
@@ -128,6 +139,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>You have exceeded the set limits for your
  *             Amazon Kendra Intelligent Ranking service. Please
  *             see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>
@@ -144,6 +156,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.
  *             Please reduce the number of requests and try again.</p>
  */
@@ -157,6 +170,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints set by
  *             the Amazon Kendra Intelligent Ranking service.
  *             Please provide the correct input and try again.</p>
@@ -170,6 +184,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteRescoreExecutionPlanRequest {
     /**
      * <p>The identifier of the rescore execution plan that you
@@ -178,6 +195,7 @@ export interface DeleteRescoreExecutionPlanRequest {
     Id: string | undefined;
 }
 /**
+ * @public
  * <p>The resource you want to use doesn't exist. Please
  *             check you have provided the correct resource and try
  *             again.</p>
@@ -191,6 +209,9 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeRescoreExecutionPlanRequest {
     /**
      * <p>The identifier of the rescore execution plan that you want
@@ -198,6 +219,9 @@ export interface DescribeRescoreExecutionPlanRequest {
      */
     Id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum RescoreExecutionPlanStatus {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -205,6 +229,9 @@ export declare enum RescoreExecutionPlanStatus {
     FAILED = "FAILED",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export interface DescribeRescoreExecutionPlanResponse {
     /**
      * <p>The identifier of the rescore execution plan.</p>
@@ -256,6 +283,9 @@ export interface DescribeRescoreExecutionPlanResponse {
      */
     ErrorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface ListRescoreExecutionPlansRequest {
     /**
      * <p>If the response is truncated, Amazon Kendra Intelligent
@@ -270,6 +300,7 @@ export interface ListRescoreExecutionPlansRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>Summary information for a rescore execution plan. A rescore
  *             execution plan is an Amazon Kendra Intelligent Ranking
  *             resource used for provisioning the <code>Rescore</code> API.</p>
@@ -300,6 +331,9 @@ export interface RescoreExecutionPlanSummary {
      */
     Status?: RescoreExecutionPlanStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListRescoreExecutionPlansResponse {
     /**
      * <p>An array of summary information for one or more rescore
@@ -313,6 +347,7 @@ export interface ListRescoreExecutionPlansResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The request information for listing tags associated with
  *             a rescore execution plan. A rescore execution plan is an
  *             Amazon Kendra Intelligent Ranking resource used for
@@ -326,6 +361,7 @@ export interface ListTagsForResourceRequest {
     ResourceARN: string | undefined;
 }
 /**
+ * @public
  * <p>If the action is successful, the service sends back an
  *             HTTP 200 response.</p>
  */
@@ -337,6 +373,7 @@ export interface ListTagsForResourceResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>The resource you want to use is unavailable. Please
  *             check you have provided the correct resource
  *             information and try again.</p>
@@ -351,6 +388,7 @@ export declare class ResourceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>Information about a document from a search service such
  *             as OpenSearch (self managed). Amazon Kendra Intelligent
  *             Ranking uses this information to rank and score on.</p>
@@ -395,6 +433,9 @@ export interface Document {
      */
     OriginalScore: number | undefined;
 }
+/**
+ * @public
+ */
 export interface RescoreRequest {
     /**
      * <p>The identifier of the rescore execution plan. A rescore
@@ -413,6 +454,7 @@ export interface RescoreRequest {
     Documents: Document[] | undefined;
 }
 /**
+ * @public
  * <p>A result item for a document with a new relevancy score.</p>
  */
 export interface RescoreResultItem {
@@ -426,6 +468,9 @@ export interface RescoreResultItem {
      */
     Score?: number;
 }
+/**
+ * @public
+ */
 export interface RescoreResult {
     /**
      * <p>The identifier associated with the scores that
@@ -441,6 +486,7 @@ export interface RescoreResult {
     ResultItems?: RescoreResultItem[];
 }
 /**
+ * @public
  * <p>The request information for tagging a rescore execution
  *             plan. A rescore execution plan is an Amazon Kendra
  *             Intelligent Ranking resource used for provisioning the
@@ -460,12 +506,14 @@ export interface TagResourceRequest {
     Tags: Tag[] | undefined;
 }
 /**
+ * @public
  * <p>If the action is successful, the service sends back an
  *             HTTP 200 response with an empty HTTP body.</p>
  */
 export interface TagResourceResponse {
 }
 /**
+ * @public
  * <p>The request information to remove a tag from a rescore
  *             execution plan. A rescore execution plan is an
  *             Amazon Kendra Intelligent Ranking resource used for
@@ -485,11 +533,15 @@ export interface UntagResourceRequest {
     TagKeys: string[] | undefined;
 }
 /**
+ * @public
  * <p>If the action is successful, the service sends back an
  *             HTTP 200 response with an empty HTTP body.</p>
  */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateRescoreExecutionPlanRequest {
     /**
      * <p>The identifier of the rescore execution plan that you want

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { KendraRankingClient } from "../KendraRankingClient";
+/**
+ * @public
+ */
 export interface KendraRankingPaginationConfiguration extends PaginationConfiguration {
     client: KendraRankingClient;
 }

package/dist-types/pagination/ListRescoreExecutionPlansPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput } from "../commands/ListRescoreExecutionPlansCommand";
 import { KendraRankingPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListRescoreExecutionPlans(config: KendraRankingPaginationConfiguration, input: ListRescoreExecutionPlansCommandInput, ...additionalArguments: any): Paginator<ListRescoreExecutionPlansCommandOutput>;

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.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",