batch_describe_job_queues: Describes one or more of your job queues

Description Usage Arguments Value Request syntax Examples

View source: R/batch_operations.R

Description

Describes one or more of your job queues.

Usage

1
batch_describe_job_queues(jobQueues, maxResults, nextToken)

Arguments

jobQueues

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

maxResults

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

nextToken

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
list(
  jobQueues = list(
    list(
      jobQueueName = "string",
      jobQueueArn = "string",
      state = "ENABLED"|"DISABLED",
      status = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID",
      statusReason = "string",
      priority = 123,
      computeEnvironmentOrder = list(
        list(
          order = 123,
          computeEnvironment = "string"
        )
      ),
      tags = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$describe_job_queues(
  jobQueues = list(
    "string"
  ),
  maxResults = 123,
  nextToken = "string"
)

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# This example describes the HighPriority job queue.
svc$describe_job_queues(
  jobQueues = list(
    "HighPriority"
  )
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.