File Coverage

blib/lib/Paws/Batch/DescribeJobDefinitions.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Batch::DescribeJobDefinitions;
3 1     1   442 use Moose;
  1         2  
  1         6  
4             has JobDefinitionName => (is => 'ro', isa => 'Str');
5             has JobDefinitions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has MaxResults => (is => 'ro', isa => 'Int');
7             has NextToken => (is => 'ro', isa => 'Str');
8             has Status => (is => 'ro', isa => 'Str');
9              
10 1     1   6001 use MooseX::ClassAttribute;
  1         2  
  1         6  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeJobDefinitions');
13             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/describejobdefinitions');
14             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::DescribeJobDefinitionsResponse');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::Batch::DescribeJobDefinitions - Arguments for method DescribeJobDefinitions on Paws::Batch
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method DescribeJobDefinitions on the
28             AWS Batch service. Use the attributes of this class
29             as arguments to method DescribeJobDefinitions.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeJobDefinitions.
32              
33             As an example:
34              
35             $service_obj->DescribeJobDefinitions(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 JobDefinitionName => Str
43              
44             The name of the job definition to describe.
45              
46              
47              
48             =head2 JobDefinitions => ArrayRef[Str|Undef]
49              
50             A space-separated list of up to 100 job definition names or full Amazon
51             Resource Name (ARN) entries.
52              
53              
54              
55             =head2 MaxResults => Int
56              
57             The maximum number of results returned by C<DescribeJobDefinitions> in
58             paginated output. When this parameter is used,
59             C<DescribeJobDefinitions> only returns C<maxResults> results in a
60             single page along with a C<nextToken> response element. The remaining
61             results of the initial request can be seen by sending another
62             C<DescribeJobDefinitions> request with the returned C<nextToken> value.
63             This value can be between 1 and 100. If this parameter is not used,
64             then C<DescribeJobDefinitions> returns up to 100 results and a
65             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<DescribeJobDefinitions> 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 is only used
78             to retrieve the next items in a list and not for other programmatic
79             purposes.
80              
81              
82              
83             =head2 Status => Str
84              
85             The status with which to filter job definitions.
86              
87              
88              
89              
90             =head1 SEE ALSO
91              
92             This class forms part of L<Paws>, documenting arguments for method DescribeJobDefinitions in L<Paws::Batch>
93              
94             =head1 BUGS and CONTRIBUTIONS
95              
96             The source code is located here: https://github.com/pplu/aws-sdk-perl
97              
98             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
99              
100             =cut
101