Batch / Paginator / ListSchedulingPolicies

ListSchedulingPolicies#

class Batch.Paginator.ListSchedulingPolicies#

paginator = client.get_paginator('list_scheduling_policies')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

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

{
    'schedulingPolicies': [
        {
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- schedulingPolicies (list) –
  
  A list of scheduling policies that match the request.
  - (dict) –
    
    An object that contains the details of a scheduling policy that’s returned in a ListSchedulingPolicy action.
    - arn (string) –
      
      Amazon Resource Name (ARN) of the scheduling policy.
- NextToken (string) –
  
  A token to resume pagination.