Struct StartEmailContactInput

#[non_exhaustive]
pub struct StartEmailContactInput {

    pub instance_id: Option<String>,
    pub from_email_address: Option<EmailAddressInfo>,
    pub destination_email_address: Option<String>,
    pub description: Option<String>,
    pub references: Option<HashMap<String, Reference>>,
    pub name: Option<String>,
    pub email_message: Option<InboundEmailContent>,
    pub additional_recipients: Option<InboundAdditionalRecipients>,
    pub attachments: Option<Vec<EmailAttachment>>,
    pub contact_flow_id: Option<String>,
    pub related_contact_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub segment_attributes: Option<HashMap<String, SegmentAttributeValue>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_id: Option<String>

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

from_email_address: Option<EmailAddressInfo>

The email address of the customer.

destination_email_address: Option<String>

The email address associated with the instance.

description: Option<String>

A description of the email contact.

references: Option<HashMap<String, Reference>>

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: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.

name: Option<String>

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

email_message: Option<InboundEmailContent>

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

additional_recipients: Option<InboundAdditionalRecipients>

The addtional recipients address of the email.

attachments: Option<Vec<EmailAttachment>>

List of S3 presigned URLs of email attachments and their file name.

contact_flow_id: Option<String>

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 Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

related_contact_id: Option<String>

The contactId that is related to this contact. Linking emails together by using RelatedContactID 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 RelatedContactId.

attributes: Option<HashMap<String, String>>

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.

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.

segment_attributes: Option<HashMap<String, SegmentAttributeValue>>

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.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}.

client_token: Option<String>

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.

Implementations

impl StartEmailContactInput

pub fn instance_id(&self) -> Option<&str>

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

pub fn from_email_address(&self) -> Option<&EmailAddressInfo>

The email address of the customer.

pub fn destination_email_address(&self) -> Option<&str>

The email address associated with the instance.

pub fn description(&self) -> Option<&str>

A description of the email contact.

pub fn references(&self) -> Option<&HashMap<String, Reference>>

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: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.

pub fn name(&self) -> Option<&str>

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

pub fn email_message(&self) -> Option<&InboundEmailContent>

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

pub fn additional_recipients(&self) -> Option<&InboundAdditionalRecipients>

The addtional recipients address of the email.

pub fn attachments(&self) -> &[EmailAttachment]

List of S3 presigned URLs of email attachments and their file name.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none().

pub fn contact_flow_id(&self) -> Option<&str>

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 Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

pub fn related_contact_id(&self) -> Option<&str>

The contactId that is related to this contact. Linking emails together by using RelatedContactID 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 RelatedContactId.

pub fn attributes(&self) -> Option<&HashMap<String, String>>

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.

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.

pub fn segment_attributes( &self, ) -> Option<&HashMap<String, SegmentAttributeValue>>

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.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}.

pub fn client_token(&self) -> Option<&str>

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.

impl StartEmailContactInput

pub fn builder() -> StartEmailContactInputBuilder

Creates a new builder-style object to manufacture StartEmailContactInput.

Trait Implementations

impl Clone for StartEmailContactInput

fn clone(&self) -> StartEmailContactInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartEmailContactInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartEmailContactInput

fn eq(&self, other: &StartEmailContactInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartEmailContactInput