DeleteAccessControlRuleCommand

Suggest an Edit

Deletes an access control rule for the specified WorkMail organization.

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, DeleteAccessControlRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DeleteAccessControlRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DeleteAccessControlRuleRequest
  OrganizationId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
};
const command = new DeleteAccessControlRuleCommand(input);
const response = await client.send(command);
// {};

DeleteAccessControlRuleCommand Input

See DeleteAccessControlRuleCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the access control rule.

OrganizationId
Required
string | undefined

The identifier for the organization.

DeleteAccessControlRuleCommand Output

See DeleteAccessControlRuleCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
OrganizationNotFoundException
client

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

OrganizationStateException
client

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

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.