Batch / Paginator / ListQuotaShares

ListQuotaShares¶

class Batch.Paginator.ListQuotaShares¶

paginator = client.get_paginator('list_quota_shares')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Batch.Client.list_quota_shares().

Request Syntax

response_iterator = paginator.paginate(
    jobQueue='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

jobQueue (string) –
[REQUIRED]

The name or full Amazon Resource Name (ARN) of the job queue used to list quota shares.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'quotaShares': [
        {
            'quotaShareName': 'string',
            'quotaShareArn': 'string',
            'jobQueueArn': 'string',
            'capacityLimits': [
                {
                    'maxCapacity': 123,
                    'capacityUnit': 'string'
                },
            ],
            'resourceSharingConfiguration': {
                'strategy': 'RESERVE'|'LEND'|'LEND_AND_BORROW',
                'borrowLimit': 123
            },
            'preemptionConfiguration': {
                'inSharePreemption': 'ENABLED'|'DISABLED'
            },
            'state': 'ENABLED'|'DISABLED',
            'status': 'CREATING'|'VALID'|'INVALID'|'UPDATING'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- quotaShares (list) –
  
  A list of quota shares that match the request.
  - (dict) –
    
    Detailed information about a quota share, including its configuration, state, and capacity limits.
    - quotaShareName (string) –
      
      The name of the quota share.
    - quotaShareArn (string) –
      
      The Amazon Resource Name (ARN) of the quota share.
    - jobQueueArn (string) –
      
      The Amazon Resource Name (ARN) of the job queue associated with the quota share.
    - capacityLimits (list) –
      
      A list that specifies the quantity and type of compute capacity allocated to the quota share.
      - (dict) –
        
        Defines the capacity limit for a quota share, or the type and maximum quantity of a particular resource that can be allocated to jobs in the quota share without borrowing.
        
        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.
    - resourceSharingConfiguration (dict) –
      
      Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
      - strategy (string) –
        
        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.
    - preemptionConfiguration (dict) –
      
      Specifies the preemption behavior for jobs in a quota share.
      - inSharePreemption (string) –
        
        Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    - state (string) –
      
      The state of the quota share.
    - status (string) –
      
      The current status of the quota share.
- NextToken (string) –
  
  A token to resume pagination.