get_impersonation_role_effect ¶

get_impersonation_role_effect(
    organization_id: OrganizationId,
    impersonation_role_id: ImpersonationRoleId,
    target_user: EntityIdentifier,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> GetImpersonationRoleEffectResponse

Tests whether the given impersonation role can impersonate a target user.

Parameters:

organization_id (OrganizationId) –

The WorkMail organization where the impersonation role is defined.
impersonation_role_id (ImpersonationRoleId) –

The impersonation role ID to test.
target_user (EntityIdentifier) –
The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:
- User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
- Email address: [email protected]
- User name: user

Raises:

EntityNotFoundException –

The identifier supplied for the user, group, or resource does not exist in your organization.
EntityStateException –

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.
InvalidParameterException –

One or more of the input parameters don't match the service's restrictions.
OrganizationNotFoundException –

An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException –

The organization must have a valid state to perform certain operations on the organization or its members.
ResourceNotFoundException –

The resource cannot be found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workmail/_services/work_mail.py

def get_impersonation_role_effect(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    impersonation_role_id: "capo_workmail.types.impersonation_role_id.ImpersonationRoleId",
    target_user: "capo_workmail.types.entity_identifier.EntityIdentifier",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> "capo_workmail.types.get_impersonation_role_effect_response.GetImpersonationRoleEffectResponse":
    """<p>Tests whether the given impersonation role can impersonate a target user.</p>

    Args:
        organization_id: <p>The WorkMail organization where the impersonation role is defined.</p>
        impersonation_role_id: <p>The impersonation role ID to test.</p>
        target_user: <p>The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:</p> <ul> <li> <p>User ID: <code>12345678-1234-1234-1234-123456789012</code> or <code>S-1-1-12-1234567890-123456789-123456789-1234</code> </p> </li> <li> <p>Email address: <code>[email protected]</code> </p> </li> <li> <p>User name: <code>user</code> </p> </li> </ul>

    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.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.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.get_impersonation_role_effect_request.GetImpersonationRoleEffectRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.get_impersonation_role_effect_response.GetImpersonationRoleEffectResponse"
    ]:
        import capo_workmail._operations.work_mail_service.get_impersonation_role_effect

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetImpersonationRoleEffect")
    )
    input_: capo_workmail.types.get_impersonation_role_effect_request.GetImpersonationRoleEffectRequest = {
        "organization_id": organization_id,
        "impersonation_role_id": impersonation_role_id,
        "target_user": target_user,
    }

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