« blib/lib/Paws/Transcribe/TranscriptionJob.pm
↑ Summary
blib/lib/Paws/Transcribe/UpdateMedicalVocabulary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Transcribe::TranscriptionJobSummary; | ||
| 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 LanguageCode => (is => 'ro', isa => 'Str'); | ||
| 11 | has ModelSettings => (is => 'ro', isa => 'Paws::Transcribe::ModelSettings'); | ||
| 12 | has OutputLocationType => (is => 'ro', isa => 'Str'); | ||
| 13 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 14 | has TranscriptionJobName => (is => 'ro', isa => 'Str'); | ||
| 15 | has TranscriptionJobStatus => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Transcribe::TranscriptionJobSummary | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Transcribe::TranscriptionJobSummary object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { CompletionTime => $value, ..., TranscriptionJobStatus => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::TranscriptionJobSummary object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->CompletionTime | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Provides a summary of information about a transcription job. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CompletionTime => Str | ||
| 53 | |||
| 54 | A timestamp that shows when the job was completed. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ContentRedaction => L<Paws::Transcribe::ContentRedaction> | ||
| 58 | |||
| 59 | The content redaction settings of the transcription job. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 CreationTime => Str | ||
| 63 | |||
| 64 | A timestamp that shows when the job was created. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 FailureReason => Str | ||
| 68 | |||
| 69 | If the C<TranscriptionJobStatus> field is C<FAILED>, a description of | ||
| 70 | the error. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 IdentifiedLanguageScore => Num | ||
| 74 | |||
| 75 | A value between zero and one that Amazon Transcribe assigned to the | ||
| 76 | language it identified in the source audio. A higher score indicates | ||
| 77 | that Amazon Transcribe is more confident in the language it identified. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 IdentifyLanguage => Bool | ||
| 81 | |||
| 82 | Whether automatic language identification was enabled for a | ||
| 83 | transcription job. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 LanguageCode => Str | ||
| 87 | |||
| 88 | The language code for the input speech. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ModelSettings => L<Paws::Transcribe::ModelSettings> | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 OutputLocationType => Str | ||
| 97 | |||
| 98 | Indicates the location of the output of the transcription job. | ||
| 99 | |||
| 100 | If the value is C<CUSTOMER_BUCKET> then the location is the S3 bucket | ||
| 101 | specified in the C<outputBucketName> field when the transcription job | ||
| 102 | was started with the C<StartTranscriptionJob> operation. | ||
| 103 | |||
| 104 | If the value is C<SERVICE_BUCKET> then the output is stored by Amazon | ||
| 105 | Transcribe and can be retrieved using the URI in the | ||
| 106 | C<GetTranscriptionJob> response's C<TranscriptFileUri> field. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 StartTime => Str | ||
| 110 | |||
| 111 | A timestamp that shows when the job started processing. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 TranscriptionJobName => Str | ||
| 115 | |||
| 116 | The name of the transcription job. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 TranscriptionJobStatus => Str | ||
| 120 | |||
| 121 | The status of the transcription job. When the status is C<COMPLETED>, | ||
| 122 | use the C<GetTranscriptionJob> operation to get the results of the | ||
| 123 | transcription. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, describing an object used in L<Paws::Transcribe> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |