Class: Aws::CustomerProfiles::Types::UpdateProfileRequest

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 UpdateProfileRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_numberString

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

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_informationString

Any additional information relevant to the customer’s profile.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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

#addressTypes::UpdateAddress

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



5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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

#attributesHash<String,String>

A key value pair of attributes of a customer profile.

Returns:

  • (Hash<String,String>)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressTypes::UpdateAddress

The customer’s billing address.



5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_dateString

The customer’s birth date.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressString

The customer’s business email address.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_nameString

The name of the customer’s business.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_numberString

The customer’s business phone number.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_nameString

The unique name of the domain.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressString

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

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_nameString

The customer’s first name.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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

#genderString

The gender with which the customer identifies.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_numberString

The customer’s home phone number.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_nameString

The customer’s last name.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressTypes::UpdateAddress

The customer’s mailing address.



5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_nameString

The customer’s middle name.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_numberString

The customer’s mobile phone number.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_typeString

The type of profile used to describe the customer.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressString

The customer’s personal email address.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_numberString

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

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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

#profile_idString

The unique identifier of a customer profile.

Returns:

  • (String)


5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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_addressTypes::UpdateAddress

The customer’s shipping address.



5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5212

class UpdateProfileRequest < Struct.new(
  :domain_name,
  :profile_id,
  :additional_information,
  :account_number,
  :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