PutInboundDmarcSettingsCommand

Suggest an Edit

Enables or disables a DMARC policy for a given organization.

Example Syntax

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

import { WorkMailClient, PutInboundDmarcSettingsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, PutInboundDmarcSettingsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // PutInboundDmarcSettingsRequest
  OrganizationId: "STRING_VALUE", // required
  Enforced: true || false, // required
};
const command = new PutInboundDmarcSettingsCommand(input);
const response = await client.send(command);
// {};

PutInboundDmarcSettingsCommand Input

See PutInboundDmarcSettingsCommandInput for more details

Parameter
Type
Description
Enforced
Required
boolean | undefined

Enforces or suspends a policy after it's applied.

OrganizationId
Required
string | undefined

The ID of the organization that you are applying the DMARC policy to.

PutInboundDmarcSettingsCommand Output

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