Batch / Client / list_scheduling_policies
list_scheduling_policies#
- Batch.Client.list_scheduling_policies(**kwargs)#
Returns a list of Batch scheduling policies.
See also: AWS API Documentation
Request Syntax
response = client.list_scheduling_policies( maxResults=123, nextToken='string' )
- Parameters:
maxResults (integer) – The maximum number of results that’s returned by
ListSchedulingPolicies
in paginated output. When this parameter is used,ListSchedulingPolicies
only returnsmaxResults
results in a single page and anextToken
response element. You can see the remaining results of the initial request by sending anotherListSchedulingPolicies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn’t used,ListSchedulingPolicies
returns up to 100 results and anextToken
value if applicable.nextToken (string) –
The
nextToken
value that’s returned from a previous paginatedListSchedulingPolicies
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.Note
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.
- 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) –
The
nextToken
value to include in a futureListSchedulingPolicies
request. When the results of aListSchedulingPolicies
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Exceptions
Batch.Client.exceptions.ClientException
Batch.Client.exceptions.ServerException