#[non_exhaustive]pub struct Contact {Show 37 fields
pub arn: Option<String>,
pub id: Option<String>,
pub initial_contact_id: Option<String>,
pub previous_contact_id: Option<String>,
pub contact_association_id: Option<String>,
pub initiation_method: Option<ContactInitiationMethod>,
pub name: Option<String>,
pub description: Option<String>,
pub channel: Option<Channel>,
pub queue_info: Option<QueueInfo>,
pub agent_info: Option<AgentInfo>,
pub initiation_timestamp: Option<DateTime>,
pub disconnect_timestamp: Option<DateTime>,
pub last_update_timestamp: Option<DateTime>,
pub last_paused_timestamp: Option<DateTime>,
pub last_resumed_timestamp: Option<DateTime>,
pub total_pause_count: Option<i32>,
pub total_pause_duration_in_seconds: Option<i32>,
pub scheduled_timestamp: Option<DateTime>,
pub related_contact_id: Option<String>,
pub wisdom_info: Option<WisdomInfo>,
pub customer_id: Option<String>,
pub customer_endpoint: Option<EndpointInfo>,
pub system_endpoint: Option<EndpointInfo>,
pub queue_time_adjustment_seconds: Option<i32>,
pub queue_priority: Option<i64>,
pub tags: Option<HashMap<String, String>>,
pub connected_to_system_timestamp: Option<DateTime>,
pub routing_criteria: Option<RoutingCriteria>,
pub customer: Option<Customer>,
pub campaign: Option<Campaign>,
pub answering_machine_detection_status: Option<AnsweringMachineDetectionStatus>,
pub customer_voice_activity: Option<CustomerVoiceActivity>,
pub quality_metrics: Option<QualityMetrics>,
pub disconnect_details: Option<DisconnectDetails>,
pub additional_email_recipients: Option<AdditionalEmailRecipients>,
pub segment_attributes: Option<HashMap<String, SegmentAttributeValue>>,
}Expand description
Contains information about a contact.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.arn: Option<String>The Amazon Resource Name (ARN) for the contact.
id: Option<String>The identifier for the contact.
initial_contact_id: Option<String>If this contact is related to other contacts, this is the ID of the initial contact.
previous_contact_id: Option<String>If this contact is not the first contact, this is the ID of the previous contact.
contact_association_id: Option<String>This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
initiation_method: Option<ContactInitiationMethod>Indicates how the contact was initiated.
name: Option<String>The name of the contact.
description: Option<String>The description of the contact.
channel: Option<Channel>How the contact reached your contact center.
queue_info: Option<QueueInfo>If this contact was queued, this contains information about the queue.
agent_info: Option<AgentInfo>Information about the agent who accepted the contact.
initiation_timestamp: Option<DateTime>The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
disconnect_timestamp: Option<DateTime>The timestamp when the customer endpoint disconnected from Amazon Connect.
last_update_timestamp: Option<DateTime>The timestamp when contact was last updated.
last_paused_timestamp: Option<DateTime>The timestamp when the contact was last paused.
last_resumed_timestamp: Option<DateTime>The timestamp when the contact was last resumed.
total_pause_count: Option<i32>Total pause count for a contact.
total_pause_duration_in_seconds: Option<i32>Total pause duration for a contact in seconds.
scheduled_timestamp: Option<DateTime>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
The contactId that is related to this contact.
wisdom_info: Option<WisdomInfo>Information about Amazon Connect Wisdom.
customer_id: Option<String>The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
customer_endpoint: Option<EndpointInfo>The customer or external third party participant endpoint.
system_endpoint: Option<EndpointInfo>The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
queue_time_adjustment_seconds: Option<i32>An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
queue_priority: Option<i64>An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
connected_to_system_timestamp: Option<DateTime>The timestamp when customer endpoint connected to Amazon Connect.
routing_criteria: Option<RoutingCriteria>Latest routing criteria on the contact.
customer: Option<Customer>Information about the Customer on the contact.
campaign: Option<Campaign>Information associated with a campaign.
answering_machine_detection_status: Option<AnsweringMachineDetectionStatus>Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
customer_voice_activity: Option<CustomerVoiceActivity>Information about customer’s voice activity.
quality_metrics: Option<QualityMetrics>Information about the quality of the participant's media connection.
disconnect_details: Option<DisconnectDetails>Information about the call disconnect experience.
additional_email_recipients: Option<AdditionalEmailRecipients>List of additional email addresses for an email contact.
segment_attributes: Option<HashMap<String, 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 and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
Implementations§
Source§impl Contact
impl Contact
Sourcepub fn initial_contact_id(&self) -> Option<&str>
pub fn initial_contact_id(&self) -> Option<&str>
If this contact is related to other contacts, this is the ID of the initial contact.
Sourcepub fn previous_contact_id(&self) -> Option<&str>
pub fn previous_contact_id(&self) -> Option<&str>
If this contact is not the first contact, this is the ID of the previous contact.
Sourcepub fn contact_association_id(&self) -> Option<&str>
pub fn contact_association_id(&self) -> Option<&str>
This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
Sourcepub fn initiation_method(&self) -> Option<&ContactInitiationMethod>
pub fn initiation_method(&self) -> Option<&ContactInitiationMethod>
Indicates how the contact was initiated.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the contact.
Sourcepub fn queue_info(&self) -> Option<&QueueInfo>
pub fn queue_info(&self) -> Option<&QueueInfo>
If this contact was queued, this contains information about the queue.
Sourcepub fn agent_info(&self) -> Option<&AgentInfo>
pub fn agent_info(&self) -> Option<&AgentInfo>
Information about the agent who accepted the contact.
Sourcepub fn initiation_timestamp(&self) -> Option<&DateTime>
pub fn initiation_timestamp(&self) -> Option<&DateTime>
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
Sourcepub fn disconnect_timestamp(&self) -> Option<&DateTime>
pub fn disconnect_timestamp(&self) -> Option<&DateTime>
The timestamp when the customer endpoint disconnected from Amazon Connect.
Sourcepub fn last_update_timestamp(&self) -> Option<&DateTime>
pub fn last_update_timestamp(&self) -> Option<&DateTime>
The timestamp when contact was last updated.
Sourcepub fn last_paused_timestamp(&self) -> Option<&DateTime>
pub fn last_paused_timestamp(&self) -> Option<&DateTime>
The timestamp when the contact was last paused.
Sourcepub fn last_resumed_timestamp(&self) -> Option<&DateTime>
pub fn last_resumed_timestamp(&self) -> Option<&DateTime>
The timestamp when the contact was last resumed.
Sourcepub fn total_pause_count(&self) -> Option<i32>
pub fn total_pause_count(&self) -> Option<i32>
Total pause count for a contact.
Sourcepub fn total_pause_duration_in_seconds(&self) -> Option<i32>
pub fn total_pause_duration_in_seconds(&self) -> Option<i32>
Total pause duration for a contact in seconds.
Sourcepub fn scheduled_timestamp(&self) -> Option<&DateTime>
pub fn scheduled_timestamp(&self) -> Option<&DateTime>
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
The contactId that is related to this contact.
Sourcepub fn wisdom_info(&self) -> Option<&WisdomInfo>
pub fn wisdom_info(&self) -> Option<&WisdomInfo>
Information about Amazon Connect Wisdom.
Sourcepub fn customer_id(&self) -> Option<&str>
pub fn customer_id(&self) -> Option<&str>
The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
Sourcepub fn customer_endpoint(&self) -> Option<&EndpointInfo>
pub fn customer_endpoint(&self) -> Option<&EndpointInfo>
The customer or external third party participant endpoint.
Sourcepub fn system_endpoint(&self) -> Option<&EndpointInfo>
pub fn system_endpoint(&self) -> Option<&EndpointInfo>
The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
Sourcepub fn queue_time_adjustment_seconds(&self) -> Option<i32>
pub fn queue_time_adjustment_seconds(&self) -> Option<i32>
An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
Sourcepub fn queue_priority(&self) -> Option<i64>
pub fn queue_priority(&self) -> Option<i64>
An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
Sourcepub fn connected_to_system_timestamp(&self) -> Option<&DateTime>
pub fn connected_to_system_timestamp(&self) -> Option<&DateTime>
The timestamp when customer endpoint connected to Amazon Connect.
Sourcepub fn routing_criteria(&self) -> Option<&RoutingCriteria>
pub fn routing_criteria(&self) -> Option<&RoutingCriteria>
Latest routing criteria on the contact.
Sourcepub fn answering_machine_detection_status(
&self,
) -> Option<&AnsweringMachineDetectionStatus>
pub fn answering_machine_detection_status( &self, ) -> Option<&AnsweringMachineDetectionStatus>
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
Sourcepub fn customer_voice_activity(&self) -> Option<&CustomerVoiceActivity>
pub fn customer_voice_activity(&self) -> Option<&CustomerVoiceActivity>
Information about customer’s voice activity.
Sourcepub fn quality_metrics(&self) -> Option<&QualityMetrics>
pub fn quality_metrics(&self) -> Option<&QualityMetrics>
Information about the quality of the participant's media connection.
Sourcepub fn disconnect_details(&self) -> Option<&DisconnectDetails>
pub fn disconnect_details(&self) -> Option<&DisconnectDetails>
Information about the call disconnect experience.
Sourcepub fn additional_email_recipients(&self) -> Option<&AdditionalEmailRecipients>
pub fn additional_email_recipients(&self) -> Option<&AdditionalEmailRecipients>
List of additional email addresses for an email contact.
Sourcepub fn segment_attributes(
&self,
) -> Option<&HashMap<String, SegmentAttributeValue>>
pub fn segment_attributes( &self, ) -> Option<&HashMap<String, 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 and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
Trait Implementations§
impl StructuralPartialEq for Contact
Auto Trait Implementations§
impl Freeze for Contact
impl RefUnwindSafe for Contact
impl Send for Contact
impl Sync for Contact
impl Unpin for Contact
impl UnwindSafe for Contact
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);