ComprehendMedical / Client / start_phi_detection_job



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

See also: AWS API Documentation

Request Syntax

response = client.start_phi_detection_job(
        'S3Bucket': 'string',
        'S3Key': 'string'
        'S3Bucket': 'string',
        'S3Key': 'string'
  • InputDataConfig (dict) –


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

    • S3Bucket (string) – [REQUIRED]

      The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.

    • S3Key (string) –

      The path to the input data files in the S3 bucket.

  • OutputDataConfig (dict) –


    Specifies where to send the output files.

    • S3Bucket (string) – [REQUIRED]

      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.

    • S3Key (string) –

      The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

  • DataAccessRoleArn (string) –


    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

  • JobName (string) – The identifier of the job.

  • ClientRequestToken (string) –

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

    This field is autopopulated if not provided.

  • KMSKey (string) – 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 (string) –


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

Return type:



Response Syntax

    'JobId': 'string'

Response Structure

  • (dict) –

    • JobId (string) –

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