WorkMail / Client / list_access_control_rules
list_access_control_rules#
- WorkMail.Client.list_access_control_rules(**kwargs)#
Lists the access control rules for the specified organization.
See also: AWS API Documentation
Request Syntax
response = client.list_access_control_rules( OrganizationId='string' )
- Parameters:
OrganizationId (string) –
[REQUIRED]
The identifier for the organization.
- Return type:
dict
- Returns:
Response Syntax
{ 'Rules': [ { 'Name': 'string', 'Effect': 'ALLOW'|'DENY', 'Description': 'string', 'IpRanges': [ 'string', ], 'NotIpRanges': [ 'string', ], 'Actions': [ 'string', ], 'NotActions': [ 'string', ], 'UserIds': [ 'string', ], 'NotUserIds': [ 'string', ], 'DateCreated': datetime(2015, 1, 1), 'DateModified': datetime(2015, 1, 1), 'ImpersonationRoleIds': [ 'string', ], 'NotImpersonationRoleIds': [ 'string', ] }, ] }
Response Structure
(dict) –
Rules (list) –
The access control rules.
(dict) –
A rule that controls access to an WorkMail organization.
Name (string) –
The rule name.
Effect (string) –
The rule effect.
Description (string) –
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
, andWebMail
.(string) –
NotActions (list) –
Access protocol actions to exclude from the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.(string) –
UserIds (list) –
User IDs to include in the rule.
(string) –
NotUserIds (list) –
User IDs to exclude from the rule.
(string) –
DateCreated (datetime) –
The date that the rule was created.
DateModified (datetime) –
The date that the rule was modified.
ImpersonationRoleIds (list) –
Impersonation role IDs to include in the rule.
(string) –
NotImpersonationRoleIds (list) –
Impersonation role IDs to exclude from the rule.
(string) –
Exceptions
WorkMail.Client.exceptions.OrganizationNotFoundException
WorkMail.Client.exceptions.OrganizationStateException