Amazon WorkMail

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

See also: AWS API Documentation

Request Syntax

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

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

Identifies the Amazon WorkMail organization for which you create the override.

type UserId:

string

param UserId:

[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

type DeviceId:

string

param DeviceId:

[REQUIRED]

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

type Effect:

string

param Effect:

[REQUIRED]

The effect of the override, ALLOW or DENY.

type Description:

string

param Description:

A description of the override.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

See also: AWS API Documentation

Request Syntax

client.list_mobile_device_access_overrides(
    OrganizationId='string',
    UserId='string',
    DeviceId='string',
    NextToken='string',
    MaxResults=123
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The Amazon WorkMail organization under which to list mobile device access overrides.

type UserId:

string

param UserId:

The WorkMail user under which you list the mobile device access overrides. 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

type DeviceId:

string

param DeviceId:

The mobile device to which the access override applies.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results. The first call does not require a token.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • Overrides (list) --

    The list of mobile device access overrides that exist for the specified Amazon WorkMail organization and user.

    • (dict) --

      The override object.

      • UserId (string) --

        The WorkMail user to which the access override applies.

      • DeviceId (string) --

        The device to which the 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 override was last modified.

  • NextToken (string) --

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

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

See also: AWS API Documentation

Request Syntax

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

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

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

type UserId:

string

param UserId:

[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

type DeviceId:

string

param DeviceId:

[REQUIRED]

The mobile device to which the override applies. DeviceId is case insensitive.

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.delete_mobile_device_access_override(
    OrganizationId='string',
    UserId='string',
    DeviceId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The Amazon WorkMail organization for which the access override will be deleted.

type UserId:

string

param UserId:

[REQUIRED]

The WorkMail user for which you want to delete 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

type DeviceId:

string

param DeviceId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --