Class: Aws::Connect::Types::StartEmailContactRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:destination_email_address, :description, :name, :attachments]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_recipients ⇒ Types::InboundAdditionalRecipients

The additional recipients address of the email.

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#attachments ⇒ Array<Types::EmailAttachment>

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

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#attributes ⇒ Hash<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.

Returns:

  • (Hash<String,String>) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#client_token ⇒ 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].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#contact_flow_id ⇒ 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

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#description ⇒ String

A description of the email contact.

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#destination_email_address ⇒ String

The email address associated with the Amazon Connect instance.

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#email_message ⇒ Types::InboundEmailContent

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

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#from_email_address ⇒ Types::EmailAddressInfo

The email address of the customer.

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#instance_id ⇒ String

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#references ⇒ Hash<String,Types::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.

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#related_contact_id ⇒ 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`.

Returns:

  • (String) 


23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end

#segment_attributes ⇒ Hash<String,Types::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`.

<note markdown=“1”> 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”: : { “ExpiryDuration”: { “ValueInteger”:135}}}`.

</note>

Returns:



23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
 
# File 'lib/aws-sdk-connect/types.rb', line 23794

class StartEmailContactRequest < Struct.new(
  :instance_id,
  :from_email_address,
  :destination_email_address,
  :description,
  :references,
  :name,
  :email_message,
  :additional_recipients,
  :attachments,
  :contact_flow_id,
  :related_contact_id,
  :attributes,
  :segment_attributes,
  :client_token)
  SENSITIVE = [:destination_email_address, :description, :name, :attachments]
  include Aws::Structure
end