openapi: 3.0.0 info: version: '2017-11-27' x-release: v4 title: 'Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.ListSentimentDetectionJobs 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: '#X Amz Target=Comprehend 20171127.ListSentimentDetectionJobs' paths: /#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: - '#X Amz Target=Comprehend 20171127.ListSentimentDetectionJobs' components: schemas: IamRoleArn: type: string pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ minLength: 20 maxLength: 2048 LanguageCode: type: string enum: - en - es - fr - de - it - pt - ar - hi - ja - ko - zh - zh-TW SecurityGroupId: type: string pattern: '[-0-9a-zA-Z]+' minLength: 1 maxLength: 32 SentimentDetectionJobFilter: 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. SubnetId: type: string pattern: '[-0-9a-zA-Z]+' minLength: 1 maxLength: 32 DocumentReadMode: type: string enum: - SERVICE_DEFAULT - FORCE_DOCUMENT_READ_ACTION JobStatus: type: string enum: - SUBMITTED - IN_PROGRESS - COMPLETED - FAILED - STOP_REQUESTED - STOPPED KmsKeyId: type: string pattern: ^\p{ASCII}+$ maxLength: 2048 AnyLengthString: type: string S3Uri: type: string pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)? maxLength: 1024 Subnets: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 16 DocumentReaderConfig: type: object required: - DocumentReadAction properties: DocumentReadAction: allOf: - $ref: '#/components/schemas/DocumentReadAction' - description:

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:

DocumentReadMode: allOf: - $ref: '#/components/schemas/DocumentReadMode' - description:

Determines the text extraction actions for PDF files. Enter one of the following values:

FeatureTypes: allOf: - $ref: '#/components/schemas/ListOfDocumentReadFeatureTypes' - description:

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:

description: '

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:

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.

' JobId: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ minLength: 1 maxLength: 32 InputFormat: type: string enum: - ONE_DOC_PER_FILE - ONE_DOC_PER_LINE InvalidFilterException: {} OutputDataConfig: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description:

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.

KmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: '

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:

' description:

Provides configuration parameters for the output of inference jobs.

JobName: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ minLength: 1 maxLength: 256 InvalidRequestException: {} SentimentDetectionJobPropertiesList: type: array items: $ref: '#/components/schemas/SentimentDetectionJobProperties' DocumentReadFeatureTypes: type: string enum: - TABLES - FORMS description:

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:

String: type: string minLength: 1 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. SecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' minItems: 1 maxItems: 5 SentimentDetectionJobProperties: type: object properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identifier assigned to the sentiment detection job. 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

JobName: allOf: - $ref: '#/components/schemas/JobName' - description: The name that you assigned to the sentiment detection job JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: The current status of the sentiment detection job. If the status is 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:

' VpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: ' Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC. ' description: Provides information about a sentiment detection job. ListSentimentDetectionJobsRequest: type: object title: ListSentimentDetectionJobsRequest properties: Filter: allOf: - $ref: '#/components/schemas/SentimentDetectionJobFilter' - 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. Timestamp: type: string format: date-time 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.

InputFormat: allOf: - $ref: '#/components/schemas/InputFormat' - description:

Specifies how the text in an input file should be processed:

DocumentReaderConfig: allOf: - $ref: '#/components/schemas/DocumentReaderConfig' - description: Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. description: The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis. ListOfDocumentReadFeatureTypes: type: array items: $ref: '#/components/schemas/DocumentReadFeatureTypes' minItems: 1 maxItems: 2 TooManyRequestsException: {} VpcConfig: type: object required: - SecurityGroupIds - Subnets properties: SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: 'The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC. ' Subnets: allOf: - $ref: '#/components/schemas/Subnets' - description: 'The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets. ' description: ' Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC. ' InternalServerException: {} DocumentReadAction: type: string enum: - TEXTRACT_DETECT_DOCUMENT_TEXT - TEXTRACT_ANALYZE_DOCUMENT 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 MaxResultsInteger: type: integer minimum: 1 maximum: 500 parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token 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