DeleteRetentionPolicyCommand

Suggest an Edit

Deletes the specified retention policy from the specified organization.

Example Syntax

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

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

DeleteRetentionPolicyCommand Input

See DeleteRetentionPolicyCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The retention policy ID.

OrganizationId
Required
string | undefined

The organization ID.

DeleteRetentionPolicyCommand Output

See DeleteRetentionPolicyCommandOutput 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.