Skip to content

StartPHIDetectionJobRequest

Source code in docs_src/capo_comprehendmedical/types/start_phi_detection_job_request.py
class StartPHIDetectionJobRequest(TypedDict, closed=True):
    input_data_config: "capo_comprehendmedical.types.input_data_config.InputDataConfig"
    """<p>Specifies the format and location of the input data for the job.</p>"""
    output_data_config: (
        "capo_comprehendmedical.types.output_data_config.OutputDataConfig"
    )
    """<p>Specifies where to send the output files.</p>"""
    data_access_role_arn: "capo_comprehendmedical.types.iam_role_arn.IamRoleArn"
    """<p>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 <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>.</p>"""
    job_name: NotRequired["capo_comprehendmedical.types.job_name.JobName"]
    """<p>The identifier of the job.</p>"""
    client_request_token: NotRequired[
        "capo_comprehendmedical.types.client_request_token_string.ClientRequestTokenString"
    ]
    """<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.</p>"""
    kms_key: NotRequired["capo_comprehendmedical.types.kms_key.KMSKey"]
    """<p>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.</p>"""
    language_code: "capo_comprehendmedical.types.language_code.LanguageCode"
    """<p>The language of the input documents. All documents must be in the same language.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestTokenString]

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

data_access_role_arn instance-attribute

data_access_role_arn: IamRoleArn

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.

input_data_config instance-attribute

input_data_config: InputDataConfig

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

job_name instance-attribute

job_name: NotRequired[JobName]

The identifier of the job.

kms_key instance-attribute

kms_key: NotRequired[KMSKey]

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.

language_code instance-attribute

language_code: LanguageCode

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

output_data_config instance-attribute

output_data_config: OutputDataConfig

Specifies where to send the output files.