Skip to content

ListMembershipsRequest

Source code in docs_src/capo_deadline/types/list_memberships_request.py
class ListMembershipsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_deadline.types.next_token.NextToken"]
    """<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>"""
    max_results: "capo_deadline.types.max_results.MaxResults"
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    principal_id: (
        "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId"
    )
    """<p>The ID of the IAM Identity Center principal whose Deadline Cloud resource memberships you want to list.</p>"""
    identity_store_id: NotRequired[
        "capo_deadline.types.identity_store_id.IdentityStoreId"
    ]
    """<p>The identity store ID that contains the principal. This parameter is required for callers that do not use a monitor session.</p>"""
    identity_center_region: NotRequired["capo_deadline.types.region.Region"]
    """<p>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.</p>"""
    resource_types: NotRequired[
        "capo_deadline.types.membership_resource_types.MembershipResourceTypes"
    ]
    """<p>The resource types to include when listing the principal's memberships. If not specified, memberships for all supported resource types are returned.</p>"""

identity_center_region instance-attribute

identity_center_region: NotRequired[Region]

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.

identity_store_id instance-attribute

identity_store_id: NotRequired[IdentityStoreId]

The identity store ID that contains the principal. This parameter is required for callers that do not use a monitor session.

max_results instance-attribute

max_results: MaxResults

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next set of results, or null to start from the beginning.

principal_id instance-attribute

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

resource_types instance-attribute

resource_types: NotRequired[MembershipResourceTypes]

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