aws-sdk-customerprofiles 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-customerprofiles.rb +53 -0
- data/lib/aws-sdk-customerprofiles/client.rb +1997 -0
- data/lib/aws-sdk-customerprofiles/client_api.rb +980 -0
- data/lib/aws-sdk-customerprofiles/customizations.rb +0 -0
- data/lib/aws-sdk-customerprofiles/errors.rb +118 -0
- data/lib/aws-sdk-customerprofiles/resource.rb +26 -0
- data/lib/aws-sdk-customerprofiles/types.rb +2551 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,118 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::CustomerProfiles
|
11
|
+
|
12
|
+
# When CustomerProfiles returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::CustomerProfiles::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all CustomerProfiles errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::CustomerProfiles::Errors::ServiceError
|
20
|
+
# # rescues all CustomerProfiles API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {BadRequestException}
|
32
|
+
# * {InternalServerException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ThrottlingException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
38
|
+
module Errors
|
39
|
+
|
40
|
+
extend Aws::Errors::DynamicErrors
|
41
|
+
|
42
|
+
class AccessDeniedException < ServiceError
|
43
|
+
|
44
|
+
# @param [Seahorse::Client::RequestContext] context
|
45
|
+
# @param [String] message
|
46
|
+
# @param [Aws::CustomerProfiles::Types::AccessDeniedException] data
|
47
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
48
|
+
super(context, message, data)
|
49
|
+
end
|
50
|
+
|
51
|
+
# @return [String]
|
52
|
+
def message
|
53
|
+
@message || @data[:message]
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
class BadRequestException < ServiceError
|
58
|
+
|
59
|
+
# @param [Seahorse::Client::RequestContext] context
|
60
|
+
# @param [String] message
|
61
|
+
# @param [Aws::CustomerProfiles::Types::BadRequestException] data
|
62
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
63
|
+
super(context, message, data)
|
64
|
+
end
|
65
|
+
|
66
|
+
# @return [String]
|
67
|
+
def message
|
68
|
+
@message || @data[:message]
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
class InternalServerException < ServiceError
|
73
|
+
|
74
|
+
# @param [Seahorse::Client::RequestContext] context
|
75
|
+
# @param [String] message
|
76
|
+
# @param [Aws::CustomerProfiles::Types::InternalServerException] data
|
77
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
78
|
+
super(context, message, data)
|
79
|
+
end
|
80
|
+
|
81
|
+
# @return [String]
|
82
|
+
def message
|
83
|
+
@message || @data[:message]
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
class ResourceNotFoundException < ServiceError
|
88
|
+
|
89
|
+
# @param [Seahorse::Client::RequestContext] context
|
90
|
+
# @param [String] message
|
91
|
+
# @param [Aws::CustomerProfiles::Types::ResourceNotFoundException] data
|
92
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
93
|
+
super(context, message, data)
|
94
|
+
end
|
95
|
+
|
96
|
+
# @return [String]
|
97
|
+
def message
|
98
|
+
@message || @data[:message]
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
class ThrottlingException < ServiceError
|
103
|
+
|
104
|
+
# @param [Seahorse::Client::RequestContext] context
|
105
|
+
# @param [String] message
|
106
|
+
# @param [Aws::CustomerProfiles::Types::ThrottlingException] data
|
107
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
108
|
+
super(context, message, data)
|
109
|
+
end
|
110
|
+
|
111
|
+
# @return [String]
|
112
|
+
def message
|
113
|
+
@message || @data[:message]
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::CustomerProfiles
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,2551 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::CustomerProfiles
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @note When making an API call, you may pass AddProfileKeyRequest
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# profile_id: "uuid", # required
|
31
|
+
# key_name: "name", # required
|
32
|
+
# values: ["string1To255"], # required
|
33
|
+
# domain_name: "name", # required
|
34
|
+
# }
|
35
|
+
#
|
36
|
+
# @!attribute [rw] profile_id
|
37
|
+
# The unique identifier of a customer profile.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] key_name
|
41
|
+
# A searchable identifier of a customer profile.
|
42
|
+
# @return [String]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] values
|
45
|
+
# A list of key values.
|
46
|
+
# @return [Array<String>]
|
47
|
+
#
|
48
|
+
# @!attribute [rw] domain_name
|
49
|
+
# The unique name of the domain.
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AddProfileKeyRequest AWS API Documentation
|
53
|
+
#
|
54
|
+
class AddProfileKeyRequest < Struct.new(
|
55
|
+
:profile_id,
|
56
|
+
:key_name,
|
57
|
+
:values,
|
58
|
+
:domain_name)
|
59
|
+
SENSITIVE = []
|
60
|
+
include Aws::Structure
|
61
|
+
end
|
62
|
+
|
63
|
+
# @!attribute [rw] key_name
|
64
|
+
# A searchable identifier of a customer profile.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] values
|
68
|
+
# A list of key values.
|
69
|
+
# @return [Array<String>]
|
70
|
+
#
|
71
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AddProfileKeyResponse AWS API Documentation
|
72
|
+
#
|
73
|
+
class AddProfileKeyResponse < Struct.new(
|
74
|
+
:key_name,
|
75
|
+
:values)
|
76
|
+
SENSITIVE = []
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
80
|
+
# A generic address associated with the customer that is not mailing,
|
81
|
+
# shipping, or billing.
|
82
|
+
#
|
83
|
+
# @note When making an API call, you may pass Address
|
84
|
+
# data as a hash:
|
85
|
+
#
|
86
|
+
# {
|
87
|
+
# address_1: "string1To255",
|
88
|
+
# address_2: "string1To255",
|
89
|
+
# address_3: "string1To255",
|
90
|
+
# address_4: "string1To255",
|
91
|
+
# city: "string1To255",
|
92
|
+
# county: "string1To255",
|
93
|
+
# state: "string1To255",
|
94
|
+
# province: "string1To255",
|
95
|
+
# country: "string1To255",
|
96
|
+
# postal_code: "string1To255",
|
97
|
+
# }
|
98
|
+
#
|
99
|
+
# @!attribute [rw] address_1
|
100
|
+
# The first line of a customer address.
|
101
|
+
# @return [String]
|
102
|
+
#
|
103
|
+
# @!attribute [rw] address_2
|
104
|
+
# The second line of a customer address.
|
105
|
+
# @return [String]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] address_3
|
108
|
+
# The third line of a customer address.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] address_4
|
112
|
+
# The fourth line of a customer address.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] city
|
116
|
+
# The city in which a customer lives.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] county
|
120
|
+
# The county in which a customer lives.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] state
|
124
|
+
# The state in which a customer lives.
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @!attribute [rw] province
|
128
|
+
# The province in which a customer lives.
|
129
|
+
# @return [String]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] country
|
132
|
+
# The country in which a customer lives.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] postal_code
|
136
|
+
# The postal code of a customer address.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Address AWS API Documentation
|
140
|
+
#
|
141
|
+
class Address < Struct.new(
|
142
|
+
:address_1,
|
143
|
+
:address_2,
|
144
|
+
:address_3,
|
145
|
+
:address_4,
|
146
|
+
:city,
|
147
|
+
:county,
|
148
|
+
:state,
|
149
|
+
:province,
|
150
|
+
:country,
|
151
|
+
:postal_code)
|
152
|
+
SENSITIVE = []
|
153
|
+
include Aws::Structure
|
154
|
+
end
|
155
|
+
|
156
|
+
# The input you provided is invalid.
|
157
|
+
#
|
158
|
+
# @!attribute [rw] message
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BadRequestException AWS API Documentation
|
162
|
+
#
|
163
|
+
class BadRequestException < Struct.new(
|
164
|
+
:message)
|
165
|
+
SENSITIVE = []
|
166
|
+
include Aws::Structure
|
167
|
+
end
|
168
|
+
|
169
|
+
# @note When making an API call, you may pass CreateDomainRequest
|
170
|
+
# data as a hash:
|
171
|
+
#
|
172
|
+
# {
|
173
|
+
# domain_name: "name", # required
|
174
|
+
# default_expiration_days: 1, # required
|
175
|
+
# default_encryption_key: "encryptionKey",
|
176
|
+
# dead_letter_queue_url: "sqsQueueUrl",
|
177
|
+
# tags: {
|
178
|
+
# "TagKey" => "TagValue",
|
179
|
+
# },
|
180
|
+
# }
|
181
|
+
#
|
182
|
+
# @!attribute [rw] domain_name
|
183
|
+
# The unique name of the domain.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] default_expiration_days
|
187
|
+
# The default number of days until the data within the domain expires.
|
188
|
+
# @return [Integer]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] default_encryption_key
|
191
|
+
# The default encryption key, which is an AWS managed key, is used
|
192
|
+
# when no specific type of encryption key is specified. It is used to
|
193
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
194
|
+
# storage.
|
195
|
+
# @return [String]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] dead_letter_queue_url
|
198
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
199
|
+
# errors associated with ingesting data from third party applications.
|
200
|
+
# You must set up a policy on the DeadLetterQueue for the SendMessage
|
201
|
+
# operation to enable Amazon Connect Customer Profiles to send
|
202
|
+
# messages to the DeadLetterQueue.
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] tags
|
206
|
+
# The tags used to organize, track, or control access for this
|
207
|
+
# resource.
|
208
|
+
# @return [Hash<String,String>]
|
209
|
+
#
|
210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateDomainRequest AWS API Documentation
|
211
|
+
#
|
212
|
+
class CreateDomainRequest < Struct.new(
|
213
|
+
:domain_name,
|
214
|
+
:default_expiration_days,
|
215
|
+
:default_encryption_key,
|
216
|
+
:dead_letter_queue_url,
|
217
|
+
:tags)
|
218
|
+
SENSITIVE = []
|
219
|
+
include Aws::Structure
|
220
|
+
end
|
221
|
+
|
222
|
+
# @!attribute [rw] domain_name
|
223
|
+
# The unique name of the domain.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] default_expiration_days
|
227
|
+
# The default number of days until the data within the domain expires.
|
228
|
+
# @return [Integer]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] default_encryption_key
|
231
|
+
# The default encryption key, which is an AWS managed key, is used
|
232
|
+
# when no specific type of encryption key is specified. It is used to
|
233
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
234
|
+
# storage.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] dead_letter_queue_url
|
238
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
239
|
+
# errors associated with ingesting data from third party applications.
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] created_at
|
243
|
+
# The timestamp of when the domain was created.
|
244
|
+
# @return [Time]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] last_updated_at
|
247
|
+
# The timestamp of when the domain was most recently edited.
|
248
|
+
# @return [Time]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] tags
|
251
|
+
# The tags used to organize, track, or control access for this
|
252
|
+
# resource.
|
253
|
+
# @return [Hash<String,String>]
|
254
|
+
#
|
255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateDomainResponse AWS API Documentation
|
256
|
+
#
|
257
|
+
class CreateDomainResponse < Struct.new(
|
258
|
+
:domain_name,
|
259
|
+
:default_expiration_days,
|
260
|
+
:default_encryption_key,
|
261
|
+
:dead_letter_queue_url,
|
262
|
+
:created_at,
|
263
|
+
:last_updated_at,
|
264
|
+
:tags)
|
265
|
+
SENSITIVE = []
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
268
|
+
|
269
|
+
# @note When making an API call, you may pass CreateProfileRequest
|
270
|
+
# data as a hash:
|
271
|
+
#
|
272
|
+
# {
|
273
|
+
# domain_name: "name", # required
|
274
|
+
# account_number: "string1To255",
|
275
|
+
# additional_information: "string1To1000",
|
276
|
+
# party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
|
277
|
+
# business_name: "string1To255",
|
278
|
+
# first_name: "string1To255",
|
279
|
+
# middle_name: "string1To255",
|
280
|
+
# last_name: "string1To255",
|
281
|
+
# birth_date: "string1To255",
|
282
|
+
# gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
|
283
|
+
# phone_number: "string1To255",
|
284
|
+
# mobile_phone_number: "string1To255",
|
285
|
+
# home_phone_number: "string1To255",
|
286
|
+
# business_phone_number: "string1To255",
|
287
|
+
# email_address: "string1To255",
|
288
|
+
# personal_email_address: "string1To255",
|
289
|
+
# business_email_address: "string1To255",
|
290
|
+
# address: {
|
291
|
+
# address_1: "string1To255",
|
292
|
+
# address_2: "string1To255",
|
293
|
+
# address_3: "string1To255",
|
294
|
+
# address_4: "string1To255",
|
295
|
+
# city: "string1To255",
|
296
|
+
# county: "string1To255",
|
297
|
+
# state: "string1To255",
|
298
|
+
# province: "string1To255",
|
299
|
+
# country: "string1To255",
|
300
|
+
# postal_code: "string1To255",
|
301
|
+
# },
|
302
|
+
# shipping_address: {
|
303
|
+
# address_1: "string1To255",
|
304
|
+
# address_2: "string1To255",
|
305
|
+
# address_3: "string1To255",
|
306
|
+
# address_4: "string1To255",
|
307
|
+
# city: "string1To255",
|
308
|
+
# county: "string1To255",
|
309
|
+
# state: "string1To255",
|
310
|
+
# province: "string1To255",
|
311
|
+
# country: "string1To255",
|
312
|
+
# postal_code: "string1To255",
|
313
|
+
# },
|
314
|
+
# mailing_address: {
|
315
|
+
# address_1: "string1To255",
|
316
|
+
# address_2: "string1To255",
|
317
|
+
# address_3: "string1To255",
|
318
|
+
# address_4: "string1To255",
|
319
|
+
# city: "string1To255",
|
320
|
+
# county: "string1To255",
|
321
|
+
# state: "string1To255",
|
322
|
+
# province: "string1To255",
|
323
|
+
# country: "string1To255",
|
324
|
+
# postal_code: "string1To255",
|
325
|
+
# },
|
326
|
+
# billing_address: {
|
327
|
+
# address_1: "string1To255",
|
328
|
+
# address_2: "string1To255",
|
329
|
+
# address_3: "string1To255",
|
330
|
+
# address_4: "string1To255",
|
331
|
+
# city: "string1To255",
|
332
|
+
# county: "string1To255",
|
333
|
+
# state: "string1To255",
|
334
|
+
# province: "string1To255",
|
335
|
+
# country: "string1To255",
|
336
|
+
# postal_code: "string1To255",
|
337
|
+
# },
|
338
|
+
# attributes: {
|
339
|
+
# "string1To255" => "string1To255",
|
340
|
+
# },
|
341
|
+
# }
|
342
|
+
#
|
343
|
+
# @!attribute [rw] domain_name
|
344
|
+
# The unique name of the domain.
|
345
|
+
# @return [String]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] account_number
|
348
|
+
# A unique account number that you have given to the customer.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] additional_information
|
352
|
+
# Any additional information relevant to the customer's profile.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] party_type
|
356
|
+
# The type of profile used to describe the customer.
|
357
|
+
# @return [String]
|
358
|
+
#
|
359
|
+
# @!attribute [rw] business_name
|
360
|
+
# The name of the customer’s business.
|
361
|
+
# @return [String]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] first_name
|
364
|
+
# The customer’s first name.
|
365
|
+
# @return [String]
|
366
|
+
#
|
367
|
+
# @!attribute [rw] middle_name
|
368
|
+
# The customer’s middle name.
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] last_name
|
372
|
+
# The customer’s last name.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] birth_date
|
376
|
+
# The customer’s birth date.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] gender
|
380
|
+
# The gender with which the customer identifies.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] phone_number
|
384
|
+
# The customer's phone number, which has not been specified as a
|
385
|
+
# mobile, home, or business number.
|
386
|
+
# @return [String]
|
387
|
+
#
|
388
|
+
# @!attribute [rw] mobile_phone_number
|
389
|
+
# The customer’s mobile phone number.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] home_phone_number
|
393
|
+
# The customer’s home phone number.
|
394
|
+
# @return [String]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] business_phone_number
|
397
|
+
# The customer’s business phone number.
|
398
|
+
# @return [String]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] email_address
|
401
|
+
# The customer's email address, which has not been specified as a
|
402
|
+
# personal or business address.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] personal_email_address
|
406
|
+
# The customer’s personal email address.
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] business_email_address
|
410
|
+
# The customer’s business email address.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] address
|
414
|
+
# A generic address associated with the customer that is not mailing,
|
415
|
+
# shipping, or billing.
|
416
|
+
# @return [Types::Address]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] shipping_address
|
419
|
+
# The customer’s shipping address.
|
420
|
+
# @return [Types::Address]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] mailing_address
|
423
|
+
# The customer’s mailing address.
|
424
|
+
# @return [Types::Address]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] billing_address
|
427
|
+
# The customer’s billing address.
|
428
|
+
# @return [Types::Address]
|
429
|
+
#
|
430
|
+
# @!attribute [rw] attributes
|
431
|
+
# A key value pair of attributes of a customer profile.
|
432
|
+
# @return [Hash<String,String>]
|
433
|
+
#
|
434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateProfileRequest AWS API Documentation
|
435
|
+
#
|
436
|
+
class CreateProfileRequest < Struct.new(
|
437
|
+
:domain_name,
|
438
|
+
:account_number,
|
439
|
+
:additional_information,
|
440
|
+
:party_type,
|
441
|
+
:business_name,
|
442
|
+
:first_name,
|
443
|
+
:middle_name,
|
444
|
+
:last_name,
|
445
|
+
:birth_date,
|
446
|
+
:gender,
|
447
|
+
:phone_number,
|
448
|
+
:mobile_phone_number,
|
449
|
+
:home_phone_number,
|
450
|
+
:business_phone_number,
|
451
|
+
:email_address,
|
452
|
+
:personal_email_address,
|
453
|
+
:business_email_address,
|
454
|
+
:address,
|
455
|
+
:shipping_address,
|
456
|
+
:mailing_address,
|
457
|
+
:billing_address,
|
458
|
+
:attributes)
|
459
|
+
SENSITIVE = []
|
460
|
+
include Aws::Structure
|
461
|
+
end
|
462
|
+
|
463
|
+
# @!attribute [rw] profile_id
|
464
|
+
# The unique identifier of a customer profile.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateProfileResponse AWS API Documentation
|
468
|
+
#
|
469
|
+
class CreateProfileResponse < Struct.new(
|
470
|
+
:profile_id)
|
471
|
+
SENSITIVE = []
|
472
|
+
include Aws::Structure
|
473
|
+
end
|
474
|
+
|
475
|
+
# @note When making an API call, you may pass DeleteDomainRequest
|
476
|
+
# data as a hash:
|
477
|
+
#
|
478
|
+
# {
|
479
|
+
# domain_name: "name", # required
|
480
|
+
# }
|
481
|
+
#
|
482
|
+
# @!attribute [rw] domain_name
|
483
|
+
# The unique name of the domain.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainRequest AWS API Documentation
|
487
|
+
#
|
488
|
+
class DeleteDomainRequest < Struct.new(
|
489
|
+
:domain_name)
|
490
|
+
SENSITIVE = []
|
491
|
+
include Aws::Structure
|
492
|
+
end
|
493
|
+
|
494
|
+
# @!attribute [rw] message
|
495
|
+
# A message that indicates the delete request is done.
|
496
|
+
# @return [String]
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainResponse AWS API Documentation
|
499
|
+
#
|
500
|
+
class DeleteDomainResponse < Struct.new(
|
501
|
+
:message)
|
502
|
+
SENSITIVE = []
|
503
|
+
include Aws::Structure
|
504
|
+
end
|
505
|
+
|
506
|
+
# @note When making an API call, you may pass DeleteIntegrationRequest
|
507
|
+
# data as a hash:
|
508
|
+
#
|
509
|
+
# {
|
510
|
+
# domain_name: "name", # required
|
511
|
+
# uri: "string1To255",
|
512
|
+
# }
|
513
|
+
#
|
514
|
+
# @!attribute [rw] domain_name
|
515
|
+
# The unique name of the domain.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] uri
|
519
|
+
# The URI of the S3 bucket or any other type of data source.
|
520
|
+
# @return [String]
|
521
|
+
#
|
522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteIntegrationRequest AWS API Documentation
|
523
|
+
#
|
524
|
+
class DeleteIntegrationRequest < Struct.new(
|
525
|
+
:domain_name,
|
526
|
+
:uri)
|
527
|
+
SENSITIVE = []
|
528
|
+
include Aws::Structure
|
529
|
+
end
|
530
|
+
|
531
|
+
# @!attribute [rw] message
|
532
|
+
# A message that indicates the delete request is done.
|
533
|
+
# @return [String]
|
534
|
+
#
|
535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteIntegrationResponse AWS API Documentation
|
536
|
+
#
|
537
|
+
class DeleteIntegrationResponse < Struct.new(
|
538
|
+
:message)
|
539
|
+
SENSITIVE = []
|
540
|
+
include Aws::Structure
|
541
|
+
end
|
542
|
+
|
543
|
+
# @note When making an API call, you may pass DeleteProfileKeyRequest
|
544
|
+
# data as a hash:
|
545
|
+
#
|
546
|
+
# {
|
547
|
+
# profile_id: "uuid", # required
|
548
|
+
# key_name: "name", # required
|
549
|
+
# values: ["string1To255"], # required
|
550
|
+
# domain_name: "name", # required
|
551
|
+
# }
|
552
|
+
#
|
553
|
+
# @!attribute [rw] profile_id
|
554
|
+
# The unique identifier of a customer profile.
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @!attribute [rw] key_name
|
558
|
+
# A searchable identifier of a customer profile.
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @!attribute [rw] values
|
562
|
+
# A list of key values.
|
563
|
+
# @return [Array<String>]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] domain_name
|
566
|
+
# The unique name of the domain.
|
567
|
+
# @return [String]
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileKeyRequest AWS API Documentation
|
570
|
+
#
|
571
|
+
class DeleteProfileKeyRequest < Struct.new(
|
572
|
+
:profile_id,
|
573
|
+
:key_name,
|
574
|
+
:values,
|
575
|
+
:domain_name)
|
576
|
+
SENSITIVE = []
|
577
|
+
include Aws::Structure
|
578
|
+
end
|
579
|
+
|
580
|
+
# @!attribute [rw] message
|
581
|
+
# A message that indicates the delete request is done.
|
582
|
+
# @return [String]
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileKeyResponse AWS API Documentation
|
585
|
+
#
|
586
|
+
class DeleteProfileKeyResponse < Struct.new(
|
587
|
+
:message)
|
588
|
+
SENSITIVE = []
|
589
|
+
include Aws::Structure
|
590
|
+
end
|
591
|
+
|
592
|
+
# @note When making an API call, you may pass DeleteProfileObjectRequest
|
593
|
+
# data as a hash:
|
594
|
+
#
|
595
|
+
# {
|
596
|
+
# profile_id: "uuid", # required
|
597
|
+
# profile_object_unique_key: "string1To255", # required
|
598
|
+
# object_type_name: "typeName", # required
|
599
|
+
# domain_name: "name", # required
|
600
|
+
# }
|
601
|
+
#
|
602
|
+
# @!attribute [rw] profile_id
|
603
|
+
# The unique identifier of a customer profile.
|
604
|
+
# @return [String]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] profile_object_unique_key
|
607
|
+
# The unique identifier of the profile object generated by the
|
608
|
+
# service.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] object_type_name
|
612
|
+
# The name of the profile object type.
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] domain_name
|
616
|
+
# The unique name of the domain.
|
617
|
+
# @return [String]
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileObjectRequest AWS API Documentation
|
620
|
+
#
|
621
|
+
class DeleteProfileObjectRequest < Struct.new(
|
622
|
+
:profile_id,
|
623
|
+
:profile_object_unique_key,
|
624
|
+
:object_type_name,
|
625
|
+
:domain_name)
|
626
|
+
SENSITIVE = []
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# @!attribute [rw] message
|
631
|
+
# A message that indicates the delete request is done.
|
632
|
+
# @return [String]
|
633
|
+
#
|
634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileObjectResponse AWS API Documentation
|
635
|
+
#
|
636
|
+
class DeleteProfileObjectResponse < Struct.new(
|
637
|
+
:message)
|
638
|
+
SENSITIVE = []
|
639
|
+
include Aws::Structure
|
640
|
+
end
|
641
|
+
|
642
|
+
# @note When making an API call, you may pass DeleteProfileObjectTypeRequest
|
643
|
+
# data as a hash:
|
644
|
+
#
|
645
|
+
# {
|
646
|
+
# domain_name: "name", # required
|
647
|
+
# object_type_name: "typeName", # required
|
648
|
+
# }
|
649
|
+
#
|
650
|
+
# @!attribute [rw] domain_name
|
651
|
+
# The unique name of the domain.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] object_type_name
|
655
|
+
# The name of the profile object type.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileObjectTypeRequest AWS API Documentation
|
659
|
+
#
|
660
|
+
class DeleteProfileObjectTypeRequest < Struct.new(
|
661
|
+
:domain_name,
|
662
|
+
:object_type_name)
|
663
|
+
SENSITIVE = []
|
664
|
+
include Aws::Structure
|
665
|
+
end
|
666
|
+
|
667
|
+
# @!attribute [rw] message
|
668
|
+
# A message that indicates the delete request is done.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileObjectTypeResponse AWS API Documentation
|
672
|
+
#
|
673
|
+
class DeleteProfileObjectTypeResponse < Struct.new(
|
674
|
+
:message)
|
675
|
+
SENSITIVE = []
|
676
|
+
include Aws::Structure
|
677
|
+
end
|
678
|
+
|
679
|
+
# @note When making an API call, you may pass DeleteProfileRequest
|
680
|
+
# data as a hash:
|
681
|
+
#
|
682
|
+
# {
|
683
|
+
# profile_id: "uuid", # required
|
684
|
+
# domain_name: "name", # required
|
685
|
+
# }
|
686
|
+
#
|
687
|
+
# @!attribute [rw] profile_id
|
688
|
+
# The unique identifier of a customer profile.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] domain_name
|
692
|
+
# The unique name of the domain.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileRequest AWS API Documentation
|
696
|
+
#
|
697
|
+
class DeleteProfileRequest < Struct.new(
|
698
|
+
:profile_id,
|
699
|
+
:domain_name)
|
700
|
+
SENSITIVE = []
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
704
|
+
# @!attribute [rw] message
|
705
|
+
# A message that indicates the delete request is done.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteProfileResponse AWS API Documentation
|
709
|
+
#
|
710
|
+
class DeleteProfileResponse < Struct.new(
|
711
|
+
:message)
|
712
|
+
SENSITIVE = []
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
# Usage-specific statistics about the domain.
|
717
|
+
#
|
718
|
+
# @!attribute [rw] profile_count
|
719
|
+
# The total number of profiles currently in the domain.
|
720
|
+
# @return [Integer]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] metering_profile_count
|
723
|
+
# The number of profiles that you are currently paying for in the
|
724
|
+
# domain. If you have more than 100 objects associated with a single
|
725
|
+
# profile, that profile counts as two profiles. If you have more than
|
726
|
+
# 200 objects, that profile counts as three, and so on.
|
727
|
+
# @return [Integer]
|
728
|
+
#
|
729
|
+
# @!attribute [rw] object_count
|
730
|
+
# The total number of objects in domain.
|
731
|
+
# @return [Integer]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] total_size
|
734
|
+
# The total size, in bytes, of all objects in the domain.
|
735
|
+
# @return [Integer]
|
736
|
+
#
|
737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DomainStats AWS API Documentation
|
738
|
+
#
|
739
|
+
class DomainStats < Struct.new(
|
740
|
+
:profile_count,
|
741
|
+
:metering_profile_count,
|
742
|
+
:object_count,
|
743
|
+
:total_size)
|
744
|
+
SENSITIVE = []
|
745
|
+
include Aws::Structure
|
746
|
+
end
|
747
|
+
|
748
|
+
# @note When making an API call, you may pass GetDomainRequest
|
749
|
+
# data as a hash:
|
750
|
+
#
|
751
|
+
# {
|
752
|
+
# domain_name: "name", # required
|
753
|
+
# }
|
754
|
+
#
|
755
|
+
# @!attribute [rw] domain_name
|
756
|
+
# A unique name for the domain.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainRequest AWS API Documentation
|
760
|
+
#
|
761
|
+
class GetDomainRequest < Struct.new(
|
762
|
+
:domain_name)
|
763
|
+
SENSITIVE = []
|
764
|
+
include Aws::Structure
|
765
|
+
end
|
766
|
+
|
767
|
+
# @!attribute [rw] domain_name
|
768
|
+
# The unique name of the domain.
|
769
|
+
# @return [String]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] default_expiration_days
|
772
|
+
# The default number of days until the data within the domain expires.
|
773
|
+
# @return [Integer]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] default_encryption_key
|
776
|
+
# The default encryption key, which is an AWS managed key, is used
|
777
|
+
# when no specific type of encryption key is specified. It is used to
|
778
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
779
|
+
# storage.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] dead_letter_queue_url
|
783
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
784
|
+
# errors associated with ingesting data from third party applications.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @!attribute [rw] stats
|
788
|
+
# Usage-specific statistics about the domain.
|
789
|
+
# @return [Types::DomainStats]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] created_at
|
792
|
+
# The timestamp of when the domain was created.
|
793
|
+
# @return [Time]
|
794
|
+
#
|
795
|
+
# @!attribute [rw] last_updated_at
|
796
|
+
# The timestamp of when the domain was most recently edited.
|
797
|
+
# @return [Time]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] tags
|
800
|
+
# The tags used to organize, track, or control access for this
|
801
|
+
# resource.
|
802
|
+
# @return [Hash<String,String>]
|
803
|
+
#
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainResponse AWS API Documentation
|
805
|
+
#
|
806
|
+
class GetDomainResponse < Struct.new(
|
807
|
+
:domain_name,
|
808
|
+
:default_expiration_days,
|
809
|
+
:default_encryption_key,
|
810
|
+
:dead_letter_queue_url,
|
811
|
+
:stats,
|
812
|
+
:created_at,
|
813
|
+
:last_updated_at,
|
814
|
+
:tags)
|
815
|
+
SENSITIVE = []
|
816
|
+
include Aws::Structure
|
817
|
+
end
|
818
|
+
|
819
|
+
# @note When making an API call, you may pass GetIntegrationRequest
|
820
|
+
# data as a hash:
|
821
|
+
#
|
822
|
+
# {
|
823
|
+
# domain_name: "name", # required
|
824
|
+
# uri: "string1To255",
|
825
|
+
# }
|
826
|
+
#
|
827
|
+
# @!attribute [rw] domain_name
|
828
|
+
# The unique name of the domain.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] uri
|
832
|
+
# The URI of the S3 bucket or any other type of data source.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegrationRequest AWS API Documentation
|
836
|
+
#
|
837
|
+
class GetIntegrationRequest < Struct.new(
|
838
|
+
:domain_name,
|
839
|
+
:uri)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# @!attribute [rw] domain_name
|
845
|
+
# The unique name of the domain.
|
846
|
+
# @return [String]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] uri
|
849
|
+
# The URI of the S3 bucket or any other type of data source.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] object_type_name
|
853
|
+
# The name of the profile object type.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] created_at
|
857
|
+
# The timestamp of when the domain was created.
|
858
|
+
# @return [Time]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] last_updated_at
|
861
|
+
# The timestamp of when the domain was most recently edited.
|
862
|
+
# @return [Time]
|
863
|
+
#
|
864
|
+
# @!attribute [rw] tags
|
865
|
+
# The tags used to organize, track, or control access for this
|
866
|
+
# resource.
|
867
|
+
# @return [Hash<String,String>]
|
868
|
+
#
|
869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegrationResponse AWS API Documentation
|
870
|
+
#
|
871
|
+
class GetIntegrationResponse < Struct.new(
|
872
|
+
:domain_name,
|
873
|
+
:uri,
|
874
|
+
:object_type_name,
|
875
|
+
:created_at,
|
876
|
+
:last_updated_at,
|
877
|
+
:tags)
|
878
|
+
SENSITIVE = []
|
879
|
+
include Aws::Structure
|
880
|
+
end
|
881
|
+
|
882
|
+
# @note When making an API call, you may pass GetProfileObjectTypeRequest
|
883
|
+
# data as a hash:
|
884
|
+
#
|
885
|
+
# {
|
886
|
+
# domain_name: "name", # required
|
887
|
+
# object_type_name: "typeName", # required
|
888
|
+
# }
|
889
|
+
#
|
890
|
+
# @!attribute [rw] domain_name
|
891
|
+
# The unique name of the domain.
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @!attribute [rw] object_type_name
|
895
|
+
# The name of the profile object type.
|
896
|
+
# @return [String]
|
897
|
+
#
|
898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileObjectTypeRequest AWS API Documentation
|
899
|
+
#
|
900
|
+
class GetProfileObjectTypeRequest < Struct.new(
|
901
|
+
:domain_name,
|
902
|
+
:object_type_name)
|
903
|
+
SENSITIVE = []
|
904
|
+
include Aws::Structure
|
905
|
+
end
|
906
|
+
|
907
|
+
# @!attribute [rw] object_type_name
|
908
|
+
# The name of the profile object type.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] description
|
912
|
+
# The description of the profile object type.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] template_id
|
916
|
+
# A unique identifier for the object template.
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] expiration_days
|
920
|
+
# The number of days until the data in the object expires.
|
921
|
+
# @return [Integer]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] encryption_key
|
924
|
+
# The customer-provided key to encrypt the profile object that will be
|
925
|
+
# created in this profile object type.
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] allow_profile_creation
|
929
|
+
# Indicates whether a profile should be created when data is received
|
930
|
+
# if one doesn’t exist for an object of this type. The default is
|
931
|
+
# `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then
|
932
|
+
# the service tries to fetch a standard profile and associate this
|
933
|
+
# object with the profile. If it is set to `TRUE`, and if no match is
|
934
|
+
# found, then the service creates a new standard profile.
|
935
|
+
# @return [Boolean]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] fields
|
938
|
+
# A map of the name and ObjectType field.
|
939
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] keys
|
942
|
+
# A list of unique keys that can be used to map data to the profile.
|
943
|
+
# @return [Hash<String,Array<Types::ObjectTypeKey>>]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] created_at
|
946
|
+
# The timestamp of when the domain was created.
|
947
|
+
# @return [Time]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] last_updated_at
|
950
|
+
# The timestamp of when the domain was most recently edited.
|
951
|
+
# @return [Time]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] tags
|
954
|
+
# The tags used to organize, track, or control access for this
|
955
|
+
# resource.
|
956
|
+
# @return [Hash<String,String>]
|
957
|
+
#
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileObjectTypeResponse AWS API Documentation
|
959
|
+
#
|
960
|
+
class GetProfileObjectTypeResponse < Struct.new(
|
961
|
+
:object_type_name,
|
962
|
+
:description,
|
963
|
+
:template_id,
|
964
|
+
:expiration_days,
|
965
|
+
:encryption_key,
|
966
|
+
:allow_profile_creation,
|
967
|
+
:fields,
|
968
|
+
:keys,
|
969
|
+
:created_at,
|
970
|
+
:last_updated_at,
|
971
|
+
:tags)
|
972
|
+
SENSITIVE = []
|
973
|
+
include Aws::Structure
|
974
|
+
end
|
975
|
+
|
976
|
+
# @note When making an API call, you may pass GetProfileObjectTypeTemplateRequest
|
977
|
+
# data as a hash:
|
978
|
+
#
|
979
|
+
# {
|
980
|
+
# template_id: "name", # required
|
981
|
+
# }
|
982
|
+
#
|
983
|
+
# @!attribute [rw] template_id
|
984
|
+
# A unique identifier for the object template.
|
985
|
+
# @return [String]
|
986
|
+
#
|
987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileObjectTypeTemplateRequest AWS API Documentation
|
988
|
+
#
|
989
|
+
class GetProfileObjectTypeTemplateRequest < Struct.new(
|
990
|
+
:template_id)
|
991
|
+
SENSITIVE = []
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# @!attribute [rw] template_id
|
996
|
+
# A unique identifier for the object template.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] source_name
|
1000
|
+
# The name of the source of the object template.
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] source_object
|
1004
|
+
# The source of the object template.
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] allow_profile_creation
|
1008
|
+
# Indicates whether a profile should be created when data is received
|
1009
|
+
# if one doesn’t exist for an object of this type. The default is
|
1010
|
+
# `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then
|
1011
|
+
# the service tries to fetch a standard profile and associate this
|
1012
|
+
# object with the profile. If it is set to `TRUE`, and if no match is
|
1013
|
+
# found, then the service creates a new standard profile.
|
1014
|
+
# @return [Boolean]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] fields
|
1017
|
+
# A map of the name and ObjectType field.
|
1018
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] keys
|
1021
|
+
# A list of unique keys that can be used to map data to the profile.
|
1022
|
+
# @return [Hash<String,Array<Types::ObjectTypeKey>>]
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileObjectTypeTemplateResponse AWS API Documentation
|
1025
|
+
#
|
1026
|
+
class GetProfileObjectTypeTemplateResponse < Struct.new(
|
1027
|
+
:template_id,
|
1028
|
+
:source_name,
|
1029
|
+
:source_object,
|
1030
|
+
:allow_profile_creation,
|
1031
|
+
:fields,
|
1032
|
+
:keys)
|
1033
|
+
SENSITIVE = []
|
1034
|
+
include Aws::Structure
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# An internal service error occurred.
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] message
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/InternalServerException AWS API Documentation
|
1043
|
+
#
|
1044
|
+
class InternalServerException < Struct.new(
|
1045
|
+
:message)
|
1046
|
+
SENSITIVE = []
|
1047
|
+
include Aws::Structure
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# @note When making an API call, you may pass ListAccountIntegrationsRequest
|
1051
|
+
# data as a hash:
|
1052
|
+
#
|
1053
|
+
# {
|
1054
|
+
# uri: "string1To255", # required
|
1055
|
+
# next_token: "token",
|
1056
|
+
# max_results: 1,
|
1057
|
+
# }
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] uri
|
1060
|
+
# The URI of the S3 bucket or any other type of data source.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] next_token
|
1064
|
+
# The pagination token from the previous ListAccountIntegrations API
|
1065
|
+
# call.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] max_results
|
1069
|
+
# The maximum number of objects returned per page.
|
1070
|
+
# @return [Integer]
|
1071
|
+
#
|
1072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrationsRequest AWS API Documentation
|
1073
|
+
#
|
1074
|
+
class ListAccountIntegrationsRequest < Struct.new(
|
1075
|
+
:uri,
|
1076
|
+
:next_token,
|
1077
|
+
:max_results)
|
1078
|
+
SENSITIVE = []
|
1079
|
+
include Aws::Structure
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# @!attribute [rw] items
|
1083
|
+
# The list of ListAccountIntegration instances.
|
1084
|
+
# @return [Array<Types::ListIntegrationItem>]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] next_token
|
1087
|
+
# The pagination token from the previous ListAccountIntegrations API
|
1088
|
+
# call.
|
1089
|
+
# @return [String]
|
1090
|
+
#
|
1091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrationsResponse AWS API Documentation
|
1092
|
+
#
|
1093
|
+
class ListAccountIntegrationsResponse < Struct.new(
|
1094
|
+
:items,
|
1095
|
+
:next_token)
|
1096
|
+
SENSITIVE = []
|
1097
|
+
include Aws::Structure
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# An object in a list that represents a domain.
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] domain_name
|
1103
|
+
# The unique name of the domain.
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @!attribute [rw] created_at
|
1107
|
+
# The timestamp of when the domain was created.
|
1108
|
+
# @return [Time]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] last_updated_at
|
1111
|
+
# The timestamp of when the domain was most recently edited.
|
1112
|
+
# @return [Time]
|
1113
|
+
#
|
1114
|
+
# @!attribute [rw] tags
|
1115
|
+
# The tags used to organize, track, or control access for this
|
1116
|
+
# resource.
|
1117
|
+
# @return [Hash<String,String>]
|
1118
|
+
#
|
1119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainItem AWS API Documentation
|
1120
|
+
#
|
1121
|
+
class ListDomainItem < Struct.new(
|
1122
|
+
:domain_name,
|
1123
|
+
:created_at,
|
1124
|
+
:last_updated_at,
|
1125
|
+
:tags)
|
1126
|
+
SENSITIVE = []
|
1127
|
+
include Aws::Structure
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# @note When making an API call, you may pass ListDomainsRequest
|
1131
|
+
# data as a hash:
|
1132
|
+
#
|
1133
|
+
# {
|
1134
|
+
# next_token: "token",
|
1135
|
+
# max_results: 1,
|
1136
|
+
# }
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] next_token
|
1139
|
+
# The pagination token from the previous ListDomain API call.
|
1140
|
+
# @return [String]
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] max_results
|
1143
|
+
# The maximum number of objects returned per page.
|
1144
|
+
# @return [Integer]
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainsRequest AWS API Documentation
|
1147
|
+
#
|
1148
|
+
class ListDomainsRequest < Struct.new(
|
1149
|
+
:next_token,
|
1150
|
+
:max_results)
|
1151
|
+
SENSITIVE = []
|
1152
|
+
include Aws::Structure
|
1153
|
+
end
|
1154
|
+
|
1155
|
+
# @!attribute [rw] items
|
1156
|
+
# The list of ListDomains instances.
|
1157
|
+
# @return [Array<Types::ListDomainItem>]
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] next_token
|
1160
|
+
# The pagination token from the previous ListDomains API call.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainsResponse AWS API Documentation
|
1164
|
+
#
|
1165
|
+
class ListDomainsResponse < Struct.new(
|
1166
|
+
:items,
|
1167
|
+
:next_token)
|
1168
|
+
SENSITIVE = []
|
1169
|
+
include Aws::Structure
|
1170
|
+
end
|
1171
|
+
|
1172
|
+
# An integration in list of integrations.
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] domain_name
|
1175
|
+
# The unique name of the domain.
|
1176
|
+
# @return [String]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] uri
|
1179
|
+
# The URI of the S3 bucket or any other type of data source.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] object_type_name
|
1183
|
+
# The name of the profile object type.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] created_at
|
1187
|
+
# The timestamp of when the domain was created.
|
1188
|
+
# @return [Time]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] last_updated_at
|
1191
|
+
# The timestamp of when the domain was most recently edited.
|
1192
|
+
# @return [Time]
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] tags
|
1195
|
+
# The tags used to organize, track, or control access for this
|
1196
|
+
# resource.
|
1197
|
+
# @return [Hash<String,String>]
|
1198
|
+
#
|
1199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationItem AWS API Documentation
|
1200
|
+
#
|
1201
|
+
class ListIntegrationItem < Struct.new(
|
1202
|
+
:domain_name,
|
1203
|
+
:uri,
|
1204
|
+
:object_type_name,
|
1205
|
+
:created_at,
|
1206
|
+
:last_updated_at,
|
1207
|
+
:tags)
|
1208
|
+
SENSITIVE = []
|
1209
|
+
include Aws::Structure
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# @note When making an API call, you may pass ListIntegrationsRequest
|
1213
|
+
# data as a hash:
|
1214
|
+
#
|
1215
|
+
# {
|
1216
|
+
# domain_name: "name", # required
|
1217
|
+
# next_token: "token",
|
1218
|
+
# max_results: 1,
|
1219
|
+
# }
|
1220
|
+
#
|
1221
|
+
# @!attribute [rw] domain_name
|
1222
|
+
# The unique name of the domain.
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] next_token
|
1226
|
+
# The pagination token from the previous ListIntegrations API call.
|
1227
|
+
# @return [String]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] max_results
|
1230
|
+
# The maximum number of objects returned per page.
|
1231
|
+
# @return [Integer]
|
1232
|
+
#
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsRequest AWS API Documentation
|
1234
|
+
#
|
1235
|
+
class ListIntegrationsRequest < Struct.new(
|
1236
|
+
:domain_name,
|
1237
|
+
:next_token,
|
1238
|
+
:max_results)
|
1239
|
+
SENSITIVE = []
|
1240
|
+
include Aws::Structure
|
1241
|
+
end
|
1242
|
+
|
1243
|
+
# @!attribute [rw] items
|
1244
|
+
# The list of ListIntegrations instances.
|
1245
|
+
# @return [Array<Types::ListIntegrationItem>]
|
1246
|
+
#
|
1247
|
+
# @!attribute [rw] next_token
|
1248
|
+
# The pagination token from the previous ListIntegrations API call.
|
1249
|
+
# @return [String]
|
1250
|
+
#
|
1251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsResponse AWS API Documentation
|
1252
|
+
#
|
1253
|
+
class ListIntegrationsResponse < Struct.new(
|
1254
|
+
:items,
|
1255
|
+
:next_token)
|
1256
|
+
SENSITIVE = []
|
1257
|
+
include Aws::Structure
|
1258
|
+
end
|
1259
|
+
|
1260
|
+
# A ProfileObjectType instance.
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] object_type_name
|
1263
|
+
# The name of the profile object type.
|
1264
|
+
# @return [String]
|
1265
|
+
#
|
1266
|
+
# @!attribute [rw] description
|
1267
|
+
# Description of the profile object type.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] created_at
|
1271
|
+
# The timestamp of when the domain was created.
|
1272
|
+
# @return [Time]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] last_updated_at
|
1275
|
+
# The timestamp of when the domain was most recently edited.
|
1276
|
+
# @return [Time]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] tags
|
1279
|
+
# The tags used to organize, track, or control access for this
|
1280
|
+
# resource.
|
1281
|
+
# @return [Hash<String,String>]
|
1282
|
+
#
|
1283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypeItem AWS API Documentation
|
1284
|
+
#
|
1285
|
+
class ListProfileObjectTypeItem < Struct.new(
|
1286
|
+
:object_type_name,
|
1287
|
+
:description,
|
1288
|
+
:created_at,
|
1289
|
+
:last_updated_at,
|
1290
|
+
:tags)
|
1291
|
+
SENSITIVE = []
|
1292
|
+
include Aws::Structure
|
1293
|
+
end
|
1294
|
+
|
1295
|
+
# A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] template_id
|
1298
|
+
# A unique identifier for the object template.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] source_name
|
1302
|
+
# The name of the source of the object template.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] source_object
|
1306
|
+
# The source of the object template.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypeTemplateItem AWS API Documentation
|
1310
|
+
#
|
1311
|
+
class ListProfileObjectTypeTemplateItem < Struct.new(
|
1312
|
+
:template_id,
|
1313
|
+
:source_name,
|
1314
|
+
:source_object)
|
1315
|
+
SENSITIVE = []
|
1316
|
+
include Aws::Structure
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# @note When making an API call, you may pass ListProfileObjectTypeTemplatesRequest
|
1320
|
+
# data as a hash:
|
1321
|
+
#
|
1322
|
+
# {
|
1323
|
+
# next_token: "token",
|
1324
|
+
# max_results: 1,
|
1325
|
+
# }
|
1326
|
+
#
|
1327
|
+
# @!attribute [rw] next_token
|
1328
|
+
# The pagination token from the previous ListObjectTypeTemplates API
|
1329
|
+
# call.
|
1330
|
+
# @return [String]
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] max_results
|
1333
|
+
# The maximum number of objects returned per page.
|
1334
|
+
# @return [Integer]
|
1335
|
+
#
|
1336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypeTemplatesRequest AWS API Documentation
|
1337
|
+
#
|
1338
|
+
class ListProfileObjectTypeTemplatesRequest < Struct.new(
|
1339
|
+
:next_token,
|
1340
|
+
:max_results)
|
1341
|
+
SENSITIVE = []
|
1342
|
+
include Aws::Structure
|
1343
|
+
end
|
1344
|
+
|
1345
|
+
# @!attribute [rw] items
|
1346
|
+
# The list of ListProfileObjectType template instances.
|
1347
|
+
# @return [Array<Types::ListProfileObjectTypeTemplateItem>]
|
1348
|
+
#
|
1349
|
+
# @!attribute [rw] next_token
|
1350
|
+
# The pagination token from the previous ListObjectTypeTemplates API
|
1351
|
+
# call.
|
1352
|
+
# @return [String]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypeTemplatesResponse AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class ListProfileObjectTypeTemplatesResponse < Struct.new(
|
1357
|
+
:items,
|
1358
|
+
:next_token)
|
1359
|
+
SENSITIVE = []
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
# @note When making an API call, you may pass ListProfileObjectTypesRequest
|
1364
|
+
# data as a hash:
|
1365
|
+
#
|
1366
|
+
# {
|
1367
|
+
# domain_name: "name", # required
|
1368
|
+
# next_token: "token",
|
1369
|
+
# max_results: 1,
|
1370
|
+
# }
|
1371
|
+
#
|
1372
|
+
# @!attribute [rw] domain_name
|
1373
|
+
# The unique name of the domain.
|
1374
|
+
# @return [String]
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] next_token
|
1377
|
+
# Identifies the next page of results to return.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] max_results
|
1381
|
+
# The maximum number of objects returned per page.
|
1382
|
+
# @return [Integer]
|
1383
|
+
#
|
1384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypesRequest AWS API Documentation
|
1385
|
+
#
|
1386
|
+
class ListProfileObjectTypesRequest < Struct.new(
|
1387
|
+
:domain_name,
|
1388
|
+
:next_token,
|
1389
|
+
:max_results)
|
1390
|
+
SENSITIVE = []
|
1391
|
+
include Aws::Structure
|
1392
|
+
end
|
1393
|
+
|
1394
|
+
# @!attribute [rw] items
|
1395
|
+
# The list of ListProfileObjectTypes instances.
|
1396
|
+
# @return [Array<Types::ListProfileObjectTypeItem>]
|
1397
|
+
#
|
1398
|
+
# @!attribute [rw] next_token
|
1399
|
+
# Identifies the next page of results to return.
|
1400
|
+
# @return [String]
|
1401
|
+
#
|
1402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectTypesResponse AWS API Documentation
|
1403
|
+
#
|
1404
|
+
class ListProfileObjectTypesResponse < Struct.new(
|
1405
|
+
:items,
|
1406
|
+
:next_token)
|
1407
|
+
SENSITIVE = []
|
1408
|
+
include Aws::Structure
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
# A ProfileObject in a list of ProfileObjects.
|
1412
|
+
#
|
1413
|
+
# @!attribute [rw] object_type_name
|
1414
|
+
# Specifies the kind of object being added to a profile, such as
|
1415
|
+
# "Salesforce-Account."
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] profile_object_unique_key
|
1419
|
+
# The unique identifier of the ProfileObject generated by the service.
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] object
|
1423
|
+
# A JSON representation of a ProfileObject that belongs to a profile.
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsItem AWS API Documentation
|
1427
|
+
#
|
1428
|
+
class ListProfileObjectsItem < Struct.new(
|
1429
|
+
:object_type_name,
|
1430
|
+
:profile_object_unique_key,
|
1431
|
+
:object)
|
1432
|
+
SENSITIVE = []
|
1433
|
+
include Aws::Structure
|
1434
|
+
end
|
1435
|
+
|
1436
|
+
# @note When making an API call, you may pass ListProfileObjectsRequest
|
1437
|
+
# data as a hash:
|
1438
|
+
#
|
1439
|
+
# {
|
1440
|
+
# next_token: "token",
|
1441
|
+
# max_results: 1,
|
1442
|
+
# domain_name: "name", # required
|
1443
|
+
# object_type_name: "typeName", # required
|
1444
|
+
# profile_id: "uuid", # required
|
1445
|
+
# }
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] next_token
|
1448
|
+
# The pagination token from the previous call to ListProfileObjects.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] max_results
|
1452
|
+
# The maximum number of objects returned per page.
|
1453
|
+
# @return [Integer]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] domain_name
|
1456
|
+
# The unique name of the domain.
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] object_type_name
|
1460
|
+
# The name of the profile object type.
|
1461
|
+
# @return [String]
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] profile_id
|
1464
|
+
# The unique identifier of a customer profile.
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsRequest AWS API Documentation
|
1468
|
+
#
|
1469
|
+
class ListProfileObjectsRequest < Struct.new(
|
1470
|
+
:next_token,
|
1471
|
+
:max_results,
|
1472
|
+
:domain_name,
|
1473
|
+
:object_type_name,
|
1474
|
+
:profile_id)
|
1475
|
+
SENSITIVE = []
|
1476
|
+
include Aws::Structure
|
1477
|
+
end
|
1478
|
+
|
1479
|
+
# @!attribute [rw] items
|
1480
|
+
# The list of ListProfileObject instances.
|
1481
|
+
# @return [Array<Types::ListProfileObjectsItem>]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] next_token
|
1484
|
+
# The pagination token from the previous call to ListProfileObjects.
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsResponse AWS API Documentation
|
1488
|
+
#
|
1489
|
+
class ListProfileObjectsResponse < Struct.new(
|
1490
|
+
:items,
|
1491
|
+
:next_token)
|
1492
|
+
SENSITIVE = []
|
1493
|
+
include Aws::Structure
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1497
|
+
# data as a hash:
|
1498
|
+
#
|
1499
|
+
# {
|
1500
|
+
# resource_arn: "TagArn", # required
|
1501
|
+
# }
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] resource_arn
|
1504
|
+
# The ARN of the resource for which you want to view tags.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListTagsForResourceRequest AWS API Documentation
|
1508
|
+
#
|
1509
|
+
class ListTagsForResourceRequest < Struct.new(
|
1510
|
+
:resource_arn)
|
1511
|
+
SENSITIVE = []
|
1512
|
+
include Aws::Structure
|
1513
|
+
end
|
1514
|
+
|
1515
|
+
# @!attribute [rw] tags
|
1516
|
+
# The tags used to organize, track, or control access for this
|
1517
|
+
# resource.
|
1518
|
+
# @return [Hash<String,String>]
|
1519
|
+
#
|
1520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListTagsForResourceResponse AWS API Documentation
|
1521
|
+
#
|
1522
|
+
class ListTagsForResourceResponse < Struct.new(
|
1523
|
+
:tags)
|
1524
|
+
SENSITIVE = []
|
1525
|
+
include Aws::Structure
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# Represents a field in a ProfileObjectType.
|
1529
|
+
#
|
1530
|
+
# @note When making an API call, you may pass ObjectTypeField
|
1531
|
+
# data as a hash:
|
1532
|
+
#
|
1533
|
+
# {
|
1534
|
+
# source: "text",
|
1535
|
+
# target: "text",
|
1536
|
+
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
1537
|
+
# }
|
1538
|
+
#
|
1539
|
+
# @!attribute [rw] source
|
1540
|
+
# A field of a ProfileObject. For example: \_source.FirstName, where
|
1541
|
+
# “\_source” is a ProfileObjectType of a Zendesk user and “FirstName”
|
1542
|
+
# is a field in that ObjectType.
|
1543
|
+
# @return [String]
|
1544
|
+
#
|
1545
|
+
# @!attribute [rw] target
|
1546
|
+
# The location of the data in the standard ProfileObject model. For
|
1547
|
+
# example: \_profile.Address.PostalCode.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] content_type
|
1551
|
+
# The content type of the field. Used for determining equality when
|
1552
|
+
# searching.
|
1553
|
+
# @return [String]
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ObjectTypeField AWS API Documentation
|
1556
|
+
#
|
1557
|
+
class ObjectTypeField < Struct.new(
|
1558
|
+
:source,
|
1559
|
+
:target,
|
1560
|
+
:content_type)
|
1561
|
+
SENSITIVE = []
|
1562
|
+
include Aws::Structure
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# An object that defines the Key element of a ProfileObject. A Key is a
|
1566
|
+
# special element that can be used to search for a customer profile.
|
1567
|
+
#
|
1568
|
+
# @note When making an API call, you may pass ObjectTypeKey
|
1569
|
+
# data as a hash:
|
1570
|
+
#
|
1571
|
+
# {
|
1572
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
1573
|
+
# field_names: ["name"],
|
1574
|
+
# }
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] standard_identifiers
|
1577
|
+
# The types of keys that a ProfileObject can have. Each ProfileObject
|
1578
|
+
# can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means
|
1579
|
+
# that this key can be used to tie an object to a PROFILE. UNIQUE
|
1580
|
+
# means that it can be used to uniquely identify an object. If a key a
|
1581
|
+
# is marked as SECONDARY, it will be used to search for profiles after
|
1582
|
+
# all other PROFILE keys have been searched. A LOOKUP\_ONLY key is
|
1583
|
+
# only used to match a profile but is not persisted to be used for
|
1584
|
+
# searching of the profile. A NEW\_ONLY key is only used if the
|
1585
|
+
# profile does not already exist before the object is ingested,
|
1586
|
+
# otherwise it is only used for matching objects to profiles.
|
1587
|
+
# @return [Array<String>]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] field_names
|
1590
|
+
# The reference for the key name of the fields map.
|
1591
|
+
# @return [Array<String>]
|
1592
|
+
#
|
1593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ObjectTypeKey AWS API Documentation
|
1594
|
+
#
|
1595
|
+
class ObjectTypeKey < Struct.new(
|
1596
|
+
:standard_identifiers,
|
1597
|
+
:field_names)
|
1598
|
+
SENSITIVE = []
|
1599
|
+
include Aws::Structure
|
1600
|
+
end
|
1601
|
+
|
1602
|
+
# The standard profile of a customer.
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] profile_id
|
1605
|
+
# The unique identifier of a customer profile.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] account_number
|
1609
|
+
# A unique account number that you have given to the customer.
|
1610
|
+
# @return [String]
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] additional_information
|
1613
|
+
# Any additional information relevant to the customer's profile.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] party_type
|
1617
|
+
# The type of profile used to describe the customer.
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] business_name
|
1621
|
+
# The name of the customer’s business.
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] first_name
|
1625
|
+
# The customer’s first name.
|
1626
|
+
# @return [String]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] middle_name
|
1629
|
+
# The customer’s middle name.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] last_name
|
1633
|
+
# The customer’s last name.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] birth_date
|
1637
|
+
# The customer’s birth date.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] gender
|
1641
|
+
# The gender with which the customer identifies.
|
1642
|
+
# @return [String]
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] phone_number
|
1645
|
+
# The customer's phone number, which has not been specified as a
|
1646
|
+
# mobile, home, or business number.
|
1647
|
+
# @return [String]
|
1648
|
+
#
|
1649
|
+
# @!attribute [rw] mobile_phone_number
|
1650
|
+
# The customer’s mobile phone number.
|
1651
|
+
# @return [String]
|
1652
|
+
#
|
1653
|
+
# @!attribute [rw] home_phone_number
|
1654
|
+
# The customer’s home phone number.
|
1655
|
+
# @return [String]
|
1656
|
+
#
|
1657
|
+
# @!attribute [rw] business_phone_number
|
1658
|
+
# The customer’s home phone number.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] email_address
|
1662
|
+
# The customer's email address, which has not been specified as a
|
1663
|
+
# personal or business address.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] personal_email_address
|
1667
|
+
# The customer’s personal email address.
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] business_email_address
|
1671
|
+
# The customer’s business email address.
|
1672
|
+
# @return [String]
|
1673
|
+
#
|
1674
|
+
# @!attribute [rw] address
|
1675
|
+
# A generic address associated with the customer that is not mailing,
|
1676
|
+
# shipping, or billing.
|
1677
|
+
# @return [Types::Address]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] shipping_address
|
1680
|
+
# The customer’s shipping address.
|
1681
|
+
# @return [Types::Address]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] mailing_address
|
1684
|
+
# The customer’s mailing address.
|
1685
|
+
# @return [Types::Address]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] billing_address
|
1688
|
+
# The customer’s billing address.
|
1689
|
+
# @return [Types::Address]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] attributes
|
1692
|
+
# A key value pair of attributes of a customer profile.
|
1693
|
+
# @return [Hash<String,String>]
|
1694
|
+
#
|
1695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Profile AWS API Documentation
|
1696
|
+
#
|
1697
|
+
class Profile < Struct.new(
|
1698
|
+
:profile_id,
|
1699
|
+
:account_number,
|
1700
|
+
:additional_information,
|
1701
|
+
:party_type,
|
1702
|
+
:business_name,
|
1703
|
+
:first_name,
|
1704
|
+
:middle_name,
|
1705
|
+
:last_name,
|
1706
|
+
:birth_date,
|
1707
|
+
:gender,
|
1708
|
+
:phone_number,
|
1709
|
+
:mobile_phone_number,
|
1710
|
+
:home_phone_number,
|
1711
|
+
:business_phone_number,
|
1712
|
+
:email_address,
|
1713
|
+
:personal_email_address,
|
1714
|
+
:business_email_address,
|
1715
|
+
:address,
|
1716
|
+
:shipping_address,
|
1717
|
+
:mailing_address,
|
1718
|
+
:billing_address,
|
1719
|
+
:attributes)
|
1720
|
+
SENSITIVE = []
|
1721
|
+
include Aws::Structure
|
1722
|
+
end
|
1723
|
+
|
1724
|
+
# @note When making an API call, you may pass PutIntegrationRequest
|
1725
|
+
# data as a hash:
|
1726
|
+
#
|
1727
|
+
# {
|
1728
|
+
# domain_name: "name", # required
|
1729
|
+
# uri: "string1To255", # required
|
1730
|
+
# object_type_name: "typeName", # required
|
1731
|
+
# tags: {
|
1732
|
+
# "TagKey" => "TagValue",
|
1733
|
+
# },
|
1734
|
+
# }
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] domain_name
|
1737
|
+
# The unique name of the domain.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] uri
|
1741
|
+
# The URI of the S3 bucket or any other type of data source.
|
1742
|
+
# @return [String]
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] object_type_name
|
1745
|
+
# The name of the profile object type.
|
1746
|
+
# @return [String]
|
1747
|
+
#
|
1748
|
+
# @!attribute [rw] tags
|
1749
|
+
# The tags used to organize, track, or control access for this
|
1750
|
+
# resource.
|
1751
|
+
# @return [Hash<String,String>]
|
1752
|
+
#
|
1753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationRequest AWS API Documentation
|
1754
|
+
#
|
1755
|
+
class PutIntegrationRequest < Struct.new(
|
1756
|
+
:domain_name,
|
1757
|
+
:uri,
|
1758
|
+
:object_type_name,
|
1759
|
+
:tags)
|
1760
|
+
SENSITIVE = []
|
1761
|
+
include Aws::Structure
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# @!attribute [rw] domain_name
|
1765
|
+
# The unique name of the domain.
|
1766
|
+
# @return [String]
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] uri
|
1769
|
+
# The URI of the S3 bucket or any other type of data source.
|
1770
|
+
# @return [String]
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] object_type_name
|
1773
|
+
# The name of the profile object type.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] created_at
|
1777
|
+
# The timestamp of when the domain was created.
|
1778
|
+
# @return [Time]
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] last_updated_at
|
1781
|
+
# The timestamp of when the domain was most recently edited.
|
1782
|
+
# @return [Time]
|
1783
|
+
#
|
1784
|
+
# @!attribute [rw] tags
|
1785
|
+
# The tags used to organize, track, or control access for this
|
1786
|
+
# resource.
|
1787
|
+
# @return [Hash<String,String>]
|
1788
|
+
#
|
1789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationResponse AWS API Documentation
|
1790
|
+
#
|
1791
|
+
class PutIntegrationResponse < Struct.new(
|
1792
|
+
:domain_name,
|
1793
|
+
:uri,
|
1794
|
+
:object_type_name,
|
1795
|
+
:created_at,
|
1796
|
+
:last_updated_at,
|
1797
|
+
:tags)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# @note When making an API call, you may pass PutProfileObjectRequest
|
1803
|
+
# data as a hash:
|
1804
|
+
#
|
1805
|
+
# {
|
1806
|
+
# object_type_name: "typeName", # required
|
1807
|
+
# object: "stringifiedJson", # required
|
1808
|
+
# domain_name: "name", # required
|
1809
|
+
# }
|
1810
|
+
#
|
1811
|
+
# @!attribute [rw] object_type_name
|
1812
|
+
# The name of the profile object type.
|
1813
|
+
# @return [String]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] object
|
1816
|
+
# A string that is serialized from a JSON object.
|
1817
|
+
# @return [String]
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] domain_name
|
1820
|
+
# The unique name of the domain.
|
1821
|
+
# @return [String]
|
1822
|
+
#
|
1823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutProfileObjectRequest AWS API Documentation
|
1824
|
+
#
|
1825
|
+
class PutProfileObjectRequest < Struct.new(
|
1826
|
+
:object_type_name,
|
1827
|
+
:object,
|
1828
|
+
:domain_name)
|
1829
|
+
SENSITIVE = []
|
1830
|
+
include Aws::Structure
|
1831
|
+
end
|
1832
|
+
|
1833
|
+
# @!attribute [rw] profile_object_unique_key
|
1834
|
+
# The unique identifier of the profile object generated by the
|
1835
|
+
# service.
|
1836
|
+
# @return [String]
|
1837
|
+
#
|
1838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutProfileObjectResponse AWS API Documentation
|
1839
|
+
#
|
1840
|
+
class PutProfileObjectResponse < Struct.new(
|
1841
|
+
:profile_object_unique_key)
|
1842
|
+
SENSITIVE = []
|
1843
|
+
include Aws::Structure
|
1844
|
+
end
|
1845
|
+
|
1846
|
+
# @note When making an API call, you may pass PutProfileObjectTypeRequest
|
1847
|
+
# data as a hash:
|
1848
|
+
#
|
1849
|
+
# {
|
1850
|
+
# domain_name: "name", # required
|
1851
|
+
# object_type_name: "typeName", # required
|
1852
|
+
# description: "text", # required
|
1853
|
+
# template_id: "name",
|
1854
|
+
# expiration_days: 1,
|
1855
|
+
# encryption_key: "encryptionKey",
|
1856
|
+
# allow_profile_creation: false,
|
1857
|
+
# fields: {
|
1858
|
+
# "name" => {
|
1859
|
+
# source: "text",
|
1860
|
+
# target: "text",
|
1861
|
+
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
1862
|
+
# },
|
1863
|
+
# },
|
1864
|
+
# keys: {
|
1865
|
+
# "name" => [
|
1866
|
+
# {
|
1867
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
1868
|
+
# field_names: ["name"],
|
1869
|
+
# },
|
1870
|
+
# ],
|
1871
|
+
# },
|
1872
|
+
# tags: {
|
1873
|
+
# "TagKey" => "TagValue",
|
1874
|
+
# },
|
1875
|
+
# }
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] domain_name
|
1878
|
+
# The unique name of the domain.
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] object_type_name
|
1882
|
+
# The name of the profile object type.
|
1883
|
+
# @return [String]
|
1884
|
+
#
|
1885
|
+
# @!attribute [rw] description
|
1886
|
+
# Description of the profile object type.
|
1887
|
+
# @return [String]
|
1888
|
+
#
|
1889
|
+
# @!attribute [rw] template_id
|
1890
|
+
# A unique identifier for the object template.
|
1891
|
+
# @return [String]
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] expiration_days
|
1894
|
+
# The number of days until the data in the object expires.
|
1895
|
+
# @return [Integer]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] encryption_key
|
1898
|
+
# The customer-provided key to encrypt the profile object that will be
|
1899
|
+
# created in this profile object type.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] allow_profile_creation
|
1903
|
+
# Indicates whether a profile should be created when data is received
|
1904
|
+
# if one doesn’t exist for an object of this type. The default is
|
1905
|
+
# `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then
|
1906
|
+
# the service tries to fetch a standard profile and associate this
|
1907
|
+
# object with the profile. If it is set to `TRUE`, and if no match is
|
1908
|
+
# found, then the service creates a new standard profile.
|
1909
|
+
# @return [Boolean]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] fields
|
1912
|
+
# A map of the name and ObjectType field.
|
1913
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] keys
|
1916
|
+
# A list of unique keys that can be used to map data to the profile.
|
1917
|
+
# @return [Hash<String,Array<Types::ObjectTypeKey>>]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] tags
|
1920
|
+
# The tags used to organize, track, or control access for this
|
1921
|
+
# resource.
|
1922
|
+
# @return [Hash<String,String>]
|
1923
|
+
#
|
1924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutProfileObjectTypeRequest AWS API Documentation
|
1925
|
+
#
|
1926
|
+
class PutProfileObjectTypeRequest < Struct.new(
|
1927
|
+
:domain_name,
|
1928
|
+
:object_type_name,
|
1929
|
+
:description,
|
1930
|
+
:template_id,
|
1931
|
+
:expiration_days,
|
1932
|
+
:encryption_key,
|
1933
|
+
:allow_profile_creation,
|
1934
|
+
:fields,
|
1935
|
+
:keys,
|
1936
|
+
:tags)
|
1937
|
+
SENSITIVE = []
|
1938
|
+
include Aws::Structure
|
1939
|
+
end
|
1940
|
+
|
1941
|
+
# @!attribute [rw] object_type_name
|
1942
|
+
# The name of the profile object type.
|
1943
|
+
# @return [String]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] description
|
1946
|
+
# Description of the profile object type.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] template_id
|
1950
|
+
# A unique identifier for the object template.
|
1951
|
+
# @return [String]
|
1952
|
+
#
|
1953
|
+
# @!attribute [rw] expiration_days
|
1954
|
+
# The number of days until the data in the object expires.
|
1955
|
+
# @return [Integer]
|
1956
|
+
#
|
1957
|
+
# @!attribute [rw] encryption_key
|
1958
|
+
# The customer-provided key to encrypt the profile object that will be
|
1959
|
+
# created in this profile object type.
|
1960
|
+
# @return [String]
|
1961
|
+
#
|
1962
|
+
# @!attribute [rw] allow_profile_creation
|
1963
|
+
# Indicates whether a profile should be created when data is received
|
1964
|
+
# if one doesn’t exist for an object of this type. The default is
|
1965
|
+
# `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then
|
1966
|
+
# the service tries to fetch a standard profile and associate this
|
1967
|
+
# object with the profile. If it is set to `TRUE`, and if no match is
|
1968
|
+
# found, then the service creates a new standard profile.
|
1969
|
+
# @return [Boolean]
|
1970
|
+
#
|
1971
|
+
# @!attribute [rw] fields
|
1972
|
+
# A map of the name and ObjectType field.
|
1973
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
1974
|
+
#
|
1975
|
+
# @!attribute [rw] keys
|
1976
|
+
# A list of unique keys that can be used to map data to the profile.
|
1977
|
+
# @return [Hash<String,Array<Types::ObjectTypeKey>>]
|
1978
|
+
#
|
1979
|
+
# @!attribute [rw] created_at
|
1980
|
+
# The timestamp of when the domain was created.
|
1981
|
+
# @return [Time]
|
1982
|
+
#
|
1983
|
+
# @!attribute [rw] last_updated_at
|
1984
|
+
# The timestamp of when the domain was most recently edited.
|
1985
|
+
# @return [Time]
|
1986
|
+
#
|
1987
|
+
# @!attribute [rw] tags
|
1988
|
+
# The tags used to organize, track, or control access for this
|
1989
|
+
# resource.
|
1990
|
+
# @return [Hash<String,String>]
|
1991
|
+
#
|
1992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutProfileObjectTypeResponse AWS API Documentation
|
1993
|
+
#
|
1994
|
+
class PutProfileObjectTypeResponse < Struct.new(
|
1995
|
+
:object_type_name,
|
1996
|
+
:description,
|
1997
|
+
:template_id,
|
1998
|
+
:expiration_days,
|
1999
|
+
:encryption_key,
|
2000
|
+
:allow_profile_creation,
|
2001
|
+
:fields,
|
2002
|
+
:keys,
|
2003
|
+
:created_at,
|
2004
|
+
:last_updated_at,
|
2005
|
+
:tags)
|
2006
|
+
SENSITIVE = []
|
2007
|
+
include Aws::Structure
|
2008
|
+
end
|
2009
|
+
|
2010
|
+
# The requested resource does not exist, or access was denied.
|
2011
|
+
#
|
2012
|
+
# @!attribute [rw] message
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ResourceNotFoundException AWS API Documentation
|
2016
|
+
#
|
2017
|
+
class ResourceNotFoundException < Struct.new(
|
2018
|
+
:message)
|
2019
|
+
SENSITIVE = []
|
2020
|
+
include Aws::Structure
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# @note When making an API call, you may pass SearchProfilesRequest
|
2024
|
+
# data as a hash:
|
2025
|
+
#
|
2026
|
+
# {
|
2027
|
+
# next_token: "token",
|
2028
|
+
# max_results: 1,
|
2029
|
+
# domain_name: "name", # required
|
2030
|
+
# key_name: "name", # required
|
2031
|
+
# values: ["string1To255"], # required
|
2032
|
+
# }
|
2033
|
+
#
|
2034
|
+
# @!attribute [rw] next_token
|
2035
|
+
# The pagination token from the previous SearchProfiles API call.
|
2036
|
+
# @return [String]
|
2037
|
+
#
|
2038
|
+
# @!attribute [rw] max_results
|
2039
|
+
# The maximum number of objects returned per page.
|
2040
|
+
# @return [Integer]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] domain_name
|
2043
|
+
# The unique name of the domain.
|
2044
|
+
# @return [String]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] key_name
|
2047
|
+
# A searchable identifier of a customer profile. The predefined keys
|
2048
|
+
# you can use to search include: \_account, \_profileId, \_fullName,
|
2049
|
+
# \_phone, \_email, \_ctrContactId, \_marketoLeadId,
|
2050
|
+
# \_salesforceAccountId, \_salesforceContactId, \_zendeskUserId,
|
2051
|
+
# \_zendeskExternalId, \_serviceNowSystemId.
|
2052
|
+
# @return [String]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] values
|
2055
|
+
# A list of key values.
|
2056
|
+
# @return [Array<String>]
|
2057
|
+
#
|
2058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfilesRequest AWS API Documentation
|
2059
|
+
#
|
2060
|
+
class SearchProfilesRequest < Struct.new(
|
2061
|
+
:next_token,
|
2062
|
+
:max_results,
|
2063
|
+
:domain_name,
|
2064
|
+
:key_name,
|
2065
|
+
:values)
|
2066
|
+
SENSITIVE = []
|
2067
|
+
include Aws::Structure
|
2068
|
+
end
|
2069
|
+
|
2070
|
+
# @!attribute [rw] items
|
2071
|
+
# The list of SearchProfiles instances.
|
2072
|
+
# @return [Array<Types::Profile>]
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] next_token
|
2075
|
+
# The pagination token from the previous SearchProfiles API call.
|
2076
|
+
# @return [String]
|
2077
|
+
#
|
2078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfilesResponse AWS API Documentation
|
2079
|
+
#
|
2080
|
+
class SearchProfilesResponse < Struct.new(
|
2081
|
+
:items,
|
2082
|
+
:next_token)
|
2083
|
+
SENSITIVE = []
|
2084
|
+
include Aws::Structure
|
2085
|
+
end
|
2086
|
+
|
2087
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2088
|
+
# data as a hash:
|
2089
|
+
#
|
2090
|
+
# {
|
2091
|
+
# resource_arn: "TagArn", # required
|
2092
|
+
# tags: { # required
|
2093
|
+
# "TagKey" => "TagValue",
|
2094
|
+
# },
|
2095
|
+
# }
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] resource_arn
|
2098
|
+
# The ARN of the resource that you're adding tags to.
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] tags
|
2102
|
+
# The tags used to organize, track, or control access for this
|
2103
|
+
# resource.
|
2104
|
+
# @return [Hash<String,String>]
|
2105
|
+
#
|
2106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/TagResourceRequest AWS API Documentation
|
2107
|
+
#
|
2108
|
+
class TagResourceRequest < Struct.new(
|
2109
|
+
:resource_arn,
|
2110
|
+
:tags)
|
2111
|
+
SENSITIVE = []
|
2112
|
+
include Aws::Structure
|
2113
|
+
end
|
2114
|
+
|
2115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/TagResourceResponse AWS API Documentation
|
2116
|
+
#
|
2117
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2118
|
+
|
2119
|
+
# You exceeded the maximum number of requests.
|
2120
|
+
#
|
2121
|
+
# @!attribute [rw] message
|
2122
|
+
# @return [String]
|
2123
|
+
#
|
2124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ThrottlingException AWS API Documentation
|
2125
|
+
#
|
2126
|
+
class ThrottlingException < Struct.new(
|
2127
|
+
:message)
|
2128
|
+
SENSITIVE = []
|
2129
|
+
include Aws::Structure
|
2130
|
+
end
|
2131
|
+
|
2132
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2133
|
+
# data as a hash:
|
2134
|
+
#
|
2135
|
+
# {
|
2136
|
+
# resource_arn: "TagArn", # required
|
2137
|
+
# tag_keys: ["TagKey"], # required
|
2138
|
+
# }
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] resource_arn
|
2141
|
+
# The ARN of the resource from which you are removing tags.
|
2142
|
+
# @return [String]
|
2143
|
+
#
|
2144
|
+
# @!attribute [rw] tag_keys
|
2145
|
+
# The list of tag keys to remove from the resource.
|
2146
|
+
# @return [Array<String>]
|
2147
|
+
#
|
2148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UntagResourceRequest AWS API Documentation
|
2149
|
+
#
|
2150
|
+
class UntagResourceRequest < Struct.new(
|
2151
|
+
:resource_arn,
|
2152
|
+
:tag_keys)
|
2153
|
+
SENSITIVE = []
|
2154
|
+
include Aws::Structure
|
2155
|
+
end
|
2156
|
+
|
2157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UntagResourceResponse AWS API Documentation
|
2158
|
+
#
|
2159
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2160
|
+
|
2161
|
+
# Updates associated with the address properties of a customer profile.
|
2162
|
+
#
|
2163
|
+
# @note When making an API call, you may pass UpdateAddress
|
2164
|
+
# data as a hash:
|
2165
|
+
#
|
2166
|
+
# {
|
2167
|
+
# address_1: "string0To255",
|
2168
|
+
# address_2: "string0To255",
|
2169
|
+
# address_3: "string0To255",
|
2170
|
+
# address_4: "string0To255",
|
2171
|
+
# city: "string0To255",
|
2172
|
+
# county: "string0To255",
|
2173
|
+
# state: "string0To255",
|
2174
|
+
# province: "string0To255",
|
2175
|
+
# country: "string0To255",
|
2176
|
+
# postal_code: "string0To255",
|
2177
|
+
# }
|
2178
|
+
#
|
2179
|
+
# @!attribute [rw] address_1
|
2180
|
+
# The first line of a customer address.
|
2181
|
+
# @return [String]
|
2182
|
+
#
|
2183
|
+
# @!attribute [rw] address_2
|
2184
|
+
# The second line of a customer address.
|
2185
|
+
# @return [String]
|
2186
|
+
#
|
2187
|
+
# @!attribute [rw] address_3
|
2188
|
+
# The third line of a customer address.
|
2189
|
+
# @return [String]
|
2190
|
+
#
|
2191
|
+
# @!attribute [rw] address_4
|
2192
|
+
# The fourth line of a customer address.
|
2193
|
+
# @return [String]
|
2194
|
+
#
|
2195
|
+
# @!attribute [rw] city
|
2196
|
+
# The city in which a customer lives.
|
2197
|
+
# @return [String]
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] county
|
2200
|
+
# The county in which a customer lives.
|
2201
|
+
# @return [String]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] state
|
2204
|
+
# The state in which a customer lives.
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @!attribute [rw] province
|
2208
|
+
# The province in which a customer lives.
|
2209
|
+
# @return [String]
|
2210
|
+
#
|
2211
|
+
# @!attribute [rw] country
|
2212
|
+
# The country in which a customer lives.
|
2213
|
+
# @return [String]
|
2214
|
+
#
|
2215
|
+
# @!attribute [rw] postal_code
|
2216
|
+
# The postal code of a customer address.
|
2217
|
+
# @return [String]
|
2218
|
+
#
|
2219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateAddress AWS API Documentation
|
2220
|
+
#
|
2221
|
+
class UpdateAddress < Struct.new(
|
2222
|
+
:address_1,
|
2223
|
+
:address_2,
|
2224
|
+
:address_3,
|
2225
|
+
:address_4,
|
2226
|
+
:city,
|
2227
|
+
:county,
|
2228
|
+
:state,
|
2229
|
+
:province,
|
2230
|
+
:country,
|
2231
|
+
:postal_code)
|
2232
|
+
SENSITIVE = []
|
2233
|
+
include Aws::Structure
|
2234
|
+
end
|
2235
|
+
|
2236
|
+
# @note When making an API call, you may pass UpdateDomainRequest
|
2237
|
+
# data as a hash:
|
2238
|
+
#
|
2239
|
+
# {
|
2240
|
+
# domain_name: "name", # required
|
2241
|
+
# default_expiration_days: 1,
|
2242
|
+
# default_encryption_key: "encryptionKey",
|
2243
|
+
# dead_letter_queue_url: "sqsQueueUrl",
|
2244
|
+
# tags: {
|
2245
|
+
# "TagKey" => "TagValue",
|
2246
|
+
# },
|
2247
|
+
# }
|
2248
|
+
#
|
2249
|
+
# @!attribute [rw] domain_name
|
2250
|
+
# The unique name for the domain.
|
2251
|
+
# @return [String]
|
2252
|
+
#
|
2253
|
+
# @!attribute [rw] default_expiration_days
|
2254
|
+
# The default number of days until the data within the domain expires.
|
2255
|
+
# @return [Integer]
|
2256
|
+
#
|
2257
|
+
# @!attribute [rw] default_encryption_key
|
2258
|
+
# The default encryption key, which is an AWS managed key, is used
|
2259
|
+
# when no specific type of encryption key is specified. It is used to
|
2260
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
2261
|
+
# storage. If specified as an empty string, it will clear any existing
|
2262
|
+
# value.
|
2263
|
+
# @return [String]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] dead_letter_queue_url
|
2266
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
2267
|
+
# errors associated with ingesting data from third party applications.
|
2268
|
+
# If specified as an empty string, it will clear any existing value.
|
2269
|
+
# You must set up a policy on the DeadLetterQueue for the SendMessage
|
2270
|
+
# operation to enable Amazon Connect Customer Profiles to send
|
2271
|
+
# messages to the DeadLetterQueue.
|
2272
|
+
# @return [String]
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] tags
|
2275
|
+
# The tags used to organize, track, or control access for this
|
2276
|
+
# resource.
|
2277
|
+
# @return [Hash<String,String>]
|
2278
|
+
#
|
2279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainRequest AWS API Documentation
|
2280
|
+
#
|
2281
|
+
class UpdateDomainRequest < Struct.new(
|
2282
|
+
:domain_name,
|
2283
|
+
:default_expiration_days,
|
2284
|
+
:default_encryption_key,
|
2285
|
+
:dead_letter_queue_url,
|
2286
|
+
:tags)
|
2287
|
+
SENSITIVE = []
|
2288
|
+
include Aws::Structure
|
2289
|
+
end
|
2290
|
+
|
2291
|
+
# @!attribute [rw] domain_name
|
2292
|
+
# The unique name for the domain.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] default_expiration_days
|
2296
|
+
# The default number of days until the data within the domain expires.
|
2297
|
+
# @return [Integer]
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] default_encryption_key
|
2300
|
+
# The default encryption key, which is an AWS managed key, is used
|
2301
|
+
# when no specific type of encryption key is specified. It is used to
|
2302
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
2303
|
+
# storage.
|
2304
|
+
# @return [String]
|
2305
|
+
#
|
2306
|
+
# @!attribute [rw] dead_letter_queue_url
|
2307
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
2308
|
+
# errors associated with ingesting data from third party applications.
|
2309
|
+
# @return [String]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] created_at
|
2312
|
+
# The timestamp of when the domain was created.
|
2313
|
+
# @return [Time]
|
2314
|
+
#
|
2315
|
+
# @!attribute [rw] last_updated_at
|
2316
|
+
# The timestamp of when the domain was most recently edited.
|
2317
|
+
# @return [Time]
|
2318
|
+
#
|
2319
|
+
# @!attribute [rw] tags
|
2320
|
+
# The tags used to organize, track, or control access for this
|
2321
|
+
# resource.
|
2322
|
+
# @return [Hash<String,String>]
|
2323
|
+
#
|
2324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainResponse AWS API Documentation
|
2325
|
+
#
|
2326
|
+
class UpdateDomainResponse < Struct.new(
|
2327
|
+
:domain_name,
|
2328
|
+
:default_expiration_days,
|
2329
|
+
:default_encryption_key,
|
2330
|
+
:dead_letter_queue_url,
|
2331
|
+
:created_at,
|
2332
|
+
:last_updated_at,
|
2333
|
+
:tags)
|
2334
|
+
SENSITIVE = []
|
2335
|
+
include Aws::Structure
|
2336
|
+
end
|
2337
|
+
|
2338
|
+
# @note When making an API call, you may pass UpdateProfileRequest
|
2339
|
+
# data as a hash:
|
2340
|
+
#
|
2341
|
+
# {
|
2342
|
+
# domain_name: "name", # required
|
2343
|
+
# profile_id: "uuid", # required
|
2344
|
+
# additional_information: "string0To1000",
|
2345
|
+
# account_number: "string0To255",
|
2346
|
+
# party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
|
2347
|
+
# business_name: "string0To255",
|
2348
|
+
# first_name: "string0To255",
|
2349
|
+
# middle_name: "string0To255",
|
2350
|
+
# last_name: "string0To255",
|
2351
|
+
# birth_date: "string0To255",
|
2352
|
+
# gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
|
2353
|
+
# phone_number: "string0To255",
|
2354
|
+
# mobile_phone_number: "string0To255",
|
2355
|
+
# home_phone_number: "string0To255",
|
2356
|
+
# business_phone_number: "string0To255",
|
2357
|
+
# email_address: "string0To255",
|
2358
|
+
# personal_email_address: "string0To255",
|
2359
|
+
# business_email_address: "string0To255",
|
2360
|
+
# address: {
|
2361
|
+
# address_1: "string0To255",
|
2362
|
+
# address_2: "string0To255",
|
2363
|
+
# address_3: "string0To255",
|
2364
|
+
# address_4: "string0To255",
|
2365
|
+
# city: "string0To255",
|
2366
|
+
# county: "string0To255",
|
2367
|
+
# state: "string0To255",
|
2368
|
+
# province: "string0To255",
|
2369
|
+
# country: "string0To255",
|
2370
|
+
# postal_code: "string0To255",
|
2371
|
+
# },
|
2372
|
+
# shipping_address: {
|
2373
|
+
# address_1: "string0To255",
|
2374
|
+
# address_2: "string0To255",
|
2375
|
+
# address_3: "string0To255",
|
2376
|
+
# address_4: "string0To255",
|
2377
|
+
# city: "string0To255",
|
2378
|
+
# county: "string0To255",
|
2379
|
+
# state: "string0To255",
|
2380
|
+
# province: "string0To255",
|
2381
|
+
# country: "string0To255",
|
2382
|
+
# postal_code: "string0To255",
|
2383
|
+
# },
|
2384
|
+
# mailing_address: {
|
2385
|
+
# address_1: "string0To255",
|
2386
|
+
# address_2: "string0To255",
|
2387
|
+
# address_3: "string0To255",
|
2388
|
+
# address_4: "string0To255",
|
2389
|
+
# city: "string0To255",
|
2390
|
+
# county: "string0To255",
|
2391
|
+
# state: "string0To255",
|
2392
|
+
# province: "string0To255",
|
2393
|
+
# country: "string0To255",
|
2394
|
+
# postal_code: "string0To255",
|
2395
|
+
# },
|
2396
|
+
# billing_address: {
|
2397
|
+
# address_1: "string0To255",
|
2398
|
+
# address_2: "string0To255",
|
2399
|
+
# address_3: "string0To255",
|
2400
|
+
# address_4: "string0To255",
|
2401
|
+
# city: "string0To255",
|
2402
|
+
# county: "string0To255",
|
2403
|
+
# state: "string0To255",
|
2404
|
+
# province: "string0To255",
|
2405
|
+
# country: "string0To255",
|
2406
|
+
# postal_code: "string0To255",
|
2407
|
+
# },
|
2408
|
+
# attributes: {
|
2409
|
+
# "string1To255" => "string0To255",
|
2410
|
+
# },
|
2411
|
+
# }
|
2412
|
+
#
|
2413
|
+
# @!attribute [rw] domain_name
|
2414
|
+
# The unique name of the domain.
|
2415
|
+
# @return [String]
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] profile_id
|
2418
|
+
# The unique identifier of a customer profile.
|
2419
|
+
# @return [String]
|
2420
|
+
#
|
2421
|
+
# @!attribute [rw] additional_information
|
2422
|
+
# Any additional information relevant to the customer's profile.
|
2423
|
+
# @return [String]
|
2424
|
+
#
|
2425
|
+
# @!attribute [rw] account_number
|
2426
|
+
# A unique account number that you have given to the customer.
|
2427
|
+
# @return [String]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] party_type
|
2430
|
+
# The type of profile used to describe the customer.
|
2431
|
+
# @return [String]
|
2432
|
+
#
|
2433
|
+
# @!attribute [rw] business_name
|
2434
|
+
# The name of the customer’s business.
|
2435
|
+
# @return [String]
|
2436
|
+
#
|
2437
|
+
# @!attribute [rw] first_name
|
2438
|
+
# The customer’s first name.
|
2439
|
+
# @return [String]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] middle_name
|
2442
|
+
# The customer’s middle name.
|
2443
|
+
# @return [String]
|
2444
|
+
#
|
2445
|
+
# @!attribute [rw] last_name
|
2446
|
+
# The customer’s last name.
|
2447
|
+
# @return [String]
|
2448
|
+
#
|
2449
|
+
# @!attribute [rw] birth_date
|
2450
|
+
# The customer’s birth date.
|
2451
|
+
# @return [String]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] gender
|
2454
|
+
# The gender with which the customer identifies.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @!attribute [rw] phone_number
|
2458
|
+
# The customer's phone number, which has not been specified as a
|
2459
|
+
# mobile, home, or business number.
|
2460
|
+
# @return [String]
|
2461
|
+
#
|
2462
|
+
# @!attribute [rw] mobile_phone_number
|
2463
|
+
# The customer’s mobile phone number.
|
2464
|
+
# @return [String]
|
2465
|
+
#
|
2466
|
+
# @!attribute [rw] home_phone_number
|
2467
|
+
# The customer’s home phone number.
|
2468
|
+
# @return [String]
|
2469
|
+
#
|
2470
|
+
# @!attribute [rw] business_phone_number
|
2471
|
+
# The customer’s business phone number.
|
2472
|
+
# @return [String]
|
2473
|
+
#
|
2474
|
+
# @!attribute [rw] email_address
|
2475
|
+
# The customer's email address, which has not been specified as a
|
2476
|
+
# personal or business address.
|
2477
|
+
# @return [String]
|
2478
|
+
#
|
2479
|
+
# @!attribute [rw] personal_email_address
|
2480
|
+
# The customer’s personal email address.
|
2481
|
+
# @return [String]
|
2482
|
+
#
|
2483
|
+
# @!attribute [rw] business_email_address
|
2484
|
+
# The customer’s business email address.
|
2485
|
+
# @return [String]
|
2486
|
+
#
|
2487
|
+
# @!attribute [rw] address
|
2488
|
+
# A generic address associated with the customer that is not mailing,
|
2489
|
+
# shipping, or billing.
|
2490
|
+
# @return [Types::UpdateAddress]
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] shipping_address
|
2493
|
+
# The customer’s shipping address.
|
2494
|
+
# @return [Types::UpdateAddress]
|
2495
|
+
#
|
2496
|
+
# @!attribute [rw] mailing_address
|
2497
|
+
# The customer’s mailing address.
|
2498
|
+
# @return [Types::UpdateAddress]
|
2499
|
+
#
|
2500
|
+
# @!attribute [rw] billing_address
|
2501
|
+
# The customer’s billing address.
|
2502
|
+
# @return [Types::UpdateAddress]
|
2503
|
+
#
|
2504
|
+
# @!attribute [rw] attributes
|
2505
|
+
# A key value pair of attributes of a customer profile.
|
2506
|
+
# @return [Hash<String,String>]
|
2507
|
+
#
|
2508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateProfileRequest AWS API Documentation
|
2509
|
+
#
|
2510
|
+
class UpdateProfileRequest < Struct.new(
|
2511
|
+
:domain_name,
|
2512
|
+
:profile_id,
|
2513
|
+
:additional_information,
|
2514
|
+
:account_number,
|
2515
|
+
:party_type,
|
2516
|
+
:business_name,
|
2517
|
+
:first_name,
|
2518
|
+
:middle_name,
|
2519
|
+
:last_name,
|
2520
|
+
:birth_date,
|
2521
|
+
:gender,
|
2522
|
+
:phone_number,
|
2523
|
+
:mobile_phone_number,
|
2524
|
+
:home_phone_number,
|
2525
|
+
:business_phone_number,
|
2526
|
+
:email_address,
|
2527
|
+
:personal_email_address,
|
2528
|
+
:business_email_address,
|
2529
|
+
:address,
|
2530
|
+
:shipping_address,
|
2531
|
+
:mailing_address,
|
2532
|
+
:billing_address,
|
2533
|
+
:attributes)
|
2534
|
+
SENSITIVE = []
|
2535
|
+
include Aws::Structure
|
2536
|
+
end
|
2537
|
+
|
2538
|
+
# @!attribute [rw] profile_id
|
2539
|
+
# The unique identifier of a customer profile.
|
2540
|
+
# @return [String]
|
2541
|
+
#
|
2542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateProfileResponse AWS API Documentation
|
2543
|
+
#
|
2544
|
+
class UpdateProfileResponse < Struct.new(
|
2545
|
+
:profile_id)
|
2546
|
+
SENSITIVE = []
|
2547
|
+
include Aws::Structure
|
2548
|
+
end
|
2549
|
+
|
2550
|
+
end
|
2551
|
+
end
|