WorkMail / Client / put_mobile_device_access_override

put_mobile_device_access_override#

WorkMail.Client.put_mobile_device_access_override(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_mobile_device_access_override(
    OrganizationId='string',
    UserId='string',
    DeviceId='string',
    Effect='ALLOW'|'DENY',
    Description='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    Identifies the WorkMail organization for which you create the override.

  • UserId (string) –

    [REQUIRED]

    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: user@domain.tld

    • User name: user

  • DeviceId (string) –

    [REQUIRED]

    The mobile device for which you create the override. DeviceId is case insensitive.

  • Effect (string) –

    [REQUIRED]

    The effect of the override, ALLOW or DENY.

  • Description (string) – A description of the override.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.EntityStateException