DeadlineCloud / Paginator / ListJobParameterDefinitions

ListJobParameterDefinitions#

class DeadlineCloud.Paginator.ListJobParameterDefinitions#
paginator = client.get_paginator('list_job_parameter_definitions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_job_parameter_definitions().

See also: AWS API Documentation

Request Syntax

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

  • farmId (string) –

    [REQUIRED]

    The farm ID of the job to list.

  • jobId (string) –

    [REQUIRED]

    The job ID to include on the list.

  • queueId (string) –

    [REQUIRED]

    The queue ID to include on the list.

  • 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

{
    'jobParameterDefinitions': [
        {...}|[...]|123|123.4|'string'|True|None,
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • jobParameterDefinitions (list) –

      Lists parameter definitions of a job.

    • NextToken (string) –

      A token to resume pagination.