Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAccessControlRules

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

Lists the access control rules for the specified organization.

Request Syntax


{
   "OrganizationId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

OrganizationId

The identifier for the organization.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax


{
   "Rules": [ 
      { 
         "Actions": [ "string" ],
         "DateCreated": number,
         "DateModified": number,
         "Description": "string",
         "Effect": "string",
         "ImpersonationRoleIds": [ "string" ],
         "IpRanges": [ "string" ],
         "Name": "string",
         "NotActions": [ "string" ],
         "NotImpersonationRoleIds": [ "string" ],
         "NotIpRanges": [ "string" ],
         "NotUserIds": [ "string" ],
         "UserIds": [ "string" ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Rules

The access control rules.

Type: Array of AccessControlRule objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Error Types.

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400