Menu
Amazon Simple Email Service
API Reference (API Version 2010-12-01)

PutIdentityPolicy

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

Note

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Identity

The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

Type: String

Required: Yes

Policy

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

PolicyName

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidPolicy

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: