List Jobs By Consumable Resource

batch_list_jobs_by_consumable_resource

R Documentation

Returns a list of Batch jobs that require a specific consumable resource

Description

Returns a list of Batch jobs that require a specific consumable resource.

Usage

batch_list_jobs_by_consumable_resource(consumableResource, filters,
  maxResults, nextToken)

Arguments

consumableResource	[required] The name or ARN of the consumable resource.
filters	The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be: name: JOB_STATUS values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED name: JOB_NAME The values are case-insensitive matches for the job name. If a filter value ends with an asterisk (), it matches any job name that begins with the string before the ''.
maxResults	The maximum number of results returned by list_jobs_by_consumable_resource in paginated output. When this parameter is used, list_jobs_by_consumable_resource 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 list_jobs_by_consumable_resource request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_jobs_by_consumable_resource returns up to 100 results and a nextToken value if applicable.
nextToken	The nextToken value returned from a previous paginated list_jobs_by_consumable_resource 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.

Value

A list with the following syntax:

list(
  jobs = list(
    list(
      jobArn = "string",
      jobQueueArn = "string",
      jobName = "string",
      jobDefinitionArn = "string",
      shareIdentifier = "string",
      jobStatus = "string",
      quantity = 123,
      statusReason = "string",
      startedAt = 123,
      createdAt = 123,
      consumableResourceProperties = list(
        consumableResourceList = list(
          list(
            consumableResource = "string",
            quantity = 123
          )
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_jobs_by_consumable_resource(
  consumableResource = "string",
  filters = list(
    list(
      name = "string",
      values = list(
        "string"
      )
    )
  ),
  maxResults = 123,
  nextToken = "string"
)