aws_sdk_connect/client/

start_email_contact.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartEmailContact`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect 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><br>
    ///   - [`from_email_address(EmailAddressInfo)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::from_email_address) / [`set_from_email_address(Option<EmailAddressInfo>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_from_email_address):<br>required: **true**<br><p>The email address of the customer.</p><br>
    ///   - [`destination_email_address(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::destination_email_address) / [`set_destination_email_address(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_destination_email_address):<br>required: **true**<br><p>The email address associated with the instance.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_description):<br>required: **false**<br><p>A description of the email contact.</p><br>
    ///   - [`references(impl Into<String>, Reference)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::references) / [`set_references(Option<HashMap::<String, Reference>>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_references):<br>required: **false**<br><p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> | <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during email creation.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_name):<br>required: **false**<br><p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p><br>
    ///   - [`email_message(InboundEmailContent)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::email_message) / [`set_email_message(Option<InboundEmailContent>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_email_message):<br>required: **true**<br><p>The email message body to be sent to the newly created email.</p><br>
    ///   - [`additional_recipients(InboundAdditionalRecipients)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::additional_recipients) / [`set_additional_recipients(Option<InboundAdditionalRecipients>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_additional_recipients):<br>required: **false**<br><p>The addtional recipients address of the email.</p><br>
    ///   - [`attachments(EmailAttachment)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::attachments) / [`set_attachments(Option<Vec::<EmailAttachment>>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_attachments):<br>required: **false**<br><p>List of S3 presigned URLs of email attachments and their file name.</p><br>
    ///   - [`contact_flow_id(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::contact_flow_id) / [`set_contact_flow_id(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_contact_flow_id):<br>required: **false**<br><p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold:</p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></p><br>
    ///   - [`related_contact_id(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::related_contact_id) / [`set_related_contact_id(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_related_contact_id):<br>required: **false**<br><p>The contactId that is related to this contact. Linking emails together by using <code>RelatedContactID</code> copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>.</p><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_attributes):<br>required: **false**<br><p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p><br>
    ///   - [`segment_attributes(impl Into<String>, SegmentAttributeValue)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::segment_attributes) / [`set_segment_attributes(Option<HashMap::<String, SegmentAttributeValue>>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_segment_attributes):<br>required: **false**<br><p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p><note>  <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer number of minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like { <code> "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}</code>.</p> </note><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`StartEmailContactOutput`](crate::operation::start_email_contact::StartEmailContactOutput) with field(s):
    ///   - [`contact_id(Option<String>)`](crate::operation::start_email_contact::StartEmailContactOutput::contact_id): <p>The identifier of this contact within the Amazon Connect instance.</p>
    /// - On failure, responds with [`SdkError<StartEmailContactError>`](crate::operation::start_email_contact::StartEmailContactError)
    pub fn start_email_contact(&self) -> crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder {
        crate::operation::start_email_contact::builders::StartEmailContactFluentBuilder::new(self.handle.clone())
    }
}