DeadlineCloud / Client / list_memberships

list_memberships¶

DeadlineCloud.Client.list_memberships(**kwargs)¶

Lists the Deadline Cloud resource memberships associated with a specified IAM Identity Center principal, optionally filtered by the requested resource types.

Request Syntax

response = client.list_memberships(
    nextToken='string',
    maxResults=123,
    principalId='string',
    identityStoreId='string',
    identityCenterRegion='string',
    resourceTypes=[
        'FARM'|'QUEUE'|'FLEET'|'JOB',
    ]
)

Parameters:

nextToken (string) – The token for the next set of results, or null to start from the beginning.
maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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) –

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) –
  
  If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException