Skip to content

List Quota Shares

batch_list_quota_shares R Documentation

Returns a list of Batch quota shares associated with a job queue

Description

Returns a list of Batch quota shares associated with a job queue.

Usage

batch_list_quota_shares(jobQueue, maxResults, nextToken)

Arguments

jobQueue

[required] The name or full Amazon Resource Name (ARN) of the job queue used to list quota shares.

maxResults

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

nextToken

The nextToken value that's returned from a previous paginated list_quota_shares 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(
  quotaShares = list(
    list(
      quotaShareName = "string",
      quotaShareArn = "string",
      jobQueueArn = "string",
      capacityLimits = list(
        list(
          maxCapacity = 123,
          capacityUnit = "string"
        )
      ),
      resourceSharingConfiguration = list(
        strategy = "RESERVE"|"LEND"|"LEND_AND_BORROW",
        borrowLimit = 123
      ),
      preemptionConfiguration = list(
        inSharePreemption = "ENABLED"|"DISABLED"
      ),
      state = "ENABLED"|"DISABLED",
      status = "CREATING"|"VALID"|"INVALID"|"UPDATING"|"DELETING"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_quota_shares(
  jobQueue = "string",
  maxResults = 123,
  nextToken = "string"
)