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

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

Overview

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#additional_recipientsTypes::InboundAdditionalRecipients

The addtional recipients address of the email.



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

#attachmentsArray<Types::EmailAttachment>

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

Returns:



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

#attributesHash<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>)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_tokenString

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)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_idString

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)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

#descriptionString

A description of the email contact.

Returns:

  • (String)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_addressString

The email address associated with the instance.

Returns:

  • (String)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_messageTypes::InboundEmailContent

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



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_addressTypes::EmailAddressInfo

The email address of the customer.



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_idString

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)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

#nameString

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

Returns:

  • (String)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

#referencesHash<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:



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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

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)


21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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_attributesHash<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:



21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
# File 'lib/aws-sdk-connect/types.rb', line 21836

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