Class: Aws::Connect::Types::CreateContactRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::CreateContactRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

  A custom key-value pair using an attribute map.

• #channel ⇒ String

  The channel for the contact.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  A description of the contact.

• #expiry_duration_in_minutes ⇒ Integer

  Number of minutes the contact will be active for before expiring.

• #initiate_as ⇒ String

  Initial state of the contact when it’s created.

• #initiation_method ⇒ String

  Indicates how the contact was initiated.

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #name ⇒ String

  The name of a the contact.

• #previous_contact_id ⇒ String

  The ID of the previous contact when creating a transfer contact.

• #references ⇒ Hash<String,Types::Reference>

  A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

• #related_contact_id ⇒ String

  The identifier of the contact in this instance of Amazon Connect.

• #segment_attributes ⇒ Hash<String,Types::SegmentAttributeValue>

  A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map.

• #user_info ⇒ Types::UserInfo

  User details for the contact.

Instance Attribute Details

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

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#channel ⇒ String

The channel for the contact.

The CHAT channel is not supported. The following information is incorrect. We’re working to correct it.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  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)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#expiry_duration_in_minutes ⇒ Integer

Number of minutes the contact will be active for before expiring

Returns:

• (Integer)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#initiate_as ⇒ String

Initial state of the contact when it’s created. Only TASK channel contacts can be initiated with COMPLETED state.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#initiation_method ⇒ String

Indicates how the contact was initiated.

CreateContact only supports the following initiation methods. Valid values by channel are:

* For VOICE: `TRANSFER` and the subtype `connect:ExternalAudio`

• For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

• For TASK: API

The other channels listed below are incorrect. We're working to

correct this information.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  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)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#name ⇒ String

The name of a the contact.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#previous_contact_id ⇒ String

The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see [Integrate Amazon Connect Contact Lens with external voice systems] in the *Amazon Connect Administrator Guide*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#references ⇒ Hash<String,Types::Reference>

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

Returns:

• (Hash<String,Types::Reference>)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#related_contact_id ⇒ String

The identifier of the contact in this instance of Amazon Connect.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#segment_attributes ⇒ Hash<String,Types::SegmentAttributeValue>

A set of system defined key-value pairs stored on individual contact segments (unique contact ID) 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 set Segment Contact Expiry as a duration in minutes.

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

• (Hash<String,Types::SegmentAttributeValue>)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#user_info ⇒ Types::UserInfo

User details for the contact

UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

Returns:

• (Types::UserInfo)

# File 'lib/aws-sdk-connect/types.rb', line 5291

class CreateContactRequest < Struct.new(
  :instance_id,
  :client_token,
  :related_contact_id,
  :attributes,
  :references,
  :channel,
  :initiation_method,
  :expiry_duration_in_minutes,
  :user_info,
  :initiate_as,
  :name,
  :description,
  :segment_attributes,
  :previous_contact_id)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end