Skip to content

disassociate_member_from_group 

disassociate_member_from_group(
    organization_id: OrganizationId,
    group_id: EntityIdentifier,
    member_id: EntityIdentifier,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> DisassociateMemberFromGroupResponse

Removes a member from a group.

Parameters:

  • organization_id (OrganizationId) –

    The identifier for the organization under which the group exists.

  • group_id (EntityIdentifier) –

    The identifier for the group from which members are removed.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: [email protected]

    • Group name: group

  • member_id (EntityIdentifier) –

    The identifier for the member to be removed from the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

    • Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: [email protected]

    • Member name: member

Raises:

Source code in docs_src/capo_workmail/_services/work_mail.py 
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
def disassociate_member_from_group(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    group_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    member_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> "capo_workmail.types.disassociate_member_from_group_response.DisassociateMemberFromGroupResponse":
    """<p>Removes a member from a group.</p>

    Args:
        organization_id: <p>The identifier for the organization under which the group exists.</p>
        group_id: <p>The identifier for the group from which members are removed.</p> <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Group name: group</p> </li> </ul>
        member_id: <p>The identifier for the member to be removed from the group.</p> <p>The member ID can accept <i>UserID or GroupId</i>, <i>Username or Groupname</i>, or <i>email</i>.</p> <ul> <li> <p>Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Member name: member</p> </li> </ul>

    Raises:
        capo_workmail.errors.directory_service_authentication_failed_exception.DirectoryServiceAuthenticationFailedException: <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
        capo_workmail.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The directory is unavailable. It might be located in another Region or deleted.</p>
        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.entity_state_exception.EntityStateException: <p>You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.</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.unsupported_operation_exception.UnsupportedOperationException: <p>You can't perform a write operation against a read-only directory.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.disassociate_member_from_group_request.DisassociateMemberFromGroupRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.disassociate_member_from_group_response.DisassociateMemberFromGroupResponse"
    ]:
        import capo_workmail._operations.work_mail_service.disassociate_member_from_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateMemberFromGroup")
    )
    input_: capo_workmail.types.disassociate_member_from_group_request.DisassociateMemberFromGroupRequest = {
        "organization_id": organization_id,
        "group_id": group_id,
        "member_id": member_id,
    }

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