- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeInboundDmarcSettingsCommand
Lists the settings in a DMARC policy for a specified organization.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkMailClient, DescribeInboundDmarcSettingsCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DescribeInboundDmarcSettingsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DescribeInboundDmarcSettingsRequest
OrganizationId: "STRING_VALUE", // required
};
const command = new DescribeInboundDmarcSettingsCommand(input);
const response = await client.send(command);
// { // DescribeInboundDmarcSettingsResponse
// Enforced: true || false,
// };
DescribeInboundDmarcSettingsCommand Input
See DescribeInboundDmarcSettingsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
OrganizationIdRequired | string | undefined | Lists the ID of the given organization. |
DescribeInboundDmarcSettingsCommand Output
See DescribeInboundDmarcSettingsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Enforced | boolean | undefined | Lists the enforcement setting of the applied policy. |
Throws
Name | Fault | Details |
|---|
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. |