SESV2 / Client / associate_email_identity_certificate

associate_email_identity_certificate

SESV2.Client.associate_email_identity_certificate(**kwargs)

Associates an S/MIME certificate with an email identity. After the certificate is active, Amazon SES API v2 can add an S/MIME signature to messages that you send from the associated address when signing is enabled on the configuration set used to send the message.

The certificate is an X.509 certificate that you manage in Certificate Manager (ACM). You identify it by its Amazon Resource Name (ARN).

  • If the email identity is a domain, you must specify a FromAddress that belongs to that domain or one of its subdomains. The certificate applies to messages sent from that address.

  • If the email identity is an email address, FromAddress is optional. If you specify it, it must exactly match the email identity.

When the association is created, the certificate begins provisioning and its status is PROVISIONING. The status changes to ACTIVE when the certificate is ready to use for signing. Each email address can have only one certificate association. If an association already exists for the address, this operation returns an error, unless the existing association is in the DEPROVISIONING state.

See also: AWS API Documentation

Request Syntax

response = client.associate_email_identity_certificate(
    EmailIdentity='string',
    FromAddress='string',
    CertificateArn='string'
)
Parameters:

  • EmailIdentity (string) –

    [REQUIRED]

    The email identity, either an email address or a domain, to associate the certificate with.

  • FromAddress (string) – The email address that the certificate applies to. This value is required when the email identity is a domain, and the address must belong to that domain or one of its subdomains. When the email identity is an email address, this value is optional. If you specify it, it must exactly match the email identity.

  • CertificateArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate to associate with the email identity.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions