v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426136110.8 KB

Starts an asynchronous job to detect protected health information (PHI). Use the <code>DescribePHIDetectionJob</code> operation to track the status of a job.

post/#X-Amz-Target=ComprehendMedical_20181030.StartPHIDetectionJob

Headers

X-Amz-Target'ComprehendMedical_20181030.StartPHIDetectionJob' required

Request body

DataAccessRoleArnstring required

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.

JobNamestring

The identifier of the job.

ClientRequestTokenstring

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

KMSKeystring

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

LanguageCode'en' required

The language of the input documents. All documents must be in the same language.

Response

Success

JobIdstring

The identifier generated for the job. To get the status of a job, use this identifier with the <code>DescribePHIDetectionJob</code> operation.