Class: Aws::CustomerProfiles::Types::CreateProfileRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass CreateProfileRequest data as a hash:

{
  domain_name: "name", # required
  account_number: "string1To255",
  additional_information: "string1To1000",
  party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
  business_name: "string1To255",
  first_name: "string1To255",
  middle_name: "string1To255",
  last_name: "string1To255",
  birth_date: "string1To255",
  gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
  phone_number: "string1To255",
  mobile_phone_number: "string1To255",
  home_phone_number: "string1To255",
  business_phone_number: "string1To255",
  email_address: "string1To255",
  personal_email_address: "string1To255",
  business_email_address: "string1To255",
  address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  shipping_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  mailing_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  billing_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  attributes: {
    "string1To255" => "string1To255",
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_number ⇒ String

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

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#additional_information ⇒ String

Any additional information relevant to the customer’s profile.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#address ⇒ Types::Address

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

Returns:



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

A key value pair of attributes of a customer profile.

Returns:

  • (Hash<String,String>) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#billing_address ⇒ Types::Address

The customer’s billing address.

Returns:



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#birth_date ⇒ String

The customer’s birth date.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#business_email_address ⇒ String

The customer’s business email address.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#business_name ⇒ String

The name of the customer’s business.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#business_phone_number ⇒ String

The customer’s business phone number.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#email_address ⇒ String

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

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#first_name ⇒ String

The customer’s first name.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#gender ⇒ String

The gender with which the customer identifies.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#home_phone_number ⇒ String

The customer’s home phone number.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#last_name ⇒ String

The customer’s last name.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#mailing_address ⇒ Types::Address

The customer’s mailing address.

Returns:



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#middle_name ⇒ String

The customer’s middle name.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#mobile_phone_number ⇒ String

The customer’s mobile phone number.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#party_type ⇒ String

The type of profile used to describe the customer.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#personal_email_address ⇒ String

The customer’s personal email address.

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number ⇒ String

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

Returns:

  • (String) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#shipping_address ⇒ Types::Address

The customer’s shipping address.

Returns:



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 651

class CreateProfileRequest < Struct.new(
  :domain_name,
  :account_number,
  :additional_information,
  :party_type,
  :business_name,
  :first_name,
  :middle_name,
  :last_name,
  :birth_date,
  :gender,
  :phone_number,
  :mobile_phone_number,
  :home_phone_number,
  :business_phone_number,
  :email_address,
  :personal_email_address,
  :business_email_address,
  :address,
  :shipping_address,
  :mailing_address,
  :billing_address,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end