package Paws::Batch::ListJobs; use Moose; has ArrayJobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'arrayJobId'); has JobQueue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobQueue'); has JobStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobStatus'); has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); has MultiNodeJobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'multiNodeJobId'); has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs'); class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/listjobs'); class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::ListJobsResponse'); 1; ### main pod documentation begin ### =head1 NAME Paws::Batch::ListJobs - Arguments for method ListJobs on L =head1 DESCRIPTION This class represents the parameters used for calling the method ListJobs on the L service. Use the attributes of this class as arguments to method ListJobs. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListJobs. =head1 SYNOPSIS my $batch = Paws->service('Batch'); # To list running jobs # This example lists the running jobs in the HighPriority job queue. my $ListJobsResponse = $batch->ListJobs( 'JobQueue' => 'HighPriority' ); # Results: my $jobSummaryList = $ListJobsResponse->jobSummaryList; # Returns a L object. # To list submitted jobs # This example lists jobs in the HighPriority job queue that are in the # SUBMITTED job status. my $ListJobsResponse = $batch->ListJobs( 'JobQueue' => 'HighPriority', 'JobStatus' => 'SUBMITTED' ); # Results: my $jobSummaryList = $ListJobsResponse->jobSummaryList; # Returns a L object. 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. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 ArrayJobId => Str The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array. =head2 JobQueue => Str The name or full Amazon Resource Name (ARN) of the job queue used to list jobs. =head2 JobStatus => Str The job status used to filter jobs in the specified queue. If you don't specify a status, only C jobs are returned. Valid values are: C<"SUBMITTED">, C<"PENDING">, C<"RUNNABLE">, C<"STARTING">, C<"RUNNING">, C<"SUCCEEDED">, C<"FAILED"> =head2 MaxResults => Int The maximum number of results returned by C in paginated output. When this parameter is used, C only returns C results in a single page and a C response element. The remaining results of the initial request can be seen by sending another C request with the returned C value. This value can be between 1 and 100. If this parameter isn't used, then C returns up to 100 results and a C value if applicable. =head2 MultiNodeJobId => Str The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job. =head2 NextToken => Str The C value returned from a previous paginated C request where C was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the C value. This value is C when there are no more results to return. This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes. =head1 SEE ALSO This class forms part of L, documenting arguments for method ListJobs in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut