blib/lib/Paws/ComprehendMedical/StartPHIDetectionJob.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ComprehendMedical::StartPHIDetectionJob;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1);
6 has InputDataConfig => (is => 'ro', isa => 'Paws::ComprehendMedical::InputDataConfig', required => 1);
7 has JobName => (is => 'ro', isa => 'Str');
8 has KMSKey => (is => 'ro', isa => 'Str');
9 has LanguageCode => (is => 'ro', isa => 'Str', required => 1);
10 has OutputDataConfig => (is => 'ro', isa => 'Paws::ComprehendMedical::OutputDataConfig', required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartPHIDetectionJob');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComprehendMedical::StartPHIDetectionJobResponse');
16 class_has _result_key => (isa => 'Str', is => 'ro');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::ComprehendMedical::StartPHIDetectionJob - Arguments for method StartPHIDetectionJob on L<Paws::ComprehendMedical>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method StartPHIDetectionJob on the
28 L<AWS Comprehend Medical|Paws::ComprehendMedical> service. Use the attributes of this class
29 as arguments to method StartPHIDetectionJob.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartPHIDetectionJob.
32  
33 =head1 SYNOPSIS
34  
35 my $comprehendmedical = Paws->service('ComprehendMedical');
36 my $StartPHIDetectionJobResponse = $comprehendmedical->StartPHIDetectionJob(
37 DataAccessRoleArn => 'MyIamRoleArn',
38 InputDataConfig => {
39 S3Bucket => 'MyS3Bucket', # min: 3, max: 63
40 S3Key => 'MyS3Key', # max: 1024; OPTIONAL
41 },
42 LanguageCode => 'en',
43 OutputDataConfig => {
44 S3Bucket => 'MyS3Bucket', # min: 3, max: 63
45 S3Key => 'MyS3Key', # max: 1024; OPTIONAL
46 },
47 ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL
48 JobName => 'MyJobName', # OPTIONAL
49 KMSKey => 'MyKMSKey', # OPTIONAL
50 );
51  
52 # Results:
53 my $JobId = $StartPHIDetectionJobResponse->JobId;
54  
55 # Returns a L<Paws::ComprehendMedical::StartPHIDetectionJobResponse> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical/StartPHIDetectionJob>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 ClientRequestToken => Str
64  
65 A unique identifier for the request. If you don't set the client
66 request token, Amazon Comprehend Medical generates one.
67  
68  
69  
70 =head2 B<REQUIRED> DataAccessRoleArn => Str
71  
72 The Amazon Resource Name (ARN) of the AWS Identity and Access
73 Management (IAM) role that grants Amazon Comprehend Medical read access
74 to your input data. For more information, see Role-Based Permissions
75 Required for Asynchronous Operations
76 (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
77  
78  
79  
80 =head2 B<REQUIRED> InputDataConfig => L<Paws::ComprehendMedical::InputDataConfig>
81  
82 Specifies the format and location of the input data for the job.
83  
84  
85  
86 =head2 JobName => Str
87  
88 The identifier of the job.
89  
90  
91  
92 =head2 KMSKey => Str
93  
94 An AWS Key Management Service key to encrypt your output files. If you
95 do not specify a key, the files are written in plain text.
96  
97  
98  
99 =head2 B<REQUIRED> LanguageCode => Str
100  
101 The language of the input documents. All documents must be in the same
102 language.
103  
104 Valid values are: C<"en">
105  
106 =head2 B<REQUIRED> OutputDataConfig => L<Paws::ComprehendMedical::OutputDataConfig>
107  
108 Specifies where to send the output files.
109  
110  
111  
112  
113 =head1 SEE ALSO
114  
115 This class forms part of L<Paws>, documenting arguments for method StartPHIDetectionJob in L<Paws::ComprehendMedical>
116  
117 =head1 BUGS and CONTRIBUTIONS
118  
119 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
120  
121 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
122  
123 =cut
124