ListAccessControlRules - Amazon WorkMail

ListAccessControlRules

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

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

Required: Yes

Response Syntax

{ "Rules": [ { "Actions": [ "string" ], "DateCreated": number, "DateModified": number, "Description": "string", "Effect": "string", "IpRanges": [ "string" ], "Name": "string", "NotActions": [ "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 Errors.

OrganizationNotFoundException

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

HTTP Status Code: 400

OrganizationStateException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: