Struct aws_sdk_customerprofiles::types::Profile

#[non_exhaustive]
pub struct Profile {

    pub profile_id: Option<String>,
    pub account_number: Option<String>,
    pub additional_information: Option<String>,
    pub party_type: Option<PartyType>,
    pub business_name: Option<String>,
    pub first_name: Option<String>,
    pub middle_name: Option<String>,
    pub last_name: Option<String>,
    pub birth_date: Option<String>,
    pub gender: Option<Gender>,
    pub phone_number: Option<String>,
    pub mobile_phone_number: Option<String>,
    pub home_phone_number: Option<String>,
    pub business_phone_number: Option<String>,
    pub email_address: Option<String>,
    pub personal_email_address: Option<String>,
    pub business_email_address: Option<String>,
    pub address: Option<Address>,
    pub shipping_address: Option<Address>,
    pub mailing_address: Option<Address>,
    pub billing_address: Option<Address>,
    pub attributes: Option<HashMap<String, String>>,
    pub found_by_items: Option<Vec<FoundByKeyValue>>,
    pub party_type_string: Option<String>,
    pub gender_string: Option<String>,
}

The standard profile of a customer.

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.

profile_id: Option<String>

The unique identifier of a customer profile.

account_number: Option<String>

A unique account number that you have given to the customer.

additional_information: Option<String>

Any additional information relevant to the customer’s profile.

party_type: Option<PartyType>

The type of profile used to describe the customer.

business_name: Option<String>

The name of the customer’s business.

first_name: Option<String>

The customer’s first name.

middle_name: Option<String>

The customer’s middle name.

last_name: Option<String>

The customer’s last name.

birth_date: Option<String>

The customer’s birth date.

gender: Option<Gender>

The gender with which the customer identifies.

phone_number: Option<String>

The customer's phone number, which has not been specified as a mobile, home, or business number.

mobile_phone_number: Option<String>

The customer’s mobile phone number.

home_phone_number: Option<String>

The customer’s home phone number.

business_phone_number: Option<String>

The customer’s home phone number.

email_address: Option<String>

The customer’s email address, which has not been specified as a personal or business address.

personal_email_address: Option<String>

The customer’s personal email address.

business_email_address: Option<String>

The customer’s business email address.

address: Option<Address>

A generic address associated with the customer that is not mailing, shipping, or billing.

shipping_address: Option<Address>

The customer’s shipping address.

mailing_address: Option<Address>

The customer’s mailing address.

billing_address: Option<Address>

The customer’s billing address.

attributes: Option<HashMap<String, String>>

A key value pair of attributes of a customer profile.

found_by_items: Option<Vec<FoundByKeyValue>>

A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

• AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

• OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

party_type_string: Option<String>

An alternative to PartyType which accepts any string as input.

gender_string: Option<String>

An alternative to Gender which accepts any string as input.

Implementations

impl Profile

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

The unique identifier of a customer profile.

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

A unique account number that you have given to the customer.

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

Any additional information relevant to the customer’s profile.

pub fn party_type(&self) -> Option<&PartyType>

The type of profile used to describe the customer.

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

The name of the customer’s business.

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

The customer’s first name.

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

The customer’s middle name.

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

The customer’s last name.

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

The customer’s birth date.

pub fn gender(&self) -> Option<&Gender>

The gender with which the customer identifies.

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

The customer's phone number, which has not been specified as a mobile, home, or business number.

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

The customer’s mobile phone number.

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

The customer’s home phone number.

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

The customer’s home phone number.

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

The customer’s email address, which has not been specified as a personal or business address.

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

The customer’s personal email address.

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

The customer’s business email address.

pub fn address(&self) -> Option<&Address>

A generic address associated with the customer that is not mailing, shipping, or billing.

pub fn shipping_address(&self) -> Option<&Address>

The customer’s shipping address.

pub fn mailing_address(&self) -> Option<&Address>

The customer’s mailing address.

pub fn billing_address(&self) -> Option<&Address>

The customer’s billing address.

pub fn attributes(&self) -> Option<&HashMap<String, String>>

A key value pair of attributes of a customer profile.

pub fn found_by_items(&self) -> &[FoundByKeyValue]

A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

• AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

• OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .found_by_items.is_none().

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

An alternative to PartyType which accepts any string as input.

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

An alternative to Gender which accepts any string as input.

impl Profile

pub fn builder() -> ProfileBuilder

Creates a new builder-style object to manufacture Profile.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl PartialEq for Profile

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Profile