Skip to content

associate_member_to_group 

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

Adds a member (user or group) to the group's set.

Parameters:

  • organization_id (OrganizationId) –

    The organization under which the group exists.

  • group_id (EntityIdentifier) –

    The group to which the member (user or group) is associated.

    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 member (user or group) to associate to the group.

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

    • Member: 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 
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
def associate_member_to_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.associate_member_to_group_response.AssociateMemberToGroupResponse":
    """<p>Adds a member (user or group) to the group's set.</p>

    Args:
        organization_id: <p>The organization under which the group exists.</p>
        group_id: <p>The group to which the member (user or group) is associated.</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 member (user or group) to associate to 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: 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.associate_member_to_group_request.AssociateMemberToGroupRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.associate_member_to_group_response.AssociateMemberToGroupResponse"
    ]:
        import capo_workmail._operations.work_mail_service.associate_member_to_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateMemberToGroup")
    )
    input_: capo_workmail.types.associate_member_to_group_request.AssociateMemberToGroupRequest = {
        "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