openapi: 3.2.0 info: version: '2017-11-27' x-release: v4 title: Amazon Comprehend API description: Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: comprehend x-aws-signingName: comprehend x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/comprehend-2017-11-27.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://comprehend.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Comprehend multi-region endpoint - url: https://comprehend.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Comprehend multi-region endpoint - url: http://comprehend.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia) - url: https://comprehend.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Amazon Comprehend paths: /#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectDominantLanguage description: Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectDominantLanguageResponse' examples: BatchDetectDominantLanguage200Example: summary: Default BatchDetectDominantLanguage 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectDominantLanguage480Example: summary: Default BatchDetectDominantLanguage 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectDominantLanguage481Example: summary: Default BatchDetectDominantLanguage 481 x-microcks-default: true value: example '482': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectDominantLanguage482Example: summary: Default BatchDetectDominantLanguage 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectDominantLanguage483Example: summary: Default BatchDetectDominantLanguage 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectDominantLanguageRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectDominantLanguage summary: Amazon Comprehend Batch Detect Dominant Language x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.BatchDetectEntities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectEntities description: Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectEntitiesResponse' examples: BatchDetectEntities200Example: summary: Default BatchDetectEntities 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectEntities480Example: summary: Default BatchDetectEntities 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectEntities481Example: summary: Default BatchDetectEntities 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: BatchDetectEntities482Example: summary: Default BatchDetectEntities 482 x-microcks-default: true value: example '483': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectEntities483Example: summary: Default BatchDetectEntities 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectEntities484Example: summary: Default BatchDetectEntities 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectEntitiesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectEntities summary: Amazon Comprehend Batch Detect Entities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.BatchDetectKeyPhrases: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectKeyPhrases description: Detects the key noun phrases found in a batch of documents. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectKeyPhrasesResponse' examples: BatchDetectKeyPhrases200Example: summary: Default BatchDetectKeyPhrases 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectKeyPhrases480Example: summary: Default BatchDetectKeyPhrases 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectKeyPhrases481Example: summary: Default BatchDetectKeyPhrases 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: BatchDetectKeyPhrases482Example: summary: Default BatchDetectKeyPhrases 482 x-microcks-default: true value: example '483': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectKeyPhrases483Example: summary: Default BatchDetectKeyPhrases 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectKeyPhrases484Example: summary: Default BatchDetectKeyPhrases 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectKeyPhrasesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectKeyPhrases summary: Amazon Comprehend Batch Detect Key Phrases x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.BatchDetectSentiment: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectSentiment description: Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectSentimentResponse' examples: BatchDetectSentiment200Example: summary: Default BatchDetectSentiment 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectSentiment480Example: summary: Default BatchDetectSentiment 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectSentiment481Example: summary: Default BatchDetectSentiment 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: BatchDetectSentiment482Example: summary: Default BatchDetectSentiment 482 x-microcks-default: true value: example '483': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectSentiment483Example: summary: Default BatchDetectSentiment 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectSentiment484Example: summary: Default BatchDetectSentiment 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectSentimentRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectSentiment summary: Amazon Comprehend Batch Detect Sentiment x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.BatchDetectSyntax: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectSyntax description: Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectSyntaxResponse' examples: BatchDetectSyntax200Example: summary: Default BatchDetectSyntax 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectSyntax480Example: summary: Default BatchDetectSyntax 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectSyntax481Example: summary: Default BatchDetectSyntax 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: BatchDetectSyntax482Example: summary: Default BatchDetectSyntax 482 x-microcks-default: true value: example '483': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectSyntax483Example: summary: Default BatchDetectSyntax 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectSyntax484Example: summary: Default BatchDetectSyntax 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectSyntaxRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectSyntax summary: Amazon Comprehend Batch Detect Syntax x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.BatchDetectTargetedSentiment: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchDetectTargetedSentiment description: 'Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see Targeted sentiment.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDetectTargetedSentimentResponse' examples: BatchDetectTargetedSentiment200Example: summary: Default BatchDetectTargetedSentiment 200 x-microcks-default: true value: ResultList: example ErrorList: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: BatchDetectTargetedSentiment480Example: summary: Default BatchDetectTargetedSentiment 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: BatchDetectTargetedSentiment481Example: summary: Default BatchDetectTargetedSentiment 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: BatchDetectTargetedSentiment482Example: summary: Default BatchDetectTargetedSentiment 482 x-microcks-default: true value: example '483': description: BatchSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/BatchSizeLimitExceededException' examples: BatchDetectTargetedSentiment483Example: summary: Default BatchDetectTargetedSentiment 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: BatchDetectTargetedSentiment484Example: summary: Default BatchDetectTargetedSentiment 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDetectTargetedSentimentRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.BatchDetectTargetedSentiment summary: Amazon Comprehend Batch Detect Targeted Sentiment x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ClassifyDocument: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ClassifyDocument description: 'Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint. You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). If the system detects errors while processing a page in the input document, the API response includes an entry in Errors that describes the errors. If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ClassifyDocumentResponse' examples: ClassifyDocument200Example: summary: Default ClassifyDocument 200 x-microcks-default: true value: Classes: example Labels: example DocumentMetadata: example DocumentType: example Errors: example Warnings: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ClassifyDocument480Example: summary: Default ClassifyDocument 480 x-microcks-default: true value: example '481': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: ClassifyDocument481Example: summary: Default ClassifyDocument 481 x-microcks-default: true value: example '482': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: ClassifyDocument482Example: summary: Default ClassifyDocument 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ClassifyDocument483Example: summary: Default ClassifyDocument 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ClassifyDocumentRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ClassifyDocument summary: Amazon Comprehend Classify Document x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ContainsPiiEntities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ContainsPiiEntities description: Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ContainsPiiEntitiesResponse' examples: ContainsPiiEntities200Example: summary: Default ContainsPiiEntities 200 x-microcks-default: true value: Labels: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ContainsPiiEntities480Example: summary: Default ContainsPiiEntities 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: ContainsPiiEntities481Example: summary: Default ContainsPiiEntities 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: ContainsPiiEntities482Example: summary: Default ContainsPiiEntities 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ContainsPiiEntities483Example: summary: Default ContainsPiiEntities 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ContainsPiiEntitiesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ContainsPiiEntities summary: Amazon Comprehend Contains Pii Entities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.CreateDataset: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDataset description: Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDatasetResponse' examples: CreateDataset200Example: summary: Default CreateDataset 200 x-microcks-default: true value: DatasetArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateDataset480Example: summary: Default CreateDataset 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: CreateDataset481Example: summary: Default CreateDataset 481 x-microcks-default: true value: example '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: CreateDataset482Example: summary: Default CreateDataset 482 x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateDataset483Example: summary: Default CreateDataset 483 x-microcks-default: true value: example '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: CreateDataset484Example: summary: Default CreateDataset 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CreateDataset485Example: summary: Default CreateDataset 485 x-microcks-default: true value: example '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateDataset486Example: summary: Default CreateDataset 486 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.CreateDataset summary: Amazon Comprehend Create Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.CreateDocumentClassifier: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDocumentClassifier description: Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDocumentClassifierResponse' examples: CreateDocumentClassifier200Example: summary: Default CreateDocumentClassifier 200 x-microcks-default: true value: DocumentClassifierArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateDocumentClassifier480Example: summary: Default CreateDocumentClassifier 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: CreateDocumentClassifier481Example: summary: Default CreateDocumentClassifier 481 x-microcks-default: true value: example '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: CreateDocumentClassifier482Example: summary: Default CreateDocumentClassifier 482 x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateDocumentClassifier483Example: summary: Default CreateDocumentClassifier 483 x-microcks-default: true value: example '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: CreateDocumentClassifier484Example: summary: Default CreateDocumentClassifier 484 x-microcks-default: true value: example '485': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: CreateDocumentClassifier485Example: summary: Default CreateDocumentClassifier 485 x-microcks-default: true value: example '486': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: CreateDocumentClassifier486Example: summary: Default CreateDocumentClassifier 486 x-microcks-default: true value: example '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateDocumentClassifier487Example: summary: Default CreateDocumentClassifier 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDocumentClassifierRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.CreateDocumentClassifier summary: Amazon Comprehend Create Document Classifier x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.CreateEndpoint: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEndpoint description: Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateEndpointResponse' examples: CreateEndpoint200Example: summary: Default CreateEndpoint 200 x-microcks-default: true value: EndpointArn: example ModelArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateEndpoint480Example: summary: Default CreateEndpoint 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: CreateEndpoint481Example: summary: Default CreateEndpoint 481 x-microcks-default: true value: example '482': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: CreateEndpoint482Example: summary: Default CreateEndpoint 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CreateEndpoint483Example: summary: Default CreateEndpoint 483 x-microcks-default: true value: example '484': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: CreateEndpoint484Example: summary: Default CreateEndpoint 484 x-microcks-default: true value: example '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateEndpoint485Example: summary: Default CreateEndpoint 485 x-microcks-default: true value: example '486': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: CreateEndpoint486Example: summary: Default CreateEndpoint 486 x-microcks-default: true value: example '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateEndpoint487Example: summary: Default CreateEndpoint 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEndpointRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.CreateEndpoint summary: Amazon Comprehend Create Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizer: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEntityRecognizer description: Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateEntityRecognizerResponse' examples: CreateEntityRecognizer200Example: summary: Default CreateEntityRecognizer 200 x-microcks-default: true value: EntityRecognizerArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateEntityRecognizer480Example: summary: Default CreateEntityRecognizer 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: CreateEntityRecognizer481Example: summary: Default CreateEntityRecognizer 481 x-microcks-default: true value: example '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: CreateEntityRecognizer482Example: summary: Default CreateEntityRecognizer 482 x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateEntityRecognizer483Example: summary: Default CreateEntityRecognizer 483 x-microcks-default: true value: example '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: CreateEntityRecognizer484Example: summary: Default CreateEntityRecognizer 484 x-microcks-default: true value: example '485': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: CreateEntityRecognizer485Example: summary: Default CreateEntityRecognizer 485 x-microcks-default: true value: example '486': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: CreateEntityRecognizer486Example: summary: Default CreateEntityRecognizer 486 x-microcks-default: true value: example '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateEntityRecognizer487Example: summary: Default CreateEntityRecognizer 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEntityRecognizerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.CreateEntityRecognizer summary: Amazon Comprehend Create Entity Recognizer x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.CreateFlywheel: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateFlywheel description: 'A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model''s training data and test data into the flywheel''s data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFlywheelResponse' examples: CreateFlywheel200Example: summary: Default CreateFlywheel 200 x-microcks-default: true value: FlywheelArn: example ActiveModelArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: CreateFlywheel480Example: summary: Default CreateFlywheel 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: CreateFlywheel481Example: summary: Default CreateFlywheel 481 x-microcks-default: true value: example '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: CreateFlywheel482Example: summary: Default CreateFlywheel 482 x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateFlywheel483Example: summary: Default CreateFlywheel 483 x-microcks-default: true value: example '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: CreateFlywheel484Example: summary: Default CreateFlywheel 484 x-microcks-default: true value: example '485': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: CreateFlywheel485Example: summary: Default CreateFlywheel 485 x-microcks-default: true value: example '486': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: CreateFlywheel486Example: summary: Default CreateFlywheel 486 x-microcks-default: true value: example '487': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CreateFlywheel487Example: summary: Default CreateFlywheel 487 x-microcks-default: true value: example '488': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: CreateFlywheel488Example: summary: Default CreateFlywheel 488 x-microcks-default: true value: example '489': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateFlywheel489Example: summary: Default CreateFlywheel 489 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFlywheelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.CreateFlywheel summary: Amazon Comprehend Create Flywheel x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DeleteDocumentClassifier: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteDocumentClassifier description: 'Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDocumentClassifierResponse' examples: DeleteDocumentClassifier200Example: summary: Default DeleteDocumentClassifier 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DeleteDocumentClassifier480Example: summary: Default DeleteDocumentClassifier 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteDocumentClassifier481Example: summary: Default DeleteDocumentClassifier 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteDocumentClassifier482Example: summary: Default DeleteDocumentClassifier 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: DeleteDocumentClassifier483Example: summary: Default DeleteDocumentClassifier 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteDocumentClassifier484Example: summary: Default DeleteDocumentClassifier 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteDocumentClassifier485Example: summary: Default DeleteDocumentClassifier 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDocumentClassifierRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DeleteDocumentClassifier summary: Amazon Comprehend Delete Document Classifier x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DeleteEndpoint: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteEndpoint description: Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEndpointResponse' examples: DeleteEndpoint200Example: summary: Default DeleteEndpoint 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DeleteEndpoint480Example: summary: Default DeleteEndpoint 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteEndpoint481Example: summary: Default DeleteEndpoint 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteEndpoint482Example: summary: Default DeleteEndpoint 482 x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteEndpoint483Example: summary: Default DeleteEndpoint 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteEndpoint484Example: summary: Default DeleteEndpoint 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteEndpointRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DeleteEndpoint summary: Amazon Comprehend Delete Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DeleteEntityRecognizer: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteEntityRecognizer description: 'Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEntityRecognizerResponse' examples: DeleteEntityRecognizer200Example: summary: Default DeleteEntityRecognizer 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DeleteEntityRecognizer480Example: summary: Default DeleteEntityRecognizer 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteEntityRecognizer481Example: summary: Default DeleteEntityRecognizer 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteEntityRecognizer482Example: summary: Default DeleteEntityRecognizer 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: DeleteEntityRecognizer483Example: summary: Default DeleteEntityRecognizer 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteEntityRecognizer484Example: summary: Default DeleteEntityRecognizer 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteEntityRecognizer485Example: summary: Default DeleteEntityRecognizer 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteEntityRecognizerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DeleteEntityRecognizer summary: Amazon Comprehend Delete Entity Recognizer x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DeleteFlywheel: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteFlywheel description: 'Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFlywheelResponse' examples: DeleteFlywheel200Example: summary: Default DeleteFlywheel 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DeleteFlywheel480Example: summary: Default DeleteFlywheel 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteFlywheel481Example: summary: Default DeleteFlywheel 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteFlywheel482Example: summary: Default DeleteFlywheel 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: DeleteFlywheel483Example: summary: Default DeleteFlywheel 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteFlywheel484Example: summary: Default DeleteFlywheel 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteFlywheel485Example: summary: Default DeleteFlywheel 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteFlywheelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DeleteFlywheel summary: Amazon Comprehend Delete Flywheel x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DeleteResourcePolicy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteResourcePolicy description: Deletes a resource-based policy that is attached to a custom model. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteResourcePolicyResponse' examples: DeleteResourcePolicy200Example: summary: Default DeleteResourcePolicy 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DeleteResourcePolicy480Example: summary: Default DeleteResourcePolicy 480 x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteResourcePolicy481Example: summary: Default DeleteResourcePolicy 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteResourcePolicy482Example: summary: Default DeleteResourcePolicy 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteResourcePolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DeleteResourcePolicy summary: Amazon Comprehend Delete Resource Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeDataset: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeDataset description: Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDatasetResponse' examples: DescribeDataset200Example: summary: Default DescribeDataset 200 x-microcks-default: true value: DatasetProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeDataset480Example: summary: Default DescribeDataset 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeDataset481Example: summary: Default DescribeDataset 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeDataset482Example: summary: Default DescribeDataset 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeDataset483Example: summary: Default DescribeDataset 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDatasetRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeDataset summary: Amazon Comprehend Describe Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassificationJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeDocumentClassificationJob description: Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDocumentClassificationJobResponse' examples: DescribeDocumentClassificationJob200Example: summary: Default DescribeDocumentClassificationJob 200 x-microcks-default: true value: DocumentClassificationJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeDocumentClassificationJob480Example: summary: Default DescribeDocumentClassificationJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeDocumentClassificationJob481Example: summary: Default DescribeDocumentClassificationJob 481 x-microcks-default: true value: example '482': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeDocumentClassificationJob482Example: summary: Default DescribeDocumentClassificationJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeDocumentClassificationJob483Example: summary: Default DescribeDocumentClassificationJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDocumentClassificationJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeDocumentClassificationJob summary: Amazon Comprehend Describe Document Classification Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassifier: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeDocumentClassifier description: Gets the properties associated with a document classifier. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDocumentClassifierResponse' examples: DescribeDocumentClassifier200Example: summary: Default DescribeDocumentClassifier 200 x-microcks-default: true value: DocumentClassifierProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeDocumentClassifier480Example: summary: Default DescribeDocumentClassifier 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeDocumentClassifier481Example: summary: Default DescribeDocumentClassifier 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeDocumentClassifier482Example: summary: Default DescribeDocumentClassifier 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeDocumentClassifier483Example: summary: Default DescribeDocumentClassifier 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDocumentClassifierRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeDocumentClassifier summary: Amazon Comprehend Describe Document Classifier x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeDominantLanguageDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeDominantLanguageDetectionJob description: Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDominantLanguageDetectionJobResponse' examples: DescribeDominantLanguageDetectionJob200Example: summary: Default DescribeDominantLanguageDetectionJob 200 x-microcks-default: true value: DominantLanguageDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeDominantLanguageDetectionJob480Example: summary: Default DescribeDominantLanguageDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeDominantLanguageDetectionJob481Example: summary: Default DescribeDominantLanguageDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeDominantLanguageDetectionJob482Example: summary: Default DescribeDominantLanguageDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeDominantLanguageDetectionJob483Example: summary: Default DescribeDominantLanguageDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDominantLanguageDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeDominantLanguageDetectionJob summary: Amazon Comprehend Describe Dominant Language Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeEndpoint: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeEndpoint description: Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEndpointResponse' examples: DescribeEndpoint200Example: summary: Default DescribeEndpoint 200 x-microcks-default: true value: EndpointProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeEndpoint480Example: summary: Default DescribeEndpoint 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeEndpoint481Example: summary: Default DescribeEndpoint 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeEndpoint482Example: summary: Default DescribeEndpoint 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeEndpoint483Example: summary: Default DescribeEndpoint 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEndpointRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeEndpoint summary: Amazon Comprehend Describe Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeEntitiesDetectionJob description: Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEntitiesDetectionJobResponse' examples: DescribeEntitiesDetectionJob200Example: summary: Default DescribeEntitiesDetectionJob 200 x-microcks-default: true value: EntitiesDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeEntitiesDetectionJob480Example: summary: Default DescribeEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeEntitiesDetectionJob481Example: summary: Default DescribeEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeEntitiesDetectionJob482Example: summary: Default DescribeEntitiesDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeEntitiesDetectionJob483Example: summary: Default DescribeEntitiesDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeEntitiesDetectionJob summary: Amazon Comprehend Describe Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeEntityRecognizer: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeEntityRecognizer description: Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEntityRecognizerResponse' examples: DescribeEntityRecognizer200Example: summary: Default DescribeEntityRecognizer 200 x-microcks-default: true value: EntityRecognizerProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeEntityRecognizer480Example: summary: Default DescribeEntityRecognizer 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeEntityRecognizer481Example: summary: Default DescribeEntityRecognizer 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeEntityRecognizer482Example: summary: Default DescribeEntityRecognizer 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeEntityRecognizer483Example: summary: Default DescribeEntityRecognizer 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEntityRecognizerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeEntityRecognizer summary: Amazon Comprehend Describe Entity Recognizer x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeEventsDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeEventsDetectionJob description: Gets the status and details of an events detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEventsDetectionJobResponse' examples: DescribeEventsDetectionJob200Example: summary: Default DescribeEventsDetectionJob 200 x-microcks-default: true value: EventsDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeEventsDetectionJob480Example: summary: Default DescribeEventsDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeEventsDetectionJob481Example: summary: Default DescribeEventsDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeEventsDetectionJob482Example: summary: Default DescribeEventsDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeEventsDetectionJob483Example: summary: Default DescribeEventsDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEventsDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeEventsDetectionJob summary: Amazon Comprehend Describe Events Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeFlywheel: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeFlywheel description: Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFlywheelResponse' examples: DescribeFlywheel200Example: summary: Default DescribeFlywheel 200 x-microcks-default: true value: FlywheelProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeFlywheel480Example: summary: Default DescribeFlywheel 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeFlywheel481Example: summary: Default DescribeFlywheel 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeFlywheel482Example: summary: Default DescribeFlywheel 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeFlywheel483Example: summary: Default DescribeFlywheel 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFlywheelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeFlywheel summary: Amazon Comprehend Describe Flywheel x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeFlywheelIteration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeFlywheelIteration description: Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFlywheelIterationResponse' examples: DescribeFlywheelIteration200Example: summary: Default DescribeFlywheelIteration 200 x-microcks-default: true value: FlywheelIterationProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeFlywheelIteration480Example: summary: Default DescribeFlywheelIteration 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeFlywheelIteration481Example: summary: Default DescribeFlywheelIteration 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeFlywheelIteration482Example: summary: Default DescribeFlywheelIteration 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeFlywheelIteration483Example: summary: Default DescribeFlywheelIteration 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFlywheelIterationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeFlywheelIteration summary: Amazon Comprehend Describe Flywheel Iteration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeKeyPhrasesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeKeyPhrasesDetectionJob description: Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeKeyPhrasesDetectionJobResponse' examples: DescribeKeyPhrasesDetectionJob200Example: summary: Default DescribeKeyPhrasesDetectionJob 200 x-microcks-default: true value: KeyPhrasesDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeKeyPhrasesDetectionJob480Example: summary: Default DescribeKeyPhrasesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeKeyPhrasesDetectionJob481Example: summary: Default DescribeKeyPhrasesDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeKeyPhrasesDetectionJob482Example: summary: Default DescribeKeyPhrasesDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeKeyPhrasesDetectionJob483Example: summary: Default DescribeKeyPhrasesDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeKeyPhrasesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeKeyPhrasesDetectionJob summary: Amazon Comprehend Describe Key Phrases Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribePiiEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribePiiEntitiesDetectionJob description: Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribePiiEntitiesDetectionJobResponse' examples: DescribePiiEntitiesDetectionJob200Example: summary: Default DescribePiiEntitiesDetectionJob 200 x-microcks-default: true value: PiiEntitiesDetectionJobProperties: JobId: {} JobArn: {} JobName: {} JobStatus: {} Message: {} SubmitTime: {} EndTime: {} InputDataConfig: {} OutputDataConfig: {} RedactionConfig: {} LanguageCode: {} DataAccessRoleArn: {} Mode: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribePiiEntitiesDetectionJob480Example: summary: Default DescribePiiEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribePiiEntitiesDetectionJob481Example: summary: Default DescribePiiEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribePiiEntitiesDetectionJob482Example: summary: Default DescribePiiEntitiesDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribePiiEntitiesDetectionJob483Example: summary: Default DescribePiiEntitiesDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribePiiEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribePiiEntitiesDetectionJob summary: Amazon Comprehend Describe Pii Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeResourcePolicy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeResourcePolicy description: Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeResourcePolicyResponse' examples: DescribeResourcePolicy200Example: summary: Default DescribeResourcePolicy 200 x-microcks-default: true value: ResourcePolicy: example CreationTime: example LastModifiedTime: example PolicyRevisionId: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeResourcePolicy480Example: summary: Default DescribeResourcePolicy 480 x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeResourcePolicy481Example: summary: Default DescribeResourcePolicy 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeResourcePolicy482Example: summary: Default DescribeResourcePolicy 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeResourcePolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeResourcePolicy summary: Amazon Comprehend Describe Resource Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeSentimentDetectionJob description: Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSentimentDetectionJobResponse' examples: DescribeSentimentDetectionJob200Example: summary: Default DescribeSentimentDetectionJob 200 x-microcks-default: true value: SentimentDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeSentimentDetectionJob480Example: summary: Default DescribeSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeSentimentDetectionJob481Example: summary: Default DescribeSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeSentimentDetectionJob482Example: summary: Default DescribeSentimentDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeSentimentDetectionJob483Example: summary: Default DescribeSentimentDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeSentimentDetectionJob summary: Amazon Comprehend Describe Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeTargetedSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeTargetedSentimentDetectionJob description: Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeTargetedSentimentDetectionJobResponse' examples: DescribeTargetedSentimentDetectionJob200Example: summary: Default DescribeTargetedSentimentDetectionJob 200 x-microcks-default: true value: TargetedSentimentDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeTargetedSentimentDetectionJob480Example: summary: Default DescribeTargetedSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeTargetedSentimentDetectionJob481Example: summary: Default DescribeTargetedSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeTargetedSentimentDetectionJob482Example: summary: Default DescribeTargetedSentimentDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeTargetedSentimentDetectionJob483Example: summary: Default DescribeTargetedSentimentDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeTargetedSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeTargetedSentimentDetectionJob summary: Amazon Comprehend Describe Targeted Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DescribeTopicsDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeTopicsDetectionJob description: Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeTopicsDetectionJobResponse' examples: DescribeTopicsDetectionJob200Example: summary: Default DescribeTopicsDetectionJob 200 x-microcks-default: true value: TopicsDetectionJobProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeTopicsDetectionJob480Example: summary: Default DescribeTopicsDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: DescribeTopicsDetectionJob481Example: summary: Default DescribeTopicsDetectionJob 481 x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeTopicsDetectionJob482Example: summary: Default DescribeTopicsDetectionJob 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeTopicsDetectionJob483Example: summary: Default DescribeTopicsDetectionJob 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeTopicsDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DescribeTopicsDetectionJob summary: Amazon Comprehend Describe Topics Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectDominantLanguage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectDominantLanguage description: Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectDominantLanguageResponse' examples: DetectDominantLanguage200Example: summary: Default DetectDominantLanguage 200 x-microcks-default: true value: Languages: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectDominantLanguage480Example: summary: Default DetectDominantLanguage 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectDominantLanguage481Example: summary: Default DetectDominantLanguage 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectDominantLanguage482Example: summary: Default DetectDominantLanguage 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectDominantLanguageRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectDominantLanguage summary: Amazon Comprehend Detect Dominant Language x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectEntities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectEntities description: 'Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model. When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide. When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image). If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error. If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectEntitiesResponse' examples: DetectEntities200Example: summary: Default DetectEntities 200 x-microcks-default: true value: Entities: example DocumentMetadata: example DocumentType: example Blocks: example Errors: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectEntities480Example: summary: Default DetectEntities 480 x-microcks-default: true value: example '481': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: DetectEntities481Example: summary: Default DetectEntities 481 x-microcks-default: true value: example '482': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectEntities482Example: summary: Default DetectEntities 482 x-microcks-default: true value: example '483': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectEntities483Example: summary: Default DetectEntities 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectEntities484Example: summary: Default DetectEntities 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectEntitiesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectEntities summary: Amazon Comprehend Detect Entities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectKeyPhrases: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectKeyPhrases description: Detects the key noun phrases found in the text. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectKeyPhrasesResponse' examples: DetectKeyPhrases200Example: summary: Default DetectKeyPhrases 200 x-microcks-default: true value: KeyPhrases: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectKeyPhrases480Example: summary: Default DetectKeyPhrases 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectKeyPhrases481Example: summary: Default DetectKeyPhrases 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectKeyPhrases482Example: summary: Default DetectKeyPhrases 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectKeyPhrases483Example: summary: Default DetectKeyPhrases 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectKeyPhrasesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectKeyPhrases summary: Amazon Comprehend Detect Key Phrases x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectPiiEntities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectPiiEntities description: Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectPiiEntitiesResponse' examples: DetectPiiEntities200Example: summary: Default DetectPiiEntities 200 x-microcks-default: true value: Entities: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectPiiEntities480Example: summary: Default DetectPiiEntities 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectPiiEntities481Example: summary: Default DetectPiiEntities 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectPiiEntities482Example: summary: Default DetectPiiEntities 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectPiiEntities483Example: summary: Default DetectPiiEntities 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectPiiEntitiesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectPiiEntities summary: Amazon Comprehend Detect Pii Entities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectSentiment: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectSentiment description: Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE). responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectSentimentResponse' examples: DetectSentiment200Example: summary: Default DetectSentiment 200 x-microcks-default: true value: Sentiment: example SentimentScore: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectSentiment480Example: summary: Default DetectSentiment 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectSentiment481Example: summary: Default DetectSentiment 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectSentiment482Example: summary: Default DetectSentiment 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectSentiment483Example: summary: Default DetectSentiment 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectSentimentRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectSentiment summary: Amazon Comprehend Detect Sentiment x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectSyntax: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectSyntax description: Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectSyntaxResponse' examples: DetectSyntax200Example: summary: Default DetectSyntax 200 x-microcks-default: true value: SyntaxTokens: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectSyntax480Example: summary: Default DetectSyntax 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectSyntax481Example: summary: Default DetectSyntax 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectSyntax482Example: summary: Default DetectSyntax 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectSyntax483Example: summary: Default DetectSyntax 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectSyntaxRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectSyntax summary: Amazon Comprehend Detect Syntax x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.DetectTargetedSentiment: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DetectTargetedSentiment description: 'Inspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DetectTargetedSentimentResponse' examples: DetectTargetedSentiment200Example: summary: Default DetectTargetedSentiment 200 x-microcks-default: true value: Entities: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DetectTargetedSentiment480Example: summary: Default DetectTargetedSentiment 480 x-microcks-default: true value: example '481': description: TextSizeLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TextSizeLimitExceededException' examples: DetectTargetedSentiment481Example: summary: Default DetectTargetedSentiment 481 x-microcks-default: true value: example '482': description: UnsupportedLanguageException content: application/json: schema: $ref: '#/components/schemas/UnsupportedLanguageException' examples: DetectTargetedSentiment482Example: summary: Default DetectTargetedSentiment 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DetectTargetedSentiment483Example: summary: Default DetectTargetedSentiment 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DetectTargetedSentimentRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.DetectTargetedSentiment summary: Amazon Comprehend Detect Targeted Sentiment x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ImportModel: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ImportModel description: 'Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you''re using when you import. You can''t import a model that''s in a different Region.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ImportModelResponse' examples: ImportModel200Example: summary: Default ImportModel 200 x-microcks-default: true value: ModelArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ImportModel480Example: summary: Default ImportModel 480 x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ImportModel481Example: summary: Default ImportModel 481 x-microcks-default: true value: example '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: ImportModel482Example: summary: Default ImportModel 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: ImportModel483Example: summary: Default ImportModel 483 x-microcks-default: true value: example '484': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: ImportModel484Example: summary: Default ImportModel 484 x-microcks-default: true value: example '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ImportModel485Example: summary: Default ImportModel 485 x-microcks-default: true value: example '486': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: ImportModel486Example: summary: Default ImportModel 486 x-microcks-default: true value: example '487': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: ImportModel487Example: summary: Default ImportModel 487 x-microcks-default: true value: example '488': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ImportModel488Example: summary: Default ImportModel 488 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ImportModelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ImportModel summary: Amazon Comprehend Import Model x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListDatasets: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListDatasets description: List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' examples: ListDatasets200Example: summary: Default ListDatasets 200 x-microcks-default: true value: DatasetPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListDatasets480Example: summary: Default ListDatasets 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListDatasets481Example: summary: Default ListDatasets 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListDatasets482Example: summary: Default ListDatasets 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListDatasets483Example: summary: Default ListDatasets 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListDatasets484Example: summary: Default ListDatasets 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDatasetsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListDatasets summary: Amazon Comprehend List Datasets x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListDocumentClassificationJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListDocumentClassificationJobs description: Gets a list of the documentation classification jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassificationJobsResponse' examples: ListDocumentClassificationJobs200Example: summary: Default ListDocumentClassificationJobs 200 x-microcks-default: true value: DocumentClassificationJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListDocumentClassificationJobs480Example: summary: Default ListDocumentClassificationJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListDocumentClassificationJobs481Example: summary: Default ListDocumentClassificationJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListDocumentClassificationJobs482Example: summary: Default ListDocumentClassificationJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListDocumentClassificationJobs483Example: summary: Default ListDocumentClassificationJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassificationJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListDocumentClassificationJobs summary: Amazon Comprehend List Document Classification Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListDocumentClassifierSummaries: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListDocumentClassifierSummaries description: Gets a list of summaries of the document classifiers that you have created responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassifierSummariesResponse' examples: ListDocumentClassifierSummaries200Example: summary: Default ListDocumentClassifierSummaries 200 x-microcks-default: true value: DocumentClassifierSummariesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListDocumentClassifierSummaries480Example: summary: Default ListDocumentClassifierSummaries 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListDocumentClassifierSummaries481Example: summary: Default ListDocumentClassifierSummaries 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListDocumentClassifierSummaries482Example: summary: Default ListDocumentClassifierSummaries 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassifierSummariesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListDocumentClassifierSummaries summary: Amazon Comprehend List Document Classifier Summaries x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListDocumentClassifiers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListDocumentClassifiers description: Gets a list of the document classifiers that you have created. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassifiersResponse' examples: ListDocumentClassifiers200Example: summary: Default ListDocumentClassifiers 200 x-microcks-default: true value: DocumentClassifierPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListDocumentClassifiers480Example: summary: Default ListDocumentClassifiers 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListDocumentClassifiers481Example: summary: Default ListDocumentClassifiers 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListDocumentClassifiers482Example: summary: Default ListDocumentClassifiers 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListDocumentClassifiers483Example: summary: Default ListDocumentClassifiers 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDocumentClassifiersRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListDocumentClassifiers summary: Amazon Comprehend List Document Classifiers x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListDominantLanguageDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListDominantLanguageDetectionJobs description: Gets a list of the dominant language detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDominantLanguageDetectionJobsResponse' examples: ListDominantLanguageDetectionJobs200Example: summary: Default ListDominantLanguageDetectionJobs 200 x-microcks-default: true value: DominantLanguageDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListDominantLanguageDetectionJobs480Example: summary: Default ListDominantLanguageDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListDominantLanguageDetectionJobs481Example: summary: Default ListDominantLanguageDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListDominantLanguageDetectionJobs482Example: summary: Default ListDominantLanguageDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListDominantLanguageDetectionJobs483Example: summary: Default ListDominantLanguageDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListDominantLanguageDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListDominantLanguageDetectionJobs summary: Amazon Comprehend List Dominant Language Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListEndpoints: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEndpoints description: Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEndpointsResponse' examples: ListEndpoints200Example: summary: Default ListEndpoints 200 x-microcks-default: true value: EndpointPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListEndpoints480Example: summary: Default ListEndpoints 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListEndpoints481Example: summary: Default ListEndpoints 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListEndpoints482Example: summary: Default ListEndpoints 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListEndpointsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListEndpoints summary: Amazon Comprehend List Endpoints x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListEntitiesDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEntitiesDetectionJobs description: Gets a list of the entity detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEntitiesDetectionJobsResponse' examples: ListEntitiesDetectionJobs200Example: summary: Default ListEntitiesDetectionJobs 200 x-microcks-default: true value: EntitiesDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListEntitiesDetectionJobs480Example: summary: Default ListEntitiesDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListEntitiesDetectionJobs481Example: summary: Default ListEntitiesDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListEntitiesDetectionJobs482Example: summary: Default ListEntitiesDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListEntitiesDetectionJobs483Example: summary: Default ListEntitiesDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListEntitiesDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListEntitiesDetectionJobs summary: Amazon Comprehend List Entities Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListEntityRecognizerSummaries: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEntityRecognizerSummaries description: Gets a list of summaries for the entity recognizers that you have created. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEntityRecognizerSummariesResponse' examples: ListEntityRecognizerSummaries200Example: summary: Default ListEntityRecognizerSummaries 200 x-microcks-default: true value: EntityRecognizerSummariesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListEntityRecognizerSummaries480Example: summary: Default ListEntityRecognizerSummaries 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListEntityRecognizerSummaries481Example: summary: Default ListEntityRecognizerSummaries 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListEntityRecognizerSummaries482Example: summary: Default ListEntityRecognizerSummaries 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListEntityRecognizerSummariesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListEntityRecognizerSummaries summary: Amazon Comprehend List Entity Recognizer Summaries x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListEntityRecognizers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEntityRecognizers description: 'Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEntityRecognizersResponse' examples: ListEntityRecognizers200Example: summary: Default ListEntityRecognizers 200 x-microcks-default: true value: EntityRecognizerPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListEntityRecognizers480Example: summary: Default ListEntityRecognizers 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListEntityRecognizers481Example: summary: Default ListEntityRecognizers 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListEntityRecognizers482Example: summary: Default ListEntityRecognizers 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListEntityRecognizers483Example: summary: Default ListEntityRecognizers 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListEntityRecognizersRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListEntityRecognizers summary: Amazon Comprehend List Entity Recognizers x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListEventsDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEventsDetectionJobs description: Gets a list of the events detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEventsDetectionJobsResponse' examples: ListEventsDetectionJobs200Example: summary: Default ListEventsDetectionJobs 200 x-microcks-default: true value: EventsDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListEventsDetectionJobs480Example: summary: Default ListEventsDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListEventsDetectionJobs481Example: summary: Default ListEventsDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListEventsDetectionJobs482Example: summary: Default ListEventsDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListEventsDetectionJobs483Example: summary: Default ListEventsDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListEventsDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListEventsDetectionJobs summary: Amazon Comprehend List Events Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListFlywheelIterationHistory: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListFlywheelIterationHistory description: Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFlywheelIterationHistoryResponse' examples: ListFlywheelIterationHistory200Example: summary: Default ListFlywheelIterationHistory 200 x-microcks-default: true value: FlywheelIterationPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListFlywheelIterationHistory480Example: summary: Default ListFlywheelIterationHistory 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListFlywheelIterationHistory481Example: summary: Default ListFlywheelIterationHistory 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListFlywheelIterationHistory482Example: summary: Default ListFlywheelIterationHistory 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListFlywheelIterationHistory483Example: summary: Default ListFlywheelIterationHistory 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListFlywheelIterationHistory484Example: summary: Default ListFlywheelIterationHistory 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListFlywheelIterationHistoryRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListFlywheelIterationHistory summary: Amazon Comprehend List Flywheel Iteration History x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListFlywheels: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListFlywheels description: Gets a list of the flywheels that you have created. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFlywheelsResponse' examples: ListFlywheels200Example: summary: Default ListFlywheels 200 x-microcks-default: true value: FlywheelSummaryList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListFlywheels480Example: summary: Default ListFlywheels 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListFlywheels481Example: summary: Default ListFlywheels 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListFlywheels482Example: summary: Default ListFlywheels 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListFlywheels483Example: summary: Default ListFlywheels 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListFlywheelsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListFlywheels summary: Amazon Comprehend List Flywheels x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListKeyPhrasesDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListKeyPhrasesDetectionJobs description: Get a list of key phrase detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListKeyPhrasesDetectionJobsResponse' examples: ListKeyPhrasesDetectionJobs200Example: summary: Default ListKeyPhrasesDetectionJobs 200 x-microcks-default: true value: KeyPhrasesDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListKeyPhrasesDetectionJobs480Example: summary: Default ListKeyPhrasesDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListKeyPhrasesDetectionJobs481Example: summary: Default ListKeyPhrasesDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListKeyPhrasesDetectionJobs482Example: summary: Default ListKeyPhrasesDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListKeyPhrasesDetectionJobs483Example: summary: Default ListKeyPhrasesDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListKeyPhrasesDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListKeyPhrasesDetectionJobs summary: Amazon Comprehend List Key Phrases Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListPiiEntitiesDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListPiiEntitiesDetectionJobs description: Gets a list of the PII entity detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPiiEntitiesDetectionJobsResponse' examples: ListPiiEntitiesDetectionJobs200Example: summary: Default ListPiiEntitiesDetectionJobs 200 x-microcks-default: true value: PiiEntitiesDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListPiiEntitiesDetectionJobs480Example: summary: Default ListPiiEntitiesDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListPiiEntitiesDetectionJobs481Example: summary: Default ListPiiEntitiesDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListPiiEntitiesDetectionJobs482Example: summary: Default ListPiiEntitiesDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListPiiEntitiesDetectionJobs483Example: summary: Default ListPiiEntitiesDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListPiiEntitiesDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListPiiEntitiesDetectionJobs summary: Amazon Comprehend List Pii Entities Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListSentimentDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListSentimentDetectionJobs description: Gets a list of sentiment detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSentimentDetectionJobsResponse' examples: ListSentimentDetectionJobs200Example: summary: Default ListSentimentDetectionJobs 200 x-microcks-default: true value: SentimentDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListSentimentDetectionJobs480Example: summary: Default ListSentimentDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListSentimentDetectionJobs481Example: summary: Default ListSentimentDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListSentimentDetectionJobs482Example: summary: Default ListSentimentDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListSentimentDetectionJobs483Example: summary: Default ListSentimentDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListSentimentDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListSentimentDetectionJobs summary: Amazon Comprehend List Sentiment Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListTagsForResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTagsForResource description: Lists all tags associated with a given Amazon Comprehend resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 x-microcks-default: true value: ResourceArn: example Tags: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListTagsForResource summary: Amazon Comprehend List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListTargetedSentimentDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTargetedSentimentDetectionJobs description: Gets a list of targeted sentiment detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTargetedSentimentDetectionJobsResponse' examples: ListTargetedSentimentDetectionJobs200Example: summary: Default ListTargetedSentimentDetectionJobs 200 x-microcks-default: true value: TargetedSentimentDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListTargetedSentimentDetectionJobs480Example: summary: Default ListTargetedSentimentDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListTargetedSentimentDetectionJobs481Example: summary: Default ListTargetedSentimentDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListTargetedSentimentDetectionJobs482Example: summary: Default ListTargetedSentimentDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListTargetedSentimentDetectionJobs483Example: summary: Default ListTargetedSentimentDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTargetedSentimentDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListTargetedSentimentDetectionJobs summary: Amazon Comprehend List Targeted Sentiment Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.ListTopicsDetectionJobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTopicsDetectionJobs description: Gets a list of the topic detection jobs that you have submitted. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTopicsDetectionJobsResponse' examples: ListTopicsDetectionJobs200Example: summary: Default ListTopicsDetectionJobs 200 x-microcks-default: true value: TopicsDetectionJobPropertiesList: example NextToken: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: ListTopicsDetectionJobs480Example: summary: Default ListTopicsDetectionJobs 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListTopicsDetectionJobs481Example: summary: Default ListTopicsDetectionJobs 481 x-microcks-default: true value: example '482': description: InvalidFilterException content: application/json: schema: $ref: '#/components/schemas/InvalidFilterException' examples: ListTopicsDetectionJobs482Example: summary: Default ListTopicsDetectionJobs 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListTopicsDetectionJobs483Example: summary: Default ListTopicsDetectionJobs 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTopicsDetectionJobsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.ListTopicsDetectionJobs summary: Amazon Comprehend List Topics Detection Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.PutResourcePolicy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: PutResourcePolicy description: Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutResourcePolicyResponse' examples: PutResourcePolicy200Example: summary: Default PutResourcePolicy 200 x-microcks-default: true value: PolicyRevisionId: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: PutResourcePolicy480Example: summary: Default PutResourcePolicy 480 x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PutResourcePolicy481Example: summary: Default PutResourcePolicy 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PutResourcePolicy482Example: summary: Default PutResourcePolicy 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutResourcePolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.PutResourcePolicy summary: Amazon Comprehend Put Resource Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartDocumentClassificationJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartDocumentClassificationJob description: Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartDocumentClassificationJobResponse' examples: StartDocumentClassificationJob200Example: summary: Default StartDocumentClassificationJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example DocumentClassifierArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartDocumentClassificationJob480Example: summary: Default StartDocumentClassificationJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartDocumentClassificationJob481Example: summary: Default StartDocumentClassificationJob 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StartDocumentClassificationJob482Example: summary: Default StartDocumentClassificationJob 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: StartDocumentClassificationJob483Example: summary: Default StartDocumentClassificationJob 483 x-microcks-default: true value: example '484': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartDocumentClassificationJob484Example: summary: Default StartDocumentClassificationJob 484 x-microcks-default: true value: example '485': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartDocumentClassificationJob485Example: summary: Default StartDocumentClassificationJob 485 x-microcks-default: true value: example '486': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartDocumentClassificationJob486Example: summary: Default StartDocumentClassificationJob 486 x-microcks-default: true value: example '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartDocumentClassificationJob487Example: summary: Default StartDocumentClassificationJob 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartDocumentClassificationJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartDocumentClassificationJob summary: Amazon Comprehend Start Document Classification Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartDominantLanguageDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartDominantLanguageDetectionJob description: Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartDominantLanguageDetectionJobResponse' examples: StartDominantLanguageDetectionJob200Example: summary: Default StartDominantLanguageDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartDominantLanguageDetectionJob480Example: summary: Default StartDominantLanguageDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartDominantLanguageDetectionJob481Example: summary: Default StartDominantLanguageDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartDominantLanguageDetectionJob482Example: summary: Default StartDominantLanguageDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartDominantLanguageDetectionJob483Example: summary: Default StartDominantLanguageDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartDominantLanguageDetectionJob484Example: summary: Default StartDominantLanguageDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartDominantLanguageDetectionJob485Example: summary: Default StartDominantLanguageDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartDominantLanguageDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartDominantLanguageDetectionJob summary: Amazon Comprehend Start Dominant Language Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartEntitiesDetectionJob description: 'Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartEntitiesDetectionJobResponse' examples: StartEntitiesDetectionJob200Example: summary: Default StartEntitiesDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example EntityRecognizerArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartEntitiesDetectionJob480Example: summary: Default StartEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartEntitiesDetectionJob481Example: summary: Default StartEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StartEntitiesDetectionJob482Example: summary: Default StartEntitiesDetectionJob 482 x-microcks-default: true value: example '483': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: StartEntitiesDetectionJob483Example: summary: Default StartEntitiesDetectionJob 483 x-microcks-default: true value: example '484': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartEntitiesDetectionJob484Example: summary: Default StartEntitiesDetectionJob 484 x-microcks-default: true value: example '485': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartEntitiesDetectionJob485Example: summary: Default StartEntitiesDetectionJob 485 x-microcks-default: true value: example '486': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartEntitiesDetectionJob486Example: summary: Default StartEntitiesDetectionJob 486 x-microcks-default: true value: example '487': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartEntitiesDetectionJob487Example: summary: Default StartEntitiesDetectionJob 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartEntitiesDetectionJob summary: Amazon Comprehend Start Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartEventsDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartEventsDetectionJob description: Starts an asynchronous event detection job for a collection of documents. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartEventsDetectionJobResponse' examples: StartEventsDetectionJob200Example: summary: Default StartEventsDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartEventsDetectionJob480Example: summary: Default StartEventsDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartEventsDetectionJob481Example: summary: Default StartEventsDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartEventsDetectionJob482Example: summary: Default StartEventsDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartEventsDetectionJob483Example: summary: Default StartEventsDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartEventsDetectionJob484Example: summary: Default StartEventsDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartEventsDetectionJob485Example: summary: Default StartEventsDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartEventsDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartEventsDetectionJob summary: Amazon Comprehend Start Events Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartFlywheelIteration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartFlywheelIteration description: Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartFlywheelIterationResponse' examples: StartFlywheelIteration200Example: summary: Default StartFlywheelIteration 200 x-microcks-default: true value: FlywheelArn: example FlywheelIterationId: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartFlywheelIteration480Example: summary: Default StartFlywheelIteration 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartFlywheelIteration481Example: summary: Default StartFlywheelIteration 481 x-microcks-default: true value: example '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartFlywheelIteration482Example: summary: Default StartFlywheelIteration 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StartFlywheelIteration483Example: summary: Default StartFlywheelIteration 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartFlywheelIteration484Example: summary: Default StartFlywheelIteration 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartFlywheelIterationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartFlywheelIteration summary: Amazon Comprehend Start Flywheel Iteration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartKeyPhrasesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartKeyPhrasesDetectionJob description: Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartKeyPhrasesDetectionJobResponse' examples: StartKeyPhrasesDetectionJob200Example: summary: Default StartKeyPhrasesDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartKeyPhrasesDetectionJob480Example: summary: Default StartKeyPhrasesDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartKeyPhrasesDetectionJob481Example: summary: Default StartKeyPhrasesDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartKeyPhrasesDetectionJob482Example: summary: Default StartKeyPhrasesDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartKeyPhrasesDetectionJob483Example: summary: Default StartKeyPhrasesDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartKeyPhrasesDetectionJob484Example: summary: Default StartKeyPhrasesDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartKeyPhrasesDetectionJob485Example: summary: Default StartKeyPhrasesDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartKeyPhrasesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartKeyPhrasesDetectionJob summary: Amazon Comprehend Start Key Phrases Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartPiiEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartPiiEntitiesDetectionJob description: Starts an asynchronous PII entity detection job for a collection of documents. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartPiiEntitiesDetectionJobResponse' examples: StartPiiEntitiesDetectionJob200Example: summary: Default StartPiiEntitiesDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartPiiEntitiesDetectionJob480Example: summary: Default StartPiiEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartPiiEntitiesDetectionJob481Example: summary: Default StartPiiEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartPiiEntitiesDetectionJob482Example: summary: Default StartPiiEntitiesDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartPiiEntitiesDetectionJob483Example: summary: Default StartPiiEntitiesDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartPiiEntitiesDetectionJob484Example: summary: Default StartPiiEntitiesDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartPiiEntitiesDetectionJob485Example: summary: Default StartPiiEntitiesDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartPiiEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartPiiEntitiesDetectionJob summary: Amazon Comprehend Start Pii Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartSentimentDetectionJob description: Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartSentimentDetectionJobResponse' examples: StartSentimentDetectionJob200Example: summary: Default StartSentimentDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartSentimentDetectionJob480Example: summary: Default StartSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartSentimentDetectionJob481Example: summary: Default StartSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartSentimentDetectionJob482Example: summary: Default StartSentimentDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartSentimentDetectionJob483Example: summary: Default StartSentimentDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartSentimentDetectionJob484Example: summary: Default StartSentimentDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartSentimentDetectionJob485Example: summary: Default StartSentimentDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartSentimentDetectionJob summary: Amazon Comprehend Start Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartTargetedSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartTargetedSentimentDetectionJob description: Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartTargetedSentimentDetectionJobResponse' examples: StartTargetedSentimentDetectionJob200Example: summary: Default StartTargetedSentimentDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartTargetedSentimentDetectionJob480Example: summary: Default StartTargetedSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartTargetedSentimentDetectionJob481Example: summary: Default StartTargetedSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartTargetedSentimentDetectionJob482Example: summary: Default StartTargetedSentimentDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartTargetedSentimentDetectionJob483Example: summary: Default StartTargetedSentimentDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartTargetedSentimentDetectionJob484Example: summary: Default StartTargetedSentimentDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartTargetedSentimentDetectionJob485Example: summary: Default StartTargetedSentimentDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartTargetedSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartTargetedSentimentDetectionJob summary: Amazon Comprehend Start Targeted Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StartTopicsDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartTopicsDetectionJob description: Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartTopicsDetectionJobResponse' examples: StartTopicsDetectionJob200Example: summary: Default StartTopicsDetectionJob 200 x-microcks-default: true value: JobId: example JobArn: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StartTopicsDetectionJob480Example: summary: Default StartTopicsDetectionJob 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StartTopicsDetectionJob481Example: summary: Default StartTopicsDetectionJob 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: StartTopicsDetectionJob482Example: summary: Default StartTopicsDetectionJob 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: StartTopicsDetectionJob483Example: summary: Default StartTopicsDetectionJob 483 x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: StartTopicsDetectionJob484Example: summary: Default StartTopicsDetectionJob 484 x-microcks-default: true value: example '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartTopicsDetectionJob485Example: summary: Default StartTopicsDetectionJob 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartTopicsDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StartTopicsDetectionJob summary: Amazon Comprehend Start Topics Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopDominantLanguageDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopDominantLanguageDetectionJob description: 'Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopDominantLanguageDetectionJobResponse' examples: StopDominantLanguageDetectionJob200Example: summary: Default StopDominantLanguageDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopDominantLanguageDetectionJob480Example: summary: Default StopDominantLanguageDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopDominantLanguageDetectionJob481Example: summary: Default StopDominantLanguageDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopDominantLanguageDetectionJob482Example: summary: Default StopDominantLanguageDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopDominantLanguageDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopDominantLanguageDetectionJob summary: Amazon Comprehend Stop Dominant Language Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopEntitiesDetectionJob description: 'Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopEntitiesDetectionJobResponse' examples: StopEntitiesDetectionJob200Example: summary: Default StopEntitiesDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopEntitiesDetectionJob480Example: summary: Default StopEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopEntitiesDetectionJob481Example: summary: Default StopEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopEntitiesDetectionJob482Example: summary: Default StopEntitiesDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopEntitiesDetectionJob summary: Amazon Comprehend Stop Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopEventsDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopEventsDetectionJob description: Stops an events detection job in progress. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopEventsDetectionJobResponse' examples: StopEventsDetectionJob200Example: summary: Default StopEventsDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopEventsDetectionJob480Example: summary: Default StopEventsDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopEventsDetectionJob481Example: summary: Default StopEventsDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopEventsDetectionJob482Example: summary: Default StopEventsDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopEventsDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopEventsDetectionJob summary: Amazon Comprehend Stop Events Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopKeyPhrasesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopKeyPhrasesDetectionJob description: 'Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopKeyPhrasesDetectionJobResponse' examples: StopKeyPhrasesDetectionJob200Example: summary: Default StopKeyPhrasesDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopKeyPhrasesDetectionJob480Example: summary: Default StopKeyPhrasesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopKeyPhrasesDetectionJob481Example: summary: Default StopKeyPhrasesDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopKeyPhrasesDetectionJob482Example: summary: Default StopKeyPhrasesDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopKeyPhrasesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopKeyPhrasesDetectionJob summary: Amazon Comprehend Stop Key Phrases Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopPiiEntitiesDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopPiiEntitiesDetectionJob description: Stops a PII entities detection job in progress. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopPiiEntitiesDetectionJobResponse' examples: StopPiiEntitiesDetectionJob200Example: summary: Default StopPiiEntitiesDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopPiiEntitiesDetectionJob480Example: summary: Default StopPiiEntitiesDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopPiiEntitiesDetectionJob481Example: summary: Default StopPiiEntitiesDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopPiiEntitiesDetectionJob482Example: summary: Default StopPiiEntitiesDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopPiiEntitiesDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopPiiEntitiesDetectionJob summary: Amazon Comprehend Stop Pii Entities Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopSentimentDetectionJob description: 'Stops a sentiment detection job in progress. If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopSentimentDetectionJobResponse' examples: StopSentimentDetectionJob200Example: summary: Default StopSentimentDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopSentimentDetectionJob480Example: summary: Default StopSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopSentimentDetectionJob481Example: summary: Default StopSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopSentimentDetectionJob482Example: summary: Default StopSentimentDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopSentimentDetectionJob summary: Amazon Comprehend Stop Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopTargetedSentimentDetectionJob: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopTargetedSentimentDetectionJob description: 'Stops a targeted sentiment detection job in progress. If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopTargetedSentimentDetectionJobResponse' examples: StopTargetedSentimentDetectionJob200Example: summary: Default StopTargetedSentimentDetectionJob 200 x-microcks-default: true value: JobId: example JobStatus: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopTargetedSentimentDetectionJob480Example: summary: Default StopTargetedSentimentDetectionJob 480 x-microcks-default: true value: example '481': description: JobNotFoundException content: application/json: schema: $ref: '#/components/schemas/JobNotFoundException' examples: StopTargetedSentimentDetectionJob481Example: summary: Default StopTargetedSentimentDetectionJob 481 x-microcks-default: true value: example '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopTargetedSentimentDetectionJob482Example: summary: Default StopTargetedSentimentDetectionJob 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopTargetedSentimentDetectionJobRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopTargetedSentimentDetectionJob summary: Amazon Comprehend Stop Targeted Sentiment Detection Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopTrainingDocumentClassifier: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopTrainingDocumentClassifier description: 'Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopTrainingDocumentClassifierResponse' examples: StopTrainingDocumentClassifier200Example: summary: Default StopTrainingDocumentClassifier 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopTrainingDocumentClassifier480Example: summary: Default StopTrainingDocumentClassifier 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StopTrainingDocumentClassifier481Example: summary: Default StopTrainingDocumentClassifier 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StopTrainingDocumentClassifier482Example: summary: Default StopTrainingDocumentClassifier 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopTrainingDocumentClassifier483Example: summary: Default StopTrainingDocumentClassifier 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopTrainingDocumentClassifierRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopTrainingDocumentClassifier summary: Amazon Comprehend Stop Training Document Classifier x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.StopTrainingEntityRecognizer: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StopTrainingEntityRecognizer description: 'Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopTrainingEntityRecognizerResponse' examples: StopTrainingEntityRecognizer200Example: summary: Default StopTrainingEntityRecognizer 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: StopTrainingEntityRecognizer480Example: summary: Default StopTrainingEntityRecognizer 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: StopTrainingEntityRecognizer481Example: summary: Default StopTrainingEntityRecognizer 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StopTrainingEntityRecognizer482Example: summary: Default StopTrainingEntityRecognizer 482 x-microcks-default: true value: example '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StopTrainingEntityRecognizer483Example: summary: Default StopTrainingEntityRecognizer 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopTrainingEntityRecognizerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.StopTrainingEntityRecognizer summary: Amazon Comprehend Stop Training Entity Recognizer x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.TagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' examples: TagResource200Example: summary: Default TagResource 200 x-microcks-default: true value: {} '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: TagResource480Example: summary: Default TagResource 480 x-microcks-default: true value: example '481': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: TagResource481Example: summary: Default TagResource 481 x-microcks-default: true value: example '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: TagResource482Example: summary: Default TagResource 482 x-microcks-default: true value: example '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' examples: TagResource483Example: summary: Default TagResource 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: TagResource484Example: summary: Default TagResource 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.TagResource summary: Amazon Comprehend Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.UntagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UntagResource description: Removes a specific tag associated with an Amazon Comprehend resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' examples: UntagResource200Example: summary: Default UntagResource 200 x-microcks-default: true value: {} '480': description: TooManyTagKeysException content: application/json: schema: $ref: '#/components/schemas/TooManyTagKeysException' examples: UntagResource480Example: summary: Default UntagResource 480 x-microcks-default: true value: example '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: UntagResource481Example: summary: Default UntagResource 481 x-microcks-default: true value: example '482': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UntagResource482Example: summary: Default UntagResource 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UntagResource483Example: summary: Default UntagResource 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UntagResource484Example: summary: Default UntagResource 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.UntagResource summary: Amazon Comprehend Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.UpdateEndpoint: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateEndpoint description: Updates information about the specified endpoint. For information about endpoints, see Managing endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointResponse' examples: UpdateEndpoint200Example: summary: Default UpdateEndpoint 200 x-microcks-default: true value: DesiredModelArn: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: UpdateEndpoint480Example: summary: Default UpdateEndpoint 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateEndpoint481Example: summary: Default UpdateEndpoint 481 x-microcks-default: true value: example '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: UpdateEndpoint482Example: summary: Default UpdateEndpoint 482 x-microcks-default: true value: example '483': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' examples: UpdateEndpoint483Example: summary: Default UpdateEndpoint 483 x-microcks-default: true value: example '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateEndpoint484Example: summary: Default UpdateEndpoint 484 x-microcks-default: true value: example '485': description: ResourceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ResourceUnavailableException' examples: UpdateEndpoint485Example: summary: Default UpdateEndpoint 485 x-microcks-default: true value: example '486': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdateEndpoint486Example: summary: Default UpdateEndpoint 486 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.UpdateEndpoint summary: Amazon Comprehend Update Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend /#X-Amz-Target=Comprehend_20171127.UpdateFlywheel: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateFlywheel description: Update the configuration information for an existing flywheel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFlywheelResponse' examples: UpdateFlywheel200Example: summary: Default UpdateFlywheel 200 x-microcks-default: true value: FlywheelProperties: example '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: UpdateFlywheel480Example: summary: Default UpdateFlywheel 480 x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateFlywheel481Example: summary: Default UpdateFlywheel 481 x-microcks-default: true value: example '482': description: KmsKeyValidationException content: application/json: schema: $ref: '#/components/schemas/KmsKeyValidationException' examples: UpdateFlywheel482Example: summary: Default UpdateFlywheel 482 x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateFlywheel483Example: summary: Default UpdateFlywheel 483 x-microcks-default: true value: example '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdateFlywheel484Example: summary: Default UpdateFlywheel 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFlywheelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - Comprehend_20171127.UpdateFlywheel summary: Amazon Comprehend Update Flywheel x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Comprehend components: schemas: DeleteEndpointResponse: type: object properties: {} DescribeEntityRecognizerResponse: type: object properties: EntityRecognizerProperties: allOf: - $ref: '#/components/schemas/EntityRecognizerProperties' - description: Describes information associated with an entity recognizer. TagKey: type: string minLength: 1 maxLength: 128 ConcurrentModificationException: {} EntitiesDetectionJobPropertiesList: type: array items: $ref: '#/components/schemas/EntitiesDetectionJobProperties' DeleteEntityRecognizerRequest: type: object required: - EntityRecognizerArn title: DeleteEntityRecognizerRequest properties: EntityRecognizerArn: allOf: - $ref: '#/components/schemas/EntityRecognizerArn' - description: The Amazon Resource Name (ARN) that identifies the entity recognizer. ComprehendArn: type: string pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))? maxLength: 256 StopDominantLanguageDetectionJobRequest: type: object required: - JobId title: StopDominantLanguageDetectionJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier of the dominant language detection job to stop. FlywheelIterationFilter: type: object properties: CreationTimeAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filter the flywheel iterations to include iterations created after the specified time. CreationTimeBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filter the flywheel iterations to include iterations created before the specified time. description: Filter the flywheel iterations based on creation time. ListOfMentions: type: array items: $ref: '#/components/schemas/TargetedSentimentMention' EntitiesDetectionJobProperties: type: object properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier assigned to the entities detection job. JobArn: allOf: - $ref: '#/components/schemas/ComprehendArn' - description:
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Message field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the entities detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the entities detection job completed
EntityRecognizerArn:
allOf:
- $ref: '#/components/schemas/EntityRecognizerArn'
- description: The Amazon Resource Name (ARN) that identifies the entity recognizer.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration that you supplied when you created the entities detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: 'The output data configuration that you supplied when you created the entities detection job. '
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language code of the input documents.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ListTargetedSentimentDetectionJobs operation.
Geometry:
type: object
properties:
BoundingBox:
allOf:
- $ref: '#/components/schemas/BoundingBox'
- description: An axis-aligned coarse representation of the location of the recognized item on the document page.
Polygon:
allOf:
- $ref: '#/components/schemas/Polygon'
- description: Within the bounding box, a fine-grained polygon around the recognized item.
description: Information about the location of items on a document page.
For additional information, see Geometry in the Amazon Textract API reference.
DominantLanguageDetectionJobPropertiesList: type: array items: $ref: '#/components/schemas/DominantLanguageDetectionJobProperties' ImportModelRequest: type: object required: - SourceModelArn title: ImportModelRequest properties: SourceModelArn: allOf: - $ref: '#/components/schemas/ComprehendModelArn' - description: The Amazon Resource Name (ARN) of the custom model to import. ModelName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: The name to assign to the custom model that is created in Amazon Comprehend by this import. VersionName: allOf: - $ref: '#/components/schemas/VersionName' - description: The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region. ModelKmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: 'ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.
If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Describes the dataset entity list for an entity recognizer model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
VersionName: type: string pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ maxLength: 63 DatasetStatus: type: string enum: - CREATING - COMPLETED - FAILED SubnetId: type: string pattern: '[-0-9a-zA-Z]+' minLength: 1 maxLength: 32 ComprehendEndpointArn: type: string pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])* maxLength: 256 StopKeyPhrasesDetectionJobRequest: type: object required: - JobId title: StopKeyPhrasesDetectionJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier of the key phrases detection job to stop. BlockType: type: string enum: - LINE - WORD DescribeTopicsDetectionJobResponse: type: object properties: TopicsDetectionJobProperties: allOf: - $ref: '#/components/schemas/TopicsDetectionJobProperties' - description: The list of properties for the requested job. StopEntitiesDetectionJobRequest: type: object required: - JobId title: StopEntitiesDetectionJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier of the entities detection job to stop. Tag: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: 'The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.” ' Value: allOf: - $ref: '#/components/schemas/TagValue' - description: ' The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department. ' description: 'A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department. ' JobStatus: type: string enum: - SUBMITTED - IN_PROGRESS - COMPLETED - FAILED - STOP_REQUESTED - STOPPED Subnets: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 16 DescribeDocumentClassificationJobRequest: type: object required: - JobId title: DescribeDocumentClassificationJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier that Amazon Comprehend generated for the job. TheStartDocumentClassificationJob operation returns this identifier in its response.
DetectTargetedSentimentRequest:
type: object
required:
- Text
- LanguageCode
title: DetectTargetedSentimentRequest
properties:
Text:
allOf:
- $ref: '#/components/schemas/CustomerInputString'
- description: A UTF-8 text string. The maximum string length is 5 KB.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language of the input documents. Currently, English is the only supported language.
DescribeFlywheelIterationRequest:
type: object
required:
- FlywheelArn
- FlywheelIterationId
title: DescribeFlywheelIterationRequest
properties:
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description:
FlywheelIterationId:
allOf:
- $ref: '#/components/schemas/FlywheelIterationId'
- description:
StartDocumentClassificationJobRequest:
type: object
required:
- InputDataConfig
- OutputDataConfig
- DataAccessRoleArn
title: StartDocumentClassificationJobRequest
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The identifier of the job.
DocumentClassifierArn:
allOf:
- $ref: '#/components/schemas/DocumentClassifierArn'
- description: The Amazon Resource Name (ARN) of the document classifier to use to process the job.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: Specifies the format and location of the input data for the job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: Specifies where to send the output files.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
DocumentMetadata:
type: object
properties:
Pages:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Number of pages in the document.
ExtractedCharacters:
allOf:
- $ref: '#/components/schemas/ListOfExtractedCharacters'
- description: List of pages in the document, with the number of characters extracted from each page.
description: Information about the document, discovered during text extraction.
DescribeKeyPhrasesDetectionJobRequest:
type: object
required:
- JobId
title: DescribeKeyPhrasesDetectionJobRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.
DocumentReadAction:
type: string
enum:
- TEXTRACT_DETECT_DOCUMENT_TEXT
- TEXTRACT_ANALYZE_DOCUMENT
LabelDelimiter:
type: string
pattern: ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$
minLength: 1
maxLength: 1
ListOfErrors:
type: array
items:
$ref: '#/components/schemas/ErrorsListItem'
StartSentimentDetectionJobResponse:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier generated for the job. To get the status of a job, use this identifier with the operation.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
Ready status before making inference requests.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: Specifies a reason for failure in cases of Failed status.
ModelArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
DesiredModelArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
DesiredInferenceUnits:
allOf:
- $ref: '#/components/schemas/InferenceUnitsInteger'
- description: The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
CurrentInferenceUnits:
allOf:
- $ref: '#/components/schemas/InferenceUnitsInteger'
- description: The number of inference units currently used by the model using this endpoint.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The creation date and time of the endpoint.
LastModifiedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time that the endpoint was last modified.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
DesiredDataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: Data access role ARN to use in case the new model is encrypted with a customer KMS key.
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The Amazon Resource Number (ARN) of the flywheel
description: Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
PiiEntitiesDetectionJobProperties:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned to the PII entities detection job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Message field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the PII entities detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the PII entities detection job completed.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input properties for a PII entities detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/PiiOutputDataConfig'
- description: The output data configuration that you supplied when you created the PII entities detection job.
RedactionConfig:
allOf:
- $ref: '#/components/schemas/RedactionConfig'
- description: Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.
FORMS - Returns additional information about any forms that are detected in the input document.
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
''{"attribute": "value", "attribute": ["value"]}''
ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.
DocumentClassifierArn:
type: string
pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
maxLength: 256
DocumentLabel:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the label.
Score:
allOf:
- $ref: '#/components/schemas/Float'
- description: The confidence score that Amazon Comprehend has this label correctly attributed.
Page:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter. '
description: Specifies one of the label or labels that categorize the document being analyzed.
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
ListEndpointsResponse:
type: object
properties:
EndpointPropertiesList:
allOf:
- $ref: '#/components/schemas/EndpointPropertiesList'
- description: Displays a list of endpoint properties being retrieved by the service in response to the request.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
ListOfDominantLanguages:
type: array
items:
$ref: '#/components/schemas/DominantLanguage'
ListTargetedSentimentDetectionJobsResponse:
type: object
properties:
TargetedSentimentDetectionJobPropertiesList:
allOf:
- $ref: '#/components/schemas/TargetedSentimentDetectionJobPropertiesList'
- description: A list containing the properties of each job that is returned.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
StopEventsDetectionJobResponse:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier of the events detection job to stop.
JobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The status of the events detection job.
BatchDetectEntitiesResponse:
type: object
required:
- ResultList
- ErrorList
properties:
ResultList:
allOf:
- $ref: '#/components/schemas/ListOfDetectEntitiesResult'
- description: A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
SentimentScore:
type: object
properties:
Positive:
allOf:
- $ref: '#/components/schemas/Float'
- description: The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
Negative:
allOf:
- $ref: '#/components/schemas/Float'
- description: The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
Neutral:
allOf:
- $ref: '#/components/schemas/Float'
- description: The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
Mixed:
allOf:
- $ref: '#/components/schemas/Float'
- description: The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
description: Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
EntityRecognizerAugmentedManifestsList:
type: array
items:
$ref: '#/components/schemas/AugmentedManifestsListItem'
TopicsDetectionJobProperties:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned to the topic detection job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
Failed, the reason for the failure is shown in the Message field.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description for the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the topic detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the topic detection job was completed.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration supplied when you created the topic detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: The output data configuration supplied when you created the topic detection job.
NumberOfTopics:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The number of topics to detect supplied when you created the topic detection job. The default is 10. '
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: 'The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data. '
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: ' The maximum number of results to return on each page. The default is 100.'
MaskCharacter:
type: string
pattern: '[!@#$%&*]'
minLength: 1
maxLength: 1
InputDataConfig:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
DescribeTargetedSentimentDetectionJob operation.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
StartDominantLanguageDetectionJob operation returns this identifier in its response.
ListDatasetsRequest:
type: object
title: ListDatasetsRequest
properties:
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The Amazon Resource Number (ARN) of the flywheel.
Filter:
allOf:
- $ref: '#/components/schemas/DatasetFilter'
- description: Filters the datasets to be returned in the response.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: Maximum number of results to return in a response. The default is 100.
TaskConfig:
type: object
required:
- LanguageCode
properties:
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: Language code for the language that the model supports.
DocumentClassificationConfig:
allOf:
- $ref: '#/components/schemas/DocumentClassificationConfig'
- description: Configuration required for a classification model.
EntityRecognitionConfig:
allOf:
- $ref: '#/components/schemas/EntityRecognitionConfig'
- description: Configuration required for an entity recognition model.
description: Configuration about the custom classifier associated with the flywheel.
StartFlywheelIterationRequest:
type: object
required:
- FlywheelArn
title: StartFlywheelIterationRequest
properties:
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The ARN of the flywheel.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
FlywheelIterationId:
type: string
pattern: '[0-9]{8}T[0-9]{6}Z'
maxLength: 63
UpdateEndpointRequest:
type: object
required:
- EndpointArn
title: UpdateEndpointRequest
properties:
EndpointArn:
allOf:
- $ref: '#/components/schemas/ComprehendEndpointArn'
- description: The Amazon Resource Number (ARN) of the endpoint being updated.
DesiredModelArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: The ARN of the new model to use when updating an existing endpoint.
DesiredInferenceUnits:
allOf:
- $ref: '#/components/schemas/InferenceUnitsInteger'
- description: ' The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.'
DesiredDataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: Data access role ARN to use in case the new model is encrypted with a customer CMK.
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The Amazon Resource Number (ARN) of the flywheel
EntityRecognizerSummariesList:
type: array
items:
$ref: '#/components/schemas/EntityRecognizerSummary'
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: 'The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying. '
ListOfPiiEntityTypes:
type: array
items:
$ref: '#/components/schemas/PiiEntityType'
BatchDetectSentimentResponse:
type: object
required:
- ResultList
- ErrorList
properties:
ResultList:
allOf:
- $ref: '#/components/schemas/ListOfDetectSentimentResult'
- description: A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
TopicsDetectionJobPropertiesList:
type: array
items:
$ref: '#/components/schemas/TopicsDetectionJobProperties'
DetectDominantLanguageResponse:
type: object
properties:
Languages:
allOf:
- $ref: '#/components/schemas/ListOfDominantLanguages'
- description: Array of languages that Amazon Comprehend detected in the input text. The array is sorted in descending order of the score (the dominant language is always the first element in the array).
For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
DetectPiiEntitiesRequest: type: object required: - Text - LanguageCode title: DetectPiiEntitiesRequest properties: Text: allOf: - $ref: '#/components/schemas/String' - description: A UTF-8 text string. The maximum string size is 100 KB. LanguageCode: allOf: - $ref: '#/components/schemas/LanguageCode' - description: The language of the input documents. Currently, English is the only valid language. DescribeEventsDetectionJobRequest: type: object required: - JobId title: DescribeEventsDetectionJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier of the events detection job. BatchDetectKeyPhrasesResponse: type: object required: - ResultList - ErrorList properties: ResultList: allOf: - $ref: '#/components/schemas/ListOfDetectKeyPhrasesResult' - description: A list of objects containing the results of the operation. The results are sorted in ascending order by theIndex field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
ClientRequestTokenString:
type: string
pattern: ^[a-zA-Z0-9-]+$
minLength: 1
maxLength: 64
ListDocumentClassifierSummariesResponse:
type: object
properties:
DocumentClassifierSummariesList:
allOf:
- $ref: '#/components/schemas/DocumentClassifierSummariesList'
- description: The list of summaries of document classifiers.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
FlywheelModelEvaluationMetrics:
type: object
properties:
AverageF1Score:
allOf:
- $ref: '#/components/schemas/Double'
- description: The average F1 score from the evaluation metrics.
AveragePrecision:
allOf:
- $ref: '#/components/schemas/Double'
- description: Average precision metric for the model.
AverageRecall:
allOf:
- $ref: '#/components/schemas/Double'
- description: Average recall metric for the model.
AverageAccuracy:
allOf:
- $ref: '#/components/schemas/Double'
- description: Average accuracy metric for the model.
description: The evaluation metrics associated with the evaluated model.
TopicsDetectionJobFilter:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description:
JobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
SubmitTimeBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
SubmitTimeAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
description: Provides information for filtering topic detection jobs. For more information, see .
DeleteDocumentClassifierRequest:
type: object
required:
- DocumentClassifierArn
title: DeleteDocumentClassifierRequest
properties:
DocumentClassifierArn:
allOf:
- $ref: '#/components/schemas/DocumentClassifierArn'
- description: 'The Amazon Resource Name (ARN) that identifies the document classifier. '
TagResourceResponse:
type: object
properties: {}
StartKeyPhrasesDetectionJobRequest:
type: object
required:
- InputDataConfig
- OutputDataConfig
- DataAccessRoleArn
- LanguageCode
title: StartKeyPhrasesDetectionJobRequest
properties:
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: Specifies the format and location of the input data for the job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: Specifies where to send the output files.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The identifier of the job.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
Provides configuration parameters for the output of inference jobs.
MentionSentiment: type: object properties: Sentiment: allOf: - $ref: '#/components/schemas/SentimentType' - description: 'The sentiment of the mention. ' SentimentScore: $ref: '#/components/schemas/SentimentScore' description:Contains the sentiment and sentiment score for one mention of an entity.
For more information about targeted sentiment, see Targeted sentiment.
DetectPiiEntitiesResponse: type: object properties: Entities: allOf: - $ref: '#/components/schemas/ListOfPiiEntities' - description: A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. EntityRecognizerAnnotations: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: ' Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.' TestS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: ' Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.' description: Describes the annotations associated with a entity recognizer. AttributeNamesListItem: type: string pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* minLength: 1 maxLength: 63 BatchDetectEntitiesItemResult: type: object properties: Index: allOf: - $ref: '#/components/schemas/Integer' - description: The zero-based index of the document in the input list. Entities: allOf: - $ref: '#/components/schemas/ListOfEntities' - description: One or more Entity objects, one for each entity detected in the document. description: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. LabelListItem: type: string pattern: ^\P{C}*$ maxLength: 5000 ListOfDetectTargetedSentimentResult: type: array items: $ref: '#/components/schemas/BatchDetectTargetedSentimentItemResult' ListKeyPhrasesDetectionJobsResponse: type: object properties: KeyPhrasesDetectionJobPropertiesList: allOf: - $ref: '#/components/schemas/KeyPhrasesDetectionJobPropertiesList' - description: A list containing the properties of each job that is returned. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Identifies the next page of results to return. DatasetPropertiesList: type: array items: $ref: '#/components/schemas/DatasetProperties' EntityRecognizerDocuments: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: ' Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.' TestS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: ' Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.' InputFormat: allOf: - $ref: '#/components/schemas/InputFormat' - description: ' Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.' description: Describes the training documents submitted with an entity recognizer. DatasetEntityRecognizerAnnotations: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: ' Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.' description: Describes the annotations associated with a entity recognizer. DescribeTargetedSentimentDetectionJobResponse: type: object properties: TargetedSentimentDetectionJobProperties: allOf: - $ref: '#/components/schemas/TargetedSentimentDetectionJobProperties' - description: An object that contains the properties associated with a targeted sentiment detection job. PiiEntityType: type: string enum: - BANK_ACCOUNT_NUMBER - BANK_ROUTING - CREDIT_DEBIT_NUMBER - CREDIT_DEBIT_CVV - CREDIT_DEBIT_EXPIRY - PIN - EMAIL - ADDRESS - NAME - PHONE - SSN - DATE_TIME - PASSPORT_NUMBER - DRIVER_ID - URL - AGE - USERNAME - PASSWORD - AWS_ACCESS_KEY - AWS_SECRET_KEY - IP_ADDRESS - MAC_ADDRESS - ALL - LICENSE_PLATE - VEHICLE_IDENTIFICATION_NUMBER - UK_NATIONAL_INSURANCE_NUMBER - CA_SOCIAL_INSURANCE_NUMBER - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER - IN_PERMANENT_ACCOUNT_NUMBER - IN_NREGA - INTERNATIONAL_BANK_ACCOUNT_NUMBER - SWIFT_CODE - UK_NATIONAL_HEALTH_SERVICE_NUMBER - CA_HEALTH_NUMBER - IN_AADHAAR - IN_VOTER_NUMBER DocumentClassifierEndpointArn: type: string pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])* maxLength: 256 EntityType: type: string enum: - PERSON - LOCATION - ORGANIZATION - COMMERCIAL_ITEM - EVENT - DATE - QUANTITY - TITLE - OTHER ListEntitiesDetectionJobsResponse: type: object properties: EntitiesDetectionJobPropertiesList: allOf: - $ref: '#/components/schemas/EntitiesDetectionJobPropertiesList' - description: A list containing the properties of each job that is returned. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Identifies the next page of results to return. DetectEntitiesRequest: type: object title: DetectEntitiesRequest properties: Text: allOf: - $ref: '#/components/schemas/CustomerInputString' - description: A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use theBytes parameter.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
All input documents must be in the same language.
EndpointArn: allOf: - $ref: '#/components/schemas/EntityRecognizerEndpointArn' - description:The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.
If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.
For information about endpoints, see Managing endpoints.
Bytes: allOf: - $ref: '#/components/schemas/SemiStructuredDocumentBlob' - description:This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.
Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).
You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes parameter, do not use the Text parameter.
The block represents a line of text or one word of text.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page
Information about each word or line of text in the input document.
For additional information, see Block in the Amazon Textract API reference.
DescribeDocumentClassifierRequest: type: object required: - DocumentClassifierArn title: DescribeDocumentClassifierRequest properties: DocumentClassifierArn: allOf: - $ref: '#/components/schemas/DocumentClassifierArn' - description: The Amazon Resource Name (ARN) that identifies the document classifier. TheCreateDocumentClassifier operation returns this identifier in its response.
DescribeResourcePolicyResponse:
type: object
properties:
ResourcePolicy:
allOf:
- $ref: '#/components/schemas/Policy'
- description: The JSON body of the resource-based policy.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the policy was created.
LastModifiedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time at which the policy was last modified.
PolicyRevisionId:
allOf:
- $ref: '#/components/schemas/PolicyRevisionId'
- description: The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
FlywheelStatus:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- FAILED
DescribeEntitiesDetectionJobResponse:
type: object
properties:
EntitiesDetectionJobProperties:
allOf:
- $ref: '#/components/schemas/EntitiesDetectionJobProperties'
- description: An object that contains the properties associated with an entities detection job.
ListSentimentDetectionJobsResponse:
type: object
properties:
SentimentDetectionJobPropertiesList:
allOf:
- $ref: '#/components/schemas/SentimentDetectionJobPropertiesList'
- description: A list containing the properties of each job that is returned.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
Policy:
type: string
pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+'
minLength: 1
maxLength: 20000
ListFlywheelIterationHistoryResponse:
type: object
properties:
FlywheelIterationPropertiesList:
allOf:
- $ref: '#/components/schemas/FlywheelIterationPropertiesList'
- description: List of flywheel iteration properties
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Next token
DocumentClassifierAugmentedManifestsList:
type: array
items:
$ref: '#/components/schemas/AugmentedManifestsListItem'
EventsDetectionJobFilter:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: Filters on the name of the events detection job.
JobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: Filters the list of jobs based on job status. Returns only jobs with the specified status.
SubmitTimeBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
SubmitTimeAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
description: Provides information for filtering a list of event detection jobs.
StartEventsDetectionJobRequest:
type: object
required:
- InputDataConfig
- OutputDataConfig
- DataAccessRoleArn
- LanguageCode
- TargetEventTypes
title: StartEventsDetectionJobRequest
properties:
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: Specifies the format and location of the input data for the job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: Specifies where to send the output files.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The identifier of the events detection job.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language code of the input documents.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
TargetEventTypes:
allOf:
- $ref: '#/components/schemas/TargetEventTypes'
- description: The types of events to detect in the input documents.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
CustomerInputStringList:
type: array
items:
$ref: '#/components/schemas/CustomerInputString'
minItems: 1
DatasetEntityRecognizerDocuments:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: ' Specifies the Amazon S3 location where the documents for the dataset are located. '
InputFormat:
allOf:
- $ref: '#/components/schemas/InputFormat'
- description: ' Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.'
description: Describes the documents submitted with a dataset for an entity recognizer model.
TagResourceRequest:
type: object
required:
- ResourceArn
- Tags
title: TagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: 'The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource. '
ComprehendModelArn:
type: string
pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
maxLength: 256
PartOfSpeechTagType:
type: string
enum:
- ADJ
- ADP
- ADV
- AUX
- CONJ
- CCONJ
- DET
- INTJ
- NOUN
- NUM
- O
- PART
- PRON
- PROPN
- PUNCT
- SCONJ
- SYM
- VERB
DocumentClassificationJobPropertiesList:
type: array
items:
$ref: '#/components/schemas/DocumentClassificationJobProperties'
ListTagsForResourceResponse:
type: object
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. '
EntityRecognizerSummary:
type: object
properties:
RecognizerName:
allOf:
- $ref: '#/components/schemas/ComprehendArnName'
- description: ' The name that you assigned the entity recognizer.'
NumberOfVersions:
allOf:
- $ref: '#/components/schemas/Integer'
- description: ' The number of versions you created.'
LatestVersionCreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The time that the latest entity recognizer version was submitted for processing.'
LatestVersionName:
allOf:
- $ref: '#/components/schemas/VersionName'
- description: ' The version name you assigned to the latest entity recognizer version.'
LatestVersionStatus:
allOf:
- $ref: '#/components/schemas/ModelStatus'
- description: ' Provides the status of the latest entity recognizer version.'
description: ' Describes the information about an entity recognizer and its versions.'
InvalidRequestException: {}
StartPiiEntitiesDetectionJobResponse:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier generated for the job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.
When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
DescribeDocumentClassificationJob operation.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
The status of the job:
SUBMITTED - The job has been received and queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.
The system identified one of the following warnings while processing the input document:
The document to classify is plain text, but the classifier is a native model.
The document to classify is semi-structured, but the classifier is a plain-text model.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.
TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.
FORMS - Returns information and the data from any forms that are detected in the input document.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
Word files - Amazon Comprehend parser extracts the text.
Digital PDF files - Amazon Comprehend parser extracts the text.
Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.
DocumentReaderConfig does not apply to plain text files or Word files.
For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.
' DocumentClassifierDataFormat: type: string enum: - COMPREHEND_CSV - AUGMENTED_MANIFEST Entity: type: object properties: Score: allOf: - $ref: '#/components/schemas/Float' - description: The level of confidence that Amazon Comprehend has in the accuracy of the detection. Type: allOf: - $ref: '#/components/schemas/EntityType' - description:The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
Text: allOf: - $ref: '#/components/schemas/String' - description: The text of the entity. BeginOffset: allOf: - $ref: '#/components/schemas/Integer' - description:The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
EndOffset: allOf: - $ref: '#/components/schemas/Integer' - description:The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
BlockReferences: allOf: - $ref: '#/components/schemas/ListOfBlockReferences' - description: A reference to each block for this entity. This field is empty for plain-text input. description:Provides information about an entity.
StringList: type: array items: $ref: '#/components/schemas/String' ListOfChildBlocks: type: array items: $ref: '#/components/schemas/ChildBlock' StartSentimentDetectionJobRequest: type: object required: - InputDataConfig - OutputDataConfig - DataAccessRoleArn - LanguageCode title: StartSentimentDetectionJobRequest properties: InputDataConfig: allOf: - $ref: '#/components/schemas/InputDataConfig' - description: Specifies the format and location of the input data for the job. OutputDataConfig: allOf: - $ref: '#/components/schemas/OutputDataConfig' - description: 'Specifies where to send the output files. ' DataAccessRoleArn: allOf: - $ref: '#/components/schemas/IamRoleArn' - description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions. JobName: allOf: - $ref: '#/components/schemas/JobName' - description: The identifier of the job. LanguageCode: allOf: - $ref: '#/components/schemas/LanguageCode' - description: The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language. ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. VolumeKmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: '
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Message field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of the job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the document classification job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the document classification job completed.
DocumentClassifierArn:
allOf:
- $ref: '#/components/schemas/DocumentClassifierArn'
- description: 'The Amazon Resource Name (ARN) that identifies the document classifier. '
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration that you supplied when you created the document classification job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: The output data configuration that you supplied when you created the document classification job.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
Text extraction encountered one or more page-level errors in the input document.
The ErrorCode contains one of the following values:
TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information about page limits in Amazon Textract, see Page Quotas in Amazon Textract.
TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit. For more information about throughput quotas in Amazon Textract, see Default quotas in Amazon Textract.
PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).
PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.
INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The identifier of the job.
NumberOfTopics:
allOf:
- $ref: '#/components/schemas/NumberOfTopicsInteger'
- description: The number of topics to detect.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Byte parameter. '
DocumentType:
allOf:
- $ref: '#/components/schemas/ListOfDocumentType'
- description: 'The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter. '
Errors:
allOf:
- $ref: '#/components/schemas/ListOfErrors'
- description: Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
Warnings:
allOf:
- $ref: '#/components/schemas/ListOfWarnings'
- description: Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.
The field is empty if the system generated no warnings.
BatchDetectDominantLanguageRequest: type: object required: - TextList title: BatchDetectDominantLanguageRequest properties: TextList: allOf: - $ref: '#/components/schemas/CustomerInputStringList' - description: A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB. DatasetProperties: type: object properties: DatasetArn: allOf: - $ref: '#/components/schemas/ComprehendDatasetArn' - description: The ARN of the dataset. DatasetName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: The name of the dataset. DatasetType: allOf: - $ref: '#/components/schemas/DatasetType' - description: The dataset type (training data or test data). DatasetS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 URI where the dataset is stored. Description: allOf: - $ref: '#/components/schemas/Description' - description: Description of the dataset. Status: allOf: - $ref: '#/components/schemas/DatasetStatus' - description: 'The dataset status. While the system creates the dataset, the status isCREATING. When the dataset is ready to use, the status changes to COMPLETED. '
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of the dataset.
NumberOfDocuments:
allOf:
- $ref: '#/components/schemas/NumberOfDocuments'
- description: The number of documents in the dataset.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Creation time of the dataset.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Time when the data from the dataset becomes available in the data lake.
description: Properties associated with the dataset.
DatasetType:
type: string
enum:
- TRAIN
- TEST
ResourceUnavailableException: {}
DatasetInputDataConfig:
type: object
properties:
AugmentedManifests:
allOf:
- $ref: '#/components/schemas/DatasetAugmentedManifestsList'
- description: 'A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth. '
DataFormat:
allOf:
- $ref: '#/components/schemas/DatasetDataFormat'
- description: ' COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.
AUGMENTED_MANIFEST: The data format
The input properties for training a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
EntityRecognizerInputDataConfig: allOf: - $ref: '#/components/schemas/DatasetEntityRecognizerInputDataConfig' - description: The input properties for training an entity recognizer model. description: Specifies the format and location of the input data for the dataset. ListOfDocumentReadFeatureTypes: type: array items: $ref: '#/components/schemas/DocumentReadFeatureTypes' minItems: 1 maxItems: 2 TargetedSentimentEntityType: type: string enum: - PERSON - LOCATION - ORGANIZATION - FACILITY - BRAND - COMMERCIAL_ITEM - MOVIE - MUSIC - BOOK - SOFTWARE - GAME - PERSONAL_TITLE - EVENT - DATE - QUANTITY - ATTRIBUTE - OTHER ListEntityRecognizersResponse: type: object properties: EntityRecognizerPropertiesList: allOf: - $ref: '#/components/schemas/EntityRecognizerPropertiesList' - description: The list of properties of an entity recognizer. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Identifies the next page of results to return. Float: type: number format: float Split: type: string enum: - TRAIN - TEST EntityRecognizerArn: type: string pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)? maxLength: 256 StopTrainingEntityRecognizerResponse: type: object properties: {} BatchDetectTargetedSentimentRequest: type: object required: - TextList - LanguageCode title: BatchDetectTargetedSentimentRequest properties: TextList: allOf: - $ref: '#/components/schemas/CustomerInputStringList' - description: A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB. LanguageCode: allOf: - $ref: '#/components/schemas/LanguageCode' - description: The language of the input documents. Currently, English is the only supported language. ListDominantLanguageDetectionJobsResponse: type: object properties: DominantLanguageDetectionJobPropertiesList: allOf: - $ref: '#/components/schemas/DominantLanguageDetectionJobPropertiesList' - description: A list containing the properties of each job that is returned. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Identifies the next page of results to return. DocumentClassifierFilter: type: object properties: Status: allOf: - $ref: '#/components/schemas/ModelStatus' - description: Filters the list of classifiers based on status. DocumentClassifierName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: The name that you assigned to the document classifier SubmitTimeBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest. SubmitTimeAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest. description: Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see theListDocumentClassifiers operation.
BatchDetectSyntaxItemResult:
type: object
properties:
Index:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The zero-based index of the document in the input list.
SyntaxTokens:
allOf:
- $ref: '#/components/schemas/ListOfSyntaxTokens'
- description: The syntax tokens for the words in the document, one token for each word.
description: The result of calling the operation. The operation returns one object that is successfully processed by the operation.
DescribeTopicsDetectionJobRequest:
type: object
required:
- JobId
title: DescribeTopicsDetectionJobRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned by the user to the detection job.
SyntaxToken:
type: object
properties:
TokenId:
allOf:
- $ref: '#/components/schemas/Integer'
- description: A unique identifier for a token.
Text:
allOf:
- $ref: '#/components/schemas/String'
- description: The word that was recognized in the source text.
BeginOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The zero-based offset from the beginning of the source text to the first character in the word.
EndOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The zero-based offset from the beginning of the source text to the last character in the word.
PartOfSpeech:
allOf:
- $ref: '#/components/schemas/PartOfSpeechTag'
- description: 'Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide. '
description: Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
DatasetEntityRecognizerInputDataConfig:
type: object
required:
- Documents
properties:
Annotations:
allOf:
- $ref: '#/components/schemas/DatasetEntityRecognizerAnnotations'
- description: The S3 location of the annotation documents for your custom entity recognizer.
Documents:
allOf:
- $ref: '#/components/schemas/DatasetEntityRecognizerDocuments'
- description: The format and location of the training documents for your custom entity recognizer.
EntityList:
allOf:
- $ref: '#/components/schemas/DatasetEntityRecognizerEntityList'
- description: The S3 location of the entity list for your custom entity recognizer.
description: Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.
ListOfDescriptiveMentionIndices:
type: array
items:
$ref: '#/components/schemas/Integer'
DetectKeyPhrasesResponse:
type: object
properties:
KeyPhrases:
allOf:
- $ref: '#/components/schemas/ListOfKeyPhrases'
- description: 'A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection. '
DocumentClassifierMode:
type: string
enum:
- MULTI_CLASS
- MULTI_LABEL
ListDocumentClassifiersRequest:
type: object
title: ListDocumentClassifiersRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/DocumentClassifierFilter'
- description: Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: The maximum number of results to return in each page. The default is 100.
LabelsList:
type: array
items:
$ref: '#/components/schemas/LabelListItem'
maxItems: 1000
ChildBlock:
type: object
properties:
ChildBlockId:
allOf:
- $ref: '#/components/schemas/String'
- description: Unique identifier for the child block.
BeginOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Offset of the start of the child block within its parent block.
EndOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Offset of the end of the child block within its parent block.
description: Nested block contained within a block.
DescribeDatasetResponse:
type: object
properties:
DatasetProperties:
allOf:
- $ref: '#/components/schemas/DatasetProperties'
- description: The dataset properties.
InternalServerException: {}
ListEventsDetectionJobsRequest:
type: object
title: ListEventsDetectionJobsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/EventsDetectionJobFilter'
- description: Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: The maximum number of results to return in each page.
Point:
type: object
properties:
X:
allOf:
- $ref: '#/components/schemas/Float'
- description: The value of the X coordinate for a point on a polygon
Y:
allOf:
- $ref: '#/components/schemas/Float'
- description: The value of the Y coordinate for a point on a polygon
description: The X and Y coordinates of a point on a document page.
For additional information, see Point in the Amazon Textract API reference.
DominantLanguage: type: object properties: LanguageCode: allOf: - $ref: '#/components/schemas/String' - description: The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site. Score: allOf: - $ref: '#/components/schemas/Float' - description: The level of confidence that Amazon Comprehend has in the accuracy of the detection. description: Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection. SentimentDetectionJobPropertiesList: type: array items: $ref: '#/components/schemas/SentimentDetectionJobProperties' BatchDetectDominantLanguageItemResult: type: object properties: Index: allOf: - $ref: '#/components/schemas/Integer' - description: The zero-based index of the document in the input list. Languages: allOf: - $ref: '#/components/schemas/ListOfDominantLanguages' - description: One or more DominantLanguage objects describing the dominant languages in the document. description: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. TextSizeLimitExceededException: {} DocumentClassifierPropertiesList: type: array items: $ref: '#/components/schemas/DocumentClassifierProperties' ListOfDetectDominantLanguageResult: type: array items: $ref: '#/components/schemas/BatchDetectDominantLanguageItemResult' SemiStructuredDocumentBlob: type: string minLength: 1 Description: type: string pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$ maxLength: 2048 PiiOutputDataConfig: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description:When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. '
MicroPrecision:
allOf:
- $ref: '#/components/schemas/Double'
- description: A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
MicroRecall:
allOf:
- $ref: '#/components/schemas/Double'
- description: A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
MicroF1Score:
allOf:
- $ref: '#/components/schemas/Double'
- description: A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
HammingLoss:
allOf:
- $ref: '#/components/schemas/Double'
- description: Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
description: Describes the result metrics for the test data associated with an documentation classifier.
CreateFlywheelRequest:
type: object
required:
- FlywheelName
- DataAccessRoleArn
- DataLakeS3Uri
title: CreateFlywheelRequest
properties:
FlywheelName:
allOf:
- $ref: '#/components/schemas/ComprehendArnName'
- description: Name for the flywheel.
ActiveModelArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
TaskConfig:
allOf:
- $ref: '#/components/schemas/TaskConfig'
- description: Configuration about the custom classifier associated with the flywheel.
ModelType:
allOf:
- $ref: '#/components/schemas/ModelType'
- description: The model type.
DataLakeS3Uri:
allOf:
- $ref: '#/components/schemas/FlywheelS3Uri'
- description: Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
DataSecurityConfig:
allOf:
- $ref: '#/components/schemas/DataSecurityConfig'
- description: Data security configurations.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags to associate with this flywheel.
DescribeDatasetRequest:
type: object
required:
- DatasetArn
title: DescribeDatasetRequest
properties:
DatasetArn:
allOf:
- $ref: '#/components/schemas/ComprehendDatasetArn'
- description: The ARN of the dataset.
LanguageCode:
type: string
enum:
- en
- es
- fr
- de
- it
- pt
- ar
- hi
- ja
- ko
- zh
- zh-TW
TargetedSentimentMention:
type: object
properties:
Score:
allOf:
- $ref: '#/components/schemas/Float'
- description: Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
GroupScore:
allOf:
- $ref: '#/components/schemas/Float'
- description: The confidence that all the entities mentioned in the group relate to the same entity.
Text:
allOf:
- $ref: '#/components/schemas/String'
- description: The text in the document that identifies the entity.
Type:
allOf:
- $ref: '#/components/schemas/TargetedSentimentEntityType'
- description: The type of the entity. Amazon Comprehend supports a variety of entity types.
MentionSentiment:
allOf:
- $ref: '#/components/schemas/MentionSentiment'
- description: Contains the sentiment and sentiment score for the mention.
BeginOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The offset into the document text where the mention begins.
EndOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The offset into the document text where the mention ends.
description: Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.
For more information about targeted sentiment, see Targeted sentiment.
DeleteFlywheelRequest: type: object required: - FlywheelArn title: DeleteFlywheelRequest properties: FlywheelArn: allOf: - $ref: '#/components/schemas/ComprehendFlywheelArn' - description: The Amazon Resource Number (ARN) of the flywheel to delete. CreateDatasetRequest: type: object required: - FlywheelArn - DatasetName - InputDataConfig title: CreateDatasetRequest properties: FlywheelArn: allOf: - $ref: '#/components/schemas/ComprehendFlywheelArn' - description: The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data. DatasetName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: Name of the dataset. DatasetType: allOf: - $ref: '#/components/schemas/DatasetType' - description: The dataset type. You can specify that the data in a dataset is for training the model or for testing the model. Description: allOf: - $ref: '#/components/schemas/Description' - description: Description of the dataset. InputDataConfig: allOf: - $ref: '#/components/schemas/DatasetInputDataConfig' - description: Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model. ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: Tags for the dataset. UnsupportedLanguageException: {} ComprehendEndpointName: type: string pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ maxLength: 40 DatasetFilter: type: object properties: Status: allOf: - $ref: '#/components/schemas/DatasetStatus' - description: Filter the datasets based on the dataset status. DatasetType: allOf: - $ref: '#/components/schemas/DatasetType' - description: Filter the datasets based on the dataset type. CreationTimeAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filter the datasets to include datasets created after the specified time. CreationTimeBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filter the datasets to include datasets created before the specified time. description: Filter the datasets based on creation time or dataset status. ListOfLabels: type: array items: $ref: '#/components/schemas/DocumentLabel' UpdateDataSecurityConfig: type: object properties: ModelKmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: 'ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StartTargetedSentimentDetectionJob operation returns this identifier in its response.
Integer:
type: integer
PutResourcePolicyRequest:
type: object
required:
- ResourceArn
- ResourcePolicy
title: PutResourcePolicyRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: The Amazon Resource Name (ARN) of the custom model to attach the policy to.
ResourcePolicy:
allOf:
- $ref: '#/components/schemas/Policy'
- description: 'The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
''{"attribute": "value", "attribute": ["value"]}''
Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. '
description: 'Detailed information about the accuracy of an entity recognizer for a specific entity type. '
AnyLengthString:
type: string
ResourceInUseException: {}
KeyPhrasesDetectionJobFilter:
type: object
properties:
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: Filters on the name of the job.
JobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: Filters the list of jobs based on job status. Returns only jobs with the specified status.
SubmitTimeBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
SubmitTimeAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
description: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
CreateEndpointRequest:
type: object
required:
- EndpointName
- DesiredInferenceUnits
title: CreateEndpointRequest
properties:
EndpointName:
allOf:
- $ref: '#/components/schemas/ComprehendEndpointName'
- description: 'This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource. '
ModelArn:
allOf:
- $ref: '#/components/schemas/ComprehendModelArn'
- description: The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
DesiredInferenceUnits:
allOf:
- $ref: '#/components/schemas/InferenceUnitsInteger'
- description: ' The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.'
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: 'An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department. '
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
CreateDocumentClassifierRequest:
type: object
required:
- DocumentClassifierName
- DataAccessRoleArn
- InputDataConfig
- LanguageCode
title: CreateDocumentClassifierRequest
properties:
DocumentClassifierName:
allOf:
- $ref: '#/components/schemas/ComprehendArnName'
- description: The name of the document classifier.
VersionName:
allOf:
- $ref: '#/components/schemas/VersionName'
- description: The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. '
InputDataConfig:
allOf:
- $ref: '#/components/schemas/DocumentClassifierInputDataConfig'
- description: Specifies the format and location of the input data for the job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/DocumentClassifierOutputDataConfig'
- description: Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native classifier model.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
''{"attribute": "value", "attribute": ["value"]}''
DescribeTopicDetectionJob operation.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
The status of the job:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Messages field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the sentiment detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the sentiment detection job ended.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration that you supplied when you created the sentiment detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: The output data configuration that you supplied when you created the sentiment detection job.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language code of the input documents.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
DocumentMetadata: allOf: - $ref: '#/components/schemas/DocumentMetadata' - description: 'Information about the document, discovered during text extraction. This field is present in the response only if your request used theByte parameter. '
DocumentType:
allOf:
- $ref: '#/components/schemas/ListOfDocumentType'
- description: 'The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter. '
Blocks:
allOf:
- $ref: '#/components/schemas/ListOfBlocks'
- description: Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block content for a Word input document does not include a Geometry field.
The Block field is not present in the response for plain-text inputs.
BatchItemError object for each document that contained an error.
EntityRecognizerEndpointArn:
type: string
pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*
maxLength: 256
BatchDetectKeyPhrasesItemResult:
type: object
properties:
Index:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The zero-based index of the document in the input list.
KeyPhrases:
allOf:
- $ref: '#/components/schemas/ListOfKeyPhrases'
- description: One or more KeyPhrase objects, one for each key phrase detected in the document.
description: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
ListTargetedSentimentDetectionJobsRequest:
type: object
title: ListTargetedSentimentDetectionJobsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/TargetedSentimentDetectionJobFilter'
- description: Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: The maximum number of results to return in each page. The default is 100.
StartFlywheelIterationResponse:
type: object
properties:
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description:
FlywheelIterationId:
allOf:
- $ref: '#/components/schemas/FlywheelIterationId'
- description:
BlockReference:
type: object
properties:
BlockId:
allOf:
- $ref: '#/components/schemas/String'
- description: Unique identifier for the block.
BeginOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Offset of the start of the block within its parent block.
EndOffset:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Offset of the end of the block within its parent block.
ChildBlocks:
allOf:
- $ref: '#/components/schemas/ListOfChildBlocks'
- description: List of child blocks within this block.
description: 'A reference to a block. '
StopTrainingDocumentClassifierRequest:
type: object
required:
- DocumentClassifierArn
title: StopTrainingDocumentClassifierRequest
properties:
DocumentClassifierArn:
allOf:
- $ref: '#/components/schemas/DocumentClassifierArn'
- description: The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
ListFlywheelsRequest:
type: object
title: ListFlywheelsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/FlywheelFilter'
- description: 'Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time. '
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsInteger'
- description: Maximum number of results to return in a response. The default is 100.
DetectSentimentResponse:
type: object
properties:
Sentiment:
allOf:
- $ref: '#/components/schemas/SentimentType'
- description: The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
SentimentScore:
allOf:
- $ref: '#/components/schemas/SentimentScore'
- description: An object that lists the sentiments, and their corresponding confidence levels.
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/SecurityGroupId'
minItems: 1
maxItems: 5
AttributeNamesList:
type: array
items:
$ref: '#/components/schemas/AttributeNamesListItem'
ModelType:
type: string
enum:
- DOCUMENT_CLASSIFIER
- ENTITY_RECOGNIZER
IamRoleArn:
type: string
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
minLength: 20
maxLength: 2048
ComprehendDatasetArn:
type: string
pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*
maxLength: 256
ListOfWarnings:
type: array
items:
$ref: '#/components/schemas/WarningsListItem'
TargetedSentimentDetectionJobProperties:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned to the targeted sentiment detection job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Messages field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the targeted sentiment detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the targeted sentiment detection job ended.
InputDataConfig:
$ref: '#/components/schemas/InputDataConfig'
OutputDataConfig:
$ref: '#/components/schemas/OutputDataConfig'
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language code of the input documents.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
For additional information, see BoundingBox in the Amazon Textract API reference.
DescribeEndpointResponse: type: object properties: EndpointProperties: allOf: - $ref: '#/components/schemas/EndpointProperties' - description: Describes information associated with the specific endpoint. PiiEntity: type: object properties: Score: allOf: - $ref: '#/components/schemas/Float' - description: The level of confidence that Amazon Comprehend has in the accuracy of the detection. Type: allOf: - $ref: '#/components/schemas/PiiEntityType' - description: The entity's type. BeginOffset: allOf: - $ref: '#/components/schemas/Integer' - description: The zero-based offset from the beginning of the source text to the first character in the entity. EndOffset: allOf: - $ref: '#/components/schemas/Integer' - description: The zero-based offset from the beginning of the source text to the last character in the entity. description: Provides information about a PII entity. BatchDetectTargetedSentimentResponse: type: object required: - ResultList - ErrorList properties: ResultList: allOf: - $ref: '#/components/schemas/ListOfDetectTargetedSentimentResult' - description: A list of objects containing the results of the operation. The results are sorted in ascending order by theIndex field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: List of errors that the operation can return.
DatasetAugmentedManifestsList:
type: array
items:
$ref: '#/components/schemas/DatasetAugmentedManifestsListItem'
EventsDetectionJobProperties:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned to the events detection job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score. '
description: 'Detailed information about the accuracy of an entity recognizer. '
BatchDetectTargetedSentimentItemResult:
type: object
properties:
Index:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The zero-based index of this result in the input list.
Entities:
allOf:
- $ref: '#/components/schemas/ListOfTargetedSentimentEntities'
- description: An array of targeted sentiment entities.
description: Analysis results for one of the documents in the batch.
DeleteEntityRecognizerResponse:
type: object
properties: {}
StopKeyPhrasesDetectionJobResponse:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier of the key phrases detection job to stop.
JobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.
ListEntityRecognizerSummariesResponse:
type: object
properties:
EntityRecognizerSummariesList:
allOf:
- $ref: '#/components/schemas/EntityRecognizerSummariesList'
- description: The list entity recognizer summaries.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
KeyPhrasesDetectionJobProperties:
type: object
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier assigned to the key phrases detection job.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Message field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description of the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the key phrases detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the key phrases detection job completed.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration that you supplied when you created the key phrases detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: The output data configuration that you supplied when you created the key phrases detection job.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language code of the input documents.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
AugmentedManifestsListItem:
type: object
required:
- S3Uri
- AttributeNames
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The Amazon S3 location of the augmented manifest file.
Split:
allOf:
- $ref: '#/components/schemas/Split'
- description: The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
AttributeNames: allOf: - $ref: '#/components/schemas/AttributeNamesList' - description:The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
AnnotationDataS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 prefix to the annotation files that are referred in the augmented manifest file. SourceDocumentsS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file. DocumentType: allOf: - $ref: '#/components/schemas/AugmentedManifestsDocumentTypeFormat' - description:The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
Information about one of the entities found by targeted sentiment analysis.
For more information about targeted sentiment, see Targeted sentiment.
DeleteEndpointRequest: type: object required: - EndpointArn title: DeleteEndpointRequest properties: EndpointArn: allOf: - $ref: '#/components/schemas/ComprehendEndpointArn' - description: The Amazon Resource Number (ARN) of the endpoint being deleted. UpdateFlywheelRequest: type: object required: - FlywheelArn title: UpdateFlywheelRequest properties: FlywheelArn: allOf: - $ref: '#/components/schemas/ComprehendFlywheelArn' - description: The Amazon Resource Number (ARN) of the flywheel to update. ActiveModelArn: allOf: - $ref: '#/components/schemas/ComprehendModelArn' - description: The Amazon Resource Number (ARN) of the active model version. DataAccessRoleArn: allOf: - $ref: '#/components/schemas/IamRoleArn' - description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data. DataSecurityConfig: allOf: - $ref: '#/components/schemas/UpdateDataSecurityConfig' - description: Flywheel data security configuration. EventTypeString: type: string pattern: '[A-Z_]*' minLength: 1 maxLength: 40 DocumentClassifierSummary: type: object properties: DocumentClassifierName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: The name that you assigned the document classifier. NumberOfVersions: allOf: - $ref: '#/components/schemas/Integer' - description: The number of versions you created. LatestVersionCreatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time that the latest document classifier version was submitted for processing. LatestVersionName: allOf: - $ref: '#/components/schemas/VersionName' - description: The version name you assigned to the latest document classifier version. LatestVersionStatus: allOf: - $ref: '#/components/schemas/ModelStatus' - description: Provides the status of the latest document classifier version. description: Describes information about a document classifier and its versions. FlywheelIterationStatus: type: string enum: - TRAINING - EVALUATING - COMPLETED - FAILED - STOP_REQUESTED - STOPPED ResourceNotFoundException: {} DominantLanguageDetectionJobFilter: type: object properties: JobName: allOf: - $ref: '#/components/schemas/JobName' - description: Filters on the name of the job. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: Filters the list of jobs based on job status. Returns only jobs with the specified status. SubmitTimeBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest. SubmitTimeAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. description: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. DocumentTypeListItem: type: object properties: Page: allOf: - $ref: '#/components/schemas/Integer' - description: Page number. Type: allOf: - $ref: '#/components/schemas/DocumentType' - description: Document type. description: Document type for each page in the document. DescribeEventsDetectionJobResponse: type: object properties: EventsDetectionJobProperties: allOf: - $ref: '#/components/schemas/EventsDetectionJobProperties' - description: An object that contains the properties associated with an event detection job. DominantLanguageDetectionJobProperties: type: object properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier assigned to the dominant language detection job. JobArn: allOf: - $ref: '#/components/schemas/ComprehendArn' - description:The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
FAILED, the Message field shows the reason for the failure.
Message:
allOf:
- $ref: '#/components/schemas/AnyLengthString'
- description: A description for the status of a job.
SubmitTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the dominant language detection job was submitted for processing.
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time that the dominant language detection job completed.
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: The input data configuration that you supplied when you created the dominant language detection job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: The output data configuration that you supplied when you created the dominant language detection job.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.
StartEntitiesDetectionJobRequest:
type: object
required:
- InputDataConfig
- OutputDataConfig
- DataAccessRoleArn
- LanguageCode
title: StartEntitiesDetectionJobRequest
properties:
InputDataConfig:
allOf:
- $ref: '#/components/schemas/InputDataConfig'
- description: Specifies the format and location of the input data for the job.
OutputDataConfig:
allOf:
- $ref: '#/components/schemas/OutputDataConfig'
- description: Specifies where to send the output files.
DataAccessRoleArn:
allOf:
- $ref: '#/components/schemas/IamRoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
JobName:
allOf:
- $ref: '#/components/schemas/JobName'
- description: The identifier of the job.
EntityRecognizerArn:
allOf:
- $ref: '#/components/schemas/EntityRecognizerArn'
- description: The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
LanguageCode:
allOf:
- $ref: '#/components/schemas/LanguageCode'
- description: The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestTokenString'
- description: A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
VolumeKmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The Amazon S3 location of the augmented manifest file. AnnotationDataS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 prefix to the annotation files that are referred in the augmented manifest file. SourceDocumentsS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file. DocumentType: allOf: - $ref: '#/components/schemas/AugmentedManifestsDocumentTypeFormat' - description:The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
The format of your training data:
COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.
If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.
AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.
If you use this value, you must provide the AugmentedManifests parameter in your request.
If you don''t specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don''t specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
' Documents: allOf: - $ref: '#/components/schemas/EntityRecognizerDocuments' - description:The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
BatchDetectSyntaxResponse:
type: object
required:
- ResultList
- ErrorList
properties:
ResultList:
allOf:
- $ref: '#/components/schemas/ListOfDetectSyntaxResult'
- description: A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
ErrorList:
allOf:
- $ref: '#/components/schemas/BatchItemErrorList'
- description: A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
ListOfDetectSyntaxResult:
type: array
items:
$ref: '#/components/schemas/BatchDetectSyntaxItemResult'
SyntaxLanguageCode:
type: string
enum:
- en
- es
- fr
- de
- it
- pt
DescribeFlywheelRequest:
type: object
required:
- FlywheelArn
title: DescribeFlywheelRequest
properties:
FlywheelArn:
allOf:
- $ref: '#/components/schemas/ComprehendFlywheelArn'
- description: The Amazon Resource Number (ARN) of the flywheel.
DescribeDocumentClassifierResponse:
type: object
properties:
DocumentClassifierProperties:
allOf:
- $ref: '#/components/schemas/DocumentClassifierProperties'
- description: An object that contains the properties associated with a document classifier.
CreateDatasetResponse:
type: object
properties:
DatasetArn:
allOf:
- $ref: '#/components/schemas/ComprehendDatasetArn'
- description: The ARN of the dataset.
UntagResourceResponse:
type: object
properties: {}
DescribeEntitiesDetectionJobRequest:
type: object
required:
- JobId
title: DescribeEntitiesDetectionJobRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.
ClassifyDocumentRequest:
type: object
required:
- EndpointArn
title: ClassifyDocumentRequest
properties:
Text:
allOf:
- $ref: '#/components/schemas/CustomerInputString'
- description: The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.
EndpointArn:
allOf:
- $ref: '#/components/schemas/DocumentClassifierEndpointArn'
- description: The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.
Bytes:
allOf:
- $ref: '#/components/schemas/SemiStructuredDocumentBlob'
- description: Use the Bytes parameter to input a text, PDF, Word or image file. You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes parameter, do not use the Text parameter.
The format of your training data:
COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.
AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.
If you use this value, you must provide the AugmentedManifests parameter in your request.
If you don''t specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
The input properties for training a document classifier.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
DataSecurityConfig: type: object properties: ModelKmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: 'ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
Describes the dataset input data configuration for a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
ComprehendFlywheelArn: type: string pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])* maxLength: 256 DetectSyntaxResponse: type: object properties: SyntaxTokens: allOf: - $ref: '#/components/schemas/ListOfSyntaxTokens' - description: 'A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide. ' ListOfBlockReferences: type: array items: $ref: '#/components/schemas/BlockReference' TooManyRequestsException: {} NumberOfTopicsInteger: type: integer minimum: 1 maximum: 100 UpdateEndpointResponse: type: object properties: DesiredModelArn: allOf: - $ref: '#/components/schemas/ComprehendModelArn' - description: The Amazon Resource Number (ARN) of the new model. EntityRecognizerMetadataEntityTypesList: type: array items: $ref: '#/components/schemas/EntityRecognizerMetadataEntityTypesListItem' DocumentClassifierDocuments: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 URI location of the training documents specified in the S3Uri CSV file. TestS3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description: The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file. description: The location of the training documents. This parameter is required in a request to create a native classifier model. DocumentClass: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the class. Score: allOf: - $ref: '#/components/schemas/Float' - description: The confidence score that Amazon Comprehend has this class correctly attributed. Page: allOf: - $ref: '#/components/schemas/Integer' - description: 'Page number in the input document. This field is present in the response only if your request includes theByte parameter. '
description: Specifies the class that categorizes the document being analyzed
DescribeDominantLanguageDetectionJobResponse:
type: object
properties:
DominantLanguageDetectionJobProperties:
allOf:
- $ref: '#/components/schemas/DominantLanguageDetectionJobProperties'
- description: An object that contains the properties associated with a dominant language detection job.
ListOfTargetedSentimentEntities:
type: array
items:
$ref: '#/components/schemas/TargetedSentimentEntity'
ModelStatus:
type: string
enum:
- SUBMITTED
- TRAINING
- DELETING
- STOP_REQUESTED
- STOPPED
- IN_ERROR
- TRAINED
- TRAINED_WITH_WARNING
DocumentClassifierSummariesList:
type: array
items:
$ref: '#/components/schemas/DocumentClassifierSummary'
FlywheelFilter:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/FlywheelStatus'
- description: Filter the flywheels based on the flywheel status.
CreationTimeAfter:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter the flywheels to include flywheels created after the specified time.
CreationTimeBefore:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Filter the flywheels to include flywheels created before the specified time.
description: Filter the flywheels based on creation time or flywheel status.
DocumentClassificationConfig:
type: object
required:
- Mode
properties:
Mode:
allOf:
- $ref: '#/components/schemas/DocumentClassifierMode'
- description: Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
Labels:
allOf:
- $ref: '#/components/schemas/LabelsList'
- description: One or more labels to associate with the custom classifier.
description: Configuration required for a custom classification model.
CreateEntityRecognizerResponse:
type: object
properties:
EntityRecognizerArn:
allOf:
- $ref: '#/components/schemas/EntityRecognizerArn'
- description: The Amazon Resource Name (ARN) that identifies the entity recognizer.
JobName:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
minLength: 1
maxLength: 256
ListOfBlocks:
type: array
items:
$ref: '#/components/schemas/Block'
EntityRecognizerEntityList:
type: object
required:
- S3Uri
properties:
S3Uri:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: Specifies the Amazon S3 location where the entity list is located. The URI must be in the same Region as the API endpoint that you are calling.
description: Describes the entity list submitted with an entity recognizer.
ListTopicsDetectionJobsResponse:
type: object
properties:
TopicsDetectionJobPropertiesList:
allOf:
- $ref: '#/components/schemas/TopicsDetectionJobPropertiesList'
- description: A list containing the properties of each job that is returned.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Identifies the next page of results to return.
StopPiiEntitiesDetectionJobRequest:
type: object
required:
- JobId
title: StopPiiEntitiesDetectionJobRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier of the PII entities detection job to stop.
InvalidFilterException: {}
NumberOfDocuments:
type: integer
EntityTypesListItem:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/EntityTypeName'
- description: 'An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
' description: An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer. ClassifierMetadata: type: object properties: NumberOfLabels: allOf: - $ref: '#/components/schemas/Integer' - description: 'The number of labels in the input data. ' NumberOfTrainedDocuments: allOf: - $ref: '#/components/schemas/Integer' - description: The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents. NumberOfTestDocuments: allOf: - $ref: '#/components/schemas/Integer' - description: The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents. EvaluationMetrics: allOf: - $ref: '#/components/schemas/ClassifierEvaluationMetrics' - description: ' Describes the result metrics for the test data associated with an documentation classifier.' description: Provides information about a document classifier. EntityRecognizerFilter: type: object properties: Status: allOf: - $ref: '#/components/schemas/ModelStatus' - description: The status of an entity recognizer. RecognizerName: allOf: - $ref: '#/components/schemas/ComprehendArnName' - description: The name that you assigned the entity recognizer. SubmitTimeBefore: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest. SubmitTimeAfter: allOf: - $ref: '#/components/schemas/Timestamp' - description: Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest. description: Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see theListEntityRecognizers operation./>
EventsDetectionJobPropertiesList:
type: array
items:
$ref: '#/components/schemas/EventsDetectionJobProperties'
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/comprehend/
x-hasEquivalentPaths: true