1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. batch
  6. getQuotaShare

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi

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

    Using getQuotaShare

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQuotaShare(args: GetQuotaShareArgs, opts?: InvokeOptions): Promise<GetQuotaShareResult>
    function getQuotaShareOutput(args: GetQuotaShareOutputArgs, opts?: InvokeOptions): Output<GetQuotaShareResult>
    def get_quota_share(quota_share_arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetQuotaShareResult
    def get_quota_share_output(quota_share_arn: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetQuotaShareResult]
    func LookupQuotaShare(ctx *Context, args *LookupQuotaShareArgs, opts ...InvokeOption) (*LookupQuotaShareResult, error)
    func LookupQuotaShareOutput(ctx *Context, args *LookupQuotaShareOutputArgs, opts ...InvokeOption) LookupQuotaShareResultOutput

    > Note: This function is named LookupQuotaShare in the Go SDK.

    public static class GetQuotaShare 
    {
        public static Task<GetQuotaShareResult> InvokeAsync(GetQuotaShareArgs args, InvokeOptions? opts = null)
        public static Output<GetQuotaShareResult> Invoke(GetQuotaShareInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQuotaShareResult> getQuotaShare(GetQuotaShareArgs args, InvokeOptions options)
    public static Output<GetQuotaShareResult> getQuotaShare(GetQuotaShareArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:batch:getQuotaShare
      arguments:
        # arguments dictionary

    The following arguments are supported:

    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.
    quotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    quota_share_arn str
    The Amazon Resource Name (ARN) of the quota share.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.

    getQuotaShare Result

    The following output properties are available:

    CapacityLimits List<Pulumi.AwsNative.Batch.Outputs.QuotaShareCapacityLimit>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    PreemptionConfiguration Pulumi.AwsNative.Batch.Outputs.QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    ResourceSharingConfiguration Pulumi.AwsNative.Batch.Outputs.QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    State Pulumi.AwsNative.Batch.QuotaShareState
    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 Dictionary<string, string>
    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.
    CapacityLimits []QuotaShareCapacityLimit
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    PreemptionConfiguration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    ResourceSharingConfiguration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    State QuotaShareStateEnum
    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 map[string]string
    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.
    capacityLimits List<QuotaShareCapacityLimit>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    preemptionConfiguration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.
    resourceSharingConfiguration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    state QuotaShareState
    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 Map<String,String>
    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.
    capacityLimits QuotaShareCapacityLimit[]
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    preemptionConfiguration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    quotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    resourceSharingConfiguration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    state QuotaShareState
    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 {[key: string]: string}
    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.
    capacity_limits Sequence[QuotaShareCapacityLimit]
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    preemption_configuration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    quota_share_arn str
    The Amazon Resource Name (ARN) of the quota share.
    resource_sharing_configuration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    state QuotaShareState
    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 Mapping[str, str]
    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.
    capacityLimits List<Property Map>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    preemptionConfiguration Property Map
    Specifies the preemption behavior for jobs in a quota share.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.
    resourceSharingConfiguration Property Map
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    state "ENABLED" | "DISABLED"
    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 Map<String>
    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.

    Supporting Types

    QuotaShareCapacityLimit

    CapacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    MaxCapacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    CapacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    MaxCapacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit String
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity Integer
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity number
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacity_unit str
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    max_capacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit String
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity Number
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.

    QuotaSharePreemptionConfiguration

    InSharePreemption Pulumi.AwsNative.Batch.QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    InSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    in_share_preemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption "ENABLED" | "DISABLED"
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.

    QuotaSharePreemptionConfigurationInSharePreemption

    QuotaShareResourceSharingConfiguration

    Strategy Pulumi.AwsNative.Batch.QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    BorrowLimit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    Strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    BorrowLimit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit Integer
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit number
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrow_limit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy "RESERVE" | "LEND" | "LEND_AND_BORROW"
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit Number
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.

    QuotaShareResourceSharingConfigurationStrategy

    QuotaShareState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.63.0
    published on Monday, May 4, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.