Skip to content

SendBulkEmailRequest

Source code in docs_src/capo_sesv2/types/send_bulk_email_request.py
class SendBulkEmailRequest(TypedDict, closed=True):
    from_email_address: NotRequired["capo_sesv2.types.email_address.EmailAddress"]
    """<p>The email address to use as the "From" address for the email. The address that you specify has to be verified.</p>"""
    from_email_address_identity_arn: NotRequired[
        "capo_sesv2.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FromEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be [email protected].</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>"""
    reply_to_addresses: NotRequired[
        "capo_sesv2.types.email_address_list.EmailAddressList"
    ]
    """<p>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</p>"""
    feedback_forwarding_email_address: NotRequired[
        "capo_sesv2.types.email_address.EmailAddress"
    ]
    """<p>The address that you want bounce and complaint notifications to be sent to.</p>"""
    feedback_forwarding_email_address_identity_arn: NotRequired[
        "capo_sesv2.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FeedbackForwardingEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be [email protected].</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>"""
    default_email_tags: NotRequired["capo_sesv2.types.message_tag_list.MessageTagList"]
    """<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>"""
    default_content: "capo_sesv2.types.bulk_email_content.BulkEmailContent"
    """<p>An object that contains the body of the message. You can specify a template message.</p>"""
    bulk_email_entries: "capo_sesv2.types.bulk_email_entry_list.BulkEmailEntryList"
    """<p>The list of bulk email entry objects.</p>"""
    configuration_set_name: NotRequired[
        "capo_sesv2.types.configuration_set_name.ConfigurationSetName"
    ]
    """<p>The name of the configuration set to use when sending the email.</p>"""
    endpoint_id: NotRequired["capo_sesv2.types.endpoint_id.EndpointId"]
    """<p>The ID of the multi-region endpoint (global-endpoint).</p>"""
    tenant_name: NotRequired["capo_sesv2.types.tenant_name.TenantName"]
    """<p>The name of the tenant through which this bulk email will be sent.</p> <note> <p> The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant. </p> </note>"""
    configuration_overrides: NotRequired[
        "capo_sesv2.types.configuration_overrides.ConfigurationOverrides"
    ]
    """<p>An object that overrides, for the messages in this request only, settings that would otherwise apply to them. The overrides apply to every message in the request. Each setting that you don't override keeps the value that already applies.</p>"""

bulk_email_entries instance-attribute

bulk_email_entries: BulkEmailEntryList

The list of bulk email entry objects.

configuration_overrides instance-attribute

configuration_overrides: NotRequired[ConfigurationOverrides]

An object that overrides, for the messages in this request only, settings that would otherwise apply to them. The overrides apply to every message in the request. Each setting that you don't override keeps the value that already applies.

configuration_set_name instance-attribute

configuration_set_name: NotRequired[ConfigurationSetName]

The name of the configuration set to use when sending the email.

default_content instance-attribute

default_content: BulkEmailContent

An object that contains the body of the message. You can specify a template message.

default_email_tags instance-attribute

default_email_tags: NotRequired[MessageTagList]

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

endpoint_id instance-attribute

endpoint_id: NotRequired[EndpointId]

The ID of the multi-region endpoint (global-endpoint).

feedback_forwarding_email_address instance-attribute

feedback_forwarding_email_address: NotRequired[EmailAddress]

The address that you want bounce and complaint notifications to be sent to.

feedback_forwarding_email_address_identity_arn instance-attribute

feedback_forwarding_email_address_identity_arn: NotRequired[AmazonResourceName]

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

from_email_address instance-attribute

from_email_address: NotRequired[EmailAddress]

The email address to use as the "From" address for the email. The address that you specify has to be verified.

from_email_address_identity_arn instance-attribute

from_email_address_identity_arn: NotRequired[AmazonResourceName]

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

reply_to_addresses instance-attribute

reply_to_addresses: NotRequired[EmailAddressList]

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

tenant_name instance-attribute

tenant_name: NotRequired[TenantName]

The name of the tenant through which this bulk email will be sent.

The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.