@aws-sdk/client-comprehend 3.218.0 → 3.223.0

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

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListEndpointsCommandInput, ListEndpointsCommandOutput } from "../commands/ListEndpointsCommand";
+import { ComprehendPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEndpoints(config: ComprehendPaginationConfiguration, input: ListEndpointsCommandInput, ...additionalArguments: any): Paginator<ListEndpointsCommandOutput>;

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

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListPiiEntitiesDetectionJobsCommandInput, ListPiiEntitiesDetectionJobsCommandOutput } from "../commands/ListPiiEntitiesDetectionJobsCommand";
+import { ComprehendPaginationConfiguration } from "./Interfaces";
+export declare function paginateListPiiEntitiesDetectionJobs(config: ComprehendPaginationConfiguration, input: ListPiiEntitiesDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListPiiEntitiesDetectionJobsCommandOutput>;

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

@@ -3,11 +3,13 @@ export * from "./ListDocumentClassificationJobsPaginator";
 export * from "./ListDocumentClassifierSummariesPaginator";
 export * from "./ListDocumentClassifiersPaginator";
 export * from "./ListDominantLanguageDetectionJobsPaginator";
+export * from "./ListEndpointsPaginator";
 export * from "./ListEntitiesDetectionJobsPaginator";
 export * from "./ListEntityRecognizerSummariesPaginator";
 export * from "./ListEntityRecognizersPaginator";
 export * from "./ListEventsDetectionJobsPaginator";
 export * from "./ListKeyPhrasesDetectionJobsPaginator";
+export * from "./ListPiiEntitiesDetectionJobsPaginator";
 export * from "./ListSentimentDetectionJobsPaginator";
 export * from "./ListTargetedSentimentDetectionJobsPaginator";
 export * from "./ListTopicsDetectionJobsPaginator";

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

@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
     defaultSigningName: string;
   };
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
+  Region: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;

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

@@ -55,10 +55,24 @@ export declare class InternalServerException extends __BaseException {
     opts: __ExceptionOptionType<InternalServerException, __BaseException>
   );
 }
+export declare enum InvalidRequestDetailReason {
+  DOCUMENT_SIZE_EXCEEDED = "DOCUMENT_SIZE_EXCEEDED",
+  PAGE_LIMIT_EXCEEDED = "PAGE_LIMIT_EXCEEDED",
+  TEXTRACT_ACCESS_DENIED = "TEXTRACT_ACCESS_DENIED",
+  UNSUPPORTED_DOC_TYPE = "UNSUPPORTED_DOC_TYPE",
+}
+export interface InvalidRequestDetail {
+  Reason?: InvalidRequestDetailReason | string;
+}
+export declare enum InvalidRequestReason {
+  INVALID_DOCUMENT = "INVALID_DOCUMENT",
+}
 export declare class InvalidRequestException extends __BaseException {
   readonly name: "InvalidRequestException";
   readonly $fault: "client";
   Message?: string;
+  Reason?: InvalidRequestReason | string;
+  Detail?: InvalidRequestDetail;
   constructor(
     opts: __ExceptionOptionType<InvalidRequestException, __BaseException>
   );
@@ -89,6 +103,17 @@ export interface BatchDetectEntitiesRequest {
   TextList: string[] | undefined;
   LanguageCode: LanguageCode | string | undefined;
 }
+export interface ChildBlock {
+  ChildBlockId?: string;
+  BeginOffset?: number;
+  EndOffset?: number;
+}
+export interface BlockReference {
+  BlockId?: string;
+  BeginOffset?: number;
+  EndOffset?: number;
+  ChildBlocks?: ChildBlock[];
+}
 export declare enum EntityType {
   COMMERCIAL_ITEM = "COMMERCIAL_ITEM",
   DATE = "DATE",
@@ -106,6 +131,7 @@ export interface Entity {
   Text?: string;
   BeginOffset?: number;
   EndOffset?: number;
+  BlockReferences?: BlockReference[];
 }
 export interface BatchDetectEntitiesItemResult {
   Index?: number;
@@ -265,6 +291,39 @@ export interface BatchDetectTargetedSentimentResponse {
   ResultList: BatchDetectTargetedSentimentItemResult[] | undefined;
   ErrorList: BatchItemError[] | undefined;
 }
+export declare enum BlockType {
+  LINE = "LINE",
+  WORD = "WORD",
+}
+export interface BoundingBox {
+  Height?: number;
+  Left?: number;
+  Top?: number;
+  Width?: number;
+}
+export interface Point {
+  X?: number;
+  Y?: number;
+}
+export interface Geometry {
+  BoundingBox?: BoundingBox;
+  Polygon?: Point[];
+}
+export declare enum RelationshipType {
+  CHILD = "CHILD",
+}
+export interface RelationshipsListItem {
+  Ids?: string[];
+  Type?: RelationshipType | string;
+}
+export interface Block {
+  Id?: string;
+  BlockType?: BlockType | string;
+  Text?: string;
+  Page?: number;
+  Geometry?: Geometry;
+  Relationships?: RelationshipsListItem[];
+}
 export interface ClassifierEvaluationMetrics {
   Accuracy?: number;
   Precision?: number;
@@ -281,21 +340,78 @@ export interface ClassifierMetadata {
   NumberOfTestDocuments?: number;
   EvaluationMetrics?: ClassifierEvaluationMetrics;
 }
+export declare enum DocumentReadAction {
+  TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
+  TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT",
+}
+export declare enum DocumentReadMode {
+  FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
+  SERVICE_DEFAULT = "SERVICE_DEFAULT",
+}
+export declare enum DocumentReadFeatureTypes {
+  FORMS = "FORMS",
+  TABLES = "TABLES",
+}
+export interface DocumentReaderConfig {
+  DocumentReadAction: DocumentReadAction | string | undefined;
+  DocumentReadMode?: DocumentReadMode | string;
+  FeatureTypes?: (DocumentReadFeatureTypes | string)[];
+}
 export interface ClassifyDocumentRequest {
-  Text: string | undefined;
+  Text?: string;
   EndpointArn: string | undefined;
+  Bytes?: Uint8Array;
+  DocumentReaderConfig?: DocumentReaderConfig;
 }
 export interface DocumentClass {
   Name?: string;
   Score?: number;
+  Page?: number;
+}
+export interface ExtractedCharactersListItem {
+  Page?: number;
+  Count?: number;
+}
+export interface DocumentMetadata {
+  Pages?: number;
+  ExtractedCharacters?: ExtractedCharactersListItem[];
+}
+export declare enum DocumentType {
+  IMAGE = "IMAGE",
+  MS_WORD = "MS_WORD",
+  NATIVE_PDF = "NATIVE_PDF",
+  PLAIN_TEXT = "PLAIN_TEXT",
+  SCANNED_PDF = "SCANNED_PDF",
+  TEXTRACT_ANALYZE_DOCUMENT_JSON = "TEXTRACT_ANALYZE_DOCUMENT_JSON",
+  TEXTRACT_DETECT_DOCUMENT_TEXT_JSON = "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON",
+}
+export interface DocumentTypeListItem {
+  Page?: number;
+  Type?: DocumentType | string;
+}
+export declare enum PageBasedErrorCode {
+  INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
+  PAGE_CHARACTERS_EXCEEDED = "PAGE_CHARACTERS_EXCEEDED",
+  PAGE_SIZE_EXCEEDED = "PAGE_SIZE_EXCEEDED",
+  TEXTRACT_BAD_PAGE = "TEXTRACT_BAD_PAGE",
+  TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED = "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED",
+}
+export interface ErrorsListItem {
+  Page?: number;
+  ErrorCode?: PageBasedErrorCode | string;
+  ErrorMessage?: string;
 }
 export interface DocumentLabel {
   Name?: string;
   Score?: number;
+  Page?: number;
 }
 export interface ClassifyDocumentResponse {
   Classes?: DocumentClass[];
   Labels?: DocumentLabel[];
+  DocumentMetadata?: DocumentMetadata;
+  DocumentType?: DocumentTypeListItem[];
+  Errors?: ErrorsListItem[];
 }
 export declare class ResourceUnavailableException extends __BaseException {
   readonly name: "ResourceUnavailableException";
@@ -526,23 +642,6 @@ export interface DeleteResourcePolicyResponse {}
 export interface DescribeDocumentClassificationJobRequest {
   JobId: string | undefined;
 }
-export declare enum DocumentReadAction {
-  TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
-  TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT",
-}
-export declare enum DocumentReadMode {
-  FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
-  SERVICE_DEFAULT = "SERVICE_DEFAULT",
-}
-export declare enum DocumentReadFeatureTypes {
-  FORMS = "FORMS",
-  TABLES = "TABLES",
-}
-export interface DocumentReaderConfig {
-  DocumentReadAction: DocumentReadAction | string | undefined;
-  DocumentReadMode?: DocumentReadMode | string;
-  FeatureTypes?: (DocumentReadFeatureTypes | string)[];
-}
 export interface InputDataConfig {
   S3Uri: string | undefined;
   InputFormat?: InputFormat | string;
@@ -892,12 +991,18 @@ export interface DetectDominantLanguageResponse {
   Languages?: DominantLanguage[];
 }
 export interface DetectEntitiesRequest {
-  Text: string | undefined;
+  Text?: string;
   LanguageCode?: LanguageCode | string;
   EndpointArn?: string;
+  Bytes?: Uint8Array;
+  DocumentReaderConfig?: DocumentReaderConfig;
 }
 export interface DetectEntitiesResponse {
   Entities?: Entity[];
+  DocumentMetadata?: DocumentMetadata;
+  DocumentType?: DocumentTypeListItem[];
+  Blocks?: Block[];
+  Errors?: ErrorsListItem[];
 }
 export interface DetectKeyPhrasesRequest {
   Text: string | undefined;
@@ -1439,9 +1544,16 @@ export declare const BatchDetectDominantLanguageItemResultFilterSensitiveLog: (
 export declare const BatchDetectDominantLanguageResponseFilterSensitiveLog: (
   obj: BatchDetectDominantLanguageResponse
 ) => any;
+export declare const InvalidRequestDetailFilterSensitiveLog: (
+  obj: InvalidRequestDetail
+) => any;
 export declare const BatchDetectEntitiesRequestFilterSensitiveLog: (
   obj: BatchDetectEntitiesRequest
 ) => any;
+export declare const ChildBlockFilterSensitiveLog: (obj: ChildBlock) => any;
+export declare const BlockReferenceFilterSensitiveLog: (
+  obj: BlockReference
+) => any;
 export declare const EntityFilterSensitiveLog: (obj: Entity) => any;
 export declare const BatchDetectEntitiesItemResultFilterSensitiveLog: (
   obj: BatchDetectEntitiesItemResult
@@ -1502,18 +1614,40 @@ export declare const BatchDetectTargetedSentimentItemResultFilterSensitiveLog: (
 export declare const BatchDetectTargetedSentimentResponseFilterSensitiveLog: (
   obj: BatchDetectTargetedSentimentResponse
 ) => any;
+export declare const BoundingBoxFilterSensitiveLog: (obj: BoundingBox) => any;
+export declare const PointFilterSensitiveLog: (obj: Point) => any;
+export declare const GeometryFilterSensitiveLog: (obj: Geometry) => any;
+export declare const RelationshipsListItemFilterSensitiveLog: (
+  obj: RelationshipsListItem
+) => any;
+export declare const BlockFilterSensitiveLog: (obj: Block) => any;
 export declare const ClassifierEvaluationMetricsFilterSensitiveLog: (
   obj: ClassifierEvaluationMetrics
 ) => any;
 export declare const ClassifierMetadataFilterSensitiveLog: (
   obj: ClassifierMetadata
 ) => any;
+export declare const DocumentReaderConfigFilterSensitiveLog: (
+  obj: DocumentReaderConfig
+) => any;
 export declare const ClassifyDocumentRequestFilterSensitiveLog: (
   obj: ClassifyDocumentRequest
 ) => any;
 export declare const DocumentClassFilterSensitiveLog: (
   obj: DocumentClass
 ) => any;
+export declare const ExtractedCharactersListItemFilterSensitiveLog: (
+  obj: ExtractedCharactersListItem
+) => any;
+export declare const DocumentMetadataFilterSensitiveLog: (
+  obj: DocumentMetadata
+) => any;
+export declare const DocumentTypeListItemFilterSensitiveLog: (
+  obj: DocumentTypeListItem
+) => any;
+export declare const ErrorsListItemFilterSensitiveLog: (
+  obj: ErrorsListItem
+) => any;
 export declare const DocumentLabelFilterSensitiveLog: (
   obj: DocumentLabel
 ) => any;
@@ -1595,9 +1729,6 @@ export declare const DeleteResourcePolicyResponseFilterSensitiveLog: (
 export declare const DescribeDocumentClassificationJobRequestFilterSensitiveLog: (
   obj: DescribeDocumentClassificationJobRequest
 ) => any;
-export declare const DocumentReaderConfigFilterSensitiveLog: (
-  obj: DocumentReaderConfig
-) => any;
 export declare const InputDataConfigFilterSensitiveLog: (
   obj: InputDataConfig
 ) => any;

package/dist-types/ts3.4/pagination/ListEndpointsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListEndpointsCommandInput,
+  ListEndpointsCommandOutput,
+} from "../commands/ListEndpointsCommand";
+import { ComprehendPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEndpoints(
+  config: ComprehendPaginationConfiguration,
+  input: ListEndpointsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListEndpointsCommandOutput>;

package/dist-types/ts3.4/pagination/ListPiiEntitiesDetectionJobsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListPiiEntitiesDetectionJobsCommandInput,
+  ListPiiEntitiesDetectionJobsCommandOutput,
+} from "../commands/ListPiiEntitiesDetectionJobsCommand";
+import { ComprehendPaginationConfiguration } from "./Interfaces";
+export declare function paginateListPiiEntitiesDetectionJobs(
+  config: ComprehendPaginationConfiguration,
+  input: ListPiiEntitiesDetectionJobsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListPiiEntitiesDetectionJobsCommandOutput>;

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

@@ -3,11 +3,13 @@ export * from "./ListDocumentClassificationJobsPaginator";
 export * from "./ListDocumentClassifierSummariesPaginator";
 export * from "./ListDocumentClassifiersPaginator";
 export * from "./ListDominantLanguageDetectionJobsPaginator";
+export * from "./ListEndpointsPaginator";
 export * from "./ListEntitiesDetectionJobsPaginator";
 export * from "./ListEntityRecognizerSummariesPaginator";
 export * from "./ListEntityRecognizersPaginator";
 export * from "./ListEventsDetectionJobsPaginator";
 export * from "./ListKeyPhrasesDetectionJobsPaginator";
+export * from "./ListPiiEntitiesDetectionJobsPaginator";
 export * from "./ListSentimentDetectionJobsPaginator";
 export * from "./ListTargetedSentimentDetectionJobsPaginator";
 export * from "./ListTopicsDetectionJobsPaginator";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-comprehend",
   "description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
-  "version": "3.218.0",
+  "version": "3.223.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -19,36 +19,36 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.218.0",
-    "@aws-sdk/config-resolver": "3.215.0",
-    "@aws-sdk/credential-provider-node": "3.218.0",
-    "@aws-sdk/fetch-http-handler": "3.215.0",
-    "@aws-sdk/hash-node": "3.215.0",
-    "@aws-sdk/invalid-dependency": "3.215.0",
-    "@aws-sdk/middleware-content-length": "3.215.0",
-    "@aws-sdk/middleware-endpoint": "3.215.0",
-    "@aws-sdk/middleware-host-header": "3.215.0",
-    "@aws-sdk/middleware-logger": "3.215.0",
-    "@aws-sdk/middleware-recursion-detection": "3.215.0",
-    "@aws-sdk/middleware-retry": "3.215.0",
-    "@aws-sdk/middleware-serde": "3.215.0",
-    "@aws-sdk/middleware-signing": "3.215.0",
-    "@aws-sdk/middleware-stack": "3.215.0",
-    "@aws-sdk/middleware-user-agent": "3.215.0",
-    "@aws-sdk/node-config-provider": "3.215.0",
-    "@aws-sdk/node-http-handler": "3.215.0",
-    "@aws-sdk/protocol-http": "3.215.0",
-    "@aws-sdk/smithy-client": "3.215.0",
-    "@aws-sdk/types": "3.215.0",
-    "@aws-sdk/url-parser": "3.215.0",
+    "@aws-sdk/client-sts": "3.223.0",
+    "@aws-sdk/config-resolver": "3.222.0",
+    "@aws-sdk/credential-provider-node": "3.223.0",
+    "@aws-sdk/fetch-http-handler": "3.222.0",
+    "@aws-sdk/hash-node": "3.222.0",
+    "@aws-sdk/invalid-dependency": "3.222.0",
+    "@aws-sdk/middleware-content-length": "3.222.0",
+    "@aws-sdk/middleware-endpoint": "3.222.0",
+    "@aws-sdk/middleware-host-header": "3.222.0",
+    "@aws-sdk/middleware-logger": "3.222.0",
+    "@aws-sdk/middleware-recursion-detection": "3.222.0",
+    "@aws-sdk/middleware-retry": "3.222.0",
+    "@aws-sdk/middleware-serde": "3.222.0",
+    "@aws-sdk/middleware-signing": "3.222.0",
+    "@aws-sdk/middleware-stack": "3.222.0",
+    "@aws-sdk/middleware-user-agent": "3.222.0",
+    "@aws-sdk/node-config-provider": "3.222.0",
+    "@aws-sdk/node-http-handler": "3.222.0",
+    "@aws-sdk/protocol-http": "3.222.0",
+    "@aws-sdk/smithy-client": "3.222.0",
+    "@aws-sdk/types": "3.222.0",
+    "@aws-sdk/url-parser": "3.222.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.215.0",
-    "@aws-sdk/util-defaults-mode-node": "3.215.0",
-    "@aws-sdk/util-endpoints": "3.216.0",
-    "@aws-sdk/util-user-agent-browser": "3.215.0",
-    "@aws-sdk/util-user-agent-node": "3.215.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.222.0",
+    "@aws-sdk/util-defaults-mode-node": "3.222.0",
+    "@aws-sdk/util-endpoints": "3.222.0",
+    "@aws-sdk/util-user-agent-browser": "3.222.0",
+    "@aws-sdk/util-user-agent-node": "3.222.0",
     "@aws-sdk/util-utf8-browser": "3.188.0",
     "@aws-sdk/util-utf8-node": "3.208.0",
     "tslib": "^2.3.1",