DeadlineCloud / Paginator / ListMemberships

ListMemberships

class DeadlineCloud.Paginator.ListMemberships

paginator = client.get_paginator('list_memberships')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    principalId='string',
    identityStoreId='string',
    identityCenterRegion='string',
    resourceTypes=[
        'FARM'|'QUEUE'|'FLEET'|'JOB',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• principalId (string) –

  [REQUIRED]

  The ID of the IAM Identity Center principal whose Deadline Cloud resource memberships you want to list.

• identityStoreId (string) – The identity store ID that contains the principal. This parameter is required for callers that do not use a monitor session.

• identityCenterRegion (string) – The Region of the IAM Identity Center instance. If not provided, the service defaults to the Amazon Web Services Region in which you make the request.

• resourceTypes (list) –

  The resource types to include when listing the principal’s memberships. If not specified, memberships for all supported resource types are returned.

  • (string) –

• 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

{
    'memberships': [
        {
            'farm': {
                'farmId': 'string',
                'principalId': 'string',
                'principalType': 'USER'|'GROUP',
                'identityStoreId': 'string',
                'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
            },
            'queue': {
                'farmId': 'string',
                'queueId': 'string',
                'principalId': 'string',
                'principalType': 'USER'|'GROUP',
                'identityStoreId': 'string',
                'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
            },
            'fleet': {
                'farmId': 'string',
                'fleetId': 'string',
                'principalId': 'string',
                'principalType': 'USER'|'GROUP',
                'identityStoreId': 'string',
                'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
            },
            'job': {
                'farmId': 'string',
                'queueId': 'string',
                'jobId': 'string',
                'principalId': 'string',
                'principalType': 'USER'|'GROUP',
                'identityStoreId': 'string',
                'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Shared pagination field for List operation outputs (nextToken).

  • memberships (list) –

    The memberships associated with the specified principal.

    • (dict) –

      A membership record for a principal on a single Deadline Cloud resource. The summary identifies the resource that the principal is a member of and the principal’s membership level for that resource.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: farm, queue, fleet, job. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • farm (dict) –

        A membership on a farm.

        • farmId (string) –

          The farm ID of the farm member.

        • principalId (string) –

          The principal ID of the farm member.

        • principalType (string) –

          The principal type of the farm member.

        • identityStoreId (string) –

          The identity store ID of the farm member.

        • membershipLevel (string) –

          The farm member’s membership level.

      • queue (dict) –

        A membership on a queue.

        • farmId (string) –

          The farm ID.

        • queueId (string) –

          The queue ID.

        • principalId (string) –

          The principal ID of the queue member.

        • principalType (string) –

          The principal type of the queue member.

        • identityStoreId (string) –

          The identity store ID.

        • membershipLevel (string) –

          The queue member’s membership level.

      • fleet (dict) –

        A membership on a fleet.

        • farmId (string) –

          The farm ID.

        • fleetId (string) –

          The fleet ID.

        • principalId (string) –

          The principal ID of the fleet member.

        • principalType (string) –

          The principal type of the fleet member.

        • identityStoreId (string) –

          The identity store ID.

        • membershipLevel (string) –

          The fleet member’s membership level.

      • job (dict) –

        A membership on a job.

        • farmId (string) –

          The farm ID.

        • queueId (string) –

          The queue ID.

        • jobId (string) –

          The job ID.

        • principalId (string) –

          The principal ID of the job member.

        • principalType (string) –

          The principal type of the job member.

        • identityStoreId (string) –

          The identity store ID.

        • membershipLevel (string) –

          The job member’s membership level.

  • NextToken (string) –

    A token to resume pagination.