Interface StartEmailContactRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<StartEmailContactRequest.Builder,StartEmailContactRequest>, SdkBuilder<StartEmailContactRequest.Builder,StartEmailContactRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartEmailContactRequest
@Mutable @NotThreadSafe public static interface StartEmailContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartEmailContactRequest.Builder,StartEmailContactRequest>

  • Method Details

    • instanceId

      StartEmailContactRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fromEmailAddress

      StartEmailContactRequest.Builder fromEmailAddress(EmailAddressInfo fromEmailAddress)

      The email address of the customer.

      Parameters:
      fromEmailAddress - The email address of the customer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fromEmailAddress

      default StartEmailContactRequest.Builder fromEmailAddress(Consumer<EmailAddressInfo.Builder> fromEmailAddress)

      The email address of the customer.

      This is a convenience method that creates an instance of the EmailAddressInfo.Builder avoiding the need to create one manually via EmailAddressInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fromEmailAddress(EmailAddressInfo).

      Parameters:
      fromEmailAddress - a consumer that will call methods on EmailAddressInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationEmailAddress

      StartEmailContactRequest.Builder destinationEmailAddress(String destinationEmailAddress)

      The email address associated with the Amazon Connect instance.

      Parameters:
      destinationEmailAddress - The email address associated with the Amazon Connect instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartEmailContactRequest.Builder description(String description)

      A description of the email contact.

      Parameters:
      description - A description of the email contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • references

      StartEmailContactRequest.Builder references(Map<String,Reference> references)

      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.

      Parameters:
      references - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartEmailContactRequest.Builder name(String name)

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

      Parameters:
      name - The name of a email that is shown to an agent in the Contact Control Panel (CCP).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailMessage

      StartEmailContactRequest.Builder emailMessage(InboundEmailContent emailMessage)

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

      Parameters:
      emailMessage - The email message body to be sent to the newly created email.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailMessage

      default StartEmailContactRequest.Builder emailMessage(Consumer<InboundEmailContent.Builder> emailMessage)

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

      This is a convenience method that creates an instance of the InboundEmailContent.Builder avoiding the need to create one manually via InboundEmailContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailMessage(InboundEmailContent).

      Parameters:
      emailMessage - a consumer that will call methods on InboundEmailContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalRecipients

      StartEmailContactRequest.Builder additionalRecipients(InboundAdditionalRecipients additionalRecipients)

      The addtional recipients address of the email.

      Parameters:
      additionalRecipients - The addtional recipients address of the email.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalRecipients

      default StartEmailContactRequest.Builder additionalRecipients(Consumer<InboundAdditionalRecipients.Builder> additionalRecipients)

      The addtional recipients address of the email.

      This is a convenience method that creates an instance of the InboundAdditionalRecipients.Builder avoiding the need to create one manually via InboundAdditionalRecipients.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalRecipients(InboundAdditionalRecipients).

      Parameters:
      additionalRecipients - a consumer that will call methods on InboundAdditionalRecipients.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attachments

      StartEmailContactRequest.Builder attachments(Collection<EmailAttachment> attachments)

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

      Parameters:
      attachments - List of S3 presigned URLs of email attachments and their file name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      StartEmailContactRequest.Builder attachments(EmailAttachment... attachments)

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

      Parameters:
      attachments - List of S3 presigned URLs of email attachments and their file name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      StartEmailContactRequest.Builder attachments(Consumer<EmailAttachment.Builder>... attachments)

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

      This is a convenience method that creates an instance of the EmailAttachment.Builder avoiding the need to create one manually via EmailAttachment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachments(List<EmailAttachment>).

      Parameters:
      attachments - a consumer that will call methods on EmailAttachment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contactFlowId

      StartEmailContactRequest.Builder contactFlowId(String contactFlowId)

      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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedContactId

      StartEmailContactRequest.Builder relatedContactId(String relatedContactId)

      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.

      Parameters:
      relatedContactId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      StartEmailContactRequest.Builder attributes(Map<String,String> attributes)

      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.

      Parameters:
      attributes - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentAttributes

      StartEmailContactRequest.Builder segmentAttributes(Map<String,SegmentAttributeValue> segmentAttributes)

      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}}}}.

      Parameters:
      segmentAttributes - 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}}}}.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartEmailContactRequest.Builder clientToken(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartEmailContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartEmailContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.