blib/lib/Paws/Transcribe/MedicalTranscriptionJob.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Transcribe::MedicalTranscriptionJob;
3 use Moose;
4 has CompletionTime => (is => 'ro', isa => 'Str');
5 has ContentIdentificationType => (is => 'ro', isa => 'Str');
6 has CreationTime => (is => 'ro', isa => 'Str');
7 has FailureReason => (is => 'ro', isa => 'Str');
8 has LanguageCode => (is => 'ro', isa => 'Str');
9 has Media => (is => 'ro', isa => 'Paws::Transcribe::Media');
10 has MediaFormat => (is => 'ro', isa => 'Str');
11 has MediaSampleRateHertz => (is => 'ro', isa => 'Int');
12 has MedicalTranscriptionJobName => (is => 'ro', isa => 'Str');
13 has Settings => (is => 'ro', isa => 'Paws::Transcribe::MedicalTranscriptionSetting');
14 has Specialty => (is => 'ro', isa => 'Str');
15 has StartTime => (is => 'ro', isa => 'Str');
16 has Transcript => (is => 'ro', isa => 'Paws::Transcribe::MedicalTranscript');
17 has TranscriptionJobStatus => (is => 'ro', isa => 'Str');
18 has Type => (is => 'ro', isa => 'Str');
19  
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Transcribe::MedicalTranscriptionJob
27  
28 =head1 USAGE
29  
30 This class represents one of two things:
31  
32 =head3 Arguments in a call to a service
33  
34 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35 Each attribute should be used as a named argument in the calls that expect this type of object.
36  
37 As an example, if Att1 is expected to be a Paws::Transcribe::MedicalTranscriptionJob object:
38  
39 $service_obj->Method(Att1 => { CompletionTime => $value, ..., Type => $value });
40  
41 =head3 Results returned from an API call
42  
43 Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::MedicalTranscriptionJob object:
44  
45 $result = $service_obj->Method(...);
46 $result->Att1->CompletionTime
47  
48 =head1 DESCRIPTION
49  
50 The data structure that contains the information for a medical
51 transcription job.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 CompletionTime => Str
57  
58 A timestamp that shows when the job was completed.
59  
60  
61 =head2 ContentIdentificationType => Str
62  
63 Shows the type of content that you've configured Amazon Transcribe
64 Medical to identify in a transcription job. If the value is C<PHI>,
65 you've configured the job to identify personal health information (PHI)
66 in the transcription output.
67  
68  
69 =head2 CreationTime => Str
70  
71 A timestamp that shows when the job was created.
72  
73  
74 =head2 FailureReason => Str
75  
76 If the C<TranscriptionJobStatus> field is C<FAILED>, this field
77 contains information about why the job failed.
78  
79 The C<FailureReason> field contains one of the following values:
80  
81 =over
82  
83 =item *
84  
85 C<Unsupported media format>- The media format specified in the
86 C<MediaFormat> field of the request isn't valid. See the description of
87 the C<MediaFormat> field for a list of valid values.
88  
89 =item *
90  
91 C<The media format provided does not match the detected media format>-
92 The media format of the audio file doesn't match the format specified
93 in the C<MediaFormat> field in the request. Check the media format of
94 your media file and make sure the two values match.
95  
96 =item *
97  
98 C<Invalid sample rate for audio file>- The sample rate specified in the
99 C<MediaSampleRateHertz> of the request isn't valid. The sample rate
100 must be between 8000 and 48000 Hertz.
101  
102 =item *
103  
104 C<The sample rate provided does not match the detected sample rate>-
105 The sample rate in the audio file doesn't match the sample rate
106 specified in the C<MediaSampleRateHertz> field in the request. Check
107 the sample rate of your media file and make sure that the two values
108 match.
109  
110 =item *
111  
112 C<Invalid file size: file size too large>- The size of your audio file
113 is larger than what Amazon Transcribe Medical can process. For more
114 information, see Guidelines and Quotas
115 (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
116 in the I<Amazon Transcribe Medical Guide>
117  
118 =item *
119  
120 C<Invalid number of channels: number of channels too large>- Your audio
121 contains more channels than Amazon Transcribe Medical is configured to
122 process. To request additional channels, see Amazon Transcribe Medical
123 Endpoints and Quotas
124 (https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html)
125 in the I<Amazon Web Services General Reference>
126  
127 =back
128  
129  
130  
131 =head2 LanguageCode => Str
132  
133 The language code for the language spoken in the source audio file. US
134 English (en-US) is the only supported language for medical
135 transcriptions. Any other value you enter for language code results in
136 a C<BadRequestException> error.
137  
138  
139 =head2 Media => L<Paws::Transcribe::Media>
140  
141  
142  
143  
144 =head2 MediaFormat => Str
145  
146 The format of the input media file.
147  
148  
149 =head2 MediaSampleRateHertz => Int
150  
151 The sample rate, in Hertz, of the source audio containing medical
152 information.
153  
154 If you don't specify the sample rate, Amazon Transcribe Medical
155 determines it for you. If you choose to specify the sample rate, it
156 must match the rate detected by Amazon Transcribe Medical. In most
157 cases, you should leave the C<MediaSampleHertz> blank and let Amazon
158 Transcribe Medical determine the sample rate.
159  
160  
161 =head2 MedicalTranscriptionJobName => Str
162  
163 The name for a given medical transcription job.
164  
165  
166 =head2 Settings => L<Paws::Transcribe::MedicalTranscriptionSetting>
167  
168 Object that contains object.
169  
170  
171 =head2 Specialty => Str
172  
173 The medical specialty of any clinicians providing a dictation or having
174 a conversation. C<PRIMARYCARE> is the only available setting for this
175 object. This specialty enables you to generate transcriptions for the
176 following medical fields:
177  
178 =over
179  
180 =item *
181  
182 Family Medicine
183  
184 =back
185  
186  
187  
188 =head2 StartTime => Str
189  
190 A timestamp that shows when the job started processing.
191  
192  
193 =head2 Transcript => L<Paws::Transcribe::MedicalTranscript>
194  
195 An object that contains the C<MedicalTranscript>. The
196 C<MedicalTranscript> contains the C<TranscriptFileUri>.
197  
198  
199 =head2 TranscriptionJobStatus => Str
200  
201 The completion status of a medical transcription job.
202  
203  
204 =head2 Type => Str
205  
206 The type of speech in the transcription job. C<CONVERSATION> is
207 generally used for patient-physician dialogues. C<DICTATION> is the
208 setting for physicians speaking their notes after seeing a patient. For
209 more information, see how-it-works-med
210  
211  
212  
213 =head1 SEE ALSO
214  
215 This class forms part of L<Paws>, describing an object used in L<Paws::Transcribe>
216  
217 =head1 BUGS and CONTRIBUTIONS
218  
219 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
220  
221 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
222  
223 =cut
224