A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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.

The response's http status code.

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.

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.

The Amazon Resource Name (ARN) that identifies the entity recognizer.

The response's http status code.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

An object that contains the properties associated with a key phrases detection job.

The response's http status code.

Identifies the next page of results to return.

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.

The maximum number of results to return in each page. The default is 100.

A list containing the properties of each job that is returned.

Identifies the next page of results to return.

The response's http status code.

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

Tags associated with the endpoint being created. 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.

This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

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.

The Amazon Resource Number (ARN) of the endpoint being created.

The response's http status code.

The identifier of the events detection job to stop.

The identifier of the events detection job to stop.

The status of the events detection job.

The response's http status code.

The identifier of the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the sentiment 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.

Specifies the format and location of the input data for the job.

Specifies where to send the output files.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

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.

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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.

The response's http status code.

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

The response's http status code.

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.

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.

The identifier of the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

ID for the AWS 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 number of topics to detect.

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Tags to be associated with the topics 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.

Specifies the format and location of the input data for the job.

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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 response's http status code.

The identifier of the events detection job.

An object that contains the properties associated with an event detection job.

The response's http status code.

The Amazon Resource Number (ARN) of the endpoint being deleted.

The response's http status code.

The ARN of the new model to use when updating an existing endpoint.

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.

Data access role ARN to use in case the new model is encrypted with a customer CMK.

The Amazon Resource Number (ARN) of the endpoint being updated.

The response's http status code.

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

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.

The response's http status code.

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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.

The response's http status code.

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.

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.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

An object that contains the properties associated with a sentiment detection job.

The response's http status code.

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.

The identifier of the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the entities 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.

Specifies the format and location of the input data for the job.

Specifies where to send the output files.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

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.

The identifier generated for the job. To get the status of job, use this identifier with the operation.

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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.

The response's http status code.

The identifier of the PII entities detection job to stop.

The identifier of the PII entities detection job to stop.

The status of the PII entities detection job.

The response's http status code.

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Describes information associated with an entity recognizer.

The response's http status code.

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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.

The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

An object that lists the sentiments, and their corresponding confidence levels.

The response's http status code.

An identifier for the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Tags to be associated with the dominant language 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.

Specifies the format and location of the input data for the job.

Specifies where to send the output files.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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.

The response's http status code.

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

The response's http status code.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

An object that describes the properties associated with the document classification job.

The response's http status code.

Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.

The language of the input documents.

The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

The response's http status code.

Identifies the next page of results to return.

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.

The maximum number of results to return in each page.

A list containing the properties of each job that is returned.

Identifies the next page of results to return.

The response's http status code.

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

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.

The response's http status code.

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.

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.

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

ID for the AWS Key Management Service (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"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the entity recognizer being created. 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.

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

The Amazon Resource Name (ARN) that identifies the entity recognizer.

The response's http status code.

The identifier of the key phrases detection job to stop.

The identifier of the key phrases detection job to stop.

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

The response's http status code.

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 account/AWS Region.

ID for the AWS Key Management Service (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"

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

ID for the AWS 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"

Enables the addition of output results configuration parameters for custom classifier jobs.

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the document classifier being created. 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.

The name of the document classifier.

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Specifies the format and location of the input data for the job.

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

The Amazon Resource Name (ARN) that identifies the document classifier.

The response's http status code.

Identifies the next page of results to return.

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.

The maximum number of results to return in each page.

Identifies the next page of results to return.

A list containing the properties of each job that is returned.

The response's http status code.

Identifies the next page of results to return.

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

The maximum number of results to return on each page. The default is 100.

Identifies the next page of results to return.

The list of properties of an entity recognizer.

The response's http status code.

The identifier of the sentiment detection job to stop.

The identifier of the sentiment detection job to stop.

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

The response's http status code.

A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

The languages that Amazon Comprehend detected in the input text. 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.

The response's http status code.

The document text to be analyzed.

The Amazon Resource Number (ARN) of the endpoint.

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

The response's http status code.

The identifier of the events detection job.

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated 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.

Specifies the format and location of the input data for the job.

Specifies where to send the output files.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

The language code of the input documents.

The types of events to detect in the input documents.

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

The status of the events detection job.

The response's http status code.

The identifier assigned by the user to the detection job.

The list of properties for the requested job.

The response's http status code.

Identifies the next page of results to return.

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

The maximum number of results to return in each page. The default is 100.

Identifies the next page of results to return.

A list containing the properties of each job returned.

The response's http status code.

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

The language of the input documents.

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.

The response's http status code.

Identifies the next page of results to return.

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

The maximum number of results to return in each page. The default is 100.

Displays a list of endpoint properties being retrieved by the service in response to the request.

Identifies the next page of results to return.

The response's http status code.

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.

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.

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.

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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 how-entities.

The response's http status code.

The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

An object that contains the properties associated with a document classifier.

The response's http status code.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

An object that contains the properties associated with a dominant language detection job.

The response's http status code.

Identifies the next page of results to return.

The maximum number of results to return on each page. The default is 100.

The list entity recognizer summaries.

The list entity recognizer summaries.

The response's http status code.

The identifier of the entities detection job to stop.

The identifier of the entities detection job to stop.

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

The response's http status code.

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

The response's http status code.

The identifier of the job.

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.

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the PII entities 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.

The input properties for a PII entities detection job.

Provides configuration parameters for the output of PII entity detection jobs.

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

The language of the input documents.

The identifier generated for the job.

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

The status of the job.

The response's http status code.

Identifies the next page of results to return.

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.

The maximum number of results to return in each page. The default is 100.

A list containing the properties of each job that is returned.

Identifies the next page of results to return.

The response's http status code.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

An object that contains the properties associated with an entities detection job.

The response's http status code.

Identifies the next page of results to return.

The maximum number of results to return on each page. The default is 100.

Identifies the next page of results to return.

The list of summaries of document classifiers.

The response's http status code.

The identifier of the dominant language detection job to stop.

The identifier of the dominant language detection job to stop.

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

The response's http status code.

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

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.

The response's http status code.

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Undocumented member.

The response's http status code.

Identifies the next page of results to return.

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

The maximum number of results to return in each page. The default is 100.

Identifies the next page of results to return.

A list containing the properties of each job that is returned.

The response's http status code.

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

The response's http status code.

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

The response's http status code.

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.

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.

The identifier of the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Tags to be associated with the document classification 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.

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Specifies the format and location of the input data for the job.

Specifies where to send the output files.

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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 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 response's http status code.

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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.

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.

The response's http status code.

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").

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 how-syntax.

The response's http status code.

The Amazon Resource Number (ARN) of the endpoint being described.

Describes information associated with the specific endpoint.

The response's http status code.

Identifies the next page of results to return.

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.

The maximum number of results to return in each page. The default is 100.

Identifies the next page of results to return.

A list containing the properties of each job that is returned.

The response's http status code.

The Amazon Resource Name (ARN) that identifies the document classifier.

The response's http status code.

Identifies the next page of results to return.

Filters that 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.

The maximum number of results to return in each page. The default is 100.

Identifies the next page of results to return.

A list containing the properties of each job that is returned.

The response's http status code.

The identifier of the job.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

ID for the AWS 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 unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Tags to be associated with the key phrases 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.

Specifies the format and location of the input data for the job.