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

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 22 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::TranscriptionJob;
3 use Moose;
4 has CompletionTime => (is => 'ro', isa => 'Str');
5 has ContentRedaction => (is => 'ro', isa => 'Paws::Transcribe::ContentRedaction');
6 has CreationTime => (is => 'ro', isa => 'Str');
7 has FailureReason => (is => 'ro', isa => 'Str');
8 has IdentifiedLanguageScore => (is => 'ro', isa => 'Num');
9 has IdentifyLanguage => (is => 'ro', isa => 'Bool');
10 has JobExecutionSettings => (is => 'ro', isa => 'Paws::Transcribe::JobExecutionSettings');
11 has LanguageCode => (is => 'ro', isa => 'Str');
12 has LanguageOptions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13 has Media => (is => 'ro', isa => 'Paws::Transcribe::Media');
14 has MediaFormat => (is => 'ro', isa => 'Str');
15 has MediaSampleRateHertz => (is => 'ro', isa => 'Int');
16 has ModelSettings => (is => 'ro', isa => 'Paws::Transcribe::ModelSettings');
17 has Settings => (is => 'ro', isa => 'Paws::Transcribe::Settings');
18 has StartTime => (is => 'ro', isa => 'Str');
19 has Transcript => (is => 'ro', isa => 'Paws::Transcribe::Transcript');
20 has TranscriptionJobName => (is => 'ro', isa => 'Str');
21 has TranscriptionJobStatus => (is => 'ro', isa => 'Str');
22  
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::Transcribe::TranscriptionJob
30  
31 =head1 USAGE
32  
33 This class represents one of two things:
34  
35 =head3 Arguments in a call to a service
36  
37 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
38 Each attribute should be used as a named argument in the calls that expect this type of object.
39  
40 As an example, if Att1 is expected to be a Paws::Transcribe::TranscriptionJob object:
41  
42 $service_obj->Method(Att1 => { CompletionTime => $value, ..., TranscriptionJobStatus => $value });
43  
44 =head3 Results returned from an API call
45  
46 Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::TranscriptionJob object:
47  
48 $result = $service_obj->Method(...);
49 $result->Att1->CompletionTime
50  
51 =head1 DESCRIPTION
52  
53 Describes an asynchronous transcription job that was created with the
54 C<StartTranscriptionJob> operation.
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 CompletionTime => Str
60  
61 A timestamp that shows when the job was completed.
62  
63  
64 =head2 ContentRedaction => L<Paws::Transcribe::ContentRedaction>
65  
66 An object that describes content redaction settings for the
67 transcription job.
68  
69  
70 =head2 CreationTime => Str
71  
72 A timestamp that shows when the job was created.
73  
74  
75 =head2 FailureReason => Str
76  
77 If the C<TranscriptionJobStatus> field is C<FAILED>, this field
78 contains information about why the job failed.
79  
80 The C<FailureReason> field can contain one of the following values:
81  
82 =over
83  
84 =item *
85  
86 C<Unsupported media format> - The media format specified in the
87 C<MediaFormat> field of the request isn't valid. See the description of
88 the C<MediaFormat> field for a list of valid values.
89  
90 =item *
91  
92 C<The media format provided does not match the detected media format> -
93 The media format of the audio file doesn't match the format specified
94 in the C<MediaFormat> field in the request. Check the media format of
95 your media file and make sure that the two values match.
96  
97 =item *
98  
99 C<Invalid sample rate for audio file> - The sample rate specified in
100 the C<MediaSampleRateHertz> of the request isn't valid. The sample rate
101 must be between 8000 and 48000 Hertz.
102  
103 =item *
104  
105 C<The sample rate provided does not match the detected sample rate> -
106 The sample rate in the audio file doesn't match the sample rate
107 specified in the C<MediaSampleRateHertz> field in the request. Check
108 the sample rate of your media file and make sure that the two values
109 match.
110  
111 =item *
112  
113 C<Invalid file size: file size too large> - The size of your audio file
114 is larger than Amazon Transcribe can process. For more information, see
115 Limits
116 (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
117 in the I<Amazon Transcribe Developer Guide>.
118  
119 =item *
120  
121 C<Invalid number of channels: number of channels too large> - Your
122 audio contains more channels than Amazon Transcribe is configured to
123 process. To request additional channels, see Amazon Transcribe Limits
124 (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits-amazon-transcribe)
125 in the I<Amazon Web Services General Reference>.
126  
127 =back
128  
129  
130  
131 =head2 IdentifiedLanguageScore => Num
132  
133 A value between zero and one that Amazon Transcribe assigned to the
134 language that it identified in the source audio. Larger values indicate
135 that Amazon Transcribe has higher confidence in the language it
136 identified.
137  
138  
139 =head2 IdentifyLanguage => Bool
140  
141 A value that shows if automatic language identification was enabled for
142 a transcription job.
143  
144  
145 =head2 JobExecutionSettings => L<Paws::Transcribe::JobExecutionSettings>
146  
147 Provides information about how a transcription job is executed.
148  
149  
150 =head2 LanguageCode => Str
151  
152 The language code for the input speech.
153  
154  
155 =head2 LanguageOptions => ArrayRef[Str|Undef]
156  
157 An object that shows the optional array of languages inputted for
158 transcription jobs with automatic language identification enabled.
159  
160  
161 =head2 Media => L<Paws::Transcribe::Media>
162  
163 An object that describes the input media for the transcription job.
164  
165  
166 =head2 MediaFormat => Str
167  
168 The format of the input media file.
169  
170  
171 =head2 MediaSampleRateHertz => Int
172  
173 The sample rate, in Hertz, of the audio track in the input media file.
174  
175  
176 =head2 ModelSettings => L<Paws::Transcribe::ModelSettings>
177  
178 An object containing the details of your custom language model.
179  
180  
181 =head2 Settings => L<Paws::Transcribe::Settings>
182  
183 Optional settings for the transcription job. Use these settings to turn
184 on speaker recognition, to set the maximum number of speakers that
185 should be identified and to specify a custom vocabulary to use when
186 processing the transcription job.
187  
188  
189 =head2 StartTime => Str
190  
191 A timestamp that shows with the job was started processing.
192  
193  
194 =head2 Transcript => L<Paws::Transcribe::Transcript>
195  
196 An object that describes the output of the transcription job.
197  
198  
199 =head2 TranscriptionJobName => Str
200  
201 The name of the transcription job.
202  
203  
204 =head2 TranscriptionJobStatus => Str
205  
206 The status of the transcription job.
207  
208  
209  
210 =head1 SEE ALSO
211  
212 This class forms part of L<Paws>, describing an object used in L<Paws::Transcribe>
213  
214 =head1 BUGS and CONTRIBUTIONS
215  
216 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
217  
218 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
219  
220 =cut
221