get_mobile_device_access_effect

WorkMail.Client.get_mobile_device_access_effect(**kwargs)

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 WorkMail organization for a particular user's attributes.

See also: AWS API Documentation

Request Syntax

response = client.get_mobile_device_access_effect(
    OrganizationId='string',
    DeviceType='string',
    DeviceModel='string',
    DeviceOperatingSystem='string',
    DeviceUserAgent='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The WorkMail organization to simulate the access effect for.

• DeviceType (string) -- Device type the simulated user will report.
• DeviceModel (string) -- Device model the simulated user will report.
• DeviceOperatingSystem (string) -- Device operating system the simulated user will report.
• DeviceUserAgent (string) -- Device user agent the simulated user will report.

Return type

dict

Returns

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 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.

Exceptions

• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException