DeadlineCloud / Paginator / ListJobMembers

ListJobMembers

class DeadlineCloud.Paginator.ListJobMembers

paginator = client.get_paginator('list_job_members')

paginate(**kwargs)

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

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

{
    'members': [
        {
            'farmId': 'string',
            'identityStoreId': 'string',
            'jobId': 'string',
            'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
            'principalId': 'string',
            'principalType': 'USER'|'GROUP',
            'queueId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • members (list) –

    The members on the list.

    • (dict) –

      The details for a job member.

      • farmId (string) –

        The farm ID.

      • identityStoreId (string) –

        The identity store ID.

      • jobId (string) –

        The job ID.

      • membershipLevel (string) –

        The job member’s membership level.

      • principalId (string) –

        The principal ID of the job member.

      • principalType (string) –

        The principal type of the job member.

      • queueId (string) –

        The queue ID.

  • NextToken (string) –

    A token to resume pagination.