@aws-sdk/client-kendra-ranking 3.686.0 → 3.691.0

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

@@ -9,7 +9,7 @@ import { KendraRankingServiceException as __BaseException } from "./KendraRankin
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -23,7 +23,7 @@ export declare class AccessDeniedException extends __BaseException {
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -85,7 +85,7 @@ export interface CreateRescoreExecutionPlanRequest {
      * <p>A description for the rescore execution plan.</p>
      * @public
      */
-    Description?: string;
+    Description?: string | undefined;
     /**
      * <p>You can set additional capacity units to meet the
      *             needs of your rescore execution plan. You are given a single
@@ -96,7 +96,7 @@ export interface CreateRescoreExecutionPlanRequest {
      *                 capacity</a>.</p>
      * @public
      */
-    CapacityUnits?: CapacityUnitsConfiguration;
+    CapacityUnits?: CapacityUnitsConfiguration | undefined;
     /**
      * <p>A list of key-value pairs that identify or categorize your
      *             rescore execution plan. You can also use tags to help control
@@ -105,7 +105,7 @@ export interface CreateRescoreExecutionPlanRequest {
      *             the following symbols: _ . : / = + - @.</p>
      * @public
      */
-    Tags?: Tag[];
+    Tags?: Tag[] | undefined;
     /**
      * <p>A token that you provide to identify the request to create
      *             a rescore execution plan. Multiple calls to the
@@ -113,7 +113,7 @@ export interface CreateRescoreExecutionPlanRequest {
      *             same client token will create only one rescore execution plan.</p>
      * @public
      */
-    ClientToken?: string;
+    ClientToken?: string | undefined;
 }
 /**
  * @public
@@ -142,7 +142,7 @@ export interface CreateRescoreExecutionPlanResponse {
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
     readonly $fault: "server";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -159,7 +159,7 @@ export declare class InternalServerException extends __BaseException {
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -173,7 +173,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -188,7 +188,7 @@ export declare class ThrottlingException extends __BaseException {
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -214,7 +214,7 @@ export interface DeleteRescoreExecutionPlanRequest {
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -254,23 +254,23 @@ export interface DescribeRescoreExecutionPlanResponse {
      * <p>The identifier of the rescore execution plan.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The Amazon Resource Name (ARN) of the rescore execution
      *             plan.</p>
      * @public
      */
-    Arn?: string;
+    Arn?: string | undefined;
     /**
      * <p>The name for the rescore execution plan.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>The description for the rescore execution plan.</p>
      * @public
      */
-    Description?: string;
+    Description?: string | undefined;
     /**
      * <p>The capacity units set for the rescore execution plan.
      *             A capacity of zero indicates that the rescore execution
@@ -279,19 +279,19 @@ export interface DescribeRescoreExecutionPlanResponse {
      *                 capacity</a>.</p>
      * @public
      */
-    CapacityUnits?: CapacityUnitsConfiguration;
+    CapacityUnits?: CapacityUnitsConfiguration | undefined;
     /**
      * <p>The Unix timestamp of when the rescore execution plan was
      *             created.</p>
      * @public
      */
-    CreatedAt?: Date;
+    CreatedAt?: Date | undefined;
     /**
      * <p>The Unix timestamp of when the rescore execution plan was
      *             last updated.</p>
      * @public
      */
-    UpdatedAt?: Date;
+    UpdatedAt?: Date | undefined;
     /**
      * <p>The current status of the rescore execution plan. When the
      *             value is <code>ACTIVE</code>, the rescore execution plan is
@@ -300,14 +300,14 @@ export interface DescribeRescoreExecutionPlanResponse {
      *             contains a message that explains why.</p>
      * @public
      */
-    Status?: RescoreExecutionPlanStatus;
+    Status?: RescoreExecutionPlanStatus | undefined;
     /**
      * <p>When the <code>Status</code> field value is
      *             <code>FAILED</code>, the <code>ErrorMessage</code> field
      *             contains a message that explains why.</p>
      * @public
      */
-    ErrorMessage?: string;
+    ErrorMessage?: string | undefined;
 }
 /**
  * @public
@@ -320,12 +320,12 @@ export interface ListRescoreExecutionPlansRequest {
      *             execution plans.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
     /**
      * <p>The maximum number of rescore execution plans to return.</p>
      * @public
      */
-    MaxResults?: number;
+    MaxResults?: number | undefined;
 }
 /**
  * <p>Summary information for a rescore execution plan. A rescore
@@ -338,31 +338,31 @@ export interface RescoreExecutionPlanSummary {
      * <p>The name of the rescore execution plan.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>The identifier of the rescore execution plan.</p>
      * @public
      */
-    Id?: string;
+    Id?: string | undefined;
     /**
      * <p>The Unix timestamp when the rescore execution plan
      *             was created.</p>
      * @public
      */
-    CreatedAt?: Date;
+    CreatedAt?: Date | undefined;
     /**
      * <p>The Unix timestamp when the rescore execution plan
      *             was last updated.</p>
      * @public
      */
-    UpdatedAt?: Date;
+    UpdatedAt?: Date | undefined;
     /**
      * <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>
      * @public
      */
-    Status?: RescoreExecutionPlanStatus;
+    Status?: RescoreExecutionPlanStatus | undefined;
 }
 /**
  * @public
@@ -373,13 +373,13 @@ export interface ListRescoreExecutionPlansResponse {
      *             execution plans.</p>
      * @public
      */
-    SummaryItems?: RescoreExecutionPlanSummary[];
+    SummaryItems?: RescoreExecutionPlanSummary[] | undefined;
     /**
      * <p>If the response is truncated, Amazon Kendra Intelligent
      *             Ranking returns a pagination token in the response.</p>
      * @public
      */
-    NextToken?: string;
+    NextToken?: string | undefined;
 }
 /**
  * <p>The request information for listing tags associated with
@@ -407,7 +407,7 @@ export interface ListTagsForResourceResponse {
      *             plan.</p>
      * @public
      */
-    Tags?: Tag[];
+    Tags?: Tag[] | undefined;
 }
 /**
  * <p>The resource you want to use is unavailable. Please
@@ -418,7 +418,7 @@ export interface ListTagsForResourceResponse {
 export declare class ResourceUnavailableException extends __BaseException {
     readonly name: "ResourceUnavailableException";
     readonly $fault: "client";
-    Message?: string;
+    Message?: string | undefined;
     /**
      * @internal
      */
@@ -442,17 +442,17 @@ export interface Document {
      *             together and processed as one document within the service.</p>
      * @public
      */
-    GroupId?: string;
+    GroupId?: string | undefined;
     /**
      * <p>The title of the search service's document.</p>
      * @public
      */
-    Title?: string;
+    Title?: string | undefined;
     /**
      * <p>The body text of the search service's document.</p>
      * @public
      */
-    Body?: string;
+    Body?: string | undefined;
     /**
      * <p>The title of the search service's document represented as
      *             a list of tokens or words. You must choose to provide
@@ -460,7 +460,7 @@ export interface Document {
      *             provide both.</p>
      * @public
      */
-    TokenizedTitle?: string[];
+    TokenizedTitle?: string[] | undefined;
     /**
      * <p>The body text of the search service's document represented
      *             as a list of tokens or words. You must choose to provide
@@ -468,7 +468,7 @@ export interface Document {
      *             provide both.</p>
      * @public
      */
-    TokenizedBody?: string[];
+    TokenizedBody?: string[] | undefined;
     /**
      * <p>The original document score or rank from the search service.
      *             Amazon Kendra Intelligent Ranking gives the document a new
@@ -509,13 +509,13 @@ export interface RescoreResultItem {
      * <p>The identifier of the document from the search service.</p>
      * @public
      */
-    DocumentId?: string;
+    DocumentId?: string | undefined;
     /**
      * <p>The relevancy score or rank that Amazon Kendra
      *             Intelligent Ranking gives to the result.</p>
      * @public
      */
-    Score?: number;
+    Score?: number | undefined;
 }
 /**
  * @public
@@ -528,13 +528,13 @@ export interface RescoreResult {
      *             rescores or re-ranks the results for the search service.</p>
      * @public
      */
-    RescoreId?: string;
+    RescoreId?: string | undefined;
     /**
      * <p>A list of result items for documents with new relevancy
      *             scores. The results are in descending order.</p>
      * @public
      */
-    ResultItems?: RescoreResultItem[];
+    ResultItems?: RescoreResultItem[] | undefined;
 }
 /**
  * <p>The request information for tagging a rescore execution
@@ -608,12 +608,12 @@ export interface UpdateRescoreExecutionPlanRequest {
      * <p>A new name for the rescore execution plan.</p>
      * @public
      */
-    Name?: string;
+    Name?: string | undefined;
     /**
      * <p>A new description for the rescore execution plan.</p>
      * @public
      */
-    Description?: string;
+    Description?: string | undefined;
     /**
      * <p>You can set additional capacity units to meet the needs
      *             of your rescore execution plan. You are given a single capacity
@@ -623,5 +623,5 @@ export interface UpdateRescoreExecutionPlanRequest {
      *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>
      * @public
      */
-    CapacityUnits?: CapacityUnitsConfiguration;
+    CapacityUnits?: CapacityUnitsConfiguration | undefined;
 }

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

@@ -3,7 +3,7 @@ import { KendraRankingServiceException as __BaseException } from "./KendraRankin
 export declare class AccessDeniedException extends __BaseException {
   readonly name: "AccessDeniedException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
   );
@@ -11,7 +11,7 @@ export declare class AccessDeniedException extends __BaseException {
 export declare class ConflictException extends __BaseException {
   readonly name: "ConflictException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 export interface CapacityUnitsConfiguration {
@@ -23,10 +23,10 @@ export interface Tag {
 }
 export interface CreateRescoreExecutionPlanRequest {
   Name: string | undefined;
-  Description?: string;
-  CapacityUnits?: CapacityUnitsConfiguration;
-  Tags?: Tag[];
-  ClientToken?: string;
+  Description?: string | undefined;
+  CapacityUnits?: CapacityUnitsConfiguration | undefined;
+  Tags?: Tag[] | undefined;
+  ClientToken?: string | undefined;
 }
 export interface CreateRescoreExecutionPlanResponse {
   Id: string | undefined;
@@ -35,7 +35,7 @@ export interface CreateRescoreExecutionPlanResponse {
 export declare class InternalServerException extends __BaseException {
   readonly name: "InternalServerException";
   readonly $fault: "server";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<InternalServerException, __BaseException>
   );
@@ -43,7 +43,7 @@ export declare class InternalServerException extends __BaseException {
 export declare class ServiceQuotaExceededException extends __BaseException {
   readonly name: "ServiceQuotaExceededException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
   );
@@ -51,7 +51,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
 export declare class ThrottlingException extends __BaseException {
   readonly name: "ThrottlingException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<ThrottlingException, __BaseException>
   );
@@ -59,7 +59,7 @@ export declare class ThrottlingException extends __BaseException {
 export declare class ValidationException extends __BaseException {
   readonly name: "ValidationException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<ValidationException, __BaseException>
   );
@@ -70,7 +70,7 @@ export interface DeleteRescoreExecutionPlanRequest {
 export declare class ResourceNotFoundException extends __BaseException {
   readonly name: "ResourceNotFoundException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
   );
@@ -88,52 +88,52 @@ export declare const RescoreExecutionPlanStatus: {
 export type RescoreExecutionPlanStatus =
   (typeof RescoreExecutionPlanStatus)[keyof typeof RescoreExecutionPlanStatus];
 export interface DescribeRescoreExecutionPlanResponse {
-  Id?: string;
-  Arn?: string;
-  Name?: string;
-  Description?: string;
-  CapacityUnits?: CapacityUnitsConfiguration;
-  CreatedAt?: Date;
-  UpdatedAt?: Date;
-  Status?: RescoreExecutionPlanStatus;
-  ErrorMessage?: string;
+  Id?: string | undefined;
+  Arn?: string | undefined;
+  Name?: string | undefined;
+  Description?: string | undefined;
+  CapacityUnits?: CapacityUnitsConfiguration | undefined;
+  CreatedAt?: Date | undefined;
+  UpdatedAt?: Date | undefined;
+  Status?: RescoreExecutionPlanStatus | undefined;
+  ErrorMessage?: string | undefined;
 }
 export interface ListRescoreExecutionPlansRequest {
-  NextToken?: string;
-  MaxResults?: number;
+  NextToken?: string | undefined;
+  MaxResults?: number | undefined;
 }
 export interface RescoreExecutionPlanSummary {
-  Name?: string;
-  Id?: string;
-  CreatedAt?: Date;
-  UpdatedAt?: Date;
-  Status?: RescoreExecutionPlanStatus;
+  Name?: string | undefined;
+  Id?: string | undefined;
+  CreatedAt?: Date | undefined;
+  UpdatedAt?: Date | undefined;
+  Status?: RescoreExecutionPlanStatus | undefined;
 }
 export interface ListRescoreExecutionPlansResponse {
-  SummaryItems?: RescoreExecutionPlanSummary[];
-  NextToken?: string;
+  SummaryItems?: RescoreExecutionPlanSummary[] | undefined;
+  NextToken?: string | undefined;
 }
 export interface ListTagsForResourceRequest {
   ResourceARN: string | undefined;
 }
 export interface ListTagsForResourceResponse {
-  Tags?: Tag[];
+  Tags?: Tag[] | undefined;
 }
 export declare class ResourceUnavailableException extends __BaseException {
   readonly name: "ResourceUnavailableException";
   readonly $fault: "client";
-  Message?: string;
+  Message?: string | undefined;
   constructor(
     opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>
   );
 }
 export interface Document {
   Id: string | undefined;
-  GroupId?: string;
-  Title?: string;
-  Body?: string;
-  TokenizedTitle?: string[];
-  TokenizedBody?: string[];
+  GroupId?: string | undefined;
+  Title?: string | undefined;
+  Body?: string | undefined;
+  TokenizedTitle?: string[] | undefined;
+  TokenizedBody?: string[] | undefined;
   OriginalScore: number | undefined;
 }
 export interface RescoreRequest {
@@ -142,12 +142,12 @@ export interface RescoreRequest {
   Documents: Document[] | undefined;
 }
 export interface RescoreResultItem {
-  DocumentId?: string;
-  Score?: number;
+  DocumentId?: string | undefined;
+  Score?: number | undefined;
 }
 export interface RescoreResult {
-  RescoreId?: string;
-  ResultItems?: RescoreResultItem[];
+  RescoreId?: string | undefined;
+  ResultItems?: RescoreResultItem[] | undefined;
 }
 export interface TagResourceRequest {
   ResourceARN: string | undefined;
@@ -161,7 +161,7 @@ export interface UntagResourceRequest {
 export interface UntagResourceResponse {}
 export interface UpdateRescoreExecutionPlanRequest {
   Id: string | undefined;
-  Name?: string;
-  Description?: string;
-  CapacityUnits?: CapacityUnitsConfiguration;
+  Name?: string | undefined;
+  Description?: string | undefined;
+  CapacityUnits?: CapacityUnitsConfiguration | undefined;
 }

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.686.0",
+  "version": "3.691.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-kendra-ranking",
@@ -20,19 +20,19 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.686.0",
-    "@aws-sdk/client-sts": "3.686.0",
-    "@aws-sdk/core": "3.686.0",
-    "@aws-sdk/credential-provider-node": "3.686.0",
+    "@aws-sdk/client-sso-oidc": "3.691.0",
+    "@aws-sdk/client-sts": "3.691.0",
+    "@aws-sdk/core": "3.691.0",
+    "@aws-sdk/credential-provider-node": "3.691.0",
     "@aws-sdk/middleware-host-header": "3.686.0",
     "@aws-sdk/middleware-logger": "3.686.0",
     "@aws-sdk/middleware-recursion-detection": "3.686.0",
-    "@aws-sdk/middleware-user-agent": "3.686.0",
+    "@aws-sdk/middleware-user-agent": "3.691.0",
     "@aws-sdk/region-config-resolver": "3.686.0",
     "@aws-sdk/types": "3.686.0",
     "@aws-sdk/util-endpoints": "3.686.0",
     "@aws-sdk/util-user-agent-browser": "3.686.0",
-    "@aws-sdk/util-user-agent-node": "3.686.0",
+    "@aws-sdk/util-user-agent-node": "3.691.0",
     "@smithy/config-resolver": "^3.0.10",
     "@smithy/core": "^2.5.1",
     "@smithy/fetch-http-handler": "^4.0.0",