WorkMail / Client / put_access_control_rule

put_access_control_rule

WorkMail.Client.put_access_control_rule(**kwargs)

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

See also: AWS API Documentation

Request Syntax

response = client.put_access_control_rule(
    Name='string',
    Effect='ALLOW'|'DENY',
    Description='string',
    IpRanges=[
        'string',
    ],
    NotIpRanges=[
        'string',
    ],
    Actions=[
        'string',
    ],
    NotActions=[
        'string',
    ],
    UserIds=[
        'string',
    ],
    NotUserIds=[
        'string',
    ],
    OrganizationId='string',
    ImpersonationRoleIds=[
        'string',
    ],
    NotImpersonationRoleIds=[
        'string',
    ]
)

Parameters:

• Name (string) –

  [REQUIRED]

  The rule name.

• Effect (string) –

  [REQUIRED]

  The rule effect.

• Description (string) –

  [REQUIRED]

  The rule description.

• IpRanges (list) –

  IPv4 CIDR ranges to include in the rule.

  • (string) –

• NotIpRanges (list) –

  IPv4 CIDR ranges to exclude from the rule.

  • (string) –

• Actions (list) –

  Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

  • (string) –

• NotActions (list) –

  Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

  • (string) –

• UserIds (list) –

  User IDs to include in the rule.

  • (string) –

• NotUserIds (list) –

  User IDs to exclude from the rule.

  • (string) –

• OrganizationId (string) –

  [REQUIRED]

  The identifier of the organization.

• ImpersonationRoleIds (list) –

  Impersonation role IDs to include in the rule.

  • (string) –

• NotImpersonationRoleIds (list) –

  Impersonation role IDs to exclude from the rule.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• WorkMail.Client.exceptions.LimitExceededException

• WorkMail.Client.exceptions.InvalidParameterException

• WorkMail.Client.exceptions.EntityNotFoundException

• WorkMail.Client.exceptions.ResourceNotFoundException

• WorkMail.Client.exceptions.OrganizationNotFoundException

• WorkMail.Client.exceptions.OrganizationStateException