WorkMail / Client / create_mobile_device_access_rule

create_mobile_device_access_rule#

WorkMail.Client.create_mobile_device_access_rule(**kwargs)#

Creates a new mobile device access rule for the specified WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = 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',
    ]
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization under which the rule will be created.

  • ClientToken (string) –

    The idempotency token for the client request.

    This field is autopopulated if not provided.

  • Name (string) –

    [REQUIRED]

    The rule name.

  • Description (string) – The rule description.

  • Effect (string) –

    [REQUIRED]

    The effect of the rule when it matches. Allowed values are ALLOW or DENY.

  • DeviceTypes (list) –

    Device types that the rule will match.

    • (string) –

  • NotDeviceTypes (list) –

    Device types that the rule will not match. All other device types will match.

    • (string) –

  • DeviceModels (list) –

    Device models that the rule will match.

    • (string) –

  • NotDeviceModels (list) –

    Device models that the rule will not match. All other device models will match.

    • (string) –

  • DeviceOperatingSystems (list) –

    Device operating systems that the rule will match.

    • (string) –

  • NotDeviceOperatingSystems (list) –

    Device operating systems that the rule will not match. All other device operating systems will match.

    • (string) –

  • DeviceUserAgents (list) –

    Device user agents that the rule will match.

    • (string) –

  • NotDeviceUserAgents (list) –

    Device user agents that the rule will not match. All other device user agents will match.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'MobileDeviceAccessRuleId': 'string'
}

Response Structure

  • (dict) –

    • MobileDeviceAccessRuleId (string) –

      The identifier for the newly created mobile device access rule.

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.LimitExceededException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException