Skip to content

StartOutboundEmailContactRequest

Source code in docs_src/capo_connect/types/start_outbound_email_contact_request.py
class StartOutboundEmailContactRequest(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>"""
    contact_id: "capo_connect.types.contact_id.ContactId"
    """<p>The identifier of the contact in this instance of Connect Customer. </p>"""
    from_email_address: NotRequired[
        "capo_connect.types.email_address_info.EmailAddressInfo"
    ]
    """<p>The email address associated with the Connect Customer instance.</p>"""
    destination_email_address: "capo_connect.types.email_address_info.EmailAddressInfo"
    """<p>The email address of the customer.</p>"""
    additional_recipients: NotRequired[
        "capo_connect.types.outbound_additional_recipients.OutboundAdditionalRecipients"
    ]
    """<p>The additional recipients address of 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>"""
    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 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.

contact_id instance-attribute

contact_id: ContactId

The identifier of the contact in this instance of Connect Customer.

destination_email_address instance-attribute

destination_email_address: EmailAddressInfo

The email address of the customer.

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: NotRequired[EmailAddressInfo]

The email address associated with the Connect Customer instance.

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.