list_mailbox_permissions ¶

def list_mailbox_permissions(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    entity_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    next_token: Optional["capo_workmail.types.next_token.NextToken"] = None,
    max_results: Optional["capo_workmail.types.max_results.MaxResults"] = None,
) -> "capo_workmail.types.list_mailbox_permissions_response.ListMailboxPermissionsResponse":
    """<p>Lists the mailbox permissions associated with a user, group, or resource mailbox.</p>

    Args:
        organization_id: <p>The identifier of the organization under which the user, group, or resource exists.</p>
        entity_id: <p>The identifier of the user, or resource for which to list mailbox permissions.</p> <p>The entity ID can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>.</p> <ul> <li> <p>Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Entity name: entity</p> </li> </ul>
        next_token: <p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>

    Raises:
        capo_workmail.errors.entity_not_found_exception.EntityNotFoundException: <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
        capo_workmail.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the input parameters don't match the service's restrictions.</p>
        capo_workmail.errors.organization_not_found_exception.OrganizationNotFoundException: <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
        capo_workmail.errors.organization_state_exception.OrganizationStateException: <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.list_mailbox_permissions_request.ListMailboxPermissionsRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.list_mailbox_permissions_response.ListMailboxPermissionsResponse"
    ]:
        import capo_workmail._operations.work_mail_service.list_mailbox_permissions

        output, http_response = (
            capo_workmail._operations.work_mail_service.list_mailbox_permissions.list_mailbox_permissions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMailboxPermissions")
    )
    input_: capo_workmail.types.list_mailbox_permissions_request.ListMailboxPermissionsRequest = {
        "organization_id": organization_id,
        "entity_id": entity_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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