put_mobile_device_access_override ¶

put_mobile_device_access_override(
    organization_id: OrganizationId,
    user_id: EntityIdentifier,
    device_id: DeviceId,
    effect: MobileDeviceAccessRuleEffect,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    description: Optional[MobileDeviceAccessRuleDescription] = None,
) -> PutMobileDeviceAccessOverrideResponse

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

Parameters:

organization_id (OrganizationId) –

Identifies the WorkMail organization for which you create the override.
user_id (EntityIdentifier) –
The WorkMail user for which you create the override. Accepts the following types of user identities:
- User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
- Email address: [email protected]
- User name: user
device_id (DeviceId) –

The mobile device for which you create the override. DeviceId is case insensitive.
effect (MobileDeviceAccessRuleEffect) –

The effect of the override, ALLOW or DENY.
description (Optional[MobileDeviceAccessRuleDescription], default: None ) –

A description of the override.

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

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

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

def put_mobile_device_access_override(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    user_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    device_id: "capo_workmail.types.device_id.DeviceId",
    effect: "capo_workmail.types.mobile_device_access_rule_effect.MobileDeviceAccessRuleEffect",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    description: Optional[
        "capo_workmail.types.mobile_device_access_rule_description.MobileDeviceAccessRuleDescription"
    ] = None,
) -> "capo_workmail.types.put_mobile_device_access_override_response.PutMobileDeviceAccessOverrideResponse":
    """<p>Creates or updates a mobile device access override for the given WorkMail organization, user, and device.</p>

    Args:
        organization_id: <p>Identifies the WorkMail organization for which you create the override.</p>
        user_id: <p>The WorkMail user for which you create the override. Accepts the following types of user identities:</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>
        device_id: <p>The mobile device for which you create the override. <code>DeviceId</code> is case insensitive.</p>
        effect: <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
        description: <p>A description of the override.</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.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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.put_mobile_device_access_override_request.PutMobileDeviceAccessOverrideRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.put_mobile_device_access_override_response.PutMobileDeviceAccessOverrideResponse"
    ]:
        import capo_workmail._operations.work_mail_service.put_mobile_device_access_override

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutMobileDeviceAccessOverride")
    )
    input_: capo_workmail.types.put_mobile_device_access_override_request.PutMobileDeviceAccessOverrideRequest = {
        "organization_id": organization_id,
        "user_id": user_id,
        "device_id": device_id,
        "effect": effect,
    }
    if description is not None:
        input_["description"] = description

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