Struct CreateContactInput

#[non_exhaustive]
pub struct CreateContactInput {

    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>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

related_contact_id: Option<String>

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

initiation_method: Option<ContactInitiationMethod>

Indicates how the contact was initiated.

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

initiate_as: Option<InitiateAs>

Initial state of the contact when it's created

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}}}}.

Implementations

impl CreateContactInput

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.

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.

pub fn related_contact_id(&self) -> Option<&str>

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

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.

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.

pub fn channel(&self) -> Option<&Channel>

The channel for the contact

pub fn initiation_method(&self) -> Option<&ContactInitiationMethod>

Indicates how the contact was initiated.

pub fn expiry_duration_in_minutes(&self) -> Option<i32>

Number of minutes the contact will be active for before expiring

pub fn user_info(&self) -> Option<&UserInfo>

User details for the contact

pub fn initiate_as(&self) -> Option<&InitiateAs>

Initial state of the contact when it's created

pub fn name(&self) -> Option<&str>

The name of a the contact.

pub fn description(&self) -> Option<&str>

A description of the contact.

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}}}}.

impl CreateContactInput

pub fn builder() -> CreateContactInputBuilder

Creates a new builder-style object to manufacture CreateContactInput.

Trait Implementations

impl Clone for CreateContactInput

fn clone(&self) -> CreateContactInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateContactInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateContactInput

fn eq(&self, other: &CreateContactInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateContactInput