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