2021/03/31 - Amazon WorkMail - 5 new api methods
Changes This release adds support for mobile device access rules management in Amazon WorkMail.
Deletes a mobile device access rule for the specified Amazon WorkMail organization.
See also: AWS API Documentation
Request Syntax
client.delete_mobile_device_access_rule(
OrganizationId='string',
MobileDeviceAccessRuleId='string'
)
string
[REQUIRED]
The Amazon WorkMail organization under which the rule will be deleted.
string
[REQUIRED]
The identifier of the rule to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a mobile device access rule for the specified Amazon WorkMail organization.
See also: AWS API Documentation
Request Syntax
client.update_mobile_device_access_rule(
OrganizationId='string',
MobileDeviceAccessRuleId='string',
Name='string',
Description='string',
Effect='ALLOW'|'DENY',
DeviceTypes=[
'string',
],
NotDeviceTypes=[
'string',
],
DeviceModels=[
'string',
],
NotDeviceModels=[
'string',
],
DeviceOperatingSystems=[
'string',
],
NotDeviceOperatingSystems=[
'string',
],
DeviceUserAgents=[
'string',
],
NotDeviceUserAgents=[
'string',
]
)
string
[REQUIRED]
The Amazon WorkMail organization under which the rule will be updated.
string
[REQUIRED]
The identifier of the rule to be updated.
string
[REQUIRED]
The updated rule name.
string
The updated rule description.
string
[REQUIRED]
The effect of the rule when it matches. Allowed values are ALLOW or DENY .
list
Device types that the updated rule will match.
(string) --
list
Device types that the updated rule will not match. All other device types will match.
(string) --
list
Device models that the updated rule will match.
(string) --
list
Device models that the updated rule will not match. All other device models will match.
(string) --
list
Device operating systems that the updated rule will match.
(string) --
list
Device operating systems that the updated rule will not match. All other device operating systems will match.
(string) --
list
User agents that the updated rule will match.
(string) --
list
User agents that the updated rule will not match. All other user agents will match.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the mobile device access rules for the specified Amazon WorkMail organization.
See also: AWS API Documentation
Request Syntax
client.list_mobile_device_access_rules(
OrganizationId='string'
)
string
[REQUIRED]
The Amazon WorkMail organization for which to list the rules.
dict
Response Syntax
{
'Rules': [
{
'MobileDeviceAccessRuleId': 'string',
'Name': 'string',
'Description': 'string',
'Effect': 'ALLOW'|'DENY',
'DeviceTypes': [
'string',
],
'NotDeviceTypes': [
'string',
],
'DeviceModels': [
'string',
],
'NotDeviceModels': [
'string',
],
'DeviceOperatingSystems': [
'string',
],
'NotDeviceOperatingSystems': [
'string',
],
'DeviceUserAgents': [
'string',
],
'NotDeviceUserAgents': [
'string',
],
'DateCreated': datetime(2015, 1, 1),
'DateModified': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Rules (list) --
The list of mobile device access rules that exist under the specified Amazon WorkMail organization.
(dict) --
A rule that controls access to mobile devices for an Amazon WorkMail group.
MobileDeviceAccessRuleId (string) --
The ID assigned to a mobile access rule.
Name (string) --
The name of a mobile access rule.
Description (string) --
The description of a mobile access rule.
Effect (string) --
The effect of the rule when it matches. Allowed values are ALLOW or DENY .
DeviceTypes (list) --
Device types that a rule will match.
(string) --
NotDeviceTypes (list) --
Device types that a rule will not match. All other device types will match.
(string) --
DeviceModels (list) --
Device models that a rule will match.
(string) --
NotDeviceModels (list) --
Device models that a rule will not match. All other device models will match.
(string) --
DeviceOperatingSystems (list) --
Device operating systems that a rule will match.
(string) --
NotDeviceOperatingSystems (list) --
Device operating systems that a rule will not match. All other device types will match.
(string) --
DeviceUserAgents (list) --
Device user agents that a rule will match.
(string) --
NotDeviceUserAgents (list) --
Device user agents that a rule will not match. All other device user agents will match.
(string) --
DateCreated (datetime) --
The date and time at which an access rule was created.
DateModified (datetime) --
The date and time at which an access rule was modified.
Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.
See also: AWS API Documentation
Request Syntax
client.get_mobile_device_access_effect(
OrganizationId='string',
DeviceType='string',
DeviceModel='string',
DeviceOperatingSystem='string',
DeviceUserAgent='string'
)
string
[REQUIRED]
The Amazon WorkMail organization to simulate the access effect for.
string
Device type the simulated user will report.
string
Device model the simulated user will report.
string
Device operating system the simulated user will report.
string
Device user agent the simulated user will report.
dict
Response Syntax
{
'Effect': 'ALLOW'|'DENY',
'MatchedRules': [
{
'MobileDeviceAccessRuleId': 'string',
'Name': 'string'
},
]
}
Response Structure
(dict) --
Effect (string) --
The effect of the simulated access, ALLOW or DENY , after evaluating mobile device access rules in the Amazon WorkMail organization for the simulated user parameters.
MatchedRules (list) --
A list of the rules which matched the simulated user input and produced the effect.
(dict) --
The rule that a simulated user matches.
MobileDeviceAccessRuleId (string) --
Identifier of the rule that a simulated user matches.
Name (string) --
Name of a rule that a simulated user matches.
Creates a new mobile device access rule for the specified Amazon WorkMail organization.
See also: AWS API Documentation
Request Syntax
client.create_mobile_device_access_rule(
OrganizationId='string',
ClientToken='string',
Name='string',
Description='string',
Effect='ALLOW'|'DENY',
DeviceTypes=[
'string',
],
NotDeviceTypes=[
'string',
],
DeviceModels=[
'string',
],
NotDeviceModels=[
'string',
],
DeviceOperatingSystems=[
'string',
],
NotDeviceOperatingSystems=[
'string',
],
DeviceUserAgents=[
'string',
],
NotDeviceUserAgents=[
'string',
]
)
string
[REQUIRED]
The Amazon WorkMail organization under which the rule will be created.
string
The idempotency token for the client request.
This field is autopopulated if not provided.
string
[REQUIRED]
The rule name.
string
The rule description.
string
[REQUIRED]
The effect of the rule when it matches. Allowed values are ALLOW or DENY .
list
Device types that the rule will match.
(string) --
list
Device types that the rule will not match. All other device types will match.
(string) --
list
Device models that the rule will match.
(string) --
list
Device models that the rule will not match. All other device models will match.
(string) --
list
Device operating systems that the rule will match.
(string) --
list
Device operating systems that the rule will not match. All other device operating systems will match.
(string) --
list
Device user agents that the rule will match.
(string) --
list
Device user agents that the rule will not match. All other device user agents will match.
(string) --
dict
Response Syntax
{
'MobileDeviceAccessRuleId': 'string'
}
Response Structure
(dict) --
MobileDeviceAccessRuleId (string) --
The identifier for the newly created mobile device access rule.