Class: Aws::Connect::Types::UpdateContactRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::UpdateContactRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :description]

Instance Attribute Summary

• #contact_id ⇒ String

  The identifier of the contact.

• #customer_endpoint ⇒ Types::Endpoint

  The endpoint of the customer for which the contact was initiated.

• #description ⇒ String

  The description of the contact.

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #name ⇒ String

  The name of the contact.

• #queue_info ⇒ Types::QueueInfoInput

  Information about the queue associated with a contact.

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

  Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

• #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.

• #system_endpoint ⇒ Types::Endpoint

  External system endpoint for the contact was initiated.

• #user_info ⇒ Types::UserInfo

  Information about the agent associated with a contact.

Instance Attribute Details

#contact_id ⇒ String

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

Returns:

• (String)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#customer_endpoint ⇒ Types::Endpoint

The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer’s phone number. This value can only be updated for external audio contacts. For more information, see [Amazon Connect Contact Lens integration] in the *Amazon Connect Administrator Guide*.

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

Returns:

• (Types::Endpoint)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the contact.

Returns:

• (String)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  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 34005

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the contact.

Returns:

• (String)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#queue_info ⇒ Types::QueueInfoInput

Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see [Amazon Connect Contact Lens integration] in the Amazon Connect Administrator Guide.

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

Returns:

• (Types::QueueInfoInput)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

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

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

Returns:

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

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  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 show channel subtype, such as ‘connect:Guide`.

Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.

Returns:

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

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#system_endpoint ⇒ Types::Endpoint

External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see [Amazon Connect Contact Lens integration] in the *Amazon Connect Administrator Guide*.

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

Returns:

• (Types::Endpoint)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end

#user_info ⇒ Types::UserInfo

Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see [Amazon Connect Contact Lens integration] in the Amazon Connect Administrator Guide.

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

Returns:

• (Types::UserInfo)

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

class UpdateContactRequest < Struct.new(
  :instance_id,
  :contact_id,
  :name,
  :description,
  :references,
  :segment_attributes,
  :queue_info,
  :user_info,
  :customer_endpoint,
  :system_endpoint)
  SENSITIVE = [:name, :description]
  include Aws::Structure
end