#[non_exhaustive]pub struct CreateContactInput {Show 14 fields
pub instance_id: Option<String>,
pub client_token: Option<String>,
pub related_contact_id: Option<String>,
pub attributes: Option<HashMap<String, String>>,
pub references: Option<HashMap<String, Reference>>,
pub channel: Option<Channel>,
pub initiation_method: Option<ContactInitiationMethod>,
pub expiry_duration_in_minutes: Option<i32>,
pub user_info: Option<UserInfo>,
pub initiate_as: Option<InitiateAs>,
pub name: Option<String>,
pub description: Option<String>,
pub segment_attributes: Option<HashMap<String, SegmentAttributeValue>>,
pub previous_contact_id: Option<String>,
}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.instance_id: Option<String>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
client_token: Option<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.
The identifier of the contact in this instance of Amazon Connect.
attributes: Option<HashMap<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.
references: Option<HashMap<String, 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.
channel: Option<Channel>The channel for the contact.
The CHAT channel is not supported. The following information is incorrect. We're working to correct it.
initiation_method: Option<ContactInitiationMethod>Indicates how the contact was initiated.
CreateContact only supports the following initiation methods. Valid values by channel are:
-
For VOICE:
TRANSFERand the subtypeconnect:ExternalAudio -
For EMAIL:
OUTBOUND|AGENT_REPLY|FLOW -
For TASK:
API
The other channels listed below are incorrect. We're working to correct this information.
expiry_duration_in_minutes: Option<i32>Number of minutes the contact will be active for before expiring
user_info: Option<UserInfo>User details for the contact
UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.
initiate_as: Option<InitiateAs>Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
name: Option<String>The name of a the contact.
description: Option<String>A description of the contact.
segment_attributes: Option<HashMap<String, 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.
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": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.
previous_contact_id: Option<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.
Implementations§
Source§impl CreateContactInput
impl CreateContactInput
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
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.
The identifier of the contact in this instance of Amazon Connect.
Sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> Option<&HashMap<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.
Sourcepub fn references(&self) -> Option<&HashMap<String, Reference>>
pub fn references(&self) -> Option<&HashMap<String, 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.
Sourcepub fn channel(&self) -> Option<&Channel>
pub fn channel(&self) -> Option<&Channel>
The channel for the contact.
The CHAT channel is not supported. The following information is incorrect. We're working to correct it.
Sourcepub fn initiation_method(&self) -> Option<&ContactInitiationMethod>
pub fn initiation_method(&self) -> Option<&ContactInitiationMethod>
Indicates how the contact was initiated.
CreateContact only supports the following initiation methods. Valid values by channel are:
-
For VOICE:
TRANSFERand the subtypeconnect:ExternalAudio -
For EMAIL:
OUTBOUND|AGENT_REPLY|FLOW -
For TASK:
API
The other channels listed below are incorrect. We're working to correct this information.
Sourcepub fn expiry_duration_in_minutes(&self) -> Option<i32>
pub fn expiry_duration_in_minutes(&self) -> Option<i32>
Number of minutes the contact will be active for before expiring
Sourcepub fn user_info(&self) -> Option<&UserInfo>
pub fn user_info(&self) -> Option<&UserInfo>
User details for the contact
UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.
Sourcepub fn initiate_as(&self) -> Option<&InitiateAs>
pub fn initiate_as(&self) -> Option<&InitiateAs>
Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the 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 (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.
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": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.
Sourcepub fn previous_contact_id(&self) -> Option<&str>
pub fn previous_contact_id(&self) -> Option<&str>
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.
Source§impl CreateContactInput
impl CreateContactInput
Sourcepub fn builder() -> CreateContactInputBuilder
pub fn builder() -> CreateContactInputBuilder
Creates a new builder-style object to manufacture CreateContactInput.
Trait Implementations§
Source§impl Clone for CreateContactInput
impl Clone for CreateContactInput
Source§fn clone(&self) -> CreateContactInput
fn clone(&self) -> CreateContactInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateContactInput
impl Debug for CreateContactInput
Source§impl PartialEq for CreateContactInput
impl PartialEq for CreateContactInput
impl StructuralPartialEq for CreateContactInput
Auto Trait Implementations§
impl Freeze for CreateContactInput
impl RefUnwindSafe for CreateContactInput
impl Send for CreateContactInput
impl Sync for CreateContactInput
impl Unpin for CreateContactInput
impl UnwindSafe for CreateContactInput
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);