/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Batch::ListJobs

NAME

Paws::Batch::ListJobs - Arguments for method ListJobs on Paws::Batch

DESCRIPTION

This class represents the parameters used for calling the method ListJobs on the AWS Batch 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.

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<Paws::Batch::ListJobsResponse> 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<Paws::Batch::ListJobsResponse> 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 https://docs.aws.amazon.com/goto/WebAPI/batch/ListJobs

ATTRIBUTES

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.

JobQueue => Str

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

JobStatus => Str

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Valid values are: "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"

MaxResults => Int

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

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.

NextToken => Str

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListJobs in Paws::Batch

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues