« blib/lib/Paws/MediaConvert/ListJobTemplatesResponse.pm
↑ Summary
blib/lib/Paws/MediaConvert/ListJobsResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConvert::ListJobs; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 6 | has Order => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'order'); | ||
| 7 | has Queue => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'queue'); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2017-08-29/jobs'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConvert::ListJobsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MediaConvert::ListJobs - Arguments for method ListJobs on L<Paws::MediaConvert> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListJobs on the | ||
| 27 | L<AWS Elemental MediaConvert|Paws::MediaConvert> service. Use the attributes of this class | ||
| 28 | as arguments to method ListJobs. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListJobs. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $mediaconvert = Paws->service('MediaConvert'); | ||
| 35 | my $ListJobsResponse = $mediaconvert->ListJobs( | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'My__string', # OPTIONAL | ||
| 38 | Order => 'ASCENDING', # OPTIONAL | ||
| 39 | Queue => 'My__string', # OPTIONAL | ||
| 40 | Status => 'SUBMITTED', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Jobs = $ListJobsResponse->Jobs; | ||
| 45 | my $NextToken = $ListJobsResponse->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::MediaConvert::ListJobsResponse> 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/mediaconvert/ListJobs> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 MaxResults => Int | ||
| 56 | |||
| 57 | Optional. Number of jobs, up to twenty, that will be returned at one | ||
| 58 | time. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 NextToken => Str | ||
| 63 | |||
| 64 | Optional. Use this string, provided with the response to a previous | ||
| 65 | request, to request the next batch of jobs. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Order => Str | ||
| 70 | |||
| 71 | Optional. When you request lists of resources, you can specify whether | ||
| 72 | they are sorted in ASCENDING or DESCENDING order. Default varies by | ||
| 73 | resource. | ||
| 74 | |||
| 75 | Valid values are: C<"ASCENDING">, C<"DESCENDING"> | ||
| 76 | |||
| 77 | =head2 Queue => Str | ||
| 78 | |||
| 79 | Optional. Provide a queue name to get back only jobs from that queue. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Status => Str | ||
| 84 | |||
| 85 | Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, | ||
| 86 | CANCELED, or ERROR. | ||
| 87 | |||
| 88 | Valid values are: C<"SUBMITTED">, C<"PROGRESSING">, C<"COMPLETE">, C<"CANCELED">, C<"ERROR"> | ||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method ListJobs in L<Paws::MediaConvert> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |