connect/aws.sdk.kotlin.services.connect.model/StartEmailContactRequest/Builder

Builder

class Builder

Properties

additionalRecipients

var additionalRecipients: InboundAdditionalRecipients?

The addtional recipients address of the email.

attachments

var attachments: List<EmailAttachment>?

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

attributes

var attributes: Map<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.

clientToken

var clientToken: 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.

contactFlowId

var contactFlowId: 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:

description

var description: String?

A description of the email contact.

destinationEmailAddress

var destinationEmailAddress: String?

The email address associated with the Amazon Connect instance.

emailMessage

var emailMessage: InboundEmailContent?

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

fromEmailAddress

var fromEmailAddress: EmailAddressInfo?

The email address of the customer.

instanceId

var instanceId: String?

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

name

var name: String?

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

references

var references: Map<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.

relatedContactId

var relatedContactId: 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.

segmentAttributes

var segmentAttributes: Map<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.

Functions

additionalRecipients

fun additionalRecipients(block: InboundAdditionalRecipients.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.connect.model.InboundAdditionalRecipients inside the given block

emailMessage

fun emailMessage(block: InboundEmailContent.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.connect.model.InboundEmailContent inside the given block

fromEmailAddress

fun fromEmailAddress(block: EmailAddressInfo.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.connect.model.EmailAddressInfo inside the given block