Skip to content

SendOutboundEmailRequest

Source code in docs_src/capo_connect/types/send_outbound_email_request.py
class SendOutboundEmailRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    from_email_address: "capo_connect.types.email_address_info.EmailAddressInfo"
    """<p>The email address to be used for sending email.</p>"""
    destination_email_address: "capo_connect.types.email_address_info.EmailAddressInfo"
    """<p>The email address to send the email to.</p>"""
    additional_recipients: NotRequired[
        "capo_connect.types.outbound_additional_recipients.OutboundAdditionalRecipients"
    ]
    """<p>The additional recipients address of the email in CC.</p>"""
    email_message: "capo_connect.types.outbound_email_content.OutboundEmailContent"
    """<p>The email message body to be sent to the newly created email.</p>"""
    traffic_type: "capo_connect.types.traffic_type.TrafficType"
    """<p>Denotes the class of traffic.</p> <note> <p>Only the CAMPAIGN traffic type is supported.</p> </note>"""
    source_campaign: NotRequired["capo_connect.types.source_campaign.SourceCampaign"]
    """<p>A Campaign object need for Campaign traffic type.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""

additional_recipients instance-attribute

additional_recipients: NotRequired[OutboundAdditionalRecipients]

The additional recipients address of the email in CC.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

destination_email_address instance-attribute

destination_email_address: EmailAddressInfo

The email address to send the email to.

email_message instance-attribute

email_message: OutboundEmailContent

The email message body to be sent to the newly created email.

from_email_address instance-attribute

from_email_address: EmailAddressInfo

The email address to be used for sending email.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

source_campaign instance-attribute

source_campaign: NotRequired[SourceCampaign]

A Campaign object need for Campaign traffic type.

traffic_type instance-attribute

traffic_type: TrafficType

Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.