WorkMail / Client / get_mobile_device_access_override

get_mobile_device_access_override#

WorkMail.Client.get_mobile_device_access_override(**kwargs)#

Gets the mobile device access override for the given WorkMail organization, user, and device.

See also: AWS API Documentation

Request Syntax

response = client.get_mobile_device_access_override(
    OrganizationId='string',
    UserId='string',
    DeviceId='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization to which you want to apply the override.

  • UserId (string) –

    [REQUIRED]

    Identifies the WorkMail user for 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 to which the override applies. DeviceId is case insensitive.

Return type:

dict

Returns:

Response Syntax

{
    'UserId': 'string',
    'DeviceId': 'string',
    'Effect': 'ALLOW'|'DENY',
    'Description': 'string',
    'DateCreated': datetime(2015, 1, 1),
    'DateModified': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • UserId (string) –

      The WorkMail user to which the access override applies.

    • DeviceId (string) –

      The device to which the access override applies.

    • Effect (string) –

      The effect of the override, ALLOW or DENY.

    • Description (string) –

      A description of the override.

    • DateCreated (datetime) –

      The date the override was first created.

    • DateModified (datetime) –

      The date the description was last modified.

Exceptions