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.ListPiiEntitiesDetectionJobs 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.ListPiiEntitiesDetectionJobs' paths: /#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: - '#X Amz Target=Comprehend 20171127.ListPiiEntitiesDetectionJobs' 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 DocumentReadMode: type: string enum: - SERVICE_DEFAULT - FORCE_DOCUMENT_READ_ACTION 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 JobStatus: type: string enum: - SUBMITTED - IN_PROGRESS - COMPLETED - FAILED - STOP_REQUESTED - STOPPED 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.

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. description: Provides configuration parameters for the output of PII entity detection jobs. KmsKeyId: type: string pattern: ^\p{ASCII}+$ maxLength: 2048 ListPiiEntitiesDetectionJobsRequest: type: object title: ListPiiEntitiesDetectionJobsRequest properties: Filter: allOf: - $ref: '#/components/schemas/PiiEntitiesDetectionJobFilter' - 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. AnyLengthString: type: string S3Uri: type: string pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)? maxLength: 1024 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.

' PiiEntitiesDetectionJobPropertiesList: type: array items: $ref: '#/components/schemas/PiiEntitiesDetectionJobProperties' 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: {} ListOfPiiEntityTypes: type: array items: $ref: '#/components/schemas/PiiEntityType' JobName: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ minLength: 1 maxLength: 256 InvalidRequestException: {} PiiEntitiesDetectionJobFilter: 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 PII entity detection jobs. 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 PiiEntitiesDetectionMode: type: string enum: - ONLY_REDACTION - ONLY_OFFSETS Timestamp: type: string format: date-time 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.

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 ListPiiEntitiesDetectionJobsResponse: type: object properties: PiiEntitiesDetectionJobPropertiesList: allOf: - $ref: '#/components/schemas/PiiEntitiesDetectionJobPropertiesList' - 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. TooManyRequestsException: {} 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

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

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. Mode: allOf: - $ref: '#/components/schemas/PiiEntitiesDetectionMode' - description: Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted. description: Provides information about a PII entities detection job. RedactionConfig: type: object properties: PiiEntityTypes: allOf: - $ref: '#/components/schemas/ListOfPiiEntityTypes' - description: An array of the types of PII entities that Amazon Comprehend detects in the input text for your request. MaskMode: allOf: - $ref: '#/components/schemas/PiiEntitiesDetectionMaskMode' - description: Specifies whether the PII entity is redacted with the mask character or the entity type. MaskCharacter: allOf: - $ref: '#/components/schemas/MaskCharacter' - description: A character that replaces each character in the redacted PII entity. description: Provides configuration parameters for PII entity redaction. 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 PiiEntitiesDetectionMaskMode: type: string enum: - MASK - REPLACE_WITH_PII_ENTITY_TYPE 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