@aws-sdk/client-customer-profiles 3.33.0 → 3.36.1

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.
Files changed (330) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/CustomerProfiles.js +3 -16
  3. package/dist-cjs/CustomerProfilesClient.js +35 -0
  4. package/{dist/cjs → dist-cjs}/commands/AddProfileKeyCommand.js +2 -30
  5. package/dist-cjs/commands/CreateDomainCommand.js +36 -0
  6. package/{dist/cjs → dist-cjs}/commands/CreateProfileCommand.js +2 -29
  7. package/{dist/cjs → dist-cjs}/commands/DeleteDomainCommand.js +2 -28
  8. package/{dist/cjs → dist-cjs}/commands/DeleteIntegrationCommand.js +2 -27
  9. package/{dist/cjs → dist-cjs}/commands/DeleteProfileCommand.js +2 -27
  10. package/{dist/cjs → dist-cjs}/commands/DeleteProfileKeyCommand.js +2 -27
  11. package/{dist/cjs → dist-cjs}/commands/DeleteProfileObjectCommand.js +2 -27
  12. package/{dist/cjs → dist-cjs}/commands/DeleteProfileObjectTypeCommand.js +2 -30
  13. package/{dist/cjs → dist-cjs}/commands/GetDomainCommand.js +2 -27
  14. package/{dist/cjs → dist-cjs}/commands/GetIntegrationCommand.js +2 -27
  15. package/dist-cjs/commands/GetMatchesCommand.js +36 -0
  16. package/{dist/cjs → dist-cjs}/commands/GetProfileObjectTypeCommand.js +2 -27
  17. package/{dist/cjs → dist-cjs}/commands/GetProfileObjectTypeTemplateCommand.js +2 -31
  18. package/{dist/cjs → dist-cjs}/commands/ListAccountIntegrationsCommand.js +2 -27
  19. package/{dist/cjs → dist-cjs}/commands/ListDomainsCommand.js +2 -27
  20. package/{dist/cjs → dist-cjs}/commands/ListIntegrationsCommand.js +2 -27
  21. package/{dist/cjs → dist-cjs}/commands/ListProfileObjectTypeTemplatesCommand.js +2 -27
  22. package/{dist/cjs → dist-cjs}/commands/ListProfileObjectTypesCommand.js +2 -27
  23. package/{dist/cjs → dist-cjs}/commands/ListProfileObjectsCommand.js +2 -27
  24. package/{dist/cjs → dist-cjs}/commands/ListTagsForResourceCommand.js +2 -28
  25. package/dist-cjs/commands/MergeProfilesCommand.js +36 -0
  26. package/{dist/cjs → dist-cjs}/commands/PutIntegrationCommand.js +2 -29
  27. package/dist-cjs/commands/PutProfileObjectCommand.js +36 -0
  28. package/{dist/cjs → dist-cjs}/commands/PutProfileObjectTypeCommand.js +2 -27
  29. package/{dist/cjs → dist-cjs}/commands/SearchProfilesCommand.js +2 -28
  30. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  31. package/{dist/cjs → dist-cjs}/commands/UntagResourceCommand.js +2 -28
  32. package/{dist/cjs → dist-cjs}/commands/UpdateDomainCommand.js +2 -32
  33. package/{dist/cjs → dist-cjs}/commands/UpdateProfileCommand.js +2 -31
  34. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  35. package/{dist/cjs → dist-cjs}/index.js +0 -1
  36. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  37. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -286
  38. package/{dist/cjs → dist-cjs}/protocols/Aws_restJson1.js +3 -9
  39. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  40. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  41. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  42. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  43. package/{dist/es → dist-es}/CustomerProfiles.js +4 -17
  44. package/{dist/es → dist-es}/CustomerProfilesClient.js +2 -20
  45. package/{dist/es → dist-es}/commands/AddProfileKeyCommand.js +4 -33
  46. package/dist-es/commands/CreateDomainCommand.js +39 -0
  47. package/{dist/es → dist-es}/commands/CreateProfileCommand.js +4 -32
  48. package/{dist/es → dist-es}/commands/DeleteDomainCommand.js +4 -31
  49. package/{dist/es → dist-es}/commands/DeleteIntegrationCommand.js +4 -30
  50. package/{dist/es → dist-es}/commands/DeleteProfileCommand.js +4 -30
  51. package/{dist/es → dist-es}/commands/DeleteProfileKeyCommand.js +4 -30
  52. package/{dist/es → dist-es}/commands/DeleteProfileObjectCommand.js +4 -30
  53. package/{dist/es → dist-es}/commands/DeleteProfileObjectTypeCommand.js +4 -33
  54. package/{dist/es → dist-es}/commands/GetDomainCommand.js +4 -30
  55. package/{dist/es → dist-es}/commands/GetIntegrationCommand.js +4 -30
  56. package/dist-es/commands/GetMatchesCommand.js +39 -0
  57. package/{dist/es → dist-es}/commands/GetProfileObjectTypeCommand.js +4 -30
  58. package/{dist/es → dist-es}/commands/GetProfileObjectTypeTemplateCommand.js +4 -34
  59. package/{dist/es → dist-es}/commands/ListAccountIntegrationsCommand.js +4 -30
  60. package/{dist/es → dist-es}/commands/ListDomainsCommand.js +4 -30
  61. package/{dist/es → dist-es}/commands/ListIntegrationsCommand.js +4 -30
  62. package/{dist/es → dist-es}/commands/ListProfileObjectTypeTemplatesCommand.js +4 -30
  63. package/{dist/es → dist-es}/commands/ListProfileObjectTypesCommand.js +4 -30
  64. package/{dist/es → dist-es}/commands/ListProfileObjectsCommand.js +4 -30
  65. package/{dist/es → dist-es}/commands/ListTagsForResourceCommand.js +4 -31
  66. package/dist-es/commands/MergeProfilesCommand.js +39 -0
  67. package/{dist/es → dist-es}/commands/PutIntegrationCommand.js +4 -32
  68. package/dist-es/commands/PutProfileObjectCommand.js +39 -0
  69. package/{dist/es → dist-es}/commands/PutProfileObjectTypeCommand.js +4 -30
  70. package/{dist/es → dist-es}/commands/SearchProfilesCommand.js +4 -31
  71. package/dist-es/commands/TagResourceCommand.js +39 -0
  72. package/{dist/es → dist-es}/commands/UntagResourceCommand.js +4 -31
  73. package/{dist/es → dist-es}/commands/UpdateDomainCommand.js +4 -35
  74. package/{dist/es → dist-es}/commands/UpdateProfileCommand.js +4 -34
  75. package/{dist/es → dist-es}/endpoints.js +1 -2
  76. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  77. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  78. package/{dist/es → dist-es}/models/models_0.js +0 -286
  79. package/{dist/es → dist-es}/protocols/Aws_restJson1.js +847 -853
  80. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  81. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  82. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  83. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  84. package/{dist/types → dist-types}/CustomerProfiles.d.ts +4 -4
  85. package/{dist/types → dist-types}/CustomerProfilesClient.d.ts +10 -10
  86. package/{dist/types → dist-types}/commands/AddProfileKeyCommand.d.ts +2 -2
  87. package/{dist/types → dist-types}/commands/CreateDomainCommand.d.ts +2 -2
  88. package/{dist/types → dist-types}/commands/CreateProfileCommand.d.ts +2 -2
  89. package/{dist/types → dist-types}/commands/DeleteDomainCommand.d.ts +2 -2
  90. package/{dist/types → dist-types}/commands/DeleteIntegrationCommand.d.ts +2 -2
  91. package/{dist/types → dist-types}/commands/DeleteProfileCommand.d.ts +2 -2
  92. package/{dist/types → dist-types}/commands/DeleteProfileKeyCommand.d.ts +2 -2
  93. package/{dist/types → dist-types}/commands/DeleteProfileObjectCommand.d.ts +2 -2
  94. package/{dist/types → dist-types}/commands/DeleteProfileObjectTypeCommand.d.ts +2 -2
  95. package/{dist/types → dist-types}/commands/GetDomainCommand.d.ts +2 -2
  96. package/{dist/types → dist-types}/commands/GetIntegrationCommand.d.ts +2 -2
  97. package/{dist/types → dist-types}/commands/GetMatchesCommand.d.ts +2 -2
  98. package/{dist/types → dist-types}/commands/GetProfileObjectTypeCommand.d.ts +2 -2
  99. package/{dist/types → dist-types}/commands/GetProfileObjectTypeTemplateCommand.d.ts +2 -2
  100. package/{dist/types → dist-types}/commands/ListAccountIntegrationsCommand.d.ts +2 -2
  101. package/{dist/types → dist-types}/commands/ListDomainsCommand.d.ts +2 -2
  102. package/{dist/types → dist-types}/commands/ListIntegrationsCommand.d.ts +2 -2
  103. package/{dist/types → dist-types}/commands/ListProfileObjectTypeTemplatesCommand.d.ts +2 -2
  104. package/{dist/types → dist-types}/commands/ListProfileObjectTypesCommand.d.ts +2 -2
  105. package/{dist/types → dist-types}/commands/ListProfileObjectsCommand.d.ts +2 -2
  106. package/{dist/types → dist-types}/commands/ListTagsForResourceCommand.d.ts +2 -2
  107. package/{dist/types → dist-types}/commands/MergeProfilesCommand.d.ts +2 -2
  108. package/{dist/types → dist-types}/commands/PutIntegrationCommand.d.ts +2 -2
  109. package/{dist/types → dist-types}/commands/PutProfileObjectCommand.d.ts +2 -2
  110. package/{dist/types → dist-types}/commands/PutProfileObjectTypeCommand.d.ts +2 -2
  111. package/{dist/types → dist-types}/commands/SearchProfilesCommand.d.ts +2 -2
  112. package/{dist/types → dist-types}/commands/TagResourceCommand.d.ts +2 -2
  113. package/{dist/types → dist-types}/commands/UntagResourceCommand.d.ts +2 -2
  114. package/{dist/types → dist-types}/commands/UpdateDomainCommand.d.ts +2 -2
  115. package/{dist/types → dist-types}/commands/UpdateProfileCommand.d.ts +2 -2
  116. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  117. package/{index.ts → dist-types/index.d.ts} +0 -0
  118. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  119. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  120. package/{dist/types → dist-types}/protocols/Aws_restJson1.d.ts +4 -4
  121. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  122. package/{dist/types → dist-types}/runtimeConfig.d.ts +2 -4
  123. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  124. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  125. package/{dist/types → dist-types}/ts3.4/CustomerProfiles.d.ts +35 -248
  126. package/{dist/types → dist-types}/ts3.4/CustomerProfilesClient.d.ts +34 -108
  127. package/dist-types/ts3.4/commands/AddProfileKeyCommand.d.ts +17 -0
  128. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +17 -0
  129. package/dist-types/ts3.4/commands/CreateProfileCommand.d.ts +17 -0
  130. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +17 -0
  131. package/{dist/types → dist-types}/ts3.4/commands/DeleteIntegrationCommand.d.ts +4 -22
  132. package/dist-types/ts3.4/commands/DeleteProfileCommand.d.ts +17 -0
  133. package/dist-types/ts3.4/commands/DeleteProfileKeyCommand.d.ts +17 -0
  134. package/dist-types/ts3.4/commands/DeleteProfileObjectCommand.d.ts +17 -0
  135. package/dist-types/ts3.4/commands/DeleteProfileObjectTypeCommand.d.ts +17 -0
  136. package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +17 -0
  137. package/dist-types/ts3.4/commands/GetIntegrationCommand.d.ts +17 -0
  138. package/dist-types/ts3.4/commands/GetMatchesCommand.d.ts +17 -0
  139. package/{dist/types → dist-types}/ts3.4/commands/GetProfileObjectTypeCommand.d.ts +4 -22
  140. package/dist-types/ts3.4/commands/GetProfileObjectTypeTemplateCommand.d.ts +17 -0
  141. package/{dist/types → dist-types}/ts3.4/commands/ListAccountIntegrationsCommand.d.ts +4 -22
  142. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +17 -0
  143. package/dist-types/ts3.4/commands/ListIntegrationsCommand.d.ts +17 -0
  144. package/{dist/types → dist-types}/ts3.4/commands/ListProfileObjectTypeTemplatesCommand.d.ts +4 -22
  145. package/{dist/types → dist-types}/ts3.4/commands/ListProfileObjectTypesCommand.d.ts +4 -22
  146. package/dist-types/ts3.4/commands/ListProfileObjectsCommand.d.ts +17 -0
  147. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  148. package/dist-types/ts3.4/commands/MergeProfilesCommand.d.ts +17 -0
  149. package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +17 -0
  150. package/dist-types/ts3.4/commands/PutProfileObjectCommand.d.ts +17 -0
  151. package/{dist/types → dist-types}/ts3.4/commands/PutProfileObjectTypeCommand.d.ts +4 -22
  152. package/dist-types/ts3.4/commands/SearchProfilesCommand.d.ts +17 -0
  153. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  154. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  155. package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +17 -0
  156. package/dist-types/ts3.4/commands/UpdateProfileCommand.d.ts +17 -0
  157. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  158. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  159. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  160. package/dist-types/ts3.4/models/models_0.d.ts +1598 -0
  161. package/{dist/types → dist-types}/ts3.4/protocols/Aws_restJson1.d.ts +4 -4
  162. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  163. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +3 -7
  164. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  165. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  166. package/package.json +52 -49
  167. package/CustomerProfiles.ts +0 -1219
  168. package/CustomerProfilesClient.ts +0 -361
  169. package/commands/AddProfileKeyCommand.ts +0 -97
  170. package/commands/CreateDomainCommand.ts +0 -101
  171. package/commands/CreateProfileCommand.ts +0 -96
  172. package/commands/DeleteDomainCommand.ts +0 -95
  173. package/commands/DeleteIntegrationCommand.ts +0 -94
  174. package/commands/DeleteProfileCommand.ts +0 -94
  175. package/commands/DeleteProfileKeyCommand.ts +0 -94
  176. package/commands/DeleteProfileObjectCommand.ts +0 -94
  177. package/commands/DeleteProfileObjectTypeCommand.ts +0 -97
  178. package/commands/GetDomainCommand.ts +0 -94
  179. package/commands/GetIntegrationCommand.ts +0 -94
  180. package/commands/GetMatchesCommand.ts +0 -138
  181. package/commands/GetProfileObjectTypeCommand.ts +0 -94
  182. package/commands/GetProfileObjectTypeTemplateCommand.ts +0 -103
  183. package/commands/ListAccountIntegrationsCommand.ts +0 -94
  184. package/commands/ListDomainsCommand.ts +0 -94
  185. package/commands/ListIntegrationsCommand.ts +0 -94
  186. package/commands/ListProfileObjectTypeTemplatesCommand.ts +0 -102
  187. package/commands/ListProfileObjectTypesCommand.ts +0 -94
  188. package/commands/ListProfileObjectsCommand.ts +0 -94
  189. package/commands/ListTagsForResourceCommand.ts +0 -95
  190. package/commands/MergeProfilesCommand.ts +0 -138
  191. package/commands/PutIntegrationCommand.ts +0 -96
  192. package/commands/PutProfileObjectCommand.ts +0 -103
  193. package/commands/PutProfileObjectTypeCommand.ts +0 -94
  194. package/commands/SearchProfilesCommand.ts +0 -95
  195. package/commands/TagResourceCommand.ts +0 -105
  196. package/commands/UntagResourceCommand.ts +0 -95
  197. package/commands/UpdateDomainCommand.ts +0 -99
  198. package/commands/UpdateProfileCommand.ts +0 -98
  199. package/dist/cjs/CustomerProfiles.js.map +0 -1
  200. package/dist/cjs/CustomerProfilesClient.js +0 -53
  201. package/dist/cjs/CustomerProfilesClient.js.map +0 -1
  202. package/dist/cjs/commands/AddProfileKeyCommand.js.map +0 -1
  203. package/dist/cjs/commands/CreateDomainCommand.js +0 -68
  204. package/dist/cjs/commands/CreateDomainCommand.js.map +0 -1
  205. package/dist/cjs/commands/CreateProfileCommand.js.map +0 -1
  206. package/dist/cjs/commands/DeleteDomainCommand.js.map +0 -1
  207. package/dist/cjs/commands/DeleteIntegrationCommand.js.map +0 -1
  208. package/dist/cjs/commands/DeleteProfileCommand.js.map +0 -1
  209. package/dist/cjs/commands/DeleteProfileKeyCommand.js.map +0 -1
  210. package/dist/cjs/commands/DeleteProfileObjectCommand.js.map +0 -1
  211. package/dist/cjs/commands/DeleteProfileObjectTypeCommand.js.map +0 -1
  212. package/dist/cjs/commands/GetDomainCommand.js.map +0 -1
  213. package/dist/cjs/commands/GetIntegrationCommand.js.map +0 -1
  214. package/dist/cjs/commands/GetMatchesCommand.js +0 -105
  215. package/dist/cjs/commands/GetMatchesCommand.js.map +0 -1
  216. package/dist/cjs/commands/GetProfileObjectTypeCommand.js.map +0 -1
  217. package/dist/cjs/commands/GetProfileObjectTypeTemplateCommand.js.map +0 -1
  218. package/dist/cjs/commands/ListAccountIntegrationsCommand.js.map +0 -1
  219. package/dist/cjs/commands/ListDomainsCommand.js.map +0 -1
  220. package/dist/cjs/commands/ListIntegrationsCommand.js.map +0 -1
  221. package/dist/cjs/commands/ListProfileObjectTypeTemplatesCommand.js.map +0 -1
  222. package/dist/cjs/commands/ListProfileObjectTypesCommand.js.map +0 -1
  223. package/dist/cjs/commands/ListProfileObjectsCommand.js.map +0 -1
  224. package/dist/cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  225. package/dist/cjs/commands/MergeProfilesCommand.js +0 -105
  226. package/dist/cjs/commands/MergeProfilesCommand.js.map +0 -1
  227. package/dist/cjs/commands/PutIntegrationCommand.js.map +0 -1
  228. package/dist/cjs/commands/PutProfileObjectCommand.js +0 -70
  229. package/dist/cjs/commands/PutProfileObjectCommand.js.map +0 -1
  230. package/dist/cjs/commands/PutProfileObjectTypeCommand.js.map +0 -1
  231. package/dist/cjs/commands/SearchProfilesCommand.js.map +0 -1
  232. package/dist/cjs/commands/TagResourceCommand.js +0 -72
  233. package/dist/cjs/commands/TagResourceCommand.js.map +0 -1
  234. package/dist/cjs/commands/UntagResourceCommand.js.map +0 -1
  235. package/dist/cjs/commands/UpdateDomainCommand.js.map +0 -1
  236. package/dist/cjs/commands/UpdateProfileCommand.js.map +0 -1
  237. package/dist/cjs/endpoints.js.map +0 -1
  238. package/dist/cjs/index.js.map +0 -1
  239. package/dist/cjs/models/index.js.map +0 -1
  240. package/dist/cjs/models/models_0.js.map +0 -1
  241. package/dist/cjs/package.json +0 -91
  242. package/dist/cjs/protocols/Aws_restJson1.js.map +0 -1
  243. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  244. package/dist/cjs/runtimeConfig.js.map +0 -1
  245. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  246. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  247. package/dist/es/CustomerProfiles.js.map +0 -1
  248. package/dist/es/CustomerProfilesClient.js.map +0 -1
  249. package/dist/es/commands/AddProfileKeyCommand.js.map +0 -1
  250. package/dist/es/commands/CreateDomainCommand.js +0 -72
  251. package/dist/es/commands/CreateDomainCommand.js.map +0 -1
  252. package/dist/es/commands/CreateProfileCommand.js.map +0 -1
  253. package/dist/es/commands/DeleteDomainCommand.js.map +0 -1
  254. package/dist/es/commands/DeleteIntegrationCommand.js.map +0 -1
  255. package/dist/es/commands/DeleteProfileCommand.js.map +0 -1
  256. package/dist/es/commands/DeleteProfileKeyCommand.js.map +0 -1
  257. package/dist/es/commands/DeleteProfileObjectCommand.js.map +0 -1
  258. package/dist/es/commands/DeleteProfileObjectTypeCommand.js.map +0 -1
  259. package/dist/es/commands/GetDomainCommand.js.map +0 -1
  260. package/dist/es/commands/GetIntegrationCommand.js.map +0 -1
  261. package/dist/es/commands/GetMatchesCommand.js +0 -109
  262. package/dist/es/commands/GetMatchesCommand.js.map +0 -1
  263. package/dist/es/commands/GetProfileObjectTypeCommand.js.map +0 -1
  264. package/dist/es/commands/GetProfileObjectTypeTemplateCommand.js.map +0 -1
  265. package/dist/es/commands/ListAccountIntegrationsCommand.js.map +0 -1
  266. package/dist/es/commands/ListDomainsCommand.js.map +0 -1
  267. package/dist/es/commands/ListIntegrationsCommand.js.map +0 -1
  268. package/dist/es/commands/ListProfileObjectTypeTemplatesCommand.js.map +0 -1
  269. package/dist/es/commands/ListProfileObjectTypesCommand.js.map +0 -1
  270. package/dist/es/commands/ListProfileObjectsCommand.js.map +0 -1
  271. package/dist/es/commands/ListTagsForResourceCommand.js.map +0 -1
  272. package/dist/es/commands/MergeProfilesCommand.js +0 -109
  273. package/dist/es/commands/MergeProfilesCommand.js.map +0 -1
  274. package/dist/es/commands/PutIntegrationCommand.js.map +0 -1
  275. package/dist/es/commands/PutProfileObjectCommand.js +0 -74
  276. package/dist/es/commands/PutProfileObjectCommand.js.map +0 -1
  277. package/dist/es/commands/PutProfileObjectTypeCommand.js.map +0 -1
  278. package/dist/es/commands/SearchProfilesCommand.js.map +0 -1
  279. package/dist/es/commands/TagResourceCommand.js +0 -76
  280. package/dist/es/commands/TagResourceCommand.js.map +0 -1
  281. package/dist/es/commands/UntagResourceCommand.js.map +0 -1
  282. package/dist/es/commands/UpdateDomainCommand.js.map +0 -1
  283. package/dist/es/commands/UpdateProfileCommand.js.map +0 -1
  284. package/dist/es/endpoints.js.map +0 -1
  285. package/dist/es/index.js +0 -34
  286. package/dist/es/index.js.map +0 -1
  287. package/dist/es/models/index.js +0 -2
  288. package/dist/es/models/index.js.map +0 -1
  289. package/dist/es/models/models_0.js.map +0 -1
  290. package/dist/es/package.json +0 -91
  291. package/dist/es/protocols/Aws_restJson1.js.map +0 -1
  292. package/dist/es/runtimeConfig.browser.js.map +0 -1
  293. package/dist/es/runtimeConfig.js.map +0 -1
  294. package/dist/es/runtimeConfig.native.js.map +0 -1
  295. package/dist/es/runtimeConfig.shared.js.map +0 -1
  296. package/dist/types/ts3.4/commands/AddProfileKeyCommand.d.ts +0 -38
  297. package/dist/types/ts3.4/commands/CreateDomainCommand.d.ts +0 -42
  298. package/dist/types/ts3.4/commands/CreateProfileCommand.d.ts +0 -37
  299. package/dist/types/ts3.4/commands/DeleteDomainCommand.d.ts +0 -36
  300. package/dist/types/ts3.4/commands/DeleteProfileCommand.d.ts +0 -35
  301. package/dist/types/ts3.4/commands/DeleteProfileKeyCommand.d.ts +0 -35
  302. package/dist/types/ts3.4/commands/DeleteProfileObjectCommand.d.ts +0 -35
  303. package/dist/types/ts3.4/commands/DeleteProfileObjectTypeCommand.d.ts +0 -38
  304. package/dist/types/ts3.4/commands/GetDomainCommand.d.ts +0 -35
  305. package/dist/types/ts3.4/commands/GetIntegrationCommand.d.ts +0 -35
  306. package/dist/types/ts3.4/commands/GetMatchesCommand.d.ts +0 -79
  307. package/dist/types/ts3.4/commands/GetProfileObjectTypeTemplateCommand.d.ts +0 -39
  308. package/dist/types/ts3.4/commands/ListDomainsCommand.d.ts +0 -35
  309. package/dist/types/ts3.4/commands/ListIntegrationsCommand.d.ts +0 -35
  310. package/dist/types/ts3.4/commands/ListProfileObjectsCommand.d.ts +0 -35
  311. package/dist/types/ts3.4/commands/ListTagsForResourceCommand.d.ts +0 -36
  312. package/dist/types/ts3.4/commands/MergeProfilesCommand.d.ts +0 -79
  313. package/dist/types/ts3.4/commands/PutIntegrationCommand.d.ts +0 -37
  314. package/dist/types/ts3.4/commands/PutProfileObjectCommand.d.ts +0 -44
  315. package/dist/types/ts3.4/commands/SearchProfilesCommand.d.ts +0 -36
  316. package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +0 -46
  317. package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +0 -36
  318. package/dist/types/ts3.4/commands/UpdateDomainCommand.d.ts +0 -40
  319. package/dist/types/ts3.4/commands/UpdateProfileCommand.d.ts +0 -39
  320. package/dist/types/ts3.4/models/models_0.d.ts +0 -2721
  321. package/endpoints.ts +0 -57
  322. package/jest.config.js +0 -4
  323. package/models/models_0.ts +0 -3342
  324. package/protocols/Aws_restJson1.ts +0 -5042
  325. package/runtimeConfig.browser.ts +0 -40
  326. package/runtimeConfig.native.ts +0 -16
  327. package/runtimeConfig.shared.ts +0 -16
  328. package/runtimeConfig.ts +0 -45
  329. package/tsconfig.es.json +0 -12
  330. package/tsconfig.json +0 -32
@@ -1,3342 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>You do not have sufficient access to perform this action.</p>
5
- */
6
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
7
- name: "AccessDeniedException";
8
- $fault: "client";
9
- Message?: string;
10
- }
11
-
12
- export namespace AccessDeniedException {
13
- /**
14
- * @internal
15
- */
16
- export const filterSensitiveLog = (obj: AccessDeniedException): any => ({
17
- ...obj,
18
- });
19
- }
20
-
21
- export interface AddProfileKeyRequest {
22
- /**
23
- * <p>The unique identifier of a customer profile.</p>
24
- */
25
- ProfileId: string | undefined;
26
-
27
- /**
28
- * <p>A searchable identifier of a customer profile.</p>
29
- */
30
- KeyName: string | undefined;
31
-
32
- /**
33
- * <p>A list of key values.</p>
34
- */
35
- Values: string[] | undefined;
36
-
37
- /**
38
- * <p>The unique name of the domain.</p>
39
- */
40
- DomainName: string | undefined;
41
- }
42
-
43
- export namespace AddProfileKeyRequest {
44
- /**
45
- * @internal
46
- */
47
- export const filterSensitiveLog = (obj: AddProfileKeyRequest): any => ({
48
- ...obj,
49
- });
50
- }
51
-
52
- export interface AddProfileKeyResponse {
53
- /**
54
- * <p>A searchable identifier of a customer profile.</p>
55
- */
56
- KeyName?: string;
57
-
58
- /**
59
- * <p>A list of key values.</p>
60
- */
61
- Values?: string[];
62
- }
63
-
64
- export namespace AddProfileKeyResponse {
65
- /**
66
- * @internal
67
- */
68
- export const filterSensitiveLog = (obj: AddProfileKeyResponse): any => ({
69
- ...obj,
70
- });
71
- }
72
-
73
- /**
74
- * <p>The input you provided is invalid.</p>
75
- */
76
- export interface BadRequestException extends __SmithyException, $MetadataBearer {
77
- name: "BadRequestException";
78
- $fault: "client";
79
- Message?: string;
80
- }
81
-
82
- export namespace BadRequestException {
83
- /**
84
- * @internal
85
- */
86
- export const filterSensitiveLog = (obj: BadRequestException): any => ({
87
- ...obj,
88
- });
89
- }
90
-
91
- /**
92
- * <p>An internal service error occurred.</p>
93
- */
94
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
95
- name: "InternalServerException";
96
- $fault: "server";
97
- Message?: string;
98
- }
99
-
100
- export namespace InternalServerException {
101
- /**
102
- * @internal
103
- */
104
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
105
- ...obj,
106
- });
107
- }
108
-
109
- /**
110
- * <p>The requested resource does not exist, or access was denied.</p>
111
- */
112
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
113
- name: "ResourceNotFoundException";
114
- $fault: "client";
115
- Message?: string;
116
- }
117
-
118
- export namespace ResourceNotFoundException {
119
- /**
120
- * @internal
121
- */
122
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
123
- ...obj,
124
- });
125
- }
126
-
127
- /**
128
- * <p>You exceeded the maximum number of requests.</p>
129
- */
130
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
131
- name: "ThrottlingException";
132
- $fault: "client";
133
- Message?: string;
134
- }
135
-
136
- export namespace ThrottlingException {
137
- /**
138
- * @internal
139
- */
140
- export const filterSensitiveLog = (obj: ThrottlingException): any => ({
141
- ...obj,
142
- });
143
- }
144
-
145
- /**
146
- * <p>A generic address associated with the customer that is not mailing, shipping, or
147
- * billing.</p>
148
- */
149
- export interface Address {
150
- /**
151
- * <p>The first line of a customer address.</p>
152
- */
153
- Address1?: string;
154
-
155
- /**
156
- * <p>The second line of a customer address.</p>
157
- */
158
- Address2?: string;
159
-
160
- /**
161
- * <p>The third line of a customer address.</p>
162
- */
163
- Address3?: string;
164
-
165
- /**
166
- * <p>The fourth line of a customer address.</p>
167
- */
168
- Address4?: string;
169
-
170
- /**
171
- * <p>The city in which a customer lives.</p>
172
- */
173
- City?: string;
174
-
175
- /**
176
- * <p>The county in which a customer lives.</p>
177
- */
178
- County?: string;
179
-
180
- /**
181
- * <p>The state in which a customer lives.</p>
182
- */
183
- State?: string;
184
-
185
- /**
186
- * <p>The province in which a customer lives.</p>
187
- */
188
- Province?: string;
189
-
190
- /**
191
- * <p>The country in which a customer lives.</p>
192
- */
193
- Country?: string;
194
-
195
- /**
196
- * <p>The postal code of a customer address.</p>
197
- */
198
- PostalCode?: string;
199
- }
200
-
201
- export namespace Address {
202
- /**
203
- * @internal
204
- */
205
- export const filterSensitiveLog = (obj: Address): any => ({
206
- ...obj,
207
- });
208
- }
209
-
210
- export enum MarketoConnectorOperator {
211
- ADDITION = "ADDITION",
212
- BETWEEN = "BETWEEN",
213
- DIVISION = "DIVISION",
214
- GREATER_THAN = "GREATER_THAN",
215
- LESS_THAN = "LESS_THAN",
216
- MASK_ALL = "MASK_ALL",
217
- MASK_FIRST_N = "MASK_FIRST_N",
218
- MASK_LAST_N = "MASK_LAST_N",
219
- MULTIPLICATION = "MULTIPLICATION",
220
- NO_OP = "NO_OP",
221
- PROJECTION = "PROJECTION",
222
- SUBTRACTION = "SUBTRACTION",
223
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
224
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
225
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
226
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
227
- }
228
-
229
- export enum S3ConnectorOperator {
230
- ADDITION = "ADDITION",
231
- BETWEEN = "BETWEEN",
232
- DIVISION = "DIVISION",
233
- EQUAL_TO = "EQUAL_TO",
234
- GREATER_THAN = "GREATER_THAN",
235
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
236
- LESS_THAN = "LESS_THAN",
237
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
238
- MASK_ALL = "MASK_ALL",
239
- MASK_FIRST_N = "MASK_FIRST_N",
240
- MASK_LAST_N = "MASK_LAST_N",
241
- MULTIPLICATION = "MULTIPLICATION",
242
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
243
- NO_OP = "NO_OP",
244
- PROJECTION = "PROJECTION",
245
- SUBTRACTION = "SUBTRACTION",
246
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
247
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
248
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
249
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
250
- }
251
-
252
- export enum SalesforceConnectorOperator {
253
- ADDITION = "ADDITION",
254
- BETWEEN = "BETWEEN",
255
- CONTAINS = "CONTAINS",
256
- DIVISION = "DIVISION",
257
- EQUAL_TO = "EQUAL_TO",
258
- GREATER_THAN = "GREATER_THAN",
259
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
260
- LESS_THAN = "LESS_THAN",
261
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
262
- MASK_ALL = "MASK_ALL",
263
- MASK_FIRST_N = "MASK_FIRST_N",
264
- MASK_LAST_N = "MASK_LAST_N",
265
- MULTIPLICATION = "MULTIPLICATION",
266
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
267
- NO_OP = "NO_OP",
268
- PROJECTION = "PROJECTION",
269
- SUBTRACTION = "SUBTRACTION",
270
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
271
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
272
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
273
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
274
- }
275
-
276
- export enum ServiceNowConnectorOperator {
277
- ADDITION = "ADDITION",
278
- BETWEEN = "BETWEEN",
279
- CONTAINS = "CONTAINS",
280
- DIVISION = "DIVISION",
281
- EQUAL_TO = "EQUAL_TO",
282
- GREATER_THAN = "GREATER_THAN",
283
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
284
- LESS_THAN = "LESS_THAN",
285
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
286
- MASK_ALL = "MASK_ALL",
287
- MASK_FIRST_N = "MASK_FIRST_N",
288
- MASK_LAST_N = "MASK_LAST_N",
289
- MULTIPLICATION = "MULTIPLICATION",
290
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
291
- NO_OP = "NO_OP",
292
- PROJECTION = "PROJECTION",
293
- SUBTRACTION = "SUBTRACTION",
294
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
295
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
296
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
297
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
298
- }
299
-
300
- export enum ZendeskConnectorOperator {
301
- ADDITION = "ADDITION",
302
- DIVISION = "DIVISION",
303
- GREATER_THAN = "GREATER_THAN",
304
- MASK_ALL = "MASK_ALL",
305
- MASK_FIRST_N = "MASK_FIRST_N",
306
- MASK_LAST_N = "MASK_LAST_N",
307
- MULTIPLICATION = "MULTIPLICATION",
308
- NO_OP = "NO_OP",
309
- PROJECTION = "PROJECTION",
310
- SUBTRACTION = "SUBTRACTION",
311
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
312
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
313
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
314
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
315
- }
316
-
317
- /**
318
- * <p>The operation to be performed on the provided source fields.</p>
319
- */
320
- export interface ConnectorOperator {
321
- /**
322
- * <p>The operation to be performed on the provided Marketo source fields.</p>
323
- */
324
- Marketo?: MarketoConnectorOperator | string;
325
-
326
- /**
327
- * <p>The operation to be performed on the provided Amazon S3 source fields.</p>
328
- */
329
- S3?: S3ConnectorOperator | string;
330
-
331
- /**
332
- * <p>The operation to be performed on the provided Salesforce source fields.</p>
333
- */
334
- Salesforce?: SalesforceConnectorOperator | string;
335
-
336
- /**
337
- * <p>The operation to be performed on the provided ServiceNow source fields.</p>
338
- */
339
- ServiceNow?: ServiceNowConnectorOperator | string;
340
-
341
- /**
342
- * <p>The operation to be performed on the provided Zendesk source fields.</p>
343
- */
344
- Zendesk?: ZendeskConnectorOperator | string;
345
- }
346
-
347
- export namespace ConnectorOperator {
348
- /**
349
- * @internal
350
- */
351
- export const filterSensitiveLog = (obj: ConnectorOperator): any => ({
352
- ...obj,
353
- });
354
- }
355
-
356
- /**
357
- * <p>The flag that enables the matching process of duplicate profiles.</p>
358
- */
359
- export interface MatchingRequest {
360
- /**
361
- * <p>The flag that enables the matching process of duplicate profiles.</p>
362
- */
363
- Enabled: boolean | undefined;
364
- }
365
-
366
- export namespace MatchingRequest {
367
- /**
368
- * @internal
369
- */
370
- export const filterSensitiveLog = (obj: MatchingRequest): any => ({
371
- ...obj,
372
- });
373
- }
374
-
375
- export interface CreateDomainRequest {
376
- /**
377
- * <p>The unique name of the domain.</p>
378
- */
379
- DomainName: string | undefined;
380
-
381
- /**
382
- * <p>The default number of days until the data within the domain expires.</p>
383
- */
384
- DefaultExpirationDays: number | undefined;
385
-
386
- /**
387
- * <p>The default encryption key, which is an AWS managed key, is used when no specific type
388
- * of encryption key is specified. It is used to encrypt all data before it is placed in
389
- * permanent or semi-permanent storage.</p>
390
- */
391
- DefaultEncryptionKey?: string;
392
-
393
- /**
394
- * <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
395
- * ingesting data from third party applications. You must set up a policy on the
396
- * DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send
397
- * messages to the DeadLetterQueue.</p>
398
- */
399
- DeadLetterQueueUrl?: string;
400
-
401
- /**
402
- * <p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains.
403
- * After that batch process completes, use the
404
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
405
- * API to return and review the results. </p>
406
- */
407
- Matching?: MatchingRequest;
408
-
409
- /**
410
- * <p>The tags used to organize, track, or control access for this resource.</p>
411
- */
412
- Tags?: { [key: string]: string };
413
- }
414
-
415
- export namespace CreateDomainRequest {
416
- /**
417
- * @internal
418
- */
419
- export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({
420
- ...obj,
421
- });
422
- }
423
-
424
- /**
425
- * <p>The flag that enables the matching process of duplicate profiles.</p>
426
- */
427
- export interface MatchingResponse {
428
- /**
429
- * <p>The flag that enables the matching process of duplicate profiles.</p>
430
- */
431
- Enabled?: boolean;
432
- }
433
-
434
- export namespace MatchingResponse {
435
- /**
436
- * @internal
437
- */
438
- export const filterSensitiveLog = (obj: MatchingResponse): any => ({
439
- ...obj,
440
- });
441
- }
442
-
443
- export interface CreateDomainResponse {
444
- /**
445
- * <p>The unique name of the domain.</p>
446
- */
447
- DomainName: string | undefined;
448
-
449
- /**
450
- * <p>The default number of days until the data within the domain expires.</p>
451
- */
452
- DefaultExpirationDays: number | undefined;
453
-
454
- /**
455
- * <p>The default encryption key, which is an AWS managed key, is used when no specific type
456
- * of encryption key is specified. It is used to encrypt all data before it is placed in
457
- * permanent or semi-permanent storage.</p>
458
- */
459
- DefaultEncryptionKey?: string;
460
-
461
- /**
462
- * <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
463
- * ingesting data from third party applications.</p>
464
- */
465
- DeadLetterQueueUrl?: string;
466
-
467
- /**
468
- * <p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains.
469
- * After that batch process completes, use the
470
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
471
- * API to return and review the results. </p>
472
- */
473
- Matching?: MatchingResponse;
474
-
475
- /**
476
- * <p>The timestamp of when the domain was created.</p>
477
- */
478
- CreatedAt: Date | undefined;
479
-
480
- /**
481
- * <p>The timestamp of when the domain was most recently edited.</p>
482
- */
483
- LastUpdatedAt: Date | undefined;
484
-
485
- /**
486
- * <p>The tags used to organize, track, or control access for this resource.</p>
487
- */
488
- Tags?: { [key: string]: string };
489
- }
490
-
491
- export namespace CreateDomainResponse {
492
- /**
493
- * @internal
494
- */
495
- export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({
496
- ...obj,
497
- });
498
- }
499
-
500
- export enum Gender {
501
- FEMALE = "FEMALE",
502
- MALE = "MALE",
503
- UNSPECIFIED = "UNSPECIFIED",
504
- }
505
-
506
- export enum PartyType {
507
- BUSINESS = "BUSINESS",
508
- INDIVIDUAL = "INDIVIDUAL",
509
- OTHER = "OTHER",
510
- }
511
-
512
- export interface CreateProfileRequest {
513
- /**
514
- * <p>The unique name of the domain.</p>
515
- */
516
- DomainName: string | undefined;
517
-
518
- /**
519
- * <p>A unique account number that you have given to the customer.</p>
520
- */
521
- AccountNumber?: string;
522
-
523
- /**
524
- * <p>Any additional information relevant to the customer’s profile.</p>
525
- */
526
- AdditionalInformation?: string;
527
-
528
- /**
529
- * <p>The type of profile used to describe the customer.</p>
530
- */
531
- PartyType?: PartyType | string;
532
-
533
- /**
534
- * <p>The name of the customer’s business.</p>
535
- */
536
- BusinessName?: string;
537
-
538
- /**
539
- * <p>The customer’s first name.</p>
540
- */
541
- FirstName?: string;
542
-
543
- /**
544
- * <p>The customer’s middle name.</p>
545
- */
546
- MiddleName?: string;
547
-
548
- /**
549
- * <p>The customer’s last name.</p>
550
- */
551
- LastName?: string;
552
-
553
- /**
554
- * <p>The customer’s birth date. </p>
555
- */
556
- BirthDate?: string;
557
-
558
- /**
559
- * <p>The gender with which the customer identifies. </p>
560
- */
561
- Gender?: Gender | string;
562
-
563
- /**
564
- * <p>The customer’s phone number, which has not been specified as a mobile, home, or business
565
- * number. </p>
566
- */
567
- PhoneNumber?: string;
568
-
569
- /**
570
- * <p>The customer’s mobile phone number.</p>
571
- */
572
- MobilePhoneNumber?: string;
573
-
574
- /**
575
- * <p>The customer’s home phone number.</p>
576
- */
577
- HomePhoneNumber?: string;
578
-
579
- /**
580
- * <p>The customer’s business phone number.</p>
581
- */
582
- BusinessPhoneNumber?: string;
583
-
584
- /**
585
- * <p>The customer’s email address, which has not been specified as a personal or business
586
- * address. </p>
587
- */
588
- EmailAddress?: string;
589
-
590
- /**
591
- * <p>The customer’s personal email address.</p>
592
- */
593
- PersonalEmailAddress?: string;
594
-
595
- /**
596
- * <p>The customer’s business email address.</p>
597
- */
598
- BusinessEmailAddress?: string;
599
-
600
- /**
601
- * <p>A generic address associated with the customer that is not mailing, shipping, or
602
- * billing.</p>
603
- */
604
- Address?: Address;
605
-
606
- /**
607
- * <p>The customer’s shipping address.</p>
608
- */
609
- ShippingAddress?: Address;
610
-
611
- /**
612
- * <p>The customer’s mailing address.</p>
613
- */
614
- MailingAddress?: Address;
615
-
616
- /**
617
- * <p>The customer’s billing address.</p>
618
- */
619
- BillingAddress?: Address;
620
-
621
- /**
622
- * <p>A key value pair of attributes of a customer profile.</p>
623
- */
624
- Attributes?: { [key: string]: string };
625
- }
626
-
627
- export namespace CreateProfileRequest {
628
- /**
629
- * @internal
630
- */
631
- export const filterSensitiveLog = (obj: CreateProfileRequest): any => ({
632
- ...obj,
633
- });
634
- }
635
-
636
- export interface CreateProfileResponse {
637
- /**
638
- * <p>The unique identifier of a customer profile.</p>
639
- */
640
- ProfileId: string | undefined;
641
- }
642
-
643
- export namespace CreateProfileResponse {
644
- /**
645
- * @internal
646
- */
647
- export const filterSensitiveLog = (obj: CreateProfileResponse): any => ({
648
- ...obj,
649
- });
650
- }
651
-
652
- export interface DeleteDomainRequest {
653
- /**
654
- * <p>The unique name of the domain.</p>
655
- */
656
- DomainName: string | undefined;
657
- }
658
-
659
- export namespace DeleteDomainRequest {
660
- /**
661
- * @internal
662
- */
663
- export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({
664
- ...obj,
665
- });
666
- }
667
-
668
- export interface DeleteDomainResponse {
669
- /**
670
- * <p>A message that indicates the delete request is done.</p>
671
- */
672
- Message: string | undefined;
673
- }
674
-
675
- export namespace DeleteDomainResponse {
676
- /**
677
- * @internal
678
- */
679
- export const filterSensitiveLog = (obj: DeleteDomainResponse): any => ({
680
- ...obj,
681
- });
682
- }
683
-
684
- export interface DeleteIntegrationRequest {
685
- /**
686
- * <p>The unique name of the domain.</p>
687
- */
688
- DomainName: string | undefined;
689
-
690
- /**
691
- * <p>The URI of the S3 bucket or any other type of data source.</p>
692
- */
693
- Uri: string | undefined;
694
- }
695
-
696
- export namespace DeleteIntegrationRequest {
697
- /**
698
- * @internal
699
- */
700
- export const filterSensitiveLog = (obj: DeleteIntegrationRequest): any => ({
701
- ...obj,
702
- });
703
- }
704
-
705
- export interface DeleteIntegrationResponse {
706
- /**
707
- * <p>A message that indicates the delete request is done.</p>
708
- */
709
- Message: string | undefined;
710
- }
711
-
712
- export namespace DeleteIntegrationResponse {
713
- /**
714
- * @internal
715
- */
716
- export const filterSensitiveLog = (obj: DeleteIntegrationResponse): any => ({
717
- ...obj,
718
- });
719
- }
720
-
721
- export interface DeleteProfileRequest {
722
- /**
723
- * <p>The unique identifier of a customer profile.</p>
724
- */
725
- ProfileId: string | undefined;
726
-
727
- /**
728
- * <p>The unique name of the domain.</p>
729
- */
730
- DomainName: string | undefined;
731
- }
732
-
733
- export namespace DeleteProfileRequest {
734
- /**
735
- * @internal
736
- */
737
- export const filterSensitiveLog = (obj: DeleteProfileRequest): any => ({
738
- ...obj,
739
- });
740
- }
741
-
742
- export interface DeleteProfileResponse {
743
- /**
744
- * <p>A message that indicates the delete request is done.</p>
745
- */
746
- Message?: string;
747
- }
748
-
749
- export namespace DeleteProfileResponse {
750
- /**
751
- * @internal
752
- */
753
- export const filterSensitiveLog = (obj: DeleteProfileResponse): any => ({
754
- ...obj,
755
- });
756
- }
757
-
758
- export interface DeleteProfileKeyRequest {
759
- /**
760
- * <p>The unique identifier of a customer profile.</p>
761
- */
762
- ProfileId: string | undefined;
763
-
764
- /**
765
- * <p>A searchable identifier of a customer profile.</p>
766
- */
767
- KeyName: string | undefined;
768
-
769
- /**
770
- * <p>A list of key values.</p>
771
- */
772
- Values: string[] | undefined;
773
-
774
- /**
775
- * <p>The unique name of the domain.</p>
776
- */
777
- DomainName: string | undefined;
778
- }
779
-
780
- export namespace DeleteProfileKeyRequest {
781
- /**
782
- * @internal
783
- */
784
- export const filterSensitiveLog = (obj: DeleteProfileKeyRequest): any => ({
785
- ...obj,
786
- });
787
- }
788
-
789
- export interface DeleteProfileKeyResponse {
790
- /**
791
- * <p>A message that indicates the delete request is done.</p>
792
- */
793
- Message?: string;
794
- }
795
-
796
- export namespace DeleteProfileKeyResponse {
797
- /**
798
- * @internal
799
- */
800
- export const filterSensitiveLog = (obj: DeleteProfileKeyResponse): any => ({
801
- ...obj,
802
- });
803
- }
804
-
805
- export interface DeleteProfileObjectRequest {
806
- /**
807
- * <p>The unique identifier of a customer profile.</p>
808
- */
809
- ProfileId: string | undefined;
810
-
811
- /**
812
- * <p>The unique identifier of the profile object generated by the service.</p>
813
- */
814
- ProfileObjectUniqueKey: string | undefined;
815
-
816
- /**
817
- * <p>The name of the profile object type.</p>
818
- */
819
- ObjectTypeName: string | undefined;
820
-
821
- /**
822
- * <p>The unique name of the domain.</p>
823
- */
824
- DomainName: string | undefined;
825
- }
826
-
827
- export namespace DeleteProfileObjectRequest {
828
- /**
829
- * @internal
830
- */
831
- export const filterSensitiveLog = (obj: DeleteProfileObjectRequest): any => ({
832
- ...obj,
833
- });
834
- }
835
-
836
- export interface DeleteProfileObjectResponse {
837
- /**
838
- * <p>A message that indicates the delete request is done.</p>
839
- */
840
- Message?: string;
841
- }
842
-
843
- export namespace DeleteProfileObjectResponse {
844
- /**
845
- * @internal
846
- */
847
- export const filterSensitiveLog = (obj: DeleteProfileObjectResponse): any => ({
848
- ...obj,
849
- });
850
- }
851
-
852
- export interface DeleteProfileObjectTypeRequest {
853
- /**
854
- * <p>The unique name of the domain.</p>
855
- */
856
- DomainName: string | undefined;
857
-
858
- /**
859
- * <p>The name of the profile object type.</p>
860
- */
861
- ObjectTypeName: string | undefined;
862
- }
863
-
864
- export namespace DeleteProfileObjectTypeRequest {
865
- /**
866
- * @internal
867
- */
868
- export const filterSensitiveLog = (obj: DeleteProfileObjectTypeRequest): any => ({
869
- ...obj,
870
- });
871
- }
872
-
873
- export interface DeleteProfileObjectTypeResponse {
874
- /**
875
- * <p>A message that indicates the delete request is done.</p>
876
- */
877
- Message: string | undefined;
878
- }
879
-
880
- export namespace DeleteProfileObjectTypeResponse {
881
- /**
882
- * @internal
883
- */
884
- export const filterSensitiveLog = (obj: DeleteProfileObjectTypeResponse): any => ({
885
- ...obj,
886
- });
887
- }
888
-
889
- export interface GetDomainRequest {
890
- /**
891
- * <p>The unique name of the domain.</p>
892
- */
893
- DomainName: string | undefined;
894
- }
895
-
896
- export namespace GetDomainRequest {
897
- /**
898
- * @internal
899
- */
900
- export const filterSensitiveLog = (obj: GetDomainRequest): any => ({
901
- ...obj,
902
- });
903
- }
904
-
905
- /**
906
- * <p>Usage-specific statistics about the domain.</p>
907
- */
908
- export interface DomainStats {
909
- /**
910
- * <p>The total number of profiles currently in the domain.</p>
911
- */
912
- ProfileCount?: number;
913
-
914
- /**
915
- * <p>The number of profiles that you are currently paying for in the domain. If you have more
916
- * than 100 objects associated with a single profile, that profile counts as two profiles. If
917
- * you have more than 200 objects, that profile counts as three, and so on.</p>
918
- */
919
- MeteringProfileCount?: number;
920
-
921
- /**
922
- * <p>The total number of objects in domain.</p>
923
- */
924
- ObjectCount?: number;
925
-
926
- /**
927
- * <p>The total size, in bytes, of all objects in the domain.</p>
928
- */
929
- TotalSize?: number;
930
- }
931
-
932
- export namespace DomainStats {
933
- /**
934
- * @internal
935
- */
936
- export const filterSensitiveLog = (obj: DomainStats): any => ({
937
- ...obj,
938
- });
939
- }
940
-
941
- export interface GetDomainResponse {
942
- /**
943
- * <p>The unique name of the domain.</p>
944
- */
945
- DomainName: string | undefined;
946
-
947
- /**
948
- * <p>The default number of days until the data within the domain expires.</p>
949
- */
950
- DefaultExpirationDays?: number;
951
-
952
- /**
953
- * <p>The default encryption key, which is an AWS managed key, is used when no specific type
954
- * of encryption key is specified. It is used to encrypt all data before it is placed in
955
- * permanent or semi-permanent storage.</p>
956
- */
957
- DefaultEncryptionKey?: string;
958
-
959
- /**
960
- * <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
961
- * ingesting data from third party applications.</p>
962
- */
963
- DeadLetterQueueUrl?: string;
964
-
965
- /**
966
- * <p>Usage-specific statistics about the domain.</p>
967
- */
968
- Stats?: DomainStats;
969
-
970
- /**
971
- * <p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains.
972
- * After that batch process completes, use the
973
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
974
- * API to return and review the results. </p>
975
- */
976
- Matching?: MatchingResponse;
977
-
978
- /**
979
- * <p>The timestamp of when the domain was created.</p>
980
- */
981
- CreatedAt: Date | undefined;
982
-
983
- /**
984
- * <p>The timestamp of when the domain was most recently edited.</p>
985
- */
986
- LastUpdatedAt: Date | undefined;
987
-
988
- /**
989
- * <p>The tags used to organize, track, or control access for this resource.</p>
990
- */
991
- Tags?: { [key: string]: string };
992
- }
993
-
994
- export namespace GetDomainResponse {
995
- /**
996
- * @internal
997
- */
998
- export const filterSensitiveLog = (obj: GetDomainResponse): any => ({
999
- ...obj,
1000
- });
1001
- }
1002
-
1003
- export interface GetIntegrationRequest {
1004
- /**
1005
- * <p>The unique name of the domain.</p>
1006
- */
1007
- DomainName: string | undefined;
1008
-
1009
- /**
1010
- * <p>The URI of the S3 bucket or any other type of data source.</p>
1011
- */
1012
- Uri: string | undefined;
1013
- }
1014
-
1015
- export namespace GetIntegrationRequest {
1016
- /**
1017
- * @internal
1018
- */
1019
- export const filterSensitiveLog = (obj: GetIntegrationRequest): any => ({
1020
- ...obj,
1021
- });
1022
- }
1023
-
1024
- export interface GetIntegrationResponse {
1025
- /**
1026
- * <p>The unique name of the domain.</p>
1027
- */
1028
- DomainName: string | undefined;
1029
-
1030
- /**
1031
- * <p>The URI of the S3 bucket or any other type of data source.</p>
1032
- */
1033
- Uri: string | undefined;
1034
-
1035
- /**
1036
- * <p>The name of the profile object type.</p>
1037
- */
1038
- ObjectTypeName: string | undefined;
1039
-
1040
- /**
1041
- * <p>The timestamp of when the domain was created.</p>
1042
- */
1043
- CreatedAt: Date | undefined;
1044
-
1045
- /**
1046
- * <p>The timestamp of when the domain was most recently edited.</p>
1047
- */
1048
- LastUpdatedAt: Date | undefined;
1049
-
1050
- /**
1051
- * <p>The tags used to organize, track, or control access for this resource.</p>
1052
- */
1053
- Tags?: { [key: string]: string };
1054
- }
1055
-
1056
- export namespace GetIntegrationResponse {
1057
- /**
1058
- * @internal
1059
- */
1060
- export const filterSensitiveLog = (obj: GetIntegrationResponse): any => ({
1061
- ...obj,
1062
- });
1063
- }
1064
-
1065
- export interface GetMatchesRequest {
1066
- /**
1067
- * <p>The token for the next set of results. Use the value returned in the previous
1068
- * response in the next request to retrieve the next set of results.</p>
1069
- */
1070
- NextToken?: string;
1071
-
1072
- /**
1073
- * <p>The maximum number of results to return per page.</p>
1074
- */
1075
- MaxResults?: number;
1076
-
1077
- /**
1078
- * <p>The unique name of the domain.</p>
1079
- */
1080
- DomainName: string | undefined;
1081
- }
1082
-
1083
- export namespace GetMatchesRequest {
1084
- /**
1085
- * @internal
1086
- */
1087
- export const filterSensitiveLog = (obj: GetMatchesRequest): any => ({
1088
- ...obj,
1089
- });
1090
- }
1091
-
1092
- /**
1093
- * <p>The Match group object.</p>
1094
- */
1095
- export interface MatchItem {
1096
- /**
1097
- * <p>The unique identifiers for this group of profiles that match.</p>
1098
- */
1099
- MatchId?: string;
1100
-
1101
- /**
1102
- * <p>A list of identifiers for profiles that match.</p>
1103
- */
1104
- ProfileIds?: string[];
1105
- }
1106
-
1107
- export namespace MatchItem {
1108
- /**
1109
- * @internal
1110
- */
1111
- export const filterSensitiveLog = (obj: MatchItem): any => ({
1112
- ...obj,
1113
- });
1114
- }
1115
-
1116
- export interface GetMatchesResponse {
1117
- /**
1118
- * <p>If there are additional results, this is the token for the next set of results.</p>
1119
- */
1120
- NextToken?: string;
1121
-
1122
- /**
1123
- * <p>The timestamp this version of Match Result generated.</p>
1124
- */
1125
- MatchGenerationDate?: Date;
1126
-
1127
- /**
1128
- * <p>The number of potential matches found.</p>
1129
- */
1130
- PotentialMatches?: number;
1131
-
1132
- /**
1133
- * <p>The list of matched profiles for this instance.</p>
1134
- */
1135
- Matches?: MatchItem[];
1136
- }
1137
-
1138
- export namespace GetMatchesResponse {
1139
- /**
1140
- * @internal
1141
- */
1142
- export const filterSensitiveLog = (obj: GetMatchesResponse): any => ({
1143
- ...obj,
1144
- });
1145
- }
1146
-
1147
- export interface GetProfileObjectTypeRequest {
1148
- /**
1149
- * <p>The unique name of the domain.</p>
1150
- */
1151
- DomainName: string | undefined;
1152
-
1153
- /**
1154
- * <p>The name of the profile object type.</p>
1155
- */
1156
- ObjectTypeName: string | undefined;
1157
- }
1158
-
1159
- export namespace GetProfileObjectTypeRequest {
1160
- /**
1161
- * @internal
1162
- */
1163
- export const filterSensitiveLog = (obj: GetProfileObjectTypeRequest): any => ({
1164
- ...obj,
1165
- });
1166
- }
1167
-
1168
- export enum FieldContentType {
1169
- EMAIL_ADDRESS = "EMAIL_ADDRESS",
1170
- NAME = "NAME",
1171
- NUMBER = "NUMBER",
1172
- PHONE_NUMBER = "PHONE_NUMBER",
1173
- STRING = "STRING",
1174
- }
1175
-
1176
- /**
1177
- * <p>Represents a field in a ProfileObjectType.</p>
1178
- */
1179
- export interface ObjectTypeField {
1180
- /**
1181
- * <p>A field of a ProfileObject. For example: _source.FirstName, where “_source” is a
1182
- * ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.</p>
1183
- */
1184
- Source?: string;
1185
-
1186
- /**
1187
- * <p>The location of the data in the standard ProfileObject model. For example:
1188
- * _profile.Address.PostalCode.</p>
1189
- */
1190
- Target?: string;
1191
-
1192
- /**
1193
- * <p>The content type of the field. Used for determining equality when searching.</p>
1194
- */
1195
- ContentType?: FieldContentType | string;
1196
- }
1197
-
1198
- export namespace ObjectTypeField {
1199
- /**
1200
- * @internal
1201
- */
1202
- export const filterSensitiveLog = (obj: ObjectTypeField): any => ({
1203
- ...obj,
1204
- });
1205
- }
1206
-
1207
- export enum StandardIdentifier {
1208
- ASSET = "ASSET",
1209
- CASE = "CASE",
1210
- LOOKUP_ONLY = "LOOKUP_ONLY",
1211
- NEW_ONLY = "NEW_ONLY",
1212
- PROFILE = "PROFILE",
1213
- SECONDARY = "SECONDARY",
1214
- UNIQUE = "UNIQUE",
1215
- }
1216
-
1217
- /**
1218
- * <p>An object that defines the Key element of a ProfileObject. A Key is a special element
1219
- * that can be used to search for a customer profile.</p>
1220
- */
1221
- export interface ObjectTypeKey {
1222
- /**
1223
- * <p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1
1224
- * UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an
1225
- * object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be used to uniquely identify an object.
1226
- * If a key a is marked as SECONDARY, it will be used to search for profiles after all other
1227
- * PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is
1228
- * not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the
1229
- * profile does not already exist before the object is ingested, otherwise it is only used for
1230
- * matching objects to profiles.</p>
1231
- */
1232
- StandardIdentifiers?: (StandardIdentifier | string)[];
1233
-
1234
- /**
1235
- * <p>The reference for the key name of the fields map.</p>
1236
- */
1237
- FieldNames?: string[];
1238
- }
1239
-
1240
- export namespace ObjectTypeKey {
1241
- /**
1242
- * @internal
1243
- */
1244
- export const filterSensitiveLog = (obj: ObjectTypeKey): any => ({
1245
- ...obj,
1246
- });
1247
- }
1248
-
1249
- export interface GetProfileObjectTypeResponse {
1250
- /**
1251
- * <p>The name of the profile object type.</p>
1252
- */
1253
- ObjectTypeName: string | undefined;
1254
-
1255
- /**
1256
- * <p>The description of the profile object type.</p>
1257
- */
1258
- Description: string | undefined;
1259
-
1260
- /**
1261
- * <p>A unique identifier for the object template.</p>
1262
- */
1263
- TemplateId?: string;
1264
-
1265
- /**
1266
- * <p>The number of days until the data in the object expires.</p>
1267
- */
1268
- ExpirationDays?: number;
1269
-
1270
- /**
1271
- * <p>The customer-provided key to encrypt the profile object that will be created in this
1272
- * profile object type.</p>
1273
- */
1274
- EncryptionKey?: string;
1275
-
1276
- /**
1277
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
1278
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
1279
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
1280
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
1281
- * is found, then the service creates a new standard profile.</p>
1282
- */
1283
- AllowProfileCreation?: boolean;
1284
-
1285
- /**
1286
- * <p>A map of the name and ObjectType field.</p>
1287
- */
1288
- Fields?: { [key: string]: ObjectTypeField };
1289
-
1290
- /**
1291
- * <p>A list of unique keys that can be used to map data to the profile.</p>
1292
- */
1293
- Keys?: { [key: string]: ObjectTypeKey[] };
1294
-
1295
- /**
1296
- * <p>The timestamp of when the domain was created.</p>
1297
- */
1298
- CreatedAt?: Date;
1299
-
1300
- /**
1301
- * <p>The timestamp of when the domain was most recently edited.</p>
1302
- */
1303
- LastUpdatedAt?: Date;
1304
-
1305
- /**
1306
- * <p>The tags used to organize, track, or control access for this resource.</p>
1307
- */
1308
- Tags?: { [key: string]: string };
1309
- }
1310
-
1311
- export namespace GetProfileObjectTypeResponse {
1312
- /**
1313
- * @internal
1314
- */
1315
- export const filterSensitiveLog = (obj: GetProfileObjectTypeResponse): any => ({
1316
- ...obj,
1317
- });
1318
- }
1319
-
1320
- export interface GetProfileObjectTypeTemplateRequest {
1321
- /**
1322
- * <p>A unique identifier for the object template.</p>
1323
- */
1324
- TemplateId: string | undefined;
1325
- }
1326
-
1327
- export namespace GetProfileObjectTypeTemplateRequest {
1328
- /**
1329
- * @internal
1330
- */
1331
- export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateRequest): any => ({
1332
- ...obj,
1333
- });
1334
- }
1335
-
1336
- export interface GetProfileObjectTypeTemplateResponse {
1337
- /**
1338
- * <p>A unique identifier for the object template.</p>
1339
- */
1340
- TemplateId?: string;
1341
-
1342
- /**
1343
- * <p>The name of the source of the object template.</p>
1344
- */
1345
- SourceName?: string;
1346
-
1347
- /**
1348
- * <p>The source of the object template.</p>
1349
- */
1350
- SourceObject?: string;
1351
-
1352
- /**
1353
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
1354
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
1355
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
1356
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
1357
- * is found, then the service creates a new standard profile.</p>
1358
- */
1359
- AllowProfileCreation?: boolean;
1360
-
1361
- /**
1362
- * <p>A map of the name and ObjectType field.</p>
1363
- */
1364
- Fields?: { [key: string]: ObjectTypeField };
1365
-
1366
- /**
1367
- * <p>A list of unique keys that can be used to map data to the profile.</p>
1368
- */
1369
- Keys?: { [key: string]: ObjectTypeKey[] };
1370
- }
1371
-
1372
- export namespace GetProfileObjectTypeTemplateResponse {
1373
- /**
1374
- * @internal
1375
- */
1376
- export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateResponse): any => ({
1377
- ...obj,
1378
- });
1379
- }
1380
-
1381
- export interface ListAccountIntegrationsRequest {
1382
- /**
1383
- * <p>The URI of the S3 bucket or any other type of data source.</p>
1384
- */
1385
- Uri: string | undefined;
1386
-
1387
- /**
1388
- * <p>The pagination token from the previous ListAccountIntegrations API call.</p>
1389
- */
1390
- NextToken?: string;
1391
-
1392
- /**
1393
- * <p>The maximum number of objects returned per page.</p>
1394
- */
1395
- MaxResults?: number;
1396
- }
1397
-
1398
- export namespace ListAccountIntegrationsRequest {
1399
- /**
1400
- * @internal
1401
- */
1402
- export const filterSensitiveLog = (obj: ListAccountIntegrationsRequest): any => ({
1403
- ...obj,
1404
- });
1405
- }
1406
-
1407
- /**
1408
- * <p>An integration in list of integrations.</p>
1409
- */
1410
- export interface ListIntegrationItem {
1411
- /**
1412
- * <p>The unique name of the domain.</p>
1413
- */
1414
- DomainName: string | undefined;
1415
-
1416
- /**
1417
- * <p>The URI of the S3 bucket or any other type of data source.</p>
1418
- */
1419
- Uri: string | undefined;
1420
-
1421
- /**
1422
- * <p>The name of the profile object type.</p>
1423
- */
1424
- ObjectTypeName: string | undefined;
1425
-
1426
- /**
1427
- * <p>The timestamp of when the domain was created.</p>
1428
- */
1429
- CreatedAt: Date | undefined;
1430
-
1431
- /**
1432
- * <p>The timestamp of when the domain was most recently edited.</p>
1433
- */
1434
- LastUpdatedAt: Date | undefined;
1435
-
1436
- /**
1437
- * <p>The tags used to organize, track, or control access for this resource.</p>
1438
- */
1439
- Tags?: { [key: string]: string };
1440
- }
1441
-
1442
- export namespace ListIntegrationItem {
1443
- /**
1444
- * @internal
1445
- */
1446
- export const filterSensitiveLog = (obj: ListIntegrationItem): any => ({
1447
- ...obj,
1448
- });
1449
- }
1450
-
1451
- export interface ListAccountIntegrationsResponse {
1452
- /**
1453
- * <p>The list of ListAccountIntegration instances.</p>
1454
- */
1455
- Items?: ListIntegrationItem[];
1456
-
1457
- /**
1458
- * <p>The pagination token from the previous ListAccountIntegrations API call.</p>
1459
- */
1460
- NextToken?: string;
1461
- }
1462
-
1463
- export namespace ListAccountIntegrationsResponse {
1464
- /**
1465
- * @internal
1466
- */
1467
- export const filterSensitiveLog = (obj: ListAccountIntegrationsResponse): any => ({
1468
- ...obj,
1469
- });
1470
- }
1471
-
1472
- export interface ListDomainsRequest {
1473
- /**
1474
- * <p>The pagination token from the previous ListDomain API call.</p>
1475
- */
1476
- NextToken?: string;
1477
-
1478
- /**
1479
- * <p>The maximum number of objects returned per page.</p>
1480
- */
1481
- MaxResults?: number;
1482
- }
1483
-
1484
- export namespace ListDomainsRequest {
1485
- /**
1486
- * @internal
1487
- */
1488
- export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({
1489
- ...obj,
1490
- });
1491
- }
1492
-
1493
- /**
1494
- * <p>An object in a list that represents a domain.</p>
1495
- */
1496
- export interface ListDomainItem {
1497
- /**
1498
- * <p>The unique name of the domain.</p>
1499
- */
1500
- DomainName: string | undefined;
1501
-
1502
- /**
1503
- * <p>The timestamp of when the domain was created.</p>
1504
- */
1505
- CreatedAt: Date | undefined;
1506
-
1507
- /**
1508
- * <p>The timestamp of when the domain was most recently edited.</p>
1509
- */
1510
- LastUpdatedAt: Date | undefined;
1511
-
1512
- /**
1513
- * <p>The tags used to organize, track, or control access for this resource.</p>
1514
- */
1515
- Tags?: { [key: string]: string };
1516
- }
1517
-
1518
- export namespace ListDomainItem {
1519
- /**
1520
- * @internal
1521
- */
1522
- export const filterSensitiveLog = (obj: ListDomainItem): any => ({
1523
- ...obj,
1524
- });
1525
- }
1526
-
1527
- export interface ListDomainsResponse {
1528
- /**
1529
- * <p>The list of ListDomains instances.</p>
1530
- */
1531
- Items?: ListDomainItem[];
1532
-
1533
- /**
1534
- * <p>The pagination token from the previous ListDomains API call.</p>
1535
- */
1536
- NextToken?: string;
1537
- }
1538
-
1539
- export namespace ListDomainsResponse {
1540
- /**
1541
- * @internal
1542
- */
1543
- export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({
1544
- ...obj,
1545
- });
1546
- }
1547
-
1548
- export interface ListIntegrationsRequest {
1549
- /**
1550
- * <p>The unique name of the domain.</p>
1551
- */
1552
- DomainName: string | undefined;
1553
-
1554
- /**
1555
- * <p>The pagination token from the previous ListIntegrations API call.</p>
1556
- */
1557
- NextToken?: string;
1558
-
1559
- /**
1560
- * <p>The maximum number of objects returned per page.</p>
1561
- */
1562
- MaxResults?: number;
1563
- }
1564
-
1565
- export namespace ListIntegrationsRequest {
1566
- /**
1567
- * @internal
1568
- */
1569
- export const filterSensitiveLog = (obj: ListIntegrationsRequest): any => ({
1570
- ...obj,
1571
- });
1572
- }
1573
-
1574
- export interface ListIntegrationsResponse {
1575
- /**
1576
- * <p>The list of ListIntegrations instances.</p>
1577
- */
1578
- Items?: ListIntegrationItem[];
1579
-
1580
- /**
1581
- * <p>The pagination token from the previous ListIntegrations API call.</p>
1582
- */
1583
- NextToken?: string;
1584
- }
1585
-
1586
- export namespace ListIntegrationsResponse {
1587
- /**
1588
- * @internal
1589
- */
1590
- export const filterSensitiveLog = (obj: ListIntegrationsResponse): any => ({
1591
- ...obj,
1592
- });
1593
- }
1594
-
1595
- /**
1596
- * <p>The filter applied to ListProfileObjects response to include profile objects with the specified index values.
1597
- * This filter is only supported for ObjectTypeName _asset and _case.</p>
1598
- */
1599
- export interface ObjectFilter {
1600
- /**
1601
- * <p>A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber.
1602
- * The predefined keys you can use to search for _case include: _caseId.</p>
1603
- */
1604
- KeyName: string | undefined;
1605
-
1606
- /**
1607
- * <p>A list of key values.</p>
1608
- */
1609
- Values: string[] | undefined;
1610
- }
1611
-
1612
- export namespace ObjectFilter {
1613
- /**
1614
- * @internal
1615
- */
1616
- export const filterSensitiveLog = (obj: ObjectFilter): any => ({
1617
- ...obj,
1618
- });
1619
- }
1620
-
1621
- export interface ListProfileObjectsRequest {
1622
- /**
1623
- * <p>The pagination token from the previous call to ListProfileObjects.</p>
1624
- */
1625
- NextToken?: string;
1626
-
1627
- /**
1628
- * <p>The maximum number of objects returned per page.</p>
1629
- */
1630
- MaxResults?: number;
1631
-
1632
- /**
1633
- * <p>The unique name of the domain.</p>
1634
- */
1635
- DomainName: string | undefined;
1636
-
1637
- /**
1638
- * <p>The name of the profile object type.</p>
1639
- */
1640
- ObjectTypeName: string | undefined;
1641
-
1642
- /**
1643
- * <p>The unique identifier of a customer profile.</p>
1644
- */
1645
- ProfileId: string | undefined;
1646
-
1647
- /**
1648
- * <p>Applies a filter to the response to include profile objects with the specified index values.
1649
- * This filter is only supported for ObjectTypeName _asset and _case.</p>
1650
- */
1651
- ObjectFilter?: ObjectFilter;
1652
- }
1653
-
1654
- export namespace ListProfileObjectsRequest {
1655
- /**
1656
- * @internal
1657
- */
1658
- export const filterSensitiveLog = (obj: ListProfileObjectsRequest): any => ({
1659
- ...obj,
1660
- });
1661
- }
1662
-
1663
- /**
1664
- * <p>A ProfileObject in a list of ProfileObjects.</p>
1665
- */
1666
- export interface ListProfileObjectsItem {
1667
- /**
1668
- * <p>Specifies the kind of object being added to a profile, such as
1669
- * "Salesforce-Account."</p>
1670
- */
1671
- ObjectTypeName?: string;
1672
-
1673
- /**
1674
- * <p>The unique identifier of the ProfileObject generated by the service.</p>
1675
- */
1676
- ProfileObjectUniqueKey?: string;
1677
-
1678
- /**
1679
- * <p>A JSON representation of a ProfileObject that belongs to a profile.</p>
1680
- */
1681
- Object?: string;
1682
- }
1683
-
1684
- export namespace ListProfileObjectsItem {
1685
- /**
1686
- * @internal
1687
- */
1688
- export const filterSensitiveLog = (obj: ListProfileObjectsItem): any => ({
1689
- ...obj,
1690
- });
1691
- }
1692
-
1693
- export interface ListProfileObjectsResponse {
1694
- /**
1695
- * <p>The list of ListProfileObject instances.</p>
1696
- */
1697
- Items?: ListProfileObjectsItem[];
1698
-
1699
- /**
1700
- * <p>The pagination token from the previous call to ListProfileObjects.</p>
1701
- */
1702
- NextToken?: string;
1703
- }
1704
-
1705
- export namespace ListProfileObjectsResponse {
1706
- /**
1707
- * @internal
1708
- */
1709
- export const filterSensitiveLog = (obj: ListProfileObjectsResponse): any => ({
1710
- ...obj,
1711
- });
1712
- }
1713
-
1714
- export interface ListProfileObjectTypesRequest {
1715
- /**
1716
- * <p>The unique name of the domain.</p>
1717
- */
1718
- DomainName: string | undefined;
1719
-
1720
- /**
1721
- * <p>Identifies the next page of results to return.</p>
1722
- */
1723
- NextToken?: string;
1724
-
1725
- /**
1726
- * <p>The maximum number of objects returned per page.</p>
1727
- */
1728
- MaxResults?: number;
1729
- }
1730
-
1731
- export namespace ListProfileObjectTypesRequest {
1732
- /**
1733
- * @internal
1734
- */
1735
- export const filterSensitiveLog = (obj: ListProfileObjectTypesRequest): any => ({
1736
- ...obj,
1737
- });
1738
- }
1739
-
1740
- /**
1741
- * <p>A ProfileObjectType instance.</p>
1742
- */
1743
- export interface ListProfileObjectTypeItem {
1744
- /**
1745
- * <p>The name of the profile object type.</p>
1746
- */
1747
- ObjectTypeName: string | undefined;
1748
-
1749
- /**
1750
- * <p>Description of the profile object type.</p>
1751
- */
1752
- Description: string | undefined;
1753
-
1754
- /**
1755
- * <p>The timestamp of when the domain was created.</p>
1756
- */
1757
- CreatedAt?: Date;
1758
-
1759
- /**
1760
- * <p>The timestamp of when the domain was most recently edited.</p>
1761
- */
1762
- LastUpdatedAt?: Date;
1763
-
1764
- /**
1765
- * <p>The tags used to organize, track, or control access for this resource.</p>
1766
- */
1767
- Tags?: { [key: string]: string };
1768
- }
1769
-
1770
- export namespace ListProfileObjectTypeItem {
1771
- /**
1772
- * @internal
1773
- */
1774
- export const filterSensitiveLog = (obj: ListProfileObjectTypeItem): any => ({
1775
- ...obj,
1776
- });
1777
- }
1778
-
1779
- export interface ListProfileObjectTypesResponse {
1780
- /**
1781
- * <p>The list of ListProfileObjectTypes instances.</p>
1782
- */
1783
- Items?: ListProfileObjectTypeItem[];
1784
-
1785
- /**
1786
- * <p>Identifies the next page of results to return.</p>
1787
- */
1788
- NextToken?: string;
1789
- }
1790
-
1791
- export namespace ListProfileObjectTypesResponse {
1792
- /**
1793
- * @internal
1794
- */
1795
- export const filterSensitiveLog = (obj: ListProfileObjectTypesResponse): any => ({
1796
- ...obj,
1797
- });
1798
- }
1799
-
1800
- export interface ListProfileObjectTypeTemplatesRequest {
1801
- /**
1802
- * <p>The pagination token from the previous ListObjectTypeTemplates API call.</p>
1803
- */
1804
- NextToken?: string;
1805
-
1806
- /**
1807
- * <p>The maximum number of objects returned per page.</p>
1808
- */
1809
- MaxResults?: number;
1810
- }
1811
-
1812
- export namespace ListProfileObjectTypeTemplatesRequest {
1813
- /**
1814
- * @internal
1815
- */
1816
- export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesRequest): any => ({
1817
- ...obj,
1818
- });
1819
- }
1820
-
1821
- /**
1822
- * <p>A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.</p>
1823
- */
1824
- export interface ListProfileObjectTypeTemplateItem {
1825
- /**
1826
- * <p>A unique identifier for the object template.</p>
1827
- */
1828
- TemplateId?: string;
1829
-
1830
- /**
1831
- * <p>The name of the source of the object template.</p>
1832
- */
1833
- SourceName?: string;
1834
-
1835
- /**
1836
- * <p>The source of the object template.</p>
1837
- */
1838
- SourceObject?: string;
1839
- }
1840
-
1841
- export namespace ListProfileObjectTypeTemplateItem {
1842
- /**
1843
- * @internal
1844
- */
1845
- export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplateItem): any => ({
1846
- ...obj,
1847
- });
1848
- }
1849
-
1850
- export interface ListProfileObjectTypeTemplatesResponse {
1851
- /**
1852
- * <p>The list of ListProfileObjectType template instances.</p>
1853
- */
1854
- Items?: ListProfileObjectTypeTemplateItem[];
1855
-
1856
- /**
1857
- * <p>The pagination token from the previous ListObjectTypeTemplates API call. </p>
1858
- */
1859
- NextToken?: string;
1860
- }
1861
-
1862
- export namespace ListProfileObjectTypeTemplatesResponse {
1863
- /**
1864
- * @internal
1865
- */
1866
- export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesResponse): any => ({
1867
- ...obj,
1868
- });
1869
- }
1870
-
1871
- export interface ListTagsForResourceRequest {
1872
- /**
1873
- * <p>The ARN of the resource for which you want to view tags.</p>
1874
- */
1875
- resourceArn: string | undefined;
1876
- }
1877
-
1878
- export namespace ListTagsForResourceRequest {
1879
- /**
1880
- * @internal
1881
- */
1882
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
1883
- ...obj,
1884
- });
1885
- }
1886
-
1887
- export interface ListTagsForResourceResponse {
1888
- /**
1889
- * <p>The tags used to organize, track, or control access for this resource.</p>
1890
- */
1891
- tags?: { [key: string]: string };
1892
- }
1893
-
1894
- export namespace ListTagsForResourceResponse {
1895
- /**
1896
- * @internal
1897
- */
1898
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
1899
- ...obj,
1900
- });
1901
- }
1902
-
1903
- /**
1904
- * <p>A duplicate customer profile that is to be merged into a main profile. </p>
1905
- */
1906
- export interface FieldSourceProfileIds {
1907
- /**
1908
- * <p>A unique identifier for the account number field to be merged. </p>
1909
- */
1910
- AccountNumber?: string;
1911
-
1912
- /**
1913
- * <p>A unique identifier for the additional information field to be merged.</p>
1914
- */
1915
- AdditionalInformation?: string;
1916
-
1917
- /**
1918
- * <p>A unique identifier for the party type field to be merged.</p>
1919
- */
1920
- PartyType?: string;
1921
-
1922
- /**
1923
- * <p>A unique identifier for the business name field to be merged.</p>
1924
- */
1925
- BusinessName?: string;
1926
-
1927
- /**
1928
- * <p>A unique identifier for the first name field to be merged.</p>
1929
- */
1930
- FirstName?: string;
1931
-
1932
- /**
1933
- * <p>A unique identifier for the middle name field to be merged.</p>
1934
- */
1935
- MiddleName?: string;
1936
-
1937
- /**
1938
- * <p>A unique identifier for the last name field to be merged.</p>
1939
- */
1940
- LastName?: string;
1941
-
1942
- /**
1943
- * <p>A unique identifier for the birthdate field to be merged.</p>
1944
- */
1945
- BirthDate?: string;
1946
-
1947
- /**
1948
- * <p>A unique identifier for the gender field to be merged.</p>
1949
- */
1950
- Gender?: string;
1951
-
1952
- /**
1953
- * <p>A unique identifier for the phone number field to be merged.</p>
1954
- */
1955
- PhoneNumber?: string;
1956
-
1957
- /**
1958
- * <p>A unique identifier for the mobile phone number field to be merged.</p>
1959
- */
1960
- MobilePhoneNumber?: string;
1961
-
1962
- /**
1963
- * <p>A unique identifier for the home phone number field to be merged.</p>
1964
- */
1965
- HomePhoneNumber?: string;
1966
-
1967
- /**
1968
- * <p>A unique identifier for the business phone number field to be merged.</p>
1969
- */
1970
- BusinessPhoneNumber?: string;
1971
-
1972
- /**
1973
- * <p>A unique identifier for the email address field to be merged.</p>
1974
- */
1975
- EmailAddress?: string;
1976
-
1977
- /**
1978
- * <p>A unique identifier for the personal email address field to be merged.</p>
1979
- */
1980
- PersonalEmailAddress?: string;
1981
-
1982
- /**
1983
- * <p>A unique identifier for the party type field to be merged.</p>
1984
- */
1985
- BusinessEmailAddress?: string;
1986
-
1987
- /**
1988
- * <p>A unique identifier for the party type field to be merged.</p>
1989
- */
1990
- Address?: string;
1991
-
1992
- /**
1993
- * <p>A unique identifier for the shipping address field to be merged.</p>
1994
- */
1995
- ShippingAddress?: string;
1996
-
1997
- /**
1998
- * <p>A unique identifier for the mailing address field to be merged.</p>
1999
- */
2000
- MailingAddress?: string;
2001
-
2002
- /**
2003
- * <p>A unique identifier for the billing type field to be merged.</p>
2004
- */
2005
- BillingAddress?: string;
2006
-
2007
- /**
2008
- * <p>A unique identifier for the attributes field to be merged.</p>
2009
- */
2010
- Attributes?: { [key: string]: string };
2011
- }
2012
-
2013
- export namespace FieldSourceProfileIds {
2014
- /**
2015
- * @internal
2016
- */
2017
- export const filterSensitiveLog = (obj: FieldSourceProfileIds): any => ({
2018
- ...obj,
2019
- });
2020
- }
2021
-
2022
- export interface MergeProfilesRequest {
2023
- /**
2024
- * <p>The unique name of the domain.</p>
2025
- */
2026
- DomainName: string | undefined;
2027
-
2028
- /**
2029
- * <p>The identifier of the profile to be taken.</p>
2030
- */
2031
- MainProfileId: string | undefined;
2032
-
2033
- /**
2034
- * <p>The identifier of the profile to be merged into MainProfileId.</p>
2035
- */
2036
- ProfileIdsToBeMerged: string[] | undefined;
2037
-
2038
- /**
2039
- * <p>The identifiers of the fields in the profile that has the information you want to apply
2040
- * to the merge. For example, say you want to merge EmailAddress from Profile1 into
2041
- * MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>
2042
- */
2043
- FieldSourceProfileIds?: FieldSourceProfileIds;
2044
- }
2045
-
2046
- export namespace MergeProfilesRequest {
2047
- /**
2048
- * @internal
2049
- */
2050
- export const filterSensitiveLog = (obj: MergeProfilesRequest): any => ({
2051
- ...obj,
2052
- });
2053
- }
2054
-
2055
- export interface MergeProfilesResponse {
2056
- /**
2057
- * <p>A message that indicates the merge request is complete.</p>
2058
- */
2059
- Message?: string;
2060
- }
2061
-
2062
- export namespace MergeProfilesResponse {
2063
- /**
2064
- * @internal
2065
- */
2066
- export const filterSensitiveLog = (obj: MergeProfilesResponse): any => ({
2067
- ...obj,
2068
- });
2069
- }
2070
-
2071
- export enum SourceConnectorType {
2072
- MARKETO = "Marketo",
2073
- S3 = "S3",
2074
- SALESFORCE = "Salesforce",
2075
- SERVICENOW = "Servicenow",
2076
- ZENDESK = "Zendesk",
2077
- }
2078
-
2079
- /**
2080
- * <p>Specifies the configuration used when importing incremental records from the
2081
- * source.</p>
2082
- */
2083
- export interface IncrementalPullConfig {
2084
- /**
2085
- * <p>A field that specifies the date time or timestamp field as the criteria to use when
2086
- * importing incremental records from the source.</p>
2087
- */
2088
- DatetimeTypeFieldName?: string;
2089
- }
2090
-
2091
- export namespace IncrementalPullConfig {
2092
- /**
2093
- * @internal
2094
- */
2095
- export const filterSensitiveLog = (obj: IncrementalPullConfig): any => ({
2096
- ...obj,
2097
- });
2098
- }
2099
-
2100
- /**
2101
- * <p>The properties that are applied when Marketo is being used as a source.</p>
2102
- */
2103
- export interface MarketoSourceProperties {
2104
- /**
2105
- * <p>The object specified in the Marketo flow source.</p>
2106
- */
2107
- Object: string | undefined;
2108
- }
2109
-
2110
- export namespace MarketoSourceProperties {
2111
- /**
2112
- * @internal
2113
- */
2114
- export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({
2115
- ...obj,
2116
- });
2117
- }
2118
-
2119
- /**
2120
- * <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
2121
- */
2122
- export interface S3SourceProperties {
2123
- /**
2124
- * <p>The Amazon S3 bucket name where the source files are stored.</p>
2125
- */
2126
- BucketName: string | undefined;
2127
-
2128
- /**
2129
- * <p>The object key for the Amazon S3 bucket in which the source files are stored.</p>
2130
- */
2131
- BucketPrefix?: string;
2132
- }
2133
-
2134
- export namespace S3SourceProperties {
2135
- /**
2136
- * @internal
2137
- */
2138
- export const filterSensitiveLog = (obj: S3SourceProperties): any => ({
2139
- ...obj,
2140
- });
2141
- }
2142
-
2143
- /**
2144
- * <p>The properties that are applied when Salesforce is being used as a source.</p>
2145
- */
2146
- export interface SalesforceSourceProperties {
2147
- /**
2148
- * <p>The object specified in the Salesforce flow source.</p>
2149
- */
2150
- Object: string | undefined;
2151
-
2152
- /**
2153
- * <p>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
2154
- * objects while running a flow.</p>
2155
- */
2156
- EnableDynamicFieldUpdate?: boolean;
2157
-
2158
- /**
2159
- * <p>Indicates whether Amazon AppFlow includes deleted files in the flow run.</p>
2160
- */
2161
- IncludeDeletedRecords?: boolean;
2162
- }
2163
-
2164
- export namespace SalesforceSourceProperties {
2165
- /**
2166
- * @internal
2167
- */
2168
- export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({
2169
- ...obj,
2170
- });
2171
- }
2172
-
2173
- /**
2174
- * <p>The properties that are applied when ServiceNow is being used as a source.</p>
2175
- */
2176
- export interface ServiceNowSourceProperties {
2177
- /**
2178
- * <p>The object specified in the ServiceNow flow source.</p>
2179
- */
2180
- Object: string | undefined;
2181
- }
2182
-
2183
- export namespace ServiceNowSourceProperties {
2184
- /**
2185
- * @internal
2186
- */
2187
- export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({
2188
- ...obj,
2189
- });
2190
- }
2191
-
2192
- /**
2193
- * <p>The properties that are applied when using Zendesk as a flow source.</p>
2194
- */
2195
- export interface ZendeskSourceProperties {
2196
- /**
2197
- * <p>The object specified in the Zendesk flow source.</p>
2198
- */
2199
- Object: string | undefined;
2200
- }
2201
-
2202
- export namespace ZendeskSourceProperties {
2203
- /**
2204
- * @internal
2205
- */
2206
- export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({
2207
- ...obj,
2208
- });
2209
- }
2210
-
2211
- /**
2212
- * <p>Specifies the information that is required to query a particular Amazon AppFlow connector.
2213
- * Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.</p>
2214
- */
2215
- export interface SourceConnectorProperties {
2216
- /**
2217
- * <p>The properties that are applied when Marketo is being used as a source.</p>
2218
- */
2219
- Marketo?: MarketoSourceProperties;
2220
-
2221
- /**
2222
- * <p>The properties that are applied when Amazon S3 is being used as the flow source.</p>
2223
- */
2224
- S3?: S3SourceProperties;
2225
-
2226
- /**
2227
- * <p>The properties that are applied when Salesforce is being used as a source.</p>
2228
- */
2229
- Salesforce?: SalesforceSourceProperties;
2230
-
2231
- /**
2232
- * <p>The properties that are applied when ServiceNow is being used as a source.</p>
2233
- */
2234
- ServiceNow?: ServiceNowSourceProperties;
2235
-
2236
- /**
2237
- * <p>The properties that are applied when using Zendesk as a flow source.</p>
2238
- */
2239
- Zendesk?: ZendeskSourceProperties;
2240
- }
2241
-
2242
- export namespace SourceConnectorProperties {
2243
- /**
2244
- * @internal
2245
- */
2246
- export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({
2247
- ...obj,
2248
- });
2249
- }
2250
-
2251
- /**
2252
- * <p>Contains information about the configuration of the source connector used in the
2253
- * flow.</p>
2254
- */
2255
- export interface SourceFlowConfig {
2256
- /**
2257
- * <p>The name of the AppFlow connector profile. This name must be unique for each connector
2258
- * profile in the AWS account.</p>
2259
- */
2260
- ConnectorProfileName?: string;
2261
-
2262
- /**
2263
- * <p>The type of connector, such as Salesforce, Marketo, and so on.</p>
2264
- */
2265
- ConnectorType: SourceConnectorType | string | undefined;
2266
-
2267
- /**
2268
- * <p>Defines the configuration for a scheduled incremental data pull. If a valid
2269
- * configuration is provided, the fields specified in the configuration are used when querying
2270
- * for the incremental data pull.</p>
2271
- */
2272
- IncrementalPullConfig?: IncrementalPullConfig;
2273
-
2274
- /**
2275
- * <p>Specifies the information that is required to query a particular source
2276
- * connector.</p>
2277
- */
2278
- SourceConnectorProperties: SourceConnectorProperties | undefined;
2279
- }
2280
-
2281
- export namespace SourceFlowConfig {
2282
- /**
2283
- * @internal
2284
- */
2285
- export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({
2286
- ...obj,
2287
- });
2288
- }
2289
-
2290
- export enum OperatorPropertiesKeys {
2291
- CONCAT_FORMAT = "CONCAT_FORMAT",
2292
- DATA_TYPE = "DATA_TYPE",
2293
- DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE",
2294
- LOWER_BOUND = "LOWER_BOUND",
2295
- MASK_LENGTH = "MASK_LENGTH",
2296
- MASK_VALUE = "MASK_VALUE",
2297
- MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER",
2298
- SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE",
2299
- SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
2300
- TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
2301
- UPPER_BOUND = "UPPER_BOUND",
2302
- VALIDATION_ACTION = "VALIDATION_ACTION",
2303
- VALUE = "VALUE",
2304
- VALUES = "VALUES",
2305
- }
2306
-
2307
- export enum TaskType {
2308
- ARITHMETIC = "Arithmetic",
2309
- FILTER = "Filter",
2310
- MAP = "Map",
2311
- MASK = "Mask",
2312
- MERGE = "Merge",
2313
- TRUNCATE = "Truncate",
2314
- VALIDATE = "Validate",
2315
- }
2316
-
2317
- /**
2318
- * <p>A class for modeling different type of tasks. Task implementation varies based on the
2319
- * TaskType.</p>
2320
- */
2321
- export interface Task {
2322
- /**
2323
- * <p>The operation to be performed on the provided source fields.</p>
2324
- */
2325
- ConnectorOperator?: ConnectorOperator;
2326
-
2327
- /**
2328
- * <p>A field in a destination connector, or a field value against which Amazon AppFlow validates a
2329
- * source field.</p>
2330
- */
2331
- DestinationField?: string;
2332
-
2333
- /**
2334
- * <p>The source fields to which a particular task is applied.</p>
2335
- */
2336
- SourceFields: string[] | undefined;
2337
-
2338
- /**
2339
- * <p>A map used to store task-related information. The service looks for particular
2340
- * information based on the TaskType.</p>
2341
- */
2342
- TaskProperties?: { [key: string]: string };
2343
-
2344
- /**
2345
- * <p>Specifies the particular task implementation that Amazon AppFlow performs.</p>
2346
- */
2347
- TaskType: TaskType | string | undefined;
2348
- }
2349
-
2350
- export namespace Task {
2351
- /**
2352
- * @internal
2353
- */
2354
- export const filterSensitiveLog = (obj: Task): any => ({
2355
- ...obj,
2356
- });
2357
- }
2358
-
2359
- export enum DataPullMode {
2360
- COMPLETE = "Complete",
2361
- INCREMENTAL = "Incremental",
2362
- }
2363
-
2364
- /**
2365
- * <p>Specifies the configuration details of a scheduled-trigger flow that you define.
2366
- * Currently, these settings only apply to the scheduled-trigger type.</p>
2367
- */
2368
- export interface ScheduledTriggerProperties {
2369
- /**
2370
- * <p>The scheduling expression that determines the rate at which the schedule will run, for
2371
- * example rate (5 minutes).</p>
2372
- */
2373
- ScheduleExpression: string | undefined;
2374
-
2375
- /**
2376
- * <p>Specifies whether a scheduled flow has an incremental data transfer or a complete data
2377
- * transfer for each flow run.</p>
2378
- */
2379
- DataPullMode?: DataPullMode | string;
2380
-
2381
- /**
2382
- * <p>Specifies the scheduled start time for a scheduled-trigger flow.</p>
2383
- */
2384
- ScheduleStartTime?: Date;
2385
-
2386
- /**
2387
- * <p>Specifies the scheduled end time for a scheduled-trigger flow.</p>
2388
- */
2389
- ScheduleEndTime?: Date;
2390
-
2391
- /**
2392
- * <p>Specifies the time zone used when referring to the date and time of a
2393
- * scheduled-triggered flow, such as America/New_York.</p>
2394
- */
2395
- Timezone?: string;
2396
-
2397
- /**
2398
- * <p>Specifies the optional offset that is added to the time interval for a
2399
- * schedule-triggered flow.</p>
2400
- */
2401
- ScheduleOffset?: number;
2402
-
2403
- /**
2404
- * <p>Specifies the date range for the records to import from the connector in the first flow
2405
- * run.</p>
2406
- */
2407
- FirstExecutionFrom?: Date;
2408
- }
2409
-
2410
- export namespace ScheduledTriggerProperties {
2411
- /**
2412
- * @internal
2413
- */
2414
- export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({
2415
- ...obj,
2416
- });
2417
- }
2418
-
2419
- /**
2420
- * <p>Specifies the configuration details that control the trigger for a flow. Currently,
2421
- * these settings only apply to the Scheduled trigger type.</p>
2422
- */
2423
- export interface TriggerProperties {
2424
- /**
2425
- * <p>Specifies the configuration details of a schedule-triggered flow that you define.</p>
2426
- */
2427
- Scheduled?: ScheduledTriggerProperties;
2428
- }
2429
-
2430
- export namespace TriggerProperties {
2431
- /**
2432
- * @internal
2433
- */
2434
- export const filterSensitiveLog = (obj: TriggerProperties): any => ({
2435
- ...obj,
2436
- });
2437
- }
2438
-
2439
- export enum TriggerType {
2440
- EVENT = "Event",
2441
- ONDEMAND = "OnDemand",
2442
- SCHEDULED = "Scheduled",
2443
- }
2444
-
2445
- /**
2446
- * <p>The trigger settings that determine how and when Amazon AppFlow runs the specified
2447
- * flow.</p>
2448
- */
2449
- export interface TriggerConfig {
2450
- /**
2451
- * <p>Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.</p>
2452
- */
2453
- TriggerType: TriggerType | string | undefined;
2454
-
2455
- /**
2456
- * <p>Specifies the configuration details of a schedule-triggered flow that you define.
2457
- * Currently, these settings only apply to the Scheduled trigger type.</p>
2458
- */
2459
- TriggerProperties?: TriggerProperties;
2460
- }
2461
-
2462
- export namespace TriggerConfig {
2463
- /**
2464
- * @internal
2465
- */
2466
- export const filterSensitiveLog = (obj: TriggerConfig): any => ({
2467
- ...obj,
2468
- });
2469
- }
2470
-
2471
- /**
2472
- * <p>The configurations that control how Customer Profiles retrieves data from the source,
2473
- * Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of
2474
- * customers.</p>
2475
- */
2476
- export interface FlowDefinition {
2477
- /**
2478
- * <p>A description of the flow you want to create.</p>
2479
- */
2480
- Description?: string;
2481
-
2482
- /**
2483
- * <p>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not
2484
- * allowed.</p>
2485
- */
2486
- FlowName: string | undefined;
2487
-
2488
- /**
2489
- * <p>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</p>
2490
- */
2491
- KmsArn: string | undefined;
2492
-
2493
- /**
2494
- * <p>The configuration that controls how Customer Profiles retrieves data from the
2495
- * source.</p>
2496
- */
2497
- SourceFlowConfig: SourceFlowConfig | undefined;
2498
-
2499
- /**
2500
- * <p>A list of tasks that Customer Profiles performs while transferring the data in the flow
2501
- * run.</p>
2502
- */
2503
- Tasks: Task[] | undefined;
2504
-
2505
- /**
2506
- * <p>The trigger settings that determine how and when the flow runs.</p>
2507
- */
2508
- TriggerConfig: TriggerConfig | undefined;
2509
- }
2510
-
2511
- export namespace FlowDefinition {
2512
- /**
2513
- * @internal
2514
- */
2515
- export const filterSensitiveLog = (obj: FlowDefinition): any => ({
2516
- ...obj,
2517
- });
2518
- }
2519
-
2520
- export interface PutIntegrationRequest {
2521
- /**
2522
- * <p>The unique name of the domain.</p>
2523
- */
2524
- DomainName: string | undefined;
2525
-
2526
- /**
2527
- * <p>The URI of the S3 bucket or any other type of data source.</p>
2528
- */
2529
- Uri?: string;
2530
-
2531
- /**
2532
- * <p>The name of the profile object type.</p>
2533
- */
2534
- ObjectTypeName: string | undefined;
2535
-
2536
- /**
2537
- * <p>The tags used to organize, track, or control access for this resource.</p>
2538
- */
2539
- Tags?: { [key: string]: string };
2540
-
2541
- /**
2542
- * <p>The configuration that controls how Customer Profiles retrieves data from the
2543
- * source.</p>
2544
- */
2545
- FlowDefinition?: FlowDefinition;
2546
- }
2547
-
2548
- export namespace PutIntegrationRequest {
2549
- /**
2550
- * @internal
2551
- */
2552
- export const filterSensitiveLog = (obj: PutIntegrationRequest): any => ({
2553
- ...obj,
2554
- });
2555
- }
2556
-
2557
- export interface PutIntegrationResponse {
2558
- /**
2559
- * <p>The unique name of the domain.</p>
2560
- */
2561
- DomainName: string | undefined;
2562
-
2563
- /**
2564
- * <p>The URI of the S3 bucket or any other type of data source.</p>
2565
- */
2566
- Uri: string | undefined;
2567
-
2568
- /**
2569
- * <p>The name of the profile object type.</p>
2570
- */
2571
- ObjectTypeName: string | undefined;
2572
-
2573
- /**
2574
- * <p>The timestamp of when the domain was created.</p>
2575
- */
2576
- CreatedAt: Date | undefined;
2577
-
2578
- /**
2579
- * <p>The timestamp of when the domain was most recently edited.</p>
2580
- */
2581
- LastUpdatedAt: Date | undefined;
2582
-
2583
- /**
2584
- * <p>The tags used to organize, track, or control access for this resource.</p>
2585
- */
2586
- Tags?: { [key: string]: string };
2587
- }
2588
-
2589
- export namespace PutIntegrationResponse {
2590
- /**
2591
- * @internal
2592
- */
2593
- export const filterSensitiveLog = (obj: PutIntegrationResponse): any => ({
2594
- ...obj,
2595
- });
2596
- }
2597
-
2598
- export interface PutProfileObjectRequest {
2599
- /**
2600
- * <p>The name of the profile object type.</p>
2601
- */
2602
- ObjectTypeName: string | undefined;
2603
-
2604
- /**
2605
- * <p>A string that is serialized from a JSON object.</p>
2606
- */
2607
- Object: string | undefined;
2608
-
2609
- /**
2610
- * <p>The unique name of the domain.</p>
2611
- */
2612
- DomainName: string | undefined;
2613
- }
2614
-
2615
- export namespace PutProfileObjectRequest {
2616
- /**
2617
- * @internal
2618
- */
2619
- export const filterSensitiveLog = (obj: PutProfileObjectRequest): any => ({
2620
- ...obj,
2621
- });
2622
- }
2623
-
2624
- export interface PutProfileObjectResponse {
2625
- /**
2626
- * <p>The unique identifier of the profile object generated by the service.</p>
2627
- */
2628
- ProfileObjectUniqueKey?: string;
2629
- }
2630
-
2631
- export namespace PutProfileObjectResponse {
2632
- /**
2633
- * @internal
2634
- */
2635
- export const filterSensitiveLog = (obj: PutProfileObjectResponse): any => ({
2636
- ...obj,
2637
- });
2638
- }
2639
-
2640
- export interface PutProfileObjectTypeRequest {
2641
- /**
2642
- * <p>The unique name of the domain.</p>
2643
- */
2644
- DomainName: string | undefined;
2645
-
2646
- /**
2647
- * <p>The name of the profile object type.</p>
2648
- */
2649
- ObjectTypeName: string | undefined;
2650
-
2651
- /**
2652
- * <p>Description of the profile object type.</p>
2653
- */
2654
- Description: string | undefined;
2655
-
2656
- /**
2657
- * <p>A unique identifier for the object template.</p>
2658
- */
2659
- TemplateId?: string;
2660
-
2661
- /**
2662
- * <p>The number of days until the data in the object expires.</p>
2663
- */
2664
- ExpirationDays?: number;
2665
-
2666
- /**
2667
- * <p>The customer-provided key to encrypt the profile object that will be created in this
2668
- * profile object type.</p>
2669
- */
2670
- EncryptionKey?: string;
2671
-
2672
- /**
2673
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
2674
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
2675
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
2676
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
2677
- * is found, then the service creates a new standard profile.</p>
2678
- */
2679
- AllowProfileCreation?: boolean;
2680
-
2681
- /**
2682
- * <p>A map of the name and ObjectType field.</p>
2683
- */
2684
- Fields?: { [key: string]: ObjectTypeField };
2685
-
2686
- /**
2687
- * <p>A list of unique keys that can be used to map data to the profile.</p>
2688
- */
2689
- Keys?: { [key: string]: ObjectTypeKey[] };
2690
-
2691
- /**
2692
- * <p>The tags used to organize, track, or control access for this resource.</p>
2693
- */
2694
- Tags?: { [key: string]: string };
2695
- }
2696
-
2697
- export namespace PutProfileObjectTypeRequest {
2698
- /**
2699
- * @internal
2700
- */
2701
- export const filterSensitiveLog = (obj: PutProfileObjectTypeRequest): any => ({
2702
- ...obj,
2703
- });
2704
- }
2705
-
2706
- export interface PutProfileObjectTypeResponse {
2707
- /**
2708
- * <p>The name of the profile object type.</p>
2709
- */
2710
- ObjectTypeName: string | undefined;
2711
-
2712
- /**
2713
- * <p>Description of the profile object type.</p>
2714
- */
2715
- Description: string | undefined;
2716
-
2717
- /**
2718
- * <p>A unique identifier for the object template.</p>
2719
- */
2720
- TemplateId?: string;
2721
-
2722
- /**
2723
- * <p>The number of days until the data in the object expires.</p>
2724
- */
2725
- ExpirationDays?: number;
2726
-
2727
- /**
2728
- * <p>The customer-provided key to encrypt the profile object that will be created in this
2729
- * profile object type.</p>
2730
- */
2731
- EncryptionKey?: string;
2732
-
2733
- /**
2734
- * <p>Indicates whether a profile should be created when data is received if one doesn’t exist
2735
- * for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation
2736
- * flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and
2737
- * associate this object with the profile. If it is set to <code>TRUE</code>, and if no match
2738
- * is found, then the service creates a new standard profile.</p>
2739
- */
2740
- AllowProfileCreation?: boolean;
2741
-
2742
- /**
2743
- * <p>A map of the name and ObjectType field.</p>
2744
- */
2745
- Fields?: { [key: string]: ObjectTypeField };
2746
-
2747
- /**
2748
- * <p>A list of unique keys that can be used to map data to the profile.</p>
2749
- */
2750
- Keys?: { [key: string]: ObjectTypeKey[] };
2751
-
2752
- /**
2753
- * <p>The timestamp of when the domain was created.</p>
2754
- */
2755
- CreatedAt?: Date;
2756
-
2757
- /**
2758
- * <p>The timestamp of when the domain was most recently edited.</p>
2759
- */
2760
- LastUpdatedAt?: Date;
2761
-
2762
- /**
2763
- * <p>The tags used to organize, track, or control access for this resource.</p>
2764
- */
2765
- Tags?: { [key: string]: string };
2766
- }
2767
-
2768
- export namespace PutProfileObjectTypeResponse {
2769
- /**
2770
- * @internal
2771
- */
2772
- export const filterSensitiveLog = (obj: PutProfileObjectTypeResponse): any => ({
2773
- ...obj,
2774
- });
2775
- }
2776
-
2777
- export interface SearchProfilesRequest {
2778
- /**
2779
- * <p>The pagination token from the previous SearchProfiles API call.</p>
2780
- */
2781
- NextToken?: string;
2782
-
2783
- /**
2784
- * <p>The maximum number of objects returned per page.</p>
2785
- */
2786
- MaxResults?: number;
2787
-
2788
- /**
2789
- * <p>The unique name of the domain.</p>
2790
- */
2791
- DomainName: string | undefined;
2792
-
2793
- /**
2794
- * <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
2795
- * _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId,
2796
- * _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.</p>
2797
- */
2798
- KeyName: string | undefined;
2799
-
2800
- /**
2801
- * <p>A list of key values.</p>
2802
- */
2803
- Values: string[] | undefined;
2804
- }
2805
-
2806
- export namespace SearchProfilesRequest {
2807
- /**
2808
- * @internal
2809
- */
2810
- export const filterSensitiveLog = (obj: SearchProfilesRequest): any => ({
2811
- ...obj,
2812
- });
2813
- }
2814
-
2815
- /**
2816
- * <p>The standard profile of a customer.</p>
2817
- */
2818
- export interface Profile {
2819
- /**
2820
- * <p>The unique identifier of a customer profile.</p>
2821
- */
2822
- ProfileId?: string;
2823
-
2824
- /**
2825
- * <p>A unique account number that you have given to the customer.</p>
2826
- */
2827
- AccountNumber?: string;
2828
-
2829
- /**
2830
- * <p>Any additional information relevant to the customer’s profile.</p>
2831
- */
2832
- AdditionalInformation?: string;
2833
-
2834
- /**
2835
- * <p>The type of profile used to describe the customer.</p>
2836
- */
2837
- PartyType?: PartyType | string;
2838
-
2839
- /**
2840
- * <p>The name of the customer’s business.</p>
2841
- */
2842
- BusinessName?: string;
2843
-
2844
- /**
2845
- * <p>The customer’s first name.</p>
2846
- */
2847
- FirstName?: string;
2848
-
2849
- /**
2850
- * <p>The customer’s middle name.</p>
2851
- */
2852
- MiddleName?: string;
2853
-
2854
- /**
2855
- * <p>The customer’s last name.</p>
2856
- */
2857
- LastName?: string;
2858
-
2859
- /**
2860
- * <p>The customer’s birth date. </p>
2861
- */
2862
- BirthDate?: string;
2863
-
2864
- /**
2865
- * <p>The gender with which the customer identifies. </p>
2866
- */
2867
- Gender?: Gender | string;
2868
-
2869
- /**
2870
- * <p>The customer's phone number, which has not been specified as a mobile, home, or business
2871
- * number.</p>
2872
- */
2873
- PhoneNumber?: string;
2874
-
2875
- /**
2876
- * <p>The customer’s mobile phone number.</p>
2877
- */
2878
- MobilePhoneNumber?: string;
2879
-
2880
- /**
2881
- * <p>The customer’s home phone number.</p>
2882
- */
2883
- HomePhoneNumber?: string;
2884
-
2885
- /**
2886
- * <p>The customer’s home phone number.</p>
2887
- */
2888
- BusinessPhoneNumber?: string;
2889
-
2890
- /**
2891
- * <p>The customer’s email address, which has not been specified as a personal or business
2892
- * address. </p>
2893
- */
2894
- EmailAddress?: string;
2895
-
2896
- /**
2897
- * <p>The customer’s personal email address.</p>
2898
- */
2899
- PersonalEmailAddress?: string;
2900
-
2901
- /**
2902
- * <p>The customer’s business email address.</p>
2903
- */
2904
- BusinessEmailAddress?: string;
2905
-
2906
- /**
2907
- * <p>A generic address associated with the customer that is not mailing, shipping, or
2908
- * billing.</p>
2909
- */
2910
- Address?: Address;
2911
-
2912
- /**
2913
- * <p>The customer’s shipping address.</p>
2914
- */
2915
- ShippingAddress?: Address;
2916
-
2917
- /**
2918
- * <p>The customer’s mailing address.</p>
2919
- */
2920
- MailingAddress?: Address;
2921
-
2922
- /**
2923
- * <p>The customer’s billing address.</p>
2924
- */
2925
- BillingAddress?: Address;
2926
-
2927
- /**
2928
- * <p>A key value pair of attributes of a customer profile.</p>
2929
- */
2930
- Attributes?: { [key: string]: string };
2931
- }
2932
-
2933
- export namespace Profile {
2934
- /**
2935
- * @internal
2936
- */
2937
- export const filterSensitiveLog = (obj: Profile): any => ({
2938
- ...obj,
2939
- });
2940
- }
2941
-
2942
- export interface SearchProfilesResponse {
2943
- /**
2944
- * <p>The list of SearchProfiles instances.</p>
2945
- */
2946
- Items?: Profile[];
2947
-
2948
- /**
2949
- * <p>The pagination token from the previous SearchProfiles API call.</p>
2950
- */
2951
- NextToken?: string;
2952
- }
2953
-
2954
- export namespace SearchProfilesResponse {
2955
- /**
2956
- * @internal
2957
- */
2958
- export const filterSensitiveLog = (obj: SearchProfilesResponse): any => ({
2959
- ...obj,
2960
- });
2961
- }
2962
-
2963
- export interface TagResourceRequest {
2964
- /**
2965
- * <p>The ARN of the resource that you're adding tags to.</p>
2966
- */
2967
- resourceArn: string | undefined;
2968
-
2969
- /**
2970
- * <p>The tags used to organize, track, or control access for this resource.</p>
2971
- */
2972
- tags: { [key: string]: string } | undefined;
2973
- }
2974
-
2975
- export namespace TagResourceRequest {
2976
- /**
2977
- * @internal
2978
- */
2979
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
2980
- ...obj,
2981
- });
2982
- }
2983
-
2984
- export interface TagResourceResponse {}
2985
-
2986
- export namespace TagResourceResponse {
2987
- /**
2988
- * @internal
2989
- */
2990
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
2991
- ...obj,
2992
- });
2993
- }
2994
-
2995
- export interface UntagResourceRequest {
2996
- /**
2997
- * <p>The ARN of the resource from which you are removing tags.</p>
2998
- */
2999
- resourceArn: string | undefined;
3000
-
3001
- /**
3002
- * <p>The list of tag keys to remove from the resource.</p>
3003
- */
3004
- tagKeys: string[] | undefined;
3005
- }
3006
-
3007
- export namespace UntagResourceRequest {
3008
- /**
3009
- * @internal
3010
- */
3011
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
3012
- ...obj,
3013
- });
3014
- }
3015
-
3016
- export interface UntagResourceResponse {}
3017
-
3018
- export namespace UntagResourceResponse {
3019
- /**
3020
- * @internal
3021
- */
3022
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
3023
- ...obj,
3024
- });
3025
- }
3026
-
3027
- export interface UpdateDomainRequest {
3028
- /**
3029
- * <p>The unique name of the domain.</p>
3030
- */
3031
- DomainName: string | undefined;
3032
-
3033
- /**
3034
- * <p>The default number of days until the data within the domain expires.</p>
3035
- */
3036
- DefaultExpirationDays?: number;
3037
-
3038
- /**
3039
- * <p>The default encryption key, which is an AWS managed key, is used when no specific type
3040
- * of encryption key is specified. It is used to encrypt all data before it is placed in
3041
- * permanent or semi-permanent storage. If specified as an empty string, it will clear any
3042
- * existing value.</p>
3043
- */
3044
- DefaultEncryptionKey?: string;
3045
-
3046
- /**
3047
- * <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
3048
- * ingesting data from third party applications. If specified as an empty string, it will
3049
- * clear any existing value. You must set up a policy on the DeadLetterQueue for the
3050
- * SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the
3051
- * DeadLetterQueue.</p>
3052
- */
3053
- DeadLetterQueueUrl?: string;
3054
-
3055
- /**
3056
- * <p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains.
3057
- * After that batch process completes, use the
3058
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
3059
- * API to return and review the results. </p>
3060
- */
3061
- Matching?: MatchingRequest;
3062
-
3063
- /**
3064
- * <p>The tags used to organize, track, or control access for this resource.</p>
3065
- */
3066
- Tags?: { [key: string]: string };
3067
- }
3068
-
3069
- export namespace UpdateDomainRequest {
3070
- /**
3071
- * @internal
3072
- */
3073
- export const filterSensitiveLog = (obj: UpdateDomainRequest): any => ({
3074
- ...obj,
3075
- });
3076
- }
3077
-
3078
- export interface UpdateDomainResponse {
3079
- /**
3080
- * <p>The unique name of the domain.</p>
3081
- */
3082
- DomainName: string | undefined;
3083
-
3084
- /**
3085
- * <p>The default number of days until the data within the domain expires.</p>
3086
- */
3087
- DefaultExpirationDays?: number;
3088
-
3089
- /**
3090
- * <p>The default encryption key, which is an AWS managed key, is used when no specific type
3091
- * of encryption key is specified. It is used to encrypt all data before it is placed in
3092
- * permanent or semi-permanent storage.</p>
3093
- */
3094
- DefaultEncryptionKey?: string;
3095
-
3096
- /**
3097
- * <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
3098
- * ingesting data from third party applications.</p>
3099
- */
3100
- DeadLetterQueueUrl?: string;
3101
-
3102
- /**
3103
- * <p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains.
3104
- * After that batch process completes, use the
3105
- * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
3106
- * API to return and review the results. </p>
3107
- */
3108
- Matching?: MatchingResponse;
3109
-
3110
- /**
3111
- * <p>The timestamp of when the domain was created.</p>
3112
- */
3113
- CreatedAt: Date | undefined;
3114
-
3115
- /**
3116
- * <p>The timestamp of when the domain was most recently edited.</p>
3117
- */
3118
- LastUpdatedAt: Date | undefined;
3119
-
3120
- /**
3121
- * <p>The tags used to organize, track, or control access for this resource.</p>
3122
- */
3123
- Tags?: { [key: string]: string };
3124
- }
3125
-
3126
- export namespace UpdateDomainResponse {
3127
- /**
3128
- * @internal
3129
- */
3130
- export const filterSensitiveLog = (obj: UpdateDomainResponse): any => ({
3131
- ...obj,
3132
- });
3133
- }
3134
-
3135
- /**
3136
- * <p>Updates associated with the address properties of a customer profile.</p>
3137
- */
3138
- export interface UpdateAddress {
3139
- /**
3140
- * <p>The first line of a customer address.</p>
3141
- */
3142
- Address1?: string;
3143
-
3144
- /**
3145
- * <p>The second line of a customer address.</p>
3146
- */
3147
- Address2?: string;
3148
-
3149
- /**
3150
- * <p>The third line of a customer address.</p>
3151
- */
3152
- Address3?: string;
3153
-
3154
- /**
3155
- * <p>The fourth line of a customer address.</p>
3156
- */
3157
- Address4?: string;
3158
-
3159
- /**
3160
- * <p>The city in which a customer lives.</p>
3161
- */
3162
- City?: string;
3163
-
3164
- /**
3165
- * <p>The county in which a customer lives.</p>
3166
- */
3167
- County?: string;
3168
-
3169
- /**
3170
- * <p>The state in which a customer lives.</p>
3171
- */
3172
- State?: string;
3173
-
3174
- /**
3175
- * <p>The province in which a customer lives.</p>
3176
- */
3177
- Province?: string;
3178
-
3179
- /**
3180
- * <p>The country in which a customer lives.</p>
3181
- */
3182
- Country?: string;
3183
-
3184
- /**
3185
- * <p>The postal code of a customer address.</p>
3186
- */
3187
- PostalCode?: string;
3188
- }
3189
-
3190
- export namespace UpdateAddress {
3191
- /**
3192
- * @internal
3193
- */
3194
- export const filterSensitiveLog = (obj: UpdateAddress): any => ({
3195
- ...obj,
3196
- });
3197
- }
3198
-
3199
- export interface UpdateProfileRequest {
3200
- /**
3201
- * <p>The unique name of the domain.</p>
3202
- */
3203
- DomainName: string | undefined;
3204
-
3205
- /**
3206
- * <p>The unique identifier of a customer profile.</p>
3207
- */
3208
- ProfileId: string | undefined;
3209
-
3210
- /**
3211
- * <p>Any additional information relevant to the customer’s profile.</p>
3212
- */
3213
- AdditionalInformation?: string;
3214
-
3215
- /**
3216
- * <p>A unique account number that you have given to the customer.</p>
3217
- */
3218
- AccountNumber?: string;
3219
-
3220
- /**
3221
- * <p>The type of profile used to describe the customer.</p>
3222
- */
3223
- PartyType?: PartyType | string;
3224
-
3225
- /**
3226
- * <p>The name of the customer’s business.</p>
3227
- */
3228
- BusinessName?: string;
3229
-
3230
- /**
3231
- * <p>The customer’s first name.</p>
3232
- */
3233
- FirstName?: string;
3234
-
3235
- /**
3236
- * <p>The customer’s middle name.</p>
3237
- */
3238
- MiddleName?: string;
3239
-
3240
- /**
3241
- * <p>The customer’s last name.</p>
3242
- */
3243
- LastName?: string;
3244
-
3245
- /**
3246
- * <p>The customer’s birth date. </p>
3247
- */
3248
- BirthDate?: string;
3249
-
3250
- /**
3251
- * <p>The gender with which the customer identifies. </p>
3252
- */
3253
- Gender?: Gender | string;
3254
-
3255
- /**
3256
- * <p>The customer’s phone number, which has not been specified as a mobile, home, or business
3257
- * number. </p>
3258
- */
3259
- PhoneNumber?: string;
3260
-
3261
- /**
3262
- * <p>The customer’s mobile phone number.</p>
3263
- */
3264
- MobilePhoneNumber?: string;
3265
-
3266
- /**
3267
- * <p>The customer’s home phone number.</p>
3268
- */
3269
- HomePhoneNumber?: string;
3270
-
3271
- /**
3272
- * <p>The customer’s business phone number.</p>
3273
- */
3274
- BusinessPhoneNumber?: string;
3275
-
3276
- /**
3277
- * <p>The customer’s email address, which has not been specified as a personal or business
3278
- * address. </p>
3279
- */
3280
- EmailAddress?: string;
3281
-
3282
- /**
3283
- * <p>The customer’s personal email address.</p>
3284
- */
3285
- PersonalEmailAddress?: string;
3286
-
3287
- /**
3288
- * <p>The customer’s business email address.</p>
3289
- */
3290
- BusinessEmailAddress?: string;
3291
-
3292
- /**
3293
- * <p>A generic address associated with the customer that is not mailing, shipping, or
3294
- * billing.</p>
3295
- */
3296
- Address?: UpdateAddress;
3297
-
3298
- /**
3299
- * <p>The customer’s shipping address.</p>
3300
- */
3301
- ShippingAddress?: UpdateAddress;
3302
-
3303
- /**
3304
- * <p>The customer’s mailing address.</p>
3305
- */
3306
- MailingAddress?: UpdateAddress;
3307
-
3308
- /**
3309
- * <p>The customer’s billing address.</p>
3310
- */
3311
- BillingAddress?: UpdateAddress;
3312
-
3313
- /**
3314
- * <p>A key value pair of attributes of a customer profile.</p>
3315
- */
3316
- Attributes?: { [key: string]: string };
3317
- }
3318
-
3319
- export namespace UpdateProfileRequest {
3320
- /**
3321
- * @internal
3322
- */
3323
- export const filterSensitiveLog = (obj: UpdateProfileRequest): any => ({
3324
- ...obj,
3325
- });
3326
- }
3327
-
3328
- export interface UpdateProfileResponse {
3329
- /**
3330
- * <p>The unique identifier of a customer profile.</p>
3331
- */
3332
- ProfileId: string | undefined;
3333
- }
3334
-
3335
- export namespace UpdateProfileResponse {
3336
- /**
3337
- * @internal
3338
- */
3339
- export const filterSensitiveLog = (obj: UpdateProfileResponse): any => ({
3340
- ...obj,
3341
- });
3342
- }