mobile_device_access_overrides

Creates, updates, deletes, gets or lists a mobile_device_access_overrides resource.

Overview

Name	mobile_device_access_overrides
Type	Resource
Id	aws.workmail.mobile_device_access_overrides

Fields

The following fields are returned by SELECT queries:

get_mobile_device_access_override

Name	Datatype	Description
date_created	string (date-time)	The date the override was first created.
date_modified	string (date-time)	The date the description was last modified.
description	string	A description of the override. (pattern: <code>[\S\s]+</code>)
device_id	string	The device to which the access override applies. (pattern: <code>[A-Za-z0-9]+</code>)
effect	string	The effect of the override, ALLOW or DENY. (ALLOW, DENY)
user_id	string	The WorkMail user to which the access override applies.

list_mobile_device_access_overrides

Name	Datatype	Description
next_token	string	The token to use to retrieve the next page of results. The value is “null” when there are no more results to return. (pattern: <code>[\S\s]*|[a-zA-Z0-9/+=]{1,1024}</code>)
overrides	array	The list of mobile device access overrides that exist for the specified WorkMail organization and user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_mobile_device_access_override	select	region		Gets the mobile device access override for the given WorkMail organization, user, and device.
list_mobile_device_access_overrides	select	region		Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
put_mobile_device_access_override	replace	region, OrganizationId, UserId, DeviceId		Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
delete_mobile_device_access_override	delete	region		Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_mobile_device_access_override

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

SELECT
date_created,
date_modified,
description,
device_id,
effect,
user_id
FROM aws.workmail.mobile_device_access_overrides
WHERE region = '{{ region }}' -- required
;

list_mobile_device_access_overrides

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

SELECT
next_token,
overrides
FROM aws.workmail.mobile_device_access_overrides
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_mobile_device_access_override

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

REPLACE aws.workmail.mobile_device_access_overrides
SET 
OrganizationId = '{{ OrganizationId }}',
UserId = '{{ UserId }}',
DeviceId = '{{ DeviceId }}',
Effect = '{{ Effect }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required
AND UserId = '{{ UserId }}' --required
AND DeviceId = '{{ DeviceId }}' --required;

DELETE examples

delete_mobile_device_access_override

Deletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

DELETE FROM aws.workmail.mobile_device_access_overrides
WHERE region = '{{ region }}' --required
;