NAME

Paws::ComprehendMedical::StartPHIDetectionJob - Arguments for method StartPHIDetectionJob on Paws::ComprehendMedical

DESCRIPTION

This class represents the parameters used for calling the method StartPHIDetectionJob on the AWS Comprehend Medical service. Use the attributes of this class as arguments to method StartPHIDetectionJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartPHIDetectionJob.

SYNOPSIS

    my $comprehendmedical = Paws->service('ComprehendMedical');
    my $StartPHIDetectionJobResponse = $comprehendmedical->StartPHIDetectionJob(
      DataAccessRoleArn => 'MyIamRoleArn',
      InputDataConfig   => {
        S3Bucket => 'MyS3Bucket',    # min: 3, max: 63
        S3Key    => 'MyS3Key',       # max: 1024; OPTIONAL
      },
      LanguageCode     => 'en',
      OutputDataConfig => {
        S3Bucket => 'MyS3Bucket',    # min: 3, max: 63
        S3Key    => 'MyS3Key',       # max: 1024; OPTIONAL
      },
      ClientRequestToken => 'MyClientRequestTokenString',    # OPTIONAL
      JobName            => 'MyJobName',                     # OPTIONAL
      KMSKey             => 'MyKMSKey',                      # OPTIONAL
    );

    # Results:
    my $JobId = $StartPHIDetectionJobResponse->JobId;

    # Returns a L<Paws::ComprehendMedical::StartPHIDetectionJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical/StartPHIDetectionJob

ATTRIBUTES

ClientRequestToken => Str

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

REQUIRED DataAccessRoleArn => Str

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 (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).

REQUIRED InputDataConfig => Paws::ComprehendMedical::InputDataConfig

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

JobName => Str

The identifier of the job.

KMSKey => Str

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.

REQUIRED LanguageCode => Str

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

Valid values are: "en"

REQUIRED OutputDataConfig => Paws::ComprehendMedical::OutputDataConfig

Specifies where to send the output files.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartPHIDetectionJob in Paws::ComprehendMedical

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues