class Aws::ComprehendMedical::Types::StartPHIDetectionJobRequest
@note When making an API call, you may pass StartPHIDetectionJobRequest
data as a hash: { input_data_config: { # required s3_bucket: "S3Bucket", # required s3_key: "S3Key", }, output_data_config: { # required s3_bucket: "S3Bucket", # required s3_key: "S3Key", }, data_access_role_arn: "IamRoleArn", # required job_name: "JobName", client_request_token: "ClientRequestTokenString", kms_key: "KMSKey", language_code: "en", # required, accepts en }
@!attribute [rw] input_data_config
Specifies the format and location of the input data for the job. @return [Types::InputDataConfig]
@!attribute [rw] output_data_config
Specifies where to send the output files. @return [Types::OutputDataConfig]
@!attribute [rw] data_access_role_arn
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][1]. [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med @return [String]
@!attribute [rw] job_name
The identifier of the job. @return [String]
@!attribute [rw] client_request_token
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] kms_key
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. @return [String]
@!attribute [rw] language_code
The language of the input documents. All documents must be in the same language. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobRequest AWS API Documentation
Constants
- SENSITIVE