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
ListSchedulingPoliciesin paginated output. When this parameter is used,ListSchedulingPoliciesonly returnsmaxResultsresults in a single page and anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListSchedulingPoliciesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn’t used,ListSchedulingPoliciesreturns up to 100 results and anextTokenvalue if applicable.nextToken (string) –
The
nextTokenvalue that’s returned from a previous paginatedListSchedulingPoliciesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen 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
ListSchedulingPolicyaction.arn (string) –
Amazon Resource Name (ARN) of the scheduling policy.
nextToken (string) –
The
nextTokenvalue to include in a futureListSchedulingPoliciesrequest. When the results of aListSchedulingPoliciesrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.
Exceptions
Batch.Client.exceptions.ClientExceptionBatch.Client.exceptions.ServerException