Create Quota Share

batch_create_quota_share

R Documentation

Description¶

Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

Usage¶

batch_create_quota_share(quotaShareName, jobQueue, capacityLimits,
  resourceSharingConfiguration, preemptionConfiguration, state, tags)

Arguments¶

quotaShareName

[required] The name of the quota share. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

jobQueue

[required] The Batch job queue associated with the quota share. This can be the job queue name or ARN. A job queue must be in the VALID state before you can associate it with a quota share.

capacityLimits

[required] A list that specifies the quantity and type of compute capacity allocated to the quota share.

resourceSharingConfiguration

[required] Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.

preemptionConfiguration

[required] Specifies the preemption behavior for jobs in a quota share.

state

The state of the quota share. If the quota share is ENABLED, it is able to accept jobs. If the quota share is DISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state is ENABLED.

tags

The tags that you apply to the quota share to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

Value¶

A list with the following syntax:

list(
  quotaShareName = "string",
  quotaShareArn = "string"
)

Request syntax¶

svc$create_quota_share(
  quotaShareName = "string",
  jobQueue = "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",
  tags = list(
    "string"
  )
)