list_memberships ¶

def list_memberships(
    self,
    principal_id: "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    next_token: Optional["capo_deadline.types.next_token.NextToken"] = None,
    max_results: Optional["capo_deadline.types.max_results.MaxResults"] = None,
    identity_store_id: Optional[
        "capo_deadline.types.identity_store_id.IdentityStoreId"
    ] = None,
    identity_center_region: Optional["capo_deadline.types.region.Region"] = None,
    resource_types: Optional[
        "capo_deadline.types.membership_resource_types.MembershipResourceTypes"
    ] = None,
) -> "capo_deadline.types.list_memberships_response.ListMembershipsResponse":
    """<p>Lists the Deadline Cloud resource memberships associated with a specified IAM Identity Center principal, optionally filtered by the requested resource types.</p>

    Args:
        next_token: <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
        max_results: <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: <p>The ID of the IAM Identity Center principal whose Deadline Cloud resource memberships you want to list.</p>
        identity_store_id: <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: <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: <p>The resource types to include when listing the principal's memberships. If not specified, memberships for all supported resource types are returned.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List memberships using a cross-region identity store

        >>> client.list_memberships(principal_id='12345678-1234-1234-1234-123456789abc', identity_store_id='d-1234567890', identity_center_region='us-east-1', resource_types=['QUEUE', 'JOB'])
        List a Monitor user's memberships of every resource type

        >>> client.list_memberships(principal_id='12345678-1234-1234-1234-123456789abc')
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.list_memberships_request.ListMembershipsRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.list_memberships_response.ListMembershipsResponse"
    ]:
        import capo_deadline._operations.deadline.list_memberships

        output, http_response = (
            capo_deadline._operations.deadline.list_memberships.list_memberships(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMemberships")
    )
    input_: capo_deadline.types.list_memberships_request.ListMembershipsRequest = {
        "principal_id": principal_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if identity_store_id is not None:
        input_["identity_store_id"] = identity_store_id
    if identity_center_region is not None:
        input_["identity_center_region"] = identity_center_region
    if resource_types is not None:
        input_["resource_types"] = resource_types

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output