batch_describe_job_definitions: Describes a list of job definitions

View source: R/batch_operations.R

batch_describe_job_definitionsR Documentation

Describes a list of job definitions

Description

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

See https://www.paws-r-sdk.com/docs/batch_describe_job_definitions/ for full documentation.

Usage

batch_describe_job_definitions(
  jobDefinitions = NULL,
  maxResults = NULL,
  jobDefinitionName = NULL,
  status = NULL,
  nextToken = NULL
)

Arguments

jobDefinitions

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format ⁠arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}⁠ or a short version using the form ⁠${JobDefinitionName}:${Revision}⁠. This parameter can't be used with other parameters.

maxResults

The maximum number of results returned by describe_job_definitions in paginated output. When this parameter is used, describe_job_definitions 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 describe_job_definitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_job_definitions returns up to 100 results and a nextToken value if applicable.

jobDefinitionName

The name of the job definition to describe.

status

The status used to filter job definitions.

nextToken

The nextToken value returned from a previous paginated describe_job_definitions 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.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.


paws.compute documentation built on Sept. 12, 2024, 6:12 a.m.