SES / Client / put_identity_policy

put_identity_policy#

SES.Client.put_identity_policy(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.put_identity_policy(
    Identity='string',
    PolicyName='string',
    Policy='string'
)
Parameters:

  • Identity (string) –

    [REQUIRED]

    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.

  • PolicyName (string) –

    [REQUIRED]

    The name of the policy.

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

  • Policy (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An empty element returned on a successful request.

Exceptions

  • SES.Client.exceptions.InvalidPolicyException

Examples

The following example adds a sending authorization policy to an identity:

response = client.put_identity_policy(
    Identity='example.com',
    Policy='{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}',
    PolicyName='MyPolicy',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}