@aws-sdk/client-kendra-ranking 3.247.0

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

@@ -0,0 +1,41 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
+}
+/**
+ * <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
+ *             <code>Rescore</code> API. If the tag already exists,
+ *             the existing value is replaced with the new value.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KendraRankingClient, TagResourceCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
+ * // const { KendraRankingClient, TagResourceCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
+ * const client = new KendraRankingClient(config);
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
+export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KendraRankingClientResolvedConfig> {
+    readonly input: TagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: TagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,40 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+/**
+ * <p>Removes a tag from a rescore execution plan. A rescore
+ *             execution plan is an Amazon Kendra Intelligent
+ *             Ranking resource used for provisioning the
+ *             <code>Rescore</code> operation.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KendraRankingClient, UntagResourceCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
+ * // const { KendraRankingClient, UntagResourceCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
+ * const client = new KendraRankingClient(config);
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KendraRankingClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,42 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
+import { UpdateRescoreExecutionPlanRequest } from "../models/models_0";
+export interface UpdateRescoreExecutionPlanCommandInput extends UpdateRescoreExecutionPlanRequest {
+}
+export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBearer {
+}
+/**
+ * <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
+ *             number of capacity units you require for Amazon Kendra
+ *             Intelligent Ranking to rescore or re-rank a search service's
+ *             results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KendraRankingClient, UpdateRescoreExecutionPlanCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
+ * // const { KendraRankingClient, UpdateRescoreExecutionPlanCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
+ * const client = new KendraRankingClient(config);
+ * const command = new UpdateRescoreExecutionPlanCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
+export declare class UpdateRescoreExecutionPlanCommand extends $Command<UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
+    readonly input: UpdateRescoreExecutionPlanCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: UpdateRescoreExecutionPlanCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,9 @@
+export * from "./CreateRescoreExecutionPlanCommand";
+export * from "./DeleteRescoreExecutionPlanCommand";
+export * from "./DescribeRescoreExecutionPlanCommand";
+export * from "./ListRescoreExecutionPlansCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RescoreCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateRescoreExecutionPlanCommand";

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

@@ -0,0 +1,17 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@aws-sdk/types";
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export declare type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region: string;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

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

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@aws-sdk/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

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

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@aws-sdk/util-endpoints";
+export declare const ruleSet: RuleSetObject;

package/dist-types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./KendraRanking";
+export * from "./KendraRankingClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";
+export { KendraRankingServiceException } from "./models/KendraRankingServiceException";

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

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from KendraRanking service.
+ */
+export declare class KendraRankingServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";