DeleteMobileDeviceAccessRuleCommand

Suggest an Edit

Deletes a mobile device access 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, DeleteMobileDeviceAccessRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DeleteMobileDeviceAccessRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DeleteMobileDeviceAccessRuleRequest
  OrganizationId: "STRING_VALUE", // required
  MobileDeviceAccessRuleId: "STRING_VALUE", // required
};
const command = new DeleteMobileDeviceAccessRuleCommand(input);
const response = await client.send(command);
// {};

DeleteMobileDeviceAccessRuleCommand Input

See DeleteMobileDeviceAccessRuleCommandInput for more details

Parameter
Type
Description
MobileDeviceAccessRuleId
Required
string | undefined

The identifier of the rule to be deleted.

OrganizationId
Required
string | undefined

The WorkMail organization under which the rule will be deleted.

DeleteMobileDeviceAccessRuleCommand Output

See DeleteMobileDeviceAccessRuleCommandOutput for details

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

Throws

Name
Fault
Details
InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

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.