GetEmailIdentityPoliciesCommand

Suggest an Edit

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide .

You can execute this operation no more than once per second.

Example Syntax

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

import { SESv2Client, GetEmailIdentityPoliciesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, GetEmailIdentityPoliciesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // GetEmailIdentityPoliciesRequest
  EmailIdentity: "STRING_VALUE", // required
};
const command = new GetEmailIdentityPoliciesCommand(input);
const response = await client.send(command);
// { // GetEmailIdentityPoliciesResponse
//   Policies: { // PolicyMap
//     "<keys>": "STRING_VALUE",
//   },
// };

GetEmailIdentityPoliciesCommand Input

See GetEmailIdentityPoliciesCommandInput for more details

Parameter
Type
Description
EmailIdentity
Required
string | undefined

The email identity.

GetEmailIdentityPoliciesCommand Output

See GetEmailIdentityPoliciesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Policies
Record<string, string> | undefined

A map of policy names to policies.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

SESv2ServiceException
Base exception class for all service exceptions from SESv2 service.