« blib/lib/Paws/Batch/DescribeJobDefinitionsResponse.pm
↑ Summary
blib/lib/Paws/Batch/DescribeJobQueuesResponse.pm »
| 1 | |||
| 2 | package Paws::Batch::DescribeJobQueues; | ||
| 3 | use Moose; | ||
| 4 | has JobQueues => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'jobQueues'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeJobQueues'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/describejobqueues'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::DescribeJobQueuesResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Batch::DescribeJobQueues - Arguments for method DescribeJobQueues on L<Paws::Batch> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeJobQueues on the | ||
| 25 | L<AWS Batch|Paws::Batch> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeJobQueues. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeJobQueues. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $batch = Paws->service('Batch'); | ||
| 33 | # To describe a job queue | ||
| 34 | # This example describes the HighPriority job queue. | ||
| 35 | my $DescribeJobQueuesResponse = | ||
| 36 | $batch->DescribeJobQueues( 'JobQueues' => ['HighPriority'] ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $jobQueues = $DescribeJobQueuesResponse->jobQueues; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Batch::DescribeJobQueuesResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/DescribeJobQueues> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 JobQueues => ArrayRef[Str|Undef] | ||
| 50 | |||
| 51 | A list of up to 100 queue names or full queue Amazon Resource Name | ||
| 52 | (ARN) entries. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 MaxResults => Int | ||
| 57 | |||
| 58 | The maximum number of results returned by C<DescribeJobQueues> in | ||
| 59 | paginated output. When this parameter is used, C<DescribeJobQueues> | ||
| 60 | only returns C<maxResults> results in a single page and a C<nextToken> | ||
| 61 | response element. The remaining results of the initial request can be | ||
| 62 | seen by sending another C<DescribeJobQueues> request with the returned | ||
| 63 | C<nextToken> value. This value can be between 1 and 100. If this | ||
| 64 | parameter isn't used, then C<DescribeJobQueues> returns up to 100 | ||
| 65 | results and a C<nextToken> value if applicable. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 NextToken => Str | ||
| 70 | |||
| 71 | The C<nextToken> value returned from a previous paginated | ||
| 72 | C<DescribeJobQueues> request where C<maxResults> was used and the | ||
| 73 | results exceeded the value of that parameter. Pagination continues from | ||
| 74 | the end of the previous results that returned the C<nextToken> value. | ||
| 75 | This value is C<null> when there are no more results to return. | ||
| 76 | |||
| 77 | This token should be treated as an opaque identifier that's only used | ||
| 78 | to retrieve the next items in a list and not for other programmatic | ||
| 79 | purposes. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method DescribeJobQueues in L<Paws::Batch> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |