« blib/lib/Paws/Transcribe/ListLanguageModelsResponse.pm
↑ Summary
blib/lib/Paws/Transcribe/ListMedicalTranscriptionJobsResponse.pm »
| 1 | |||
| 2 | package Paws::Transcribe::ListMedicalTranscriptionJobs; | ||
| 3 | use Moose; | ||
| 4 | has JobNameContains => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has Status => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListMedicalTranscriptionJobs'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transcribe::ListMedicalTranscriptionJobsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Transcribe::ListMedicalTranscriptionJobs - Arguments for method ListMedicalTranscriptionJobs on L<Paws::Transcribe> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListMedicalTranscriptionJobs on the | ||
| 25 | L<Amazon Transcribe Service|Paws::Transcribe> service. Use the attributes of this class | ||
| 26 | as arguments to method ListMedicalTranscriptionJobs. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListMedicalTranscriptionJobs. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $transcribe = Paws->service('Transcribe'); | ||
| 33 | my $ListMedicalTranscriptionJobsResponse = | ||
| 34 | $transcribe->ListMedicalTranscriptionJobs( | ||
| 35 | JobNameContains => 'MyTranscriptionJobName', # OPTIONAL | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 38 | Status => 'QUEUED', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $MedicalTranscriptionJobSummaries = | ||
| 43 | $ListMedicalTranscriptionJobsResponse->MedicalTranscriptionJobSummaries; | ||
| 44 | my $NextToken = $ListMedicalTranscriptionJobsResponse->NextToken; | ||
| 45 | my $Status = $ListMedicalTranscriptionJobsResponse->Status; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Transcribe::ListMedicalTranscriptionJobsResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transcribe/ListMedicalTranscriptionJobs> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 JobNameContains => Str | ||
| 56 | |||
| 57 | When specified, the jobs returned in the list are limited to jobs whose | ||
| 58 | name contains the specified string. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 MaxResults => Int | ||
| 63 | |||
| 64 | The maximum number of medical transcription jobs to return in the | ||
| 65 | response. IF there are fewer results in the list, this response | ||
| 66 | contains only the actual results. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 NextToken => Str | ||
| 71 | |||
| 72 | If you a receive a truncated result in the previous request of | ||
| 73 | C<ListMedicalTranscriptionJobs>, include C<NextToken> to fetch the next | ||
| 74 | set of jobs. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Status => Str | ||
| 79 | |||
| 80 | When specified, returns only medical transcription jobs with the | ||
| 81 | specified status. Jobs are ordered by creation date, with the newest | ||
| 82 | jobs returned first. If you don't specify a status, Amazon Transcribe | ||
| 83 | Medical returns all transcription jobs ordered by creation date. | ||
| 84 | |||
| 85 | Valid values are: C<"QUEUED">, C<"IN_PROGRESS">, C<"FAILED">, C<"COMPLETED"> | ||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method ListMedicalTranscriptionJobs in L<Paws::Transcribe> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |