WorkMail / Client / get_access_control_effect

get_access_control_effect#

WorkMail.Client.get_access_control_effect(**kwargs)#

Gets the effects of an organization’s access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

See also: AWS API Documentation

Request Syntax

response = client.get_access_control_effect(
    OrganizationId='string',
    IpAddress='string',
    Action='string',
    UserId='string',
    ImpersonationRoleId='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The identifier for the organization.

  • IpAddress (string) –

    [REQUIRED]

    The IPv4 address.

  • Action (string) –

    [REQUIRED]

    The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

  • UserId (string) – The user ID.

  • ImpersonationRoleId (string) – The impersonation role ID.

Return type:

dict

Returns:

Response Syntax

{
    'Effect': 'ALLOW'|'DENY',
    'MatchedRules': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • Effect (string) –

      The rule effect.

    • MatchedRules (list) –

      The rules that match the given parameters, resulting in an effect.

      • (string) –

Exceptions

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.ResourceNotFoundException

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException