@aws-sdk/client-pinpoint-email 3.35.0 → 3.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (365) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/PinpointEmail.js +0 -32
  3. package/dist-cjs/PinpointEmailClient.js +0 -37
  4. package/dist-cjs/commands/CreateConfigurationSetCommand.js +0 -29
  5. package/dist-cjs/commands/CreateConfigurationSetEventDestinationCommand.js +0 -31
  6. package/dist-cjs/commands/CreateDedicatedIpPoolCommand.js +0 -28
  7. package/dist-cjs/commands/CreateDeliverabilityTestReportCommand.js +0 -31
  8. package/dist-cjs/commands/CreateEmailIdentityCommand.js +0 -38
  9. package/dist-cjs/commands/DeleteConfigurationSetCommand.js +0 -30
  10. package/dist-cjs/commands/DeleteConfigurationSetEventDestinationCommand.js +0 -30
  11. package/dist-cjs/commands/DeleteDedicatedIpPoolCommand.js +0 -25
  12. package/dist-cjs/commands/DeleteEmailIdentityCommand.js +0 -26
  13. package/dist-cjs/commands/GetAccountCommand.js +0 -26
  14. package/dist-cjs/commands/GetBlacklistReportsCommand.js +0 -25
  15. package/dist-cjs/commands/GetConfigurationSetCommand.js +0 -32
  16. package/dist-cjs/commands/GetConfigurationSetEventDestinationsCommand.js +0 -31
  17. package/dist-cjs/commands/GetDedicatedIpCommand.js +0 -27
  18. package/dist-cjs/commands/GetDedicatedIpsCommand.js +0 -26
  19. package/dist-cjs/commands/GetDeliverabilityDashboardOptionsCommand.js +0 -31
  20. package/dist-cjs/commands/GetDeliverabilityTestReportCommand.js +0 -25
  21. package/dist-cjs/commands/GetDomainDeliverabilityCampaignCommand.js +0 -28
  22. package/dist-cjs/commands/GetDomainStatisticsReportCommand.js +0 -26
  23. package/dist-cjs/commands/GetEmailIdentityCommand.js +0 -27
  24. package/dist-cjs/commands/ListConfigurationSetsCommand.js +0 -31
  25. package/dist-cjs/commands/ListDedicatedIpPoolsCommand.js +0 -26
  26. package/dist-cjs/commands/ListDeliverabilityTestReportsCommand.js +0 -27
  27. package/dist-cjs/commands/ListDomainDeliverabilityCampaignsCommand.js +0 -28
  28. package/dist-cjs/commands/ListEmailIdentitiesCommand.js +0 -27
  29. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -30
  30. package/dist-cjs/commands/PutAccountDedicatedIpWarmupAttributesCommand.js +0 -25
  31. package/dist-cjs/commands/PutAccountSendingAttributesCommand.js +0 -25
  32. package/dist-cjs/commands/PutConfigurationSetDeliveryOptionsCommand.js +0 -26
  33. package/dist-cjs/commands/PutConfigurationSetReputationOptionsCommand.js +0 -26
  34. package/dist-cjs/commands/PutConfigurationSetSendingOptionsCommand.js +0 -26
  35. package/dist-cjs/commands/PutConfigurationSetTrackingOptionsCommand.js +0 -26
  36. package/dist-cjs/commands/PutDedicatedIpInPoolCommand.js +0 -34
  37. package/dist-cjs/commands/PutDedicatedIpWarmupAttributesCommand.js +0 -25
  38. package/dist-cjs/commands/PutDeliverabilityDashboardOptionCommand.js +0 -31
  39. package/dist-cjs/commands/PutEmailIdentityDkimAttributesCommand.js +0 -25
  40. package/dist-cjs/commands/PutEmailIdentityFeedbackAttributesCommand.js +0 -35
  41. package/dist-cjs/commands/PutEmailIdentityMailFromAttributesCommand.js +0 -26
  42. package/dist-cjs/commands/SendEmailCommand.js +0 -42
  43. package/dist-cjs/commands/TagResourceCommand.js +0 -33
  44. package/dist-cjs/commands/UntagResourceCommand.js +0 -25
  45. package/dist-cjs/commands/UpdateConfigurationSetEventDestinationCommand.js +0 -30
  46. package/dist-cjs/commands/index.js +45 -0
  47. package/dist-cjs/endpoints.js +1 -2
  48. package/dist-cjs/index.js +4 -52
  49. package/dist-cjs/models/index.js +0 -1
  50. package/dist-cjs/models/models_0.js +0 -391
  51. package/dist-cjs/pagination/GetDedicatedIpsPaginator.js +0 -11
  52. package/dist-cjs/pagination/Interfaces.js +0 -1
  53. package/dist-cjs/pagination/ListConfigurationSetsPaginator.js +0 -11
  54. package/dist-cjs/pagination/ListDedicatedIpPoolsPaginator.js +0 -11
  55. package/dist-cjs/pagination/ListDeliverabilityTestReportsPaginator.js +0 -11
  56. package/dist-cjs/pagination/ListDomainDeliverabilityCampaignsPaginator.js +0 -11
  57. package/dist-cjs/pagination/ListEmailIdentitiesPaginator.js +0 -11
  58. package/dist-cjs/pagination/index.js +10 -0
  59. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  60. package/dist-cjs/runtimeConfig.browser.js +1 -6
  61. package/dist-cjs/runtimeConfig.js +2 -7
  62. package/dist-cjs/runtimeConfig.native.js +0 -4
  63. package/dist-cjs/runtimeConfig.shared.js +0 -4
  64. package/dist-es/PinpointEmail.js +0 -1
  65. package/dist-es/PinpointEmailClient.js +0 -1
  66. package/dist-es/commands/CreateConfigurationSetCommand.js +0 -1
  67. package/dist-es/commands/CreateConfigurationSetEventDestinationCommand.js +0 -1
  68. package/dist-es/commands/CreateDedicatedIpPoolCommand.js +0 -1
  69. package/dist-es/commands/CreateDeliverabilityTestReportCommand.js +0 -1
  70. package/dist-es/commands/CreateEmailIdentityCommand.js +0 -1
  71. package/dist-es/commands/DeleteConfigurationSetCommand.js +0 -1
  72. package/dist-es/commands/DeleteConfigurationSetEventDestinationCommand.js +0 -1
  73. package/dist-es/commands/DeleteDedicatedIpPoolCommand.js +0 -1
  74. package/dist-es/commands/DeleteEmailIdentityCommand.js +0 -1
  75. package/dist-es/commands/GetAccountCommand.js +0 -1
  76. package/dist-es/commands/GetBlacklistReportsCommand.js +0 -1
  77. package/dist-es/commands/GetConfigurationSetCommand.js +0 -1
  78. package/dist-es/commands/GetConfigurationSetEventDestinationsCommand.js +0 -1
  79. package/dist-es/commands/GetDedicatedIpCommand.js +0 -1
  80. package/dist-es/commands/GetDedicatedIpsCommand.js +0 -1
  81. package/dist-es/commands/GetDeliverabilityDashboardOptionsCommand.js +0 -1
  82. package/dist-es/commands/GetDeliverabilityTestReportCommand.js +0 -1
  83. package/dist-es/commands/GetDomainDeliverabilityCampaignCommand.js +0 -1
  84. package/dist-es/commands/GetDomainStatisticsReportCommand.js +0 -1
  85. package/dist-es/commands/GetEmailIdentityCommand.js +0 -1
  86. package/dist-es/commands/ListConfigurationSetsCommand.js +0 -1
  87. package/dist-es/commands/ListDedicatedIpPoolsCommand.js +0 -1
  88. package/dist-es/commands/ListDeliverabilityTestReportsCommand.js +0 -1
  89. package/dist-es/commands/ListDomainDeliverabilityCampaignsCommand.js +0 -1
  90. package/dist-es/commands/ListEmailIdentitiesCommand.js +0 -1
  91. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  92. package/dist-es/commands/PutAccountDedicatedIpWarmupAttributesCommand.js +0 -1
  93. package/dist-es/commands/PutAccountSendingAttributesCommand.js +0 -1
  94. package/dist-es/commands/PutConfigurationSetDeliveryOptionsCommand.js +0 -1
  95. package/dist-es/commands/PutConfigurationSetReputationOptionsCommand.js +0 -1
  96. package/dist-es/commands/PutConfigurationSetSendingOptionsCommand.js +0 -1
  97. package/dist-es/commands/PutConfigurationSetTrackingOptionsCommand.js +0 -1
  98. package/dist-es/commands/PutDedicatedIpInPoolCommand.js +0 -1
  99. package/dist-es/commands/PutDedicatedIpWarmupAttributesCommand.js +0 -1
  100. package/dist-es/commands/PutDeliverabilityDashboardOptionCommand.js +0 -1
  101. package/dist-es/commands/PutEmailIdentityDkimAttributesCommand.js +0 -1
  102. package/dist-es/commands/PutEmailIdentityFeedbackAttributesCommand.js +0 -1
  103. package/dist-es/commands/PutEmailIdentityMailFromAttributesCommand.js +0 -1
  104. package/dist-es/commands/SendEmailCommand.js +0 -1
  105. package/dist-es/commands/TagResourceCommand.js +0 -1
  106. package/dist-es/commands/UntagResourceCommand.js +0 -1
  107. package/dist-es/commands/UpdateConfigurationSetEventDestinationCommand.js +0 -1
  108. package/dist-es/commands/index.js +42 -0
  109. package/dist-es/endpoints.js +1 -2
  110. package/dist-es/index.js +4 -52
  111. package/dist-es/models/index.js +0 -1
  112. package/dist-es/models/models_0.js +0 -1
  113. package/dist-es/pagination/GetDedicatedIpsPaginator.js +0 -1
  114. package/dist-es/pagination/Interfaces.js +0 -1
  115. package/dist-es/pagination/ListConfigurationSetsPaginator.js +0 -1
  116. package/dist-es/pagination/ListDedicatedIpPoolsPaginator.js +0 -1
  117. package/dist-es/pagination/ListDeliverabilityTestReportsPaginator.js +0 -1
  118. package/dist-es/pagination/ListDomainDeliverabilityCampaignsPaginator.js +0 -1
  119. package/dist-es/pagination/ListEmailIdentitiesPaginator.js +0 -1
  120. package/dist-es/pagination/index.js +7 -0
  121. package/dist-es/protocols/Aws_restJson1.js +0 -1
  122. package/dist-es/runtimeConfig.browser.js +1 -2
  123. package/dist-es/runtimeConfig.js +2 -3
  124. package/dist-es/runtimeConfig.native.js +0 -1
  125. package/dist-es/runtimeConfig.shared.js +0 -1
  126. package/dist-types/commands/index.d.ts +42 -0
  127. package/dist-types/index.d.ts +4 -51
  128. package/dist-types/pagination/index.d.ts +7 -0
  129. package/dist-types/ts3.4/PinpointEmail.d.ts +43 -308
  130. package/dist-types/ts3.4/PinpointEmailClient.d.ts +24 -117
  131. package/dist-types/ts3.4/commands/CreateConfigurationSetCommand.d.ts +2 -24
  132. package/dist-types/ts3.4/commands/CreateConfigurationSetEventDestinationCommand.d.ts +2 -26
  133. package/dist-types/ts3.4/commands/CreateDedicatedIpPoolCommand.d.ts +2 -23
  134. package/dist-types/ts3.4/commands/CreateDeliverabilityTestReportCommand.d.ts +2 -26
  135. package/dist-types/ts3.4/commands/CreateEmailIdentityCommand.d.ts +2 -33
  136. package/dist-types/ts3.4/commands/DeleteConfigurationSetCommand.d.ts +2 -25
  137. package/dist-types/ts3.4/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +2 -25
  138. package/dist-types/ts3.4/commands/DeleteDedicatedIpPoolCommand.d.ts +2 -20
  139. package/dist-types/ts3.4/commands/DeleteEmailIdentityCommand.d.ts +2 -21
  140. package/dist-types/ts3.4/commands/GetAccountCommand.d.ts +2 -21
  141. package/dist-types/ts3.4/commands/GetBlacklistReportsCommand.d.ts +2 -20
  142. package/dist-types/ts3.4/commands/GetConfigurationSetCommand.d.ts +2 -27
  143. package/dist-types/ts3.4/commands/GetConfigurationSetEventDestinationsCommand.d.ts +2 -26
  144. package/dist-types/ts3.4/commands/GetDedicatedIpCommand.d.ts +2 -22
  145. package/dist-types/ts3.4/commands/GetDedicatedIpsCommand.d.ts +2 -21
  146. package/dist-types/ts3.4/commands/GetDeliverabilityDashboardOptionsCommand.d.ts +2 -26
  147. package/dist-types/ts3.4/commands/GetDeliverabilityTestReportCommand.d.ts +2 -20
  148. package/dist-types/ts3.4/commands/GetDomainDeliverabilityCampaignCommand.d.ts +2 -23
  149. package/dist-types/ts3.4/commands/GetDomainStatisticsReportCommand.d.ts +2 -21
  150. package/dist-types/ts3.4/commands/GetEmailIdentityCommand.d.ts +2 -22
  151. package/dist-types/ts3.4/commands/ListConfigurationSetsCommand.d.ts +2 -26
  152. package/dist-types/ts3.4/commands/ListDedicatedIpPoolsCommand.d.ts +2 -21
  153. package/dist-types/ts3.4/commands/ListDeliverabilityTestReportsCommand.d.ts +2 -22
  154. package/dist-types/ts3.4/commands/ListDomainDeliverabilityCampaignsCommand.d.ts +2 -23
  155. package/dist-types/ts3.4/commands/ListEmailIdentitiesCommand.d.ts +2 -22
  156. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -25
  157. package/dist-types/ts3.4/commands/PutAccountDedicatedIpWarmupAttributesCommand.d.ts +2 -20
  158. package/dist-types/ts3.4/commands/PutAccountSendingAttributesCommand.d.ts +2 -20
  159. package/dist-types/ts3.4/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +2 -21
  160. package/dist-types/ts3.4/commands/PutConfigurationSetReputationOptionsCommand.d.ts +2 -21
  161. package/dist-types/ts3.4/commands/PutConfigurationSetSendingOptionsCommand.d.ts +2 -21
  162. package/dist-types/ts3.4/commands/PutConfigurationSetTrackingOptionsCommand.d.ts +2 -21
  163. package/dist-types/ts3.4/commands/PutDedicatedIpInPoolCommand.d.ts +2 -29
  164. package/dist-types/ts3.4/commands/PutDedicatedIpWarmupAttributesCommand.d.ts +2 -20
  165. package/dist-types/ts3.4/commands/PutDeliverabilityDashboardOptionCommand.d.ts +2 -26
  166. package/dist-types/ts3.4/commands/PutEmailIdentityDkimAttributesCommand.d.ts +2 -20
  167. package/dist-types/ts3.4/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +2 -30
  168. package/dist-types/ts3.4/commands/PutEmailIdentityMailFromAttributesCommand.d.ts +2 -21
  169. package/dist-types/ts3.4/commands/SendEmailCommand.d.ts +2 -37
  170. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -28
  171. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  172. package/dist-types/ts3.4/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +2 -25
  173. package/dist-types/ts3.4/commands/index.d.ts +42 -0
  174. package/dist-types/ts3.4/index.d.ts +4 -51
  175. package/dist-types/ts3.4/models/models_0.d.ts +504 -2198
  176. package/dist-types/ts3.4/pagination/index.d.ts +7 -0
  177. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  178. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  179. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  180. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  181. package/package.json +33 -30
  182. package/dist-cjs/PinpointEmail.js.map +0 -1
  183. package/dist-cjs/PinpointEmailClient.js.map +0 -1
  184. package/dist-cjs/commands/CreateConfigurationSetCommand.js.map +0 -1
  185. package/dist-cjs/commands/CreateConfigurationSetEventDestinationCommand.js.map +0 -1
  186. package/dist-cjs/commands/CreateDedicatedIpPoolCommand.js.map +0 -1
  187. package/dist-cjs/commands/CreateDeliverabilityTestReportCommand.js.map +0 -1
  188. package/dist-cjs/commands/CreateEmailIdentityCommand.js.map +0 -1
  189. package/dist-cjs/commands/DeleteConfigurationSetCommand.js.map +0 -1
  190. package/dist-cjs/commands/DeleteConfigurationSetEventDestinationCommand.js.map +0 -1
  191. package/dist-cjs/commands/DeleteDedicatedIpPoolCommand.js.map +0 -1
  192. package/dist-cjs/commands/DeleteEmailIdentityCommand.js.map +0 -1
  193. package/dist-cjs/commands/GetAccountCommand.js.map +0 -1
  194. package/dist-cjs/commands/GetBlacklistReportsCommand.js.map +0 -1
  195. package/dist-cjs/commands/GetConfigurationSetCommand.js.map +0 -1
  196. package/dist-cjs/commands/GetConfigurationSetEventDestinationsCommand.js.map +0 -1
  197. package/dist-cjs/commands/GetDedicatedIpCommand.js.map +0 -1
  198. package/dist-cjs/commands/GetDedicatedIpsCommand.js.map +0 -1
  199. package/dist-cjs/commands/GetDeliverabilityDashboardOptionsCommand.js.map +0 -1
  200. package/dist-cjs/commands/GetDeliverabilityTestReportCommand.js.map +0 -1
  201. package/dist-cjs/commands/GetDomainDeliverabilityCampaignCommand.js.map +0 -1
  202. package/dist-cjs/commands/GetDomainStatisticsReportCommand.js.map +0 -1
  203. package/dist-cjs/commands/GetEmailIdentityCommand.js.map +0 -1
  204. package/dist-cjs/commands/ListConfigurationSetsCommand.js.map +0 -1
  205. package/dist-cjs/commands/ListDedicatedIpPoolsCommand.js.map +0 -1
  206. package/dist-cjs/commands/ListDeliverabilityTestReportsCommand.js.map +0 -1
  207. package/dist-cjs/commands/ListDomainDeliverabilityCampaignsCommand.js.map +0 -1
  208. package/dist-cjs/commands/ListEmailIdentitiesCommand.js.map +0 -1
  209. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  210. package/dist-cjs/commands/PutAccountDedicatedIpWarmupAttributesCommand.js.map +0 -1
  211. package/dist-cjs/commands/PutAccountSendingAttributesCommand.js.map +0 -1
  212. package/dist-cjs/commands/PutConfigurationSetDeliveryOptionsCommand.js.map +0 -1
  213. package/dist-cjs/commands/PutConfigurationSetReputationOptionsCommand.js.map +0 -1
  214. package/dist-cjs/commands/PutConfigurationSetSendingOptionsCommand.js.map +0 -1
  215. package/dist-cjs/commands/PutConfigurationSetTrackingOptionsCommand.js.map +0 -1
  216. package/dist-cjs/commands/PutDedicatedIpInPoolCommand.js.map +0 -1
  217. package/dist-cjs/commands/PutDedicatedIpWarmupAttributesCommand.js.map +0 -1
  218. package/dist-cjs/commands/PutDeliverabilityDashboardOptionCommand.js.map +0 -1
  219. package/dist-cjs/commands/PutEmailIdentityDkimAttributesCommand.js.map +0 -1
  220. package/dist-cjs/commands/PutEmailIdentityFeedbackAttributesCommand.js.map +0 -1
  221. package/dist-cjs/commands/PutEmailIdentityMailFromAttributesCommand.js.map +0 -1
  222. package/dist-cjs/commands/SendEmailCommand.js.map +0 -1
  223. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  224. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  225. package/dist-cjs/commands/UpdateConfigurationSetEventDestinationCommand.js.map +0 -1
  226. package/dist-cjs/endpoints.js.map +0 -1
  227. package/dist-cjs/index.js.map +0 -1
  228. package/dist-cjs/models/index.js.map +0 -1
  229. package/dist-cjs/models/models_0.js.map +0 -1
  230. package/dist-cjs/pagination/GetDedicatedIpsPaginator.js.map +0 -1
  231. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  232. package/dist-cjs/pagination/ListConfigurationSetsPaginator.js.map +0 -1
  233. package/dist-cjs/pagination/ListDedicatedIpPoolsPaginator.js.map +0 -1
  234. package/dist-cjs/pagination/ListDeliverabilityTestReportsPaginator.js.map +0 -1
  235. package/dist-cjs/pagination/ListDomainDeliverabilityCampaignsPaginator.js.map +0 -1
  236. package/dist-cjs/pagination/ListEmailIdentitiesPaginator.js.map +0 -1
  237. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  238. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  239. package/dist-cjs/runtimeConfig.js.map +0 -1
  240. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  241. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  242. package/dist-es/PinpointEmail.js.map +0 -1
  243. package/dist-es/PinpointEmailClient.js.map +0 -1
  244. package/dist-es/commands/CreateConfigurationSetCommand.js.map +0 -1
  245. package/dist-es/commands/CreateConfigurationSetEventDestinationCommand.js.map +0 -1
  246. package/dist-es/commands/CreateDedicatedIpPoolCommand.js.map +0 -1
  247. package/dist-es/commands/CreateDeliverabilityTestReportCommand.js.map +0 -1
  248. package/dist-es/commands/CreateEmailIdentityCommand.js.map +0 -1
  249. package/dist-es/commands/DeleteConfigurationSetCommand.js.map +0 -1
  250. package/dist-es/commands/DeleteConfigurationSetEventDestinationCommand.js.map +0 -1
  251. package/dist-es/commands/DeleteDedicatedIpPoolCommand.js.map +0 -1
  252. package/dist-es/commands/DeleteEmailIdentityCommand.js.map +0 -1
  253. package/dist-es/commands/GetAccountCommand.js.map +0 -1
  254. package/dist-es/commands/GetBlacklistReportsCommand.js.map +0 -1
  255. package/dist-es/commands/GetConfigurationSetCommand.js.map +0 -1
  256. package/dist-es/commands/GetConfigurationSetEventDestinationsCommand.js.map +0 -1
  257. package/dist-es/commands/GetDedicatedIpCommand.js.map +0 -1
  258. package/dist-es/commands/GetDedicatedIpsCommand.js.map +0 -1
  259. package/dist-es/commands/GetDeliverabilityDashboardOptionsCommand.js.map +0 -1
  260. package/dist-es/commands/GetDeliverabilityTestReportCommand.js.map +0 -1
  261. package/dist-es/commands/GetDomainDeliverabilityCampaignCommand.js.map +0 -1
  262. package/dist-es/commands/GetDomainStatisticsReportCommand.js.map +0 -1
  263. package/dist-es/commands/GetEmailIdentityCommand.js.map +0 -1
  264. package/dist-es/commands/ListConfigurationSetsCommand.js.map +0 -1
  265. package/dist-es/commands/ListDedicatedIpPoolsCommand.js.map +0 -1
  266. package/dist-es/commands/ListDeliverabilityTestReportsCommand.js.map +0 -1
  267. package/dist-es/commands/ListDomainDeliverabilityCampaignsCommand.js.map +0 -1
  268. package/dist-es/commands/ListEmailIdentitiesCommand.js.map +0 -1
  269. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  270. package/dist-es/commands/PutAccountDedicatedIpWarmupAttributesCommand.js.map +0 -1
  271. package/dist-es/commands/PutAccountSendingAttributesCommand.js.map +0 -1
  272. package/dist-es/commands/PutConfigurationSetDeliveryOptionsCommand.js.map +0 -1
  273. package/dist-es/commands/PutConfigurationSetReputationOptionsCommand.js.map +0 -1
  274. package/dist-es/commands/PutConfigurationSetSendingOptionsCommand.js.map +0 -1
  275. package/dist-es/commands/PutConfigurationSetTrackingOptionsCommand.js.map +0 -1
  276. package/dist-es/commands/PutDedicatedIpInPoolCommand.js.map +0 -1
  277. package/dist-es/commands/PutDedicatedIpWarmupAttributesCommand.js.map +0 -1
  278. package/dist-es/commands/PutDeliverabilityDashboardOptionCommand.js.map +0 -1
  279. package/dist-es/commands/PutEmailIdentityDkimAttributesCommand.js.map +0 -1
  280. package/dist-es/commands/PutEmailIdentityFeedbackAttributesCommand.js.map +0 -1
  281. package/dist-es/commands/PutEmailIdentityMailFromAttributesCommand.js.map +0 -1
  282. package/dist-es/commands/SendEmailCommand.js.map +0 -1
  283. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  284. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  285. package/dist-es/commands/UpdateConfigurationSetEventDestinationCommand.js.map +0 -1
  286. package/dist-es/endpoints.js.map +0 -1
  287. package/dist-es/index.js.map +0 -1
  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/pagination/GetDedicatedIpsPaginator.js.map +0 -1
  291. package/dist-es/pagination/Interfaces.js.map +0 -1
  292. package/dist-es/pagination/ListConfigurationSetsPaginator.js.map +0 -1
  293. package/dist-es/pagination/ListDedicatedIpPoolsPaginator.js.map +0 -1
  294. package/dist-es/pagination/ListDeliverabilityTestReportsPaginator.js.map +0 -1
  295. package/dist-es/pagination/ListDomainDeliverabilityCampaignsPaginator.js.map +0 -1
  296. package/dist-es/pagination/ListEmailIdentitiesPaginator.js.map +0 -1
  297. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  298. package/dist-es/runtimeConfig.browser.js.map +0 -1
  299. package/dist-es/runtimeConfig.js.map +0 -1
  300. package/dist-es/runtimeConfig.native.js.map +0 -1
  301. package/dist-es/runtimeConfig.shared.js.map +0 -1
  302. package/jest.config.js +0 -4
  303. package/src/PinpointEmail.ts +0 -1719
  304. package/src/PinpointEmailClient.ts +0 -495
  305. package/src/commands/CreateConfigurationSetCommand.ts +0 -99
  306. package/src/commands/CreateConfigurationSetEventDestinationCommand.ts +0 -113
  307. package/src/commands/CreateDedicatedIpPoolCommand.ts +0 -98
  308. package/src/commands/CreateDeliverabilityTestReportCommand.ts +0 -109
  309. package/src/commands/CreateEmailIdentityCommand.ts +0 -108
  310. package/src/commands/DeleteConfigurationSetCommand.ts +0 -100
  311. package/src/commands/DeleteConfigurationSetEventDestinationCommand.ts +0 -112
  312. package/src/commands/DeleteDedicatedIpPoolCommand.ts +0 -95
  313. package/src/commands/DeleteEmailIdentityCommand.ts +0 -96
  314. package/src/commands/GetAccountCommand.ts +0 -96
  315. package/src/commands/GetBlacklistReportsCommand.ts +0 -95
  316. package/src/commands/GetConfigurationSetCommand.ts +0 -102
  317. package/src/commands/GetConfigurationSetEventDestinationsCommand.ts +0 -112
  318. package/src/commands/GetDedicatedIpCommand.ts +0 -97
  319. package/src/commands/GetDedicatedIpsCommand.ts +0 -96
  320. package/src/commands/GetDeliverabilityDashboardOptionsCommand.ts +0 -112
  321. package/src/commands/GetDeliverabilityTestReportCommand.ts +0 -100
  322. package/src/commands/GetDomainDeliverabilityCampaignCommand.ts +0 -106
  323. package/src/commands/GetDomainStatisticsReportCommand.ts +0 -99
  324. package/src/commands/GetEmailIdentityCommand.ts +0 -97
  325. package/src/commands/ListConfigurationSetsCommand.ts +0 -101
  326. package/src/commands/ListDedicatedIpPoolsCommand.ts +0 -96
  327. package/src/commands/ListDeliverabilityTestReportsCommand.ts +0 -102
  328. package/src/commands/ListDomainDeliverabilityCampaignsCommand.ts +0 -109
  329. package/src/commands/ListEmailIdentitiesCommand.ts +0 -97
  330. package/src/commands/ListTagsForResourceCommand.ts +0 -100
  331. package/src/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts +0 -107
  332. package/src/commands/PutAccountSendingAttributesCommand.ts +0 -100
  333. package/src/commands/PutConfigurationSetDeliveryOptionsCommand.ts +0 -107
  334. package/src/commands/PutConfigurationSetReputationOptionsCommand.ts +0 -107
  335. package/src/commands/PutConfigurationSetSendingOptionsCommand.ts +0 -107
  336. package/src/commands/PutConfigurationSetTrackingOptionsCommand.ts +0 -107
  337. package/src/commands/PutDedicatedIpInPoolCommand.ts +0 -104
  338. package/src/commands/PutDedicatedIpWarmupAttributesCommand.ts +0 -103
  339. package/src/commands/PutDeliverabilityDashboardOptionCommand.ts +0 -109
  340. package/src/commands/PutEmailIdentityDkimAttributesCommand.ts +0 -103
  341. package/src/commands/PutEmailIdentityFeedbackAttributesCommand.ts +0 -116
  342. package/src/commands/PutEmailIdentityMailFromAttributesCommand.ts +0 -107
  343. package/src/commands/SendEmailCommand.ts +0 -112
  344. package/src/commands/TagResourceCommand.ts +0 -103
  345. package/src/commands/UntagResourceCommand.ts +0 -95
  346. package/src/commands/UpdateConfigurationSetEventDestinationCommand.ts +0 -112
  347. package/src/endpoints.ts +0 -62
  348. package/src/index.ts +0 -52
  349. package/src/models/index.ts +0 -1
  350. package/src/models/models_0.ts +0 -3845
  351. package/src/pagination/GetDedicatedIpsPaginator.ts +0 -59
  352. package/src/pagination/Interfaces.ts +0 -8
  353. package/src/pagination/ListConfigurationSetsPaginator.ts +0 -59
  354. package/src/pagination/ListDedicatedIpPoolsPaginator.ts +0 -59
  355. package/src/pagination/ListDeliverabilityTestReportsPaginator.ts +0 -59
  356. package/src/pagination/ListDomainDeliverabilityCampaignsPaginator.ts +0 -59
  357. package/src/pagination/ListEmailIdentitiesPaginator.ts +0 -59
  358. package/src/protocols/Aws_restJson1.ts +0 -5818
  359. package/src/runtimeConfig.browser.ts +0 -41
  360. package/src/runtimeConfig.native.ts +0 -17
  361. package/src/runtimeConfig.shared.ts +0 -17
  362. package/src/runtimeConfig.ts +0 -46
  363. package/tsconfig.es.json +0 -10
  364. package/tsconfig.json +0 -33
  365. package/tsconfig.types.json +0 -9
@@ -1,297 +1,153 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>The message can't be sent because the account's ability to send email has been
4
- * permanently restricted.</p>
5
- */
2
+
6
3
  export interface AccountSuspendedException extends __SmithyException, $MetadataBearer {
7
4
  name: "AccountSuspendedException";
8
5
  $fault: "client";
9
6
  message?: string;
10
7
  }
11
8
  export declare namespace AccountSuspendedException {
12
- /**
13
- * @internal
14
- */
9
+
15
10
  const filterSensitiveLog: (obj: AccountSuspendedException) => any;
16
11
  }
17
- /**
18
- * <p>The resource specified in your request already exists.</p>
19
- */
12
+
20
13
  export interface AlreadyExistsException extends __SmithyException, $MetadataBearer {
21
14
  name: "AlreadyExistsException";
22
15
  $fault: "client";
23
16
  message?: string;
24
17
  }
25
18
  export declare namespace AlreadyExistsException {
26
- /**
27
- * @internal
28
- */
19
+
29
20
  const filterSensitiveLog: (obj: AlreadyExistsException) => any;
30
21
  }
31
- /**
32
- * <p>The input you provided is invalid.</p>
33
- */
22
+
34
23
  export interface BadRequestException extends __SmithyException, $MetadataBearer {
35
24
  name: "BadRequestException";
36
25
  $fault: "client";
37
26
  message?: string;
38
27
  }
39
28
  export declare namespace BadRequestException {
40
- /**
41
- * @internal
42
- */
29
+
43
30
  const filterSensitiveLog: (obj: BadRequestException) => any;
44
31
  }
45
- /**
46
- * <p>The resource is being modified by another operation or thread.</p>
47
- */
32
+
48
33
  export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
49
34
  name: "ConcurrentModificationException";
50
35
  $fault: "server";
51
36
  message?: string;
52
37
  }
53
38
  export declare namespace ConcurrentModificationException {
54
- /**
55
- * @internal
56
- */
39
+
57
40
  const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
58
41
  }
59
42
  export declare enum TlsPolicy {
60
43
  OPTIONAL = "OPTIONAL",
61
44
  REQUIRE = "REQUIRE"
62
45
  }
63
- /**
64
- * <p>Used to associate a configuration set with a dedicated IP pool.</p>
65
- */
46
+
66
47
  export interface DeliveryOptions {
67
- /**
68
- * <p>Specifies whether messages that use the configuration set are required to use
69
- * Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
70
- * delivered if a TLS connection can be established. If the value is <code>Optional</code>,
71
- * messages can be delivered in plain text if a TLS connection can't be established.</p>
72
- */
48
+
73
49
  TlsPolicy?: TlsPolicy | string;
74
- /**
75
- * <p>The name of the dedicated IP pool that you want to associate with the configuration
76
- * set.</p>
77
- */
50
+
78
51
  SendingPoolName?: string;
79
52
  }
80
53
  export declare namespace DeliveryOptions {
81
- /**
82
- * @internal
83
- */
54
+
84
55
  const filterSensitiveLog: (obj: DeliveryOptions) => any;
85
56
  }
86
- /**
87
- * <p>Enable or disable collection of reputation metrics for emails that you send using this
88
- * configuration set in the current AWS Region. </p>
89
- */
57
+
90
58
  export interface ReputationOptions {
91
- /**
92
- * <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
93
- * set. If <code>false</code>, tracking of reputation metrics is disabled for the
94
- * configuration set.</p>
95
- */
59
+
96
60
  ReputationMetricsEnabled?: boolean;
97
- /**
98
- * <p>The date and time (in Unix time) when the reputation metrics were last given a fresh
99
- * start. When your account is given a fresh start, your reputation metrics are calculated
100
- * starting from the date of the fresh start.</p>
101
- */
61
+
102
62
  LastFreshStart?: Date;
103
63
  }
104
64
  export declare namespace ReputationOptions {
105
- /**
106
- * @internal
107
- */
65
+
108
66
  const filterSensitiveLog: (obj: ReputationOptions) => any;
109
67
  }
110
- /**
111
- * <p>Used to enable or disable email sending for messages that use this configuration set
112
- * in the current AWS Region.</p>
113
- */
68
+
114
69
  export interface SendingOptions {
115
- /**
116
- * <p>If <code>true</code>, email sending is enabled for the configuration set. If
117
- * <code>false</code>, email sending is disabled for the configuration set.</p>
118
- */
70
+
119
71
  SendingEnabled?: boolean;
120
72
  }
121
73
  export declare namespace SendingOptions {
122
- /**
123
- * @internal
124
- */
74
+
125
75
  const filterSensitiveLog: (obj: SendingOptions) => any;
126
76
  }
127
- /**
128
- * <p>An object that defines the tags that are associated with a resource.
129
- * A <i>tag</i> is a label that you optionally define and associate with
130
- * a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different
131
- * ways, such as by purpose, owner, environment, or other criteria. A resource can have as
132
- * many as 50 tags.</p>
133
- * <p>Each tag consists of a required <i>tag key</i> and an
134
- * associated <i>tag value</i>, both of which you define. A tag key is a
135
- * general label that acts as a category for a more specific tag value. A tag value acts as
136
- * a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag
137
- * value can contain as many as 256 characters. The characters can be Unicode letters,
138
- * digits, white space, or one of the following symbols: _ . : / = + -. The following
139
- * additional restrictions apply to tags:</p>
140
- * <ul>
141
- * <li>
142
- * <p>Tag keys and values are case sensitive.</p>
143
- * </li>
144
- * <li>
145
- * <p>For each associated resource, each tag key must be unique and it can have only
146
- * one value.</p>
147
- * </li>
148
- * <li>
149
- * <p>The <code>aws:</code> prefix is reserved for use by AWS; you can’t use it in
150
- * any tag keys or values that you define. In addition, you can't edit or remove
151
- * tag keys or values that use this prefix. Tags that use this prefix don’t count
152
- * against the limit of 50 tags per resource.</p>
153
- * </li>
154
- * <li>
155
- * <p>You can associate tags with public or shared resources, but the tags are
156
- * available only for your AWS account, not any other accounts that share the
157
- * resource. In addition, the tags are available only for resources that are
158
- * located in the specified AWS Region for your AWS account.</p>
159
- * </li>
160
- * </ul>
161
- */
77
+
162
78
  export interface Tag {
163
- /**
164
- * <p>One part of a key-value pair that defines a tag. The maximum length of a tag key is
165
- * 128 characters. The minimum length is 1 character.</p>
166
- */
79
+
167
80
  Key: string | undefined;
168
- /**
169
- * <p>The optional part of a key-value pair that defines a tag. The maximum length of a tag
170
- * value is 256 characters. The minimum length is 0 characters. If you don’t want a
171
- * resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint
172
- * will set the value to an empty string.</p>
173
- */
81
+
174
82
  Value: string | undefined;
175
83
  }
176
84
  export declare namespace Tag {
177
- /**
178
- * @internal
179
- */
85
+
180
86
  const filterSensitiveLog: (obj: Tag) => any;
181
87
  }
182
- /**
183
- * <p>An object that defines the tracking options for a configuration set. When you use
184
- * Amazon Pinpoint to send an email, it contains an invisible image that's used to track when
185
- * recipients open your email. If your email contains links, those links are changed
186
- * slightly in order to track when recipients click them.</p>
187
- * <p>These images and links include references to a domain operated by AWS. You can
188
- * optionally configure Amazon Pinpoint to use a domain that you operate for these images and
189
- * links.</p>
190
- */
88
+
191
89
  export interface TrackingOptions {
192
- /**
193
- * <p>The domain that you want to use for tracking open and click events.</p>
194
- */
90
+
195
91
  CustomRedirectDomain: string | undefined;
196
92
  }
197
93
  export declare namespace TrackingOptions {
198
- /**
199
- * @internal
200
- */
94
+
201
95
  const filterSensitiveLog: (obj: TrackingOptions) => any;
202
96
  }
203
- /**
204
- * <p>A request to create a configuration set.</p>
205
- */
97
+
206
98
  export interface CreateConfigurationSetRequest {
207
- /**
208
- * <p>The name of the configuration set.</p>
209
- */
99
+
210
100
  ConfigurationSetName: string | undefined;
211
- /**
212
- * <p>An object that defines the open and click tracking options for emails that you send
213
- * using the configuration set.</p>
214
- */
101
+
215
102
  TrackingOptions?: TrackingOptions;
216
- /**
217
- * <p>An object that defines the dedicated IP pool that is used to send emails that you send
218
- * using the configuration set.</p>
219
- */
103
+
220
104
  DeliveryOptions?: DeliveryOptions;
221
- /**
222
- * <p>An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails
223
- * that you send that use the configuration set.</p>
224
- */
105
+
225
106
  ReputationOptions?: ReputationOptions;
226
- /**
227
- * <p>An object that defines whether or not Amazon Pinpoint can send email that you send using the
228
- * configuration set.</p>
229
- */
107
+
230
108
  SendingOptions?: SendingOptions;
231
- /**
232
- * <p>An array of objects that define the tags (keys and values) that you want to associate
233
- * with the configuration set.</p>
234
- */
109
+
235
110
  Tags?: Tag[];
236
111
  }
237
112
  export declare namespace CreateConfigurationSetRequest {
238
- /**
239
- * @internal
240
- */
113
+
241
114
  const filterSensitiveLog: (obj: CreateConfigurationSetRequest) => any;
242
115
  }
243
- /**
244
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
245
- * fails.</p>
246
- */
116
+
247
117
  export interface CreateConfigurationSetResponse {
248
118
  }
249
119
  export declare namespace CreateConfigurationSetResponse {
250
- /**
251
- * @internal
252
- */
120
+
253
121
  const filterSensitiveLog: (obj: CreateConfigurationSetResponse) => any;
254
122
  }
255
- /**
256
- * <p>There are too many instances of the specified resource type.</p>
257
- */
123
+
258
124
  export interface LimitExceededException extends __SmithyException, $MetadataBearer {
259
125
  name: "LimitExceededException";
260
126
  $fault: "client";
261
127
  message?: string;
262
128
  }
263
129
  export declare namespace LimitExceededException {
264
- /**
265
- * @internal
266
- */
130
+
267
131
  const filterSensitiveLog: (obj: LimitExceededException) => any;
268
132
  }
269
- /**
270
- * <p>The resource you attempted to access doesn't exist.</p>
271
- */
133
+
272
134
  export interface NotFoundException extends __SmithyException, $MetadataBearer {
273
135
  name: "NotFoundException";
274
136
  $fault: "client";
275
137
  message?: string;
276
138
  }
277
139
  export declare namespace NotFoundException {
278
- /**
279
- * @internal
280
- */
140
+
281
141
  const filterSensitiveLog: (obj: NotFoundException) => any;
282
142
  }
283
- /**
284
- * <p>Too many requests have been made to the operation.</p>
285
- */
143
+
286
144
  export interface TooManyRequestsException extends __SmithyException, $MetadataBearer {
287
145
  name: "TooManyRequestsException";
288
146
  $fault: "client";
289
147
  message?: string;
290
148
  }
291
149
  export declare namespace TooManyRequestsException {
292
- /**
293
- * @internal
294
- */
150
+
295
151
  const filterSensitiveLog: (obj: TooManyRequestsException) => any;
296
152
  }
297
153
  export declare enum DimensionValueSource {
@@ -299,92 +155,37 @@ export declare enum DimensionValueSource {
299
155
  LINK_TAG = "LINK_TAG",
300
156
  MESSAGE_TAG = "MESSAGE_TAG"
301
157
  }
302
- /**
303
- * <p>An object that defines the dimension configuration to use when you send Amazon Pinpoint email
304
- * events to Amazon CloudWatch.</p>
305
- */
158
+
306
159
  export interface CloudWatchDimensionConfiguration {
307
- /**
308
- * <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to
309
- * meet the following criteria:</p>
310
- * <ul>
311
- * <li>
312
- * <p>It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
313
- * or dashes (-).</p>
314
- * </li>
315
- * <li>
316
- * <p>It can contain no more than 256 characters.</p>
317
- * </li>
318
- * </ul>
319
- */
160
+
320
161
  DimensionName: string | undefined;
321
- /**
322
- * <p>The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you
323
- * want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header
324
- * or a parameter to the SendEmail/SendRawEmail API, choose <code>messageTag</code>. If you
325
- * want Amazon Pinpoint to use your own email headers, choose <code>emailHeader</code>. If you want
326
- * Amazon Pinpoint to use link tags, choose <code>linkTags</code>.</p>
327
- */
162
+
328
163
  DimensionValueSource: DimensionValueSource | string | undefined;
329
- /**
330
- * <p>The default value of the dimension that is published to Amazon CloudWatch if you don't provide the
331
- * value of the dimension when you send an email. This value has to meet the following
332
- * criteria:</p>
333
- * <ul>
334
- * <li>
335
- * <p>It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
336
- * or dashes (-).</p>
337
- * </li>
338
- * <li>
339
- * <p>It can contain no more than 256 characters.</p>
340
- * </li>
341
- * </ul>
342
- */
164
+
343
165
  DefaultDimensionValue: string | undefined;
344
166
  }
345
167
  export declare namespace CloudWatchDimensionConfiguration {
346
- /**
347
- * @internal
348
- */
168
+
349
169
  const filterSensitiveLog: (obj: CloudWatchDimensionConfiguration) => any;
350
170
  }
351
- /**
352
- * <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
353
- * monitor and gain insights on your email sending metrics.</p>
354
- */
171
+
355
172
  export interface CloudWatchDestination {
356
- /**
357
- * <p>An array of objects that define the dimensions to use when you send email events to
358
- * Amazon CloudWatch.</p>
359
- */
173
+
360
174
  DimensionConfigurations: CloudWatchDimensionConfiguration[] | undefined;
361
175
  }
362
176
  export declare namespace CloudWatchDestination {
363
- /**
364
- * @internal
365
- */
177
+
366
178
  const filterSensitiveLog: (obj: CloudWatchDestination) => any;
367
179
  }
368
- /**
369
- * <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
370
- * stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
371
- */
180
+
372
181
  export interface KinesisFirehoseDestination {
373
- /**
374
- * <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email
375
- * events to the Amazon Kinesis Data Firehose stream.</p>
376
- */
182
+
377
183
  IamRoleArn: string | undefined;
378
- /**
379
- * <p>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events
380
- * to.</p>
381
- */
184
+
382
185
  DeliveryStreamArn: string | undefined;
383
186
  }
384
187
  export declare namespace KinesisFirehoseDestination {
385
- /**
386
- * @internal
387
- */
188
+
388
189
  const filterSensitiveLog: (obj: KinesisFirehoseDestination) => any;
389
190
  }
390
191
  export declare enum EventType {
@@ -397,463 +198,215 @@ export declare enum EventType {
397
198
  RENDERING_FAILURE = "RENDERING_FAILURE",
398
199
  SEND = "SEND"
399
200
  }
400
- /**
401
- * <p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events
402
- * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments
403
- * for your campaigns.</p>
404
- */
201
+
405
202
  export interface PinpointDestination {
406
- /**
407
- * <p>The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email
408
- * events to.</p>
409
- */
203
+
410
204
  ApplicationArn?: string;
411
205
  }
412
206
  export declare namespace PinpointDestination {
413
- /**
414
- * @internal
415
- */
207
+
416
208
  const filterSensitiveLog: (obj: PinpointDestination) => any;
417
209
  }
418
- /**
419
- * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
420
- * send notification when certain email events occur.</p>
421
- */
210
+
422
211
  export interface SnsDestination {
423
- /**
424
- * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email
425
- * events to. For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer
426
- * Guide</a>.</p>
427
- */
212
+
428
213
  TopicArn: string | undefined;
429
214
  }
430
215
  export declare namespace SnsDestination {
431
- /**
432
- * @internal
433
- */
216
+
434
217
  const filterSensitiveLog: (obj: SnsDestination) => any;
435
218
  }
436
- /**
437
- * <p>An object that defines the event destination. Specifically, it defines which services
438
- * receive events from emails sent using the configuration set that the event destination
439
- * is associated with. Also defines the types of events that are sent to the event
440
- * destination.</p>
441
- */
219
+
442
220
  export interface EventDestinationDefinition {
443
- /**
444
- * <p>If <code>true</code>, the event destination is enabled. When the event destination is
445
- * enabled, the specified event types are sent to the destinations in this
446
- * <code>EventDestinationDefinition</code>.</p>
447
- * <p>If <code>false</code>, the event destination is disabled. When the event destination
448
- * is disabled, events aren't sent to the specified destinations.</p>
449
- */
221
+
450
222
  Enabled?: boolean;
451
- /**
452
- * <p>An array that specifies which events Amazon Pinpoint should send to the destinations in this
453
- * <code>EventDestinationDefinition</code>.</p>
454
- */
223
+
455
224
  MatchingEventTypes?: (EventType | string)[];
456
- /**
457
- * <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
458
- * stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
459
- */
225
+
460
226
  KinesisFirehoseDestination?: KinesisFirehoseDestination;
461
- /**
462
- * <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
463
- * monitor and gain insights on your email sending metrics.</p>
464
- */
227
+
465
228
  CloudWatchDestination?: CloudWatchDestination;
466
- /**
467
- * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
468
- * send notification when certain email events occur.</p>
469
- */
229
+
470
230
  SnsDestination?: SnsDestination;
471
- /**
472
- * <p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events
473
- * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments
474
- * for your campaigns.</p>
475
- */
231
+
476
232
  PinpointDestination?: PinpointDestination;
477
233
  }
478
234
  export declare namespace EventDestinationDefinition {
479
- /**
480
- * @internal
481
- */
235
+
482
236
  const filterSensitiveLog: (obj: EventDestinationDefinition) => any;
483
237
  }
484
- /**
485
- * <p>A request to add an event destination to a configuration set.</p>
486
- */
238
+
487
239
  export interface CreateConfigurationSetEventDestinationRequest {
488
- /**
489
- * <p>The name of the configuration set that you want to add an event destination to.</p>
490
- */
240
+
491
241
  ConfigurationSetName: string | undefined;
492
- /**
493
- * <p>A name that identifies the event destination within the configuration set.</p>
494
- */
242
+
495
243
  EventDestinationName: string | undefined;
496
- /**
497
- * <p>An object that defines the event destination.</p>
498
- */
244
+
499
245
  EventDestination: EventDestinationDefinition | undefined;
500
246
  }
501
247
  export declare namespace CreateConfigurationSetEventDestinationRequest {
502
- /**
503
- * @internal
504
- */
248
+
505
249
  const filterSensitiveLog: (obj: CreateConfigurationSetEventDestinationRequest) => any;
506
250
  }
507
- /**
508
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
509
- * fails.</p>
510
- */
251
+
511
252
  export interface CreateConfigurationSetEventDestinationResponse {
512
253
  }
513
254
  export declare namespace CreateConfigurationSetEventDestinationResponse {
514
- /**
515
- * @internal
516
- */
255
+
517
256
  const filterSensitiveLog: (obj: CreateConfigurationSetEventDestinationResponse) => any;
518
257
  }
519
- /**
520
- * <p>A request to create a new dedicated IP pool.</p>
521
- */
258
+
522
259
  export interface CreateDedicatedIpPoolRequest {
523
- /**
524
- * <p>The name of the dedicated IP pool.</p>
525
- */
260
+
526
261
  PoolName: string | undefined;
527
- /**
528
- * <p>An object that defines the tags (keys and values) that you want to associate with the
529
- * pool.</p>
530
- */
262
+
531
263
  Tags?: Tag[];
532
264
  }
533
265
  export declare namespace CreateDedicatedIpPoolRequest {
534
- /**
535
- * @internal
536
- */
266
+
537
267
  const filterSensitiveLog: (obj: CreateDedicatedIpPoolRequest) => any;
538
268
  }
539
- /**
540
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
541
- * fails.</p>
542
- */
269
+
543
270
  export interface CreateDedicatedIpPoolResponse {
544
271
  }
545
272
  export declare namespace CreateDedicatedIpPoolResponse {
546
- /**
547
- * @internal
548
- */
273
+
549
274
  const filterSensitiveLog: (obj: CreateDedicatedIpPoolResponse) => any;
550
275
  }
551
- /**
552
- * <p>The raw email message.</p>
553
- */
276
+
554
277
  export interface RawMessage {
555
- /**
556
- * <p>The raw email message. The message has to meet the following criteria:</p>
557
- * <ul>
558
- * <li>
559
- * <p>The message has to contain a header and a body, separated by one blank
560
- * line.</p>
561
- * </li>
562
- * <li>
563
- * <p>All of the required header fields must be present in the message.</p>
564
- * </li>
565
- * <li>
566
- * <p>Each part of a multipart MIME message must be formatted properly.</p>
567
- * </li>
568
- * <li>
569
- * <p>Attachments must be in a file format that Amazon Pinpoint supports.
570
- * </p>
571
- * </li>
572
- * <li>
573
- * <p>The entire message must be Base64 encoded.</p>
574
- * </li>
575
- * <li>
576
- * <p>If any of the MIME parts in your message contain content that is outside of
577
- * the 7-bit ASCII character range, you should encode that content to ensure that
578
- * recipients' email clients render the message properly.</p>
579
- * </li>
580
- * <li>
581
- * <p>The length of any single line of text in the message can't exceed 1,000
582
- * characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
583
- * </li>
584
- * </ul>
585
- */
278
+
586
279
  Data: Uint8Array | undefined;
587
280
  }
588
281
  export declare namespace RawMessage {
589
- /**
590
- * @internal
591
- */
282
+
592
283
  const filterSensitiveLog: (obj: RawMessage) => any;
593
284
  }
594
- /**
595
- * <p>An object that represents the content of the email, and optionally a character set
596
- * specification.</p>
597
- */
285
+
598
286
  export interface Content {
599
- /**
600
- * <p>The content of the message itself.</p>
601
- */
287
+
602
288
  Data: string | undefined;
603
- /**
604
- * <p>The character set for the content. Because of the constraints of the SMTP protocol,
605
- * Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII
606
- * range, you have to specify a character set. For example, you could specify
607
- * <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.</p>
608
- */
289
+
609
290
  Charset?: string;
610
291
  }
611
292
  export declare namespace Content {
612
- /**
613
- * @internal
614
- */
293
+
615
294
  const filterSensitiveLog: (obj: Content) => any;
616
295
  }
617
- /**
618
- * <p>Represents the body of the email message.</p>
619
- */
296
+
620
297
  export interface Body {
621
- /**
622
- * <p>An object that represents the version of the message that is displayed in email
623
- * clients that don't support HTML, or clients where the recipient has disabled HTML
624
- * rendering.</p>
625
- */
298
+
626
299
  Text?: Content;
627
- /**
628
- * <p>An object that represents the version of the message that is displayed in email
629
- * clients that support HTML. HTML messages can include formatted text, hyperlinks, images,
630
- * and more. </p>
631
- */
300
+
632
301
  Html?: Content;
633
302
  }
634
303
  export declare namespace Body {
635
- /**
636
- * @internal
637
- */
304
+
638
305
  const filterSensitiveLog: (obj: Body) => any;
639
306
  }
640
- /**
641
- * <p>Represents the email message that you're sending. The <code>Message</code> object
642
- * consists of a subject line and a message body.</p>
643
- */
307
+
644
308
  export interface Message {
645
- /**
646
- * <p>The subject line of the email. The subject line can only contain 7-bit ASCII
647
- * characters. However, you can specify non-ASCII characters in the subject line by using
648
- * encoded-word syntax, as described in <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>.</p>
649
- */
309
+
650
310
  Subject: Content | undefined;
651
- /**
652
- * <p>The body of the message. You can specify an HTML version of the message, a text-only
653
- * version of the message, or both.</p>
654
- */
311
+
655
312
  Body: Body | undefined;
656
313
  }
657
314
  export declare namespace Message {
658
- /**
659
- * @internal
660
- */
315
+
661
316
  const filterSensitiveLog: (obj: Message) => any;
662
317
  }
663
318
  export interface Template {
664
- /**
665
- * <p>The Amazon Resource Name (ARN) of the template.</p>
666
- */
319
+
667
320
  TemplateArn?: string;
668
- /**
669
- * <p>An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.</p>
670
- */
321
+
671
322
  TemplateData?: string;
672
323
  }
673
324
  export declare namespace Template {
674
- /**
675
- * @internal
676
- */
325
+
677
326
  const filterSensitiveLog: (obj: Template) => any;
678
327
  }
679
- /**
680
- * <p>An object that defines the entire content of the email, including the message headers
681
- * and the body content. You can create a simple email message, in which you specify the
682
- * subject and the text and HTML versions of the message body. You can also create raw
683
- * messages, in which you specify a complete MIME-formatted message. Raw messages can
684
- * include attachments and custom headers.</p>
685
- */
328
+
686
329
  export interface EmailContent {
687
- /**
688
- * <p>The simple email message. The message consists of a subject and a message body.</p>
689
- */
330
+
690
331
  Simple?: Message;
691
- /**
692
- * <p>The raw email message. The message has to meet the following criteria:</p>
693
- * <ul>
694
- * <li>
695
- * <p>The message has to contain a header and a body, separated by one blank
696
- * line.</p>
697
- * </li>
698
- * <li>
699
- * <p>All of the required header fields must be present in the message.</p>
700
- * </li>
701
- * <li>
702
- * <p>Each part of a multipart MIME message must be formatted properly.</p>
703
- * </li>
704
- * <li>
705
- * <p>If you include attachments, they must be in a file format that Amazon Pinpoint supports.
706
- * </p>
707
- * </li>
708
- * <li>
709
- * <p>The entire message must be Base64 encoded.</p>
710
- * </li>
711
- * <li>
712
- * <p>If any of the MIME parts in your message contain content that is outside of
713
- * the 7-bit ASCII character range, you should encode that content to ensure that
714
- * recipients' email clients render the message properly.</p>
715
- * </li>
716
- * <li>
717
- * <p>The length of any single line of text in the message can't exceed 1,000
718
- * characters. This restriction is defined in <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
719
- * </li>
720
- * </ul>
721
- */
332
+
722
333
  Raw?: RawMessage;
723
- /**
724
- * <p>The template to use for the email message.</p>
725
- */
334
+
726
335
  Template?: Template;
727
336
  }
728
337
  export declare namespace EmailContent {
729
- /**
730
- * @internal
731
- */
338
+
732
339
  const filterSensitiveLog: (obj: EmailContent) => any;
733
340
  }
734
- /**
735
- * <p>A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will
736
- * be handled by various email providers around the world. When you perform a predictive inbox placement test, you
737
- * provide a sample message that contains the content that you plan to send to your
738
- * customers. Amazon Pinpoint then sends that message to special email addresses spread across
739
- * several major email providers. After about 24 hours, the test is complete, and you can
740
- * use the <code>GetDeliverabilityTestReport</code> operation to view the results of the
741
- * test.</p>
742
- */
341
+
743
342
  export interface CreateDeliverabilityTestReportRequest {
744
- /**
745
- * <p>A unique name that helps you to identify the predictive inbox placement test when you retrieve the
746
- * results.</p>
747
- */
343
+
748
344
  ReportName?: string;
749
- /**
750
- * <p>The email address that the predictive inbox placement test email was sent from.</p>
751
- */
345
+
752
346
  FromEmailAddress: string | undefined;
753
- /**
754
- * <p>The HTML body of the message that you sent when you performed the predictive inbox placement test.</p>
755
- */
347
+
756
348
  Content: EmailContent | undefined;
757
- /**
758
- * <p>An array of objects that define the tags (keys and values) that you want to associate
759
- * with the predictive inbox placement test.</p>
760
- */
349
+
761
350
  Tags?: Tag[];
762
351
  }
763
352
  export declare namespace CreateDeliverabilityTestReportRequest {
764
- /**
765
- * @internal
766
- */
353
+
767
354
  const filterSensitiveLog: (obj: CreateDeliverabilityTestReportRequest) => any;
768
355
  }
769
356
  export declare enum DeliverabilityTestStatus {
770
357
  COMPLETED = "COMPLETED",
771
358
  IN_PROGRESS = "IN_PROGRESS"
772
359
  }
773
- /**
774
- * <p>Information about the predictive inbox placement test that you created.</p>
775
- */
360
+
776
361
  export interface CreateDeliverabilityTestReportResponse {
777
- /**
778
- * <p>A unique string that identifies the predictive inbox placement test.</p>
779
- */
362
+
780
363
  ReportId: string | undefined;
781
- /**
782
- * <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
783
- * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
784
- * test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
785
- * the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>
786
- */
364
+
787
365
  DeliverabilityTestStatus: DeliverabilityTestStatus | string | undefined;
788
366
  }
789
367
  export declare namespace CreateDeliverabilityTestReportResponse {
790
- /**
791
- * @internal
792
- */
368
+
793
369
  const filterSensitiveLog: (obj: CreateDeliverabilityTestReportResponse) => any;
794
370
  }
795
- /**
796
- * <p>The message can't be sent because the sending domain isn't verified.</p>
797
- */
371
+
798
372
  export interface MailFromDomainNotVerifiedException extends __SmithyException, $MetadataBearer {
799
373
  name: "MailFromDomainNotVerifiedException";
800
374
  $fault: "client";
801
375
  message?: string;
802
376
  }
803
377
  export declare namespace MailFromDomainNotVerifiedException {
804
- /**
805
- * @internal
806
- */
378
+
807
379
  const filterSensitiveLog: (obj: MailFromDomainNotVerifiedException) => any;
808
380
  }
809
- /**
810
- * <p>The message can't be sent because it contains invalid content.</p>
811
- */
381
+
812
382
  export interface MessageRejected extends __SmithyException, $MetadataBearer {
813
383
  name: "MessageRejected";
814
384
  $fault: "client";
815
385
  message?: string;
816
386
  }
817
387
  export declare namespace MessageRejected {
818
- /**
819
- * @internal
820
- */
388
+
821
389
  const filterSensitiveLog: (obj: MessageRejected) => any;
822
390
  }
823
- /**
824
- * <p>The message can't be sent because the account's ability to send email is currently
825
- * paused.</p>
826
- */
391
+
827
392
  export interface SendingPausedException extends __SmithyException, $MetadataBearer {
828
393
  name: "SendingPausedException";
829
394
  $fault: "client";
830
395
  message?: string;
831
396
  }
832
397
  export declare namespace SendingPausedException {
833
- /**
834
- * @internal
835
- */
398
+
836
399
  const filterSensitiveLog: (obj: SendingPausedException) => any;
837
400
  }
838
- /**
839
- * <p>A request to begin the verification process for an email identity (an email address or
840
- * domain).</p>
841
- */
401
+
842
402
  export interface CreateEmailIdentityRequest {
843
- /**
844
- * <p>The email address or domain that you want to verify.</p>
845
- */
403
+
846
404
  EmailIdentity: string | undefined;
847
- /**
848
- * <p>An array of objects that define the tags (keys and values) that you want to associate
849
- * with the email identity.</p>
850
- */
405
+
851
406
  Tags?: Tag[];
852
407
  }
853
408
  export declare namespace CreateEmailIdentityRequest {
854
- /**
855
- * @internal
856
- */
409
+
857
410
  const filterSensitiveLog: (obj: CreateEmailIdentityRequest) => any;
858
411
  }
859
412
  export declare enum DkimStatus {
@@ -863,64 +416,17 @@ export declare enum DkimStatus {
863
416
  SUCCESS = "SUCCESS",
864
417
  TEMPORARY_FAILURE = "TEMPORARY_FAILURE"
865
418
  }
866
- /**
867
- * <p>An object that contains information about the DKIM configuration for an email
868
- * identity.</p>
869
- */
419
+
870
420
  export interface DkimAttributes {
871
- /**
872
- * <p>If the value is <code>true</code>, then the messages that Amazon Pinpoint sends from the
873
- * identity are DKIM-signed. If the value is <code>false</code>, then the messages that
874
- * Amazon Pinpoint sends from the identity aren't DKIM-signed.</p>
875
- */
421
+
876
422
  SigningEnabled?: boolean;
877
- /**
878
- * <p>Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS
879
- * records for the domain. The status can be one of the following:</p>
880
- * <ul>
881
- * <li>
882
- * <p>
883
- * <code>PENDING</code> – Amazon Pinpoint hasn't yet located the DKIM records in the
884
- * DNS configuration for the domain, but will continue to attempt to locate
885
- * them.</p>
886
- * </li>
887
- * <li>
888
- * <p>
889
- * <code>SUCCESS</code> – Amazon Pinpoint located the DKIM records in the DNS
890
- * configuration for the domain and determined that they're correct. Amazon Pinpoint can now
891
- * send DKIM-signed email from the identity.</p>
892
- * </li>
893
- * <li>
894
- * <p>
895
- * <code>FAILED</code> – Amazon Pinpoint was unable to locate the DKIM records in the
896
- * DNS settings for the domain, and won't continue to search for them.</p>
897
- * </li>
898
- * <li>
899
- * <p>
900
- * <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which
901
- * prevented Amazon Pinpoint from determining the DKIM status for the domain.</p>
902
- * </li>
903
- * <li>
904
- * <p>
905
- * <code>NOT_STARTED</code> – Amazon Pinpoint hasn't yet started searching for the
906
- * DKIM records in the DKIM records for the domain.</p>
907
- * </li>
908
- * </ul>
909
- */
423
+
910
424
  Status?: DkimStatus | string;
911
- /**
912
- * <p>A set of unique strings that you use to create a set of CNAME records that you add to
913
- * the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS
914
- * configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint
915
- * usually detects these records within about 72 hours of adding them to the DNS
916
- * configuration for your domain.</p>
917
- */
425
+
918
426
  Tokens?: string[];
919
427
  }
920
428
  export declare namespace DkimAttributes {
921
- /**
922
- * @internal
923
- */
429
+
924
430
  const filterSensitiveLog: (obj: DkimAttributes) => any;
925
431
  }
926
432
  export declare enum IdentityType {
@@ -928,602 +434,288 @@ export declare enum IdentityType {
928
434
  EMAIL_ADDRESS = "EMAIL_ADDRESS",
929
435
  MANAGED_DOMAIN = "MANAGED_DOMAIN"
930
436
  }
931
- /**
932
- * <p>If the email identity is a domain, this object contains tokens that you can use to
933
- * create a set of CNAME records. To sucessfully verify your domain, you have to add these
934
- * records to the DNS configuration for your domain.</p>
935
- * <p>If the email identity is an email address, this object is empty. </p>
936
- */
437
+
937
438
  export interface CreateEmailIdentityResponse {
938
- /**
939
- * <p>The email identity type.</p>
940
- */
439
+
941
440
  IdentityType?: IdentityType | string;
942
- /**
943
- * <p>Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email
944
- * from verified email addresses or domains. For more information about verifying
945
- * identities, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
946
- */
441
+
947
442
  VerifiedForSendingStatus?: boolean;
948
- /**
949
- * <p>An object that contains information about the DKIM attributes for the identity. This
950
- * object includes the tokens that you use to create the CNAME records that are required to
951
- * complete the DKIM verification process.</p>
952
- */
443
+
953
444
  DkimAttributes?: DkimAttributes;
954
445
  }
955
446
  export declare namespace CreateEmailIdentityResponse {
956
- /**
957
- * @internal
958
- */
447
+
959
448
  const filterSensitiveLog: (obj: CreateEmailIdentityResponse) => any;
960
449
  }
961
- /**
962
- * <p>A request to delete a configuration set.</p>
963
- */
450
+
964
451
  export interface DeleteConfigurationSetRequest {
965
- /**
966
- * <p>The name of the configuration set that you want to delete.</p>
967
- */
452
+
968
453
  ConfigurationSetName: string | undefined;
969
454
  }
970
455
  export declare namespace DeleteConfigurationSetRequest {
971
- /**
972
- * @internal
973
- */
456
+
974
457
  const filterSensitiveLog: (obj: DeleteConfigurationSetRequest) => any;
975
458
  }
976
- /**
977
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
978
- * fails.</p>
979
- */
459
+
980
460
  export interface DeleteConfigurationSetResponse {
981
461
  }
982
462
  export declare namespace DeleteConfigurationSetResponse {
983
- /**
984
- * @internal
985
- */
463
+
986
464
  const filterSensitiveLog: (obj: DeleteConfigurationSetResponse) => any;
987
465
  }
988
- /**
989
- * <p>A request to delete an event destination from a configuration set.</p>
990
- */
466
+
991
467
  export interface DeleteConfigurationSetEventDestinationRequest {
992
- /**
993
- * <p>The name of the configuration set that contains the event destination that you want to
994
- * delete.</p>
995
- */
468
+
996
469
  ConfigurationSetName: string | undefined;
997
- /**
998
- * <p>The name of the event destination that you want to delete.</p>
999
- */
470
+
1000
471
  EventDestinationName: string | undefined;
1001
472
  }
1002
473
  export declare namespace DeleteConfigurationSetEventDestinationRequest {
1003
- /**
1004
- * @internal
1005
- */
474
+
1006
475
  const filterSensitiveLog: (obj: DeleteConfigurationSetEventDestinationRequest) => any;
1007
476
  }
1008
- /**
1009
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
1010
- * fails.</p>
1011
- */
477
+
1012
478
  export interface DeleteConfigurationSetEventDestinationResponse {
1013
479
  }
1014
480
  export declare namespace DeleteConfigurationSetEventDestinationResponse {
1015
- /**
1016
- * @internal
1017
- */
481
+
1018
482
  const filterSensitiveLog: (obj: DeleteConfigurationSetEventDestinationResponse) => any;
1019
483
  }
1020
- /**
1021
- * <p>A request to delete a dedicated IP pool.</p>
1022
- */
484
+
1023
485
  export interface DeleteDedicatedIpPoolRequest {
1024
- /**
1025
- * <p>The name of the dedicated IP pool that you want to delete.</p>
1026
- */
486
+
1027
487
  PoolName: string | undefined;
1028
488
  }
1029
489
  export declare namespace DeleteDedicatedIpPoolRequest {
1030
- /**
1031
- * @internal
1032
- */
490
+
1033
491
  const filterSensitiveLog: (obj: DeleteDedicatedIpPoolRequest) => any;
1034
492
  }
1035
- /**
1036
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
1037
- * fails.</p>
1038
- */
493
+
1039
494
  export interface DeleteDedicatedIpPoolResponse {
1040
495
  }
1041
496
  export declare namespace DeleteDedicatedIpPoolResponse {
1042
- /**
1043
- * @internal
1044
- */
497
+
1045
498
  const filterSensitiveLog: (obj: DeleteDedicatedIpPoolResponse) => any;
1046
499
  }
1047
- /**
1048
- * <p>A request to delete an existing email identity. When you delete an identity, you lose
1049
- * the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability
1050
- * to send email by completing the verification process for the identity again.</p>
1051
- */
500
+
1052
501
  export interface DeleteEmailIdentityRequest {
1053
- /**
1054
- * <p>The identity (that is, the email address or domain) that you want to delete from your
1055
- * Amazon Pinpoint account.</p>
1056
- */
502
+
1057
503
  EmailIdentity: string | undefined;
1058
504
  }
1059
505
  export declare namespace DeleteEmailIdentityRequest {
1060
- /**
1061
- * @internal
1062
- */
506
+
1063
507
  const filterSensitiveLog: (obj: DeleteEmailIdentityRequest) => any;
1064
508
  }
1065
- /**
1066
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
1067
- * fails.</p>
1068
- */
509
+
1069
510
  export interface DeleteEmailIdentityResponse {
1070
511
  }
1071
512
  export declare namespace DeleteEmailIdentityResponse {
1072
- /**
1073
- * @internal
1074
- */
513
+
1075
514
  const filterSensitiveLog: (obj: DeleteEmailIdentityResponse) => any;
1076
515
  }
1077
- /**
1078
- * <p>A request to obtain information about the email-sending capabilities of your Amazon Pinpoint
1079
- * account.</p>
1080
- */
516
+
1081
517
  export interface GetAccountRequest {
1082
518
  }
1083
519
  export declare namespace GetAccountRequest {
1084
- /**
1085
- * @internal
1086
- */
520
+
1087
521
  const filterSensitiveLog: (obj: GetAccountRequest) => any;
1088
522
  }
1089
- /**
1090
- * <p>An object that contains information about the per-day and per-second sending limits
1091
- * for your Amazon Pinpoint account in the current AWS Region.</p>
1092
- */
523
+
1093
524
  export interface SendQuota {
1094
- /**
1095
- * <p>The maximum number of emails that you can send in the current AWS Region over a
1096
- * 24-hour period. This value is also called your <i>sending
1097
- * quota</i>.</p>
1098
- */
525
+
1099
526
  Max24HourSend?: number;
1100
- /**
1101
- * <p>The maximum number of emails that you can send per second in the current AWS Region.
1102
- * This value is also called your <i>maximum sending rate</i> or your
1103
- * <i>maximum TPS (transactions per second) rate</i>.</p>
1104
- */
527
+
1105
528
  MaxSendRate?: number;
1106
- /**
1107
- * <p>The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the
1108
- * past 24 hours.</p>
1109
- */
529
+
1110
530
  SentLast24Hours?: number;
1111
531
  }
1112
532
  export declare namespace SendQuota {
1113
- /**
1114
- * @internal
1115
- */
533
+
1116
534
  const filterSensitiveLog: (obj: SendQuota) => any;
1117
535
  }
1118
- /**
1119
- * <p>A list of details about the email-sending capabilities of your Amazon Pinpoint account in the
1120
- * current AWS Region.</p>
1121
- */
536
+
1122
537
  export interface GetAccountResponse {
1123
- /**
1124
- * <p>An object that contains information about the per-day and per-second sending limits
1125
- * for your Amazon Pinpoint account in the current AWS Region.</p>
1126
- */
538
+
1127
539
  SendQuota?: SendQuota;
1128
- /**
1129
- * <p>Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the
1130
- * current AWS Region.</p>
1131
- */
540
+
1132
541
  SendingEnabled?: boolean;
1133
- /**
1134
- * <p>Indicates whether or not the automatic warm-up feature is enabled for dedicated IP
1135
- * addresses that are associated with your account.</p>
1136
- */
542
+
1137
543
  DedicatedIpAutoWarmupEnabled?: boolean;
1138
- /**
1139
- * <p>The reputation status of your Amazon Pinpoint account. The status can be one of the
1140
- * following:</p>
1141
- * <ul>
1142
- * <li>
1143
- * <p>
1144
- * <code>HEALTHY</code> – There are no reputation-related issues that
1145
- * currently impact your account.</p>
1146
- * </li>
1147
- * <li>
1148
- * <p>
1149
- * <code>PROBATION</code> – We've identified some issues with your Amazon Pinpoint
1150
- * account. We're placing your account under review while you work on correcting
1151
- * these issues.</p>
1152
- * </li>
1153
- * <li>
1154
- * <p>
1155
- * <code>SHUTDOWN</code> – Your account's ability to send email is
1156
- * currently paused because of an issue with the email sent from your account. When
1157
- * you correct the issue, you can contact us and request that your account's
1158
- * ability to send email is resumed.</p>
1159
- * </li>
1160
- * </ul>
1161
- */
544
+
1162
545
  EnforcementStatus?: string;
1163
- /**
1164
- * <p>Indicates whether or not your account has production access in the current AWS
1165
- * Region.</p>
1166
- * <p>If the value is <code>false</code>, then your account is in the
1167
- * <i>sandbox</i>. When your account is in the sandbox, you can only send
1168
- * email to verified identities. Additionally, the maximum number of emails you can send in
1169
- * a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
1170
- * send per second (your maximum sending rate) is 1.</p>
1171
- * <p>If the value is <code>true</code>, then your account has production access. When your
1172
- * account has production access, you can send email to any address. The sending quota and
1173
- * maximum sending rate for your account vary based on your specific use case.</p>
1174
- */
546
+
1175
547
  ProductionAccessEnabled?: boolean;
1176
548
  }
1177
549
  export declare namespace GetAccountResponse {
1178
- /**
1179
- * @internal
1180
- */
550
+
1181
551
  const filterSensitiveLog: (obj: GetAccountResponse) => any;
1182
552
  }
1183
- /**
1184
- * <p>A request to retrieve a list of the blacklists that your dedicated IP addresses appear
1185
- * on.</p>
1186
- */
553
+
1187
554
  export interface GetBlacklistReportsRequest {
1188
- /**
1189
- * <p>A list of IP addresses that you want to retrieve blacklist information about. You can
1190
- * only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or
1191
- * Amazon SES.</p>
1192
- */
555
+
1193
556
  BlacklistItemNames: string[] | undefined;
1194
557
  }
1195
558
  export declare namespace GetBlacklistReportsRequest {
1196
- /**
1197
- * @internal
1198
- */
559
+
1199
560
  const filterSensitiveLog: (obj: GetBlacklistReportsRequest) => any;
1200
561
  }
1201
- /**
1202
- * <p>An object that contains information about a blacklisting event that impacts one of the
1203
- * dedicated IP addresses that is associated with your account.</p>
1204
- */
562
+
1205
563
  export interface BlacklistEntry {
1206
- /**
1207
- * <p>The name of the blacklist that the IP address appears on.</p>
1208
- */
564
+
1209
565
  RblName?: string;
1210
- /**
1211
- * <p>The time when the blacklisting event occurred, shown in Unix time format.</p>
1212
- */
566
+
1213
567
  ListingTime?: Date;
1214
- /**
1215
- * <p>Additional information about the blacklisting event, as provided by the blacklist
1216
- * maintainer.</p>
1217
- */
568
+
1218
569
  Description?: string;
1219
570
  }
1220
571
  export declare namespace BlacklistEntry {
1221
- /**
1222
- * @internal
1223
- */
572
+
1224
573
  const filterSensitiveLog: (obj: BlacklistEntry) => any;
1225
574
  }
1226
- /**
1227
- * <p>An object that contains information about blacklist events.</p>
1228
- */
575
+
1229
576
  export interface GetBlacklistReportsResponse {
1230
- /**
1231
- * <p>An object that contains information about a blacklist that one of your dedicated IP
1232
- * addresses appears on.</p>
1233
- */
577
+
1234
578
  BlacklistReport: {
1235
579
  [key: string]: BlacklistEntry[];
1236
580
  } | undefined;
1237
581
  }
1238
582
  export declare namespace GetBlacklistReportsResponse {
1239
- /**
1240
- * @internal
1241
- */
583
+
1242
584
  const filterSensitiveLog: (obj: GetBlacklistReportsResponse) => any;
1243
585
  }
1244
- /**
1245
- * <p>A request to obtain information about a configuration set.</p>
1246
- */
586
+
1247
587
  export interface GetConfigurationSetRequest {
1248
- /**
1249
- * <p>The name of the configuration set that you want to obtain more information
1250
- * about.</p>
1251
- */
588
+
1252
589
  ConfigurationSetName: string | undefined;
1253
590
  }
1254
591
  export declare namespace GetConfigurationSetRequest {
1255
- /**
1256
- * @internal
1257
- */
592
+
1258
593
  const filterSensitiveLog: (obj: GetConfigurationSetRequest) => any;
1259
594
  }
1260
- /**
1261
- * <p>Information about a configuration set.</p>
1262
- */
595
+
1263
596
  export interface GetConfigurationSetResponse {
1264
- /**
1265
- * <p>The name of the configuration set.</p>
1266
- */
597
+
1267
598
  ConfigurationSetName?: string;
1268
- /**
1269
- * <p>An object that defines the open and click tracking options for emails that you send
1270
- * using the configuration set.</p>
1271
- */
599
+
1272
600
  TrackingOptions?: TrackingOptions;
1273
- /**
1274
- * <p>An object that defines the dedicated IP pool that is used to send emails that you send
1275
- * using the configuration set.</p>
1276
- */
601
+
1277
602
  DeliveryOptions?: DeliveryOptions;
1278
- /**
1279
- * <p>An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails
1280
- * that you send that use the configuration set.</p>
1281
- */
603
+
1282
604
  ReputationOptions?: ReputationOptions;
1283
- /**
1284
- * <p>An object that defines whether or not Amazon Pinpoint can send email that you send using the
1285
- * configuration set.</p>
1286
- */
605
+
1287
606
  SendingOptions?: SendingOptions;
1288
- /**
1289
- * <p>An array of objects that define the tags (keys and values) that are associated with
1290
- * the configuration set.</p>
1291
- */
607
+
1292
608
  Tags?: Tag[];
1293
609
  }
1294
610
  export declare namespace GetConfigurationSetResponse {
1295
- /**
1296
- * @internal
1297
- */
611
+
1298
612
  const filterSensitiveLog: (obj: GetConfigurationSetResponse) => any;
1299
613
  }
1300
- /**
1301
- * <p>A request to obtain information about the event destinations for a configuration
1302
- * set.</p>
1303
- */
614
+
1304
615
  export interface GetConfigurationSetEventDestinationsRequest {
1305
- /**
1306
- * <p>The name of the configuration set that contains the event destination.</p>
1307
- */
616
+
1308
617
  ConfigurationSetName: string | undefined;
1309
618
  }
1310
619
  export declare namespace GetConfigurationSetEventDestinationsRequest {
1311
- /**
1312
- * @internal
1313
- */
620
+
1314
621
  const filterSensitiveLog: (obj: GetConfigurationSetEventDestinationsRequest) => any;
1315
622
  }
1316
- /**
1317
- * <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
1318
- * clicks, bounces, and complaints. <i>Event destinations</i> are places that
1319
- * you can send information about these events to. For example, you can send event data to
1320
- * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use
1321
- * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.</p>
1322
- */
623
+
1323
624
  export interface EventDestination {
1324
- /**
1325
- * <p>A name that identifies the event destination.</p>
1326
- */
625
+
1327
626
  Name: string | undefined;
1328
- /**
1329
- * <p>If <code>true</code>, the event destination is enabled. When the event destination is
1330
- * enabled, the specified event types are sent to the destinations in this
1331
- * <code>EventDestinationDefinition</code>.</p>
1332
- * <p>If <code>false</code>, the event destination is disabled. When the event destination
1333
- * is disabled, events aren't sent to the specified destinations.</p>
1334
- */
627
+
1335
628
  Enabled?: boolean;
1336
- /**
1337
- * <p>The types of events that Amazon Pinpoint sends to the specified event destinations.</p>
1338
- */
629
+
1339
630
  MatchingEventTypes: (EventType | string)[] | undefined;
1340
- /**
1341
- * <p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to
1342
- * stream data to other services, such as Amazon S3 and Amazon Redshift.</p>
1343
- */
631
+
1344
632
  KinesisFirehoseDestination?: KinesisFirehoseDestination;
1345
- /**
1346
- * <p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
1347
- * monitor and gain insights on your email sending metrics.</p>
1348
- */
633
+
1349
634
  CloudWatchDestination?: CloudWatchDestination;
1350
- /**
1351
- * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
1352
- * send notification when certain email events occur.</p>
1353
- */
635
+
1354
636
  SnsDestination?: SnsDestination;
1355
- /**
1356
- * <p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events
1357
- * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments
1358
- * for your campaigns.</p>
1359
- */
637
+
1360
638
  PinpointDestination?: PinpointDestination;
1361
639
  }
1362
640
  export declare namespace EventDestination {
1363
- /**
1364
- * @internal
1365
- */
641
+
1366
642
  const filterSensitiveLog: (obj: EventDestination) => any;
1367
643
  }
1368
- /**
1369
- * <p>Information about an event destination for a configuration set.</p>
1370
- */
644
+
1371
645
  export interface GetConfigurationSetEventDestinationsResponse {
1372
- /**
1373
- * <p>An array that includes all of the events destinations that have been configured for
1374
- * the configuration set.</p>
1375
- */
646
+
1376
647
  EventDestinations?: EventDestination[];
1377
648
  }
1378
649
  export declare namespace GetConfigurationSetEventDestinationsResponse {
1379
- /**
1380
- * @internal
1381
- */
650
+
1382
651
  const filterSensitiveLog: (obj: GetConfigurationSetEventDestinationsResponse) => any;
1383
652
  }
1384
- /**
1385
- * <p>A request to obtain more information about a dedicated IP address.</p>
1386
- */
653
+
1387
654
  export interface GetDedicatedIpRequest {
1388
- /**
1389
- * <p>The IP address that you want to obtain more information about. The value you specify
1390
- * has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.</p>
1391
- */
655
+
1392
656
  Ip: string | undefined;
1393
657
  }
1394
658
  export declare namespace GetDedicatedIpRequest {
1395
- /**
1396
- * @internal
1397
- */
659
+
1398
660
  const filterSensitiveLog: (obj: GetDedicatedIpRequest) => any;
1399
661
  }
1400
662
  export declare enum WarmupStatus {
1401
663
  DONE = "DONE",
1402
664
  IN_PROGRESS = "IN_PROGRESS"
1403
665
  }
1404
- /**
1405
- * <p>Contains information about a dedicated IP address that is associated with your Amazon Pinpoint
1406
- * account.</p>
1407
- * <p></p>
1408
- */
666
+
1409
667
  export interface DedicatedIp {
1410
- /**
1411
- * <p>An IP address that is reserved for use by your Amazon Pinpoint account.</p>
1412
- */
668
+
1413
669
  Ip: string | undefined;
1414
- /**
1415
- * <p>The warm-up status of a dedicated IP address. The status can have one of the following
1416
- * values:</p>
1417
- * <ul>
1418
- * <li>
1419
- * <p>
1420
- * <code>IN_PROGRESS</code> – The IP address isn't ready to use because the
1421
- * dedicated IP warm-up process is ongoing.</p>
1422
- * </li>
1423
- * <li>
1424
- * <p>
1425
- * <code>DONE</code> – The dedicated IP warm-up process is complete, and
1426
- * the IP address is ready to use.</p>
1427
- * </li>
1428
- * </ul>
1429
- */
670
+
1430
671
  WarmupStatus: WarmupStatus | string | undefined;
1431
- /**
1432
- * <p>Indicates how complete the dedicated IP warm-up process is. When this value equals 1,
1433
- * the address has completed the warm-up process and is ready for use.</p>
1434
- */
672
+
1435
673
  WarmupPercentage: number | undefined;
1436
- /**
1437
- * <p>The name of the dedicated IP pool that the IP address is associated with.</p>
1438
- */
674
+
1439
675
  PoolName?: string;
1440
676
  }
1441
677
  export declare namespace DedicatedIp {
1442
- /**
1443
- * @internal
1444
- */
678
+
1445
679
  const filterSensitiveLog: (obj: DedicatedIp) => any;
1446
680
  }
1447
- /**
1448
- * <p>Information about a dedicated IP address.</p>
1449
- */
681
+
1450
682
  export interface GetDedicatedIpResponse {
1451
- /**
1452
- * <p>An object that contains information about a dedicated IP address.</p>
1453
- */
683
+
1454
684
  DedicatedIp?: DedicatedIp;
1455
685
  }
1456
686
  export declare namespace GetDedicatedIpResponse {
1457
- /**
1458
- * @internal
1459
- */
687
+
1460
688
  const filterSensitiveLog: (obj: GetDedicatedIpResponse) => any;
1461
689
  }
1462
- /**
1463
- * <p>A request to obtain more information about dedicated IP pools.</p>
1464
- */
690
+
1465
691
  export interface GetDedicatedIpsRequest {
1466
- /**
1467
- * <p>The name of the IP pool that the dedicated IP address is associated with.</p>
1468
- */
692
+
1469
693
  PoolName?: string;
1470
- /**
1471
- * <p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the
1472
- * position of the dedicated IP pool in the list of IP pools.</p>
1473
- */
694
+
1474
695
  NextToken?: string;
1475
- /**
1476
- * <p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>.
1477
- * If the number of results is larger than the number you specified in this parameter, then
1478
- * the response includes a <code>NextToken</code> element, which you can use to obtain
1479
- * additional results.</p>
1480
- */
696
+
1481
697
  PageSize?: number;
1482
698
  }
1483
699
  export declare namespace GetDedicatedIpsRequest {
1484
- /**
1485
- * @internal
1486
- */
700
+
1487
701
  const filterSensitiveLog: (obj: GetDedicatedIpsRequest) => any;
1488
702
  }
1489
- /**
1490
- * <p>Information about the dedicated IP addresses that are associated with your Amazon Pinpoint
1491
- * account.</p>
1492
- */
703
+
1493
704
  export interface GetDedicatedIpsResponse {
1494
- /**
1495
- * <p>A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint
1496
- * account.</p>
1497
- */
705
+
1498
706
  DedicatedIps?: DedicatedIp[];
1499
- /**
1500
- * <p>A token that indicates that there are additional dedicated IP addresses to list. To
1501
- * view additional addresses, issue another request to <code>GetDedicatedIps</code>,
1502
- * passing this token in the <code>NextToken</code> parameter.</p>
1503
- */
707
+
1504
708
  NextToken?: string;
1505
709
  }
1506
710
  export declare namespace GetDedicatedIpsResponse {
1507
- /**
1508
- * @internal
1509
- */
711
+
1510
712
  const filterSensitiveLog: (obj: GetDedicatedIpsResponse) => any;
1511
713
  }
1512
- /**
1513
- * <p>Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
1514
- * When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and
1515
- * other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the
1516
- * ability to perform predictive inbox placement tests.</p>
1517
- * <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
1518
- * to any other fees that you accrue by using Amazon Pinpoint. For more information about the
1519
- * features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>
1520
- */
714
+
1521
715
  export interface GetDeliverabilityDashboardOptionsRequest {
1522
716
  }
1523
717
  export declare namespace GetDeliverabilityDashboardOptionsRequest {
1524
- /**
1525
- * @internal
1526
- */
718
+
1527
719
  const filterSensitiveLog: (obj: GetDeliverabilityDashboardOptionsRequest) => any;
1528
720
  }
1529
721
  export declare enum DeliverabilityDashboardAccountStatus {
@@ -1531,550 +723,262 @@ export declare enum DeliverabilityDashboardAccountStatus {
1531
723
  DISABLED = "DISABLED",
1532
724
  PENDING_EXPIRATION = "PENDING_EXPIRATION"
1533
725
  }
1534
- /**
1535
- * <p>An object that contains information about the inbox placement data settings for a
1536
- * verified domain that’s associated with your AWS account. This data is available only
1537
- * if you enabled the Deliverability dashboard for the domain
1538
- * (<code>PutDeliverabilityDashboardOption</code> operation).</p>
1539
- */
726
+
1540
727
  export interface InboxPlacementTrackingOption {
1541
- /**
1542
- * <p>Specifies whether inbox placement data is being tracked for the domain.</p>
1543
- */
728
+
1544
729
  Global?: boolean;
1545
- /**
1546
- * <p>An array of strings, one for each major email provider that the inbox placement data
1547
- * applies to.</p>
1548
- */
730
+
1549
731
  TrackedIsps?: string[];
1550
732
  }
1551
733
  export declare namespace InboxPlacementTrackingOption {
1552
- /**
1553
- * @internal
1554
- */
734
+
1555
735
  const filterSensitiveLog: (obj: InboxPlacementTrackingOption) => any;
1556
736
  }
1557
- /**
1558
- * <p>An object that contains information about the Deliverability dashboard subscription for a
1559
- * verified domain that you use to send email and currently has an active Deliverability dashboard
1560
- * subscription. If a Deliverability dashboard subscription is active for a domain, you gain access
1561
- * to reputation, inbox placement, and other metrics for the domain.</p>
1562
- */
737
+
1563
738
  export interface DomainDeliverabilityTrackingOption {
1564
- /**
1565
- * <p>A verified domain that’s associated with your AWS account and currently has an
1566
- * active Deliverability dashboard subscription.</p>
1567
- */
739
+
1568
740
  Domain?: string;
1569
- /**
1570
- * <p>The date, in Unix time format, when you enabled the Deliverability dashboard for the
1571
- * domain.</p>
1572
- */
741
+
1573
742
  SubscriptionStartDate?: Date;
1574
- /**
1575
- * <p>An object that contains information about the inbox placement data settings for the
1576
- * domain.</p>
1577
- */
743
+
1578
744
  InboxPlacementTrackingOption?: InboxPlacementTrackingOption;
1579
745
  }
1580
746
  export declare namespace DomainDeliverabilityTrackingOption {
1581
- /**
1582
- * @internal
1583
- */
747
+
1584
748
  const filterSensitiveLog: (obj: DomainDeliverabilityTrackingOption) => any;
1585
749
  }
1586
- /**
1587
- * <p>An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.</p>
1588
- */
750
+
1589
751
  export interface GetDeliverabilityDashboardOptionsResponse {
1590
- /**
1591
- * <p>Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value
1592
- * is <code>true</code>, the dashboard is enabled.</p>
1593
- */
752
+
1594
753
  DashboardEnabled: boolean | undefined;
1595
- /**
1596
- * <p>The date, in Unix time format, when your current subscription to the Deliverability dashboard
1597
- * is scheduled to expire, if your subscription is scheduled to expire at the end of the
1598
- * current calendar month. This value is null if you have an active subscription that isn’t
1599
- * due to expire at the end of the month.</p>
1600
- */
754
+
1601
755
  SubscriptionExpiryDate?: Date;
1602
- /**
1603
- * <p>The current status of your Deliverability dashboard subscription. If this value is
1604
- * <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end
1605
- * of the current calendar month.</p>
1606
- */
756
+
1607
757
  AccountStatus?: DeliverabilityDashboardAccountStatus | string;
1608
- /**
1609
- * <p>An array of objects, one for each verified domain that you use to send email and
1610
- * currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at
1611
- * the end of the current calendar month.</p>
1612
- */
758
+
1613
759
  ActiveSubscribedDomains?: DomainDeliverabilityTrackingOption[];
1614
- /**
1615
- * <p>An array of objects, one for each verified domain that you use to send email and
1616
- * currently has an active Deliverability dashboard subscription that's scheduled to expire at the
1617
- * end of the current calendar month.</p>
1618
- */
760
+
1619
761
  PendingExpirationSubscribedDomains?: DomainDeliverabilityTrackingOption[];
1620
762
  }
1621
763
  export declare namespace GetDeliverabilityDashboardOptionsResponse {
1622
- /**
1623
- * @internal
1624
- */
764
+
1625
765
  const filterSensitiveLog: (obj: GetDeliverabilityDashboardOptionsResponse) => any;
1626
766
  }
1627
- /**
1628
- * <p>A request to retrieve the results of a predictive inbox placement test.</p>
1629
- */
767
+
1630
768
  export interface GetDeliverabilityTestReportRequest {
1631
- /**
1632
- * <p>A unique string that identifies the predictive inbox placement test.</p>
1633
- */
769
+
1634
770
  ReportId: string | undefined;
1635
771
  }
1636
772
  export declare namespace GetDeliverabilityTestReportRequest {
1637
- /**
1638
- * @internal
1639
- */
773
+
1640
774
  const filterSensitiveLog: (obj: GetDeliverabilityTestReportRequest) => any;
1641
775
  }
1642
- /**
1643
- * <p>An object that contains metadata related to a predictive inbox placement test.</p>
1644
- */
776
+
1645
777
  export interface DeliverabilityTestReport {
1646
- /**
1647
- * <p>A unique string that identifies the predictive inbox placement test.</p>
1648
- */
778
+
1649
779
  ReportId?: string;
1650
- /**
1651
- * <p>A name that helps you identify a predictive inbox placement test report.</p>
1652
- */
780
+
1653
781
  ReportName?: string;
1654
- /**
1655
- * <p>The subject line for an email that you submitted in a predictive inbox placement test.</p>
1656
- */
782
+
1657
783
  Subject?: string;
1658
- /**
1659
- * <p>The sender address that you specified for the predictive inbox placement test.</p>
1660
- */
784
+
1661
785
  FromEmailAddress?: string;
1662
- /**
1663
- * <p>The date and time when the predictive inbox placement test was created, in Unix time format.</p>
1664
- */
786
+
1665
787
  CreateDate?: Date;
1666
- /**
1667
- * <p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test
1668
- * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
1669
- * test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use
1670
- * the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>
1671
- */
788
+
1672
789
  DeliverabilityTestStatus?: DeliverabilityTestStatus | string;
1673
790
  }
1674
791
  export declare namespace DeliverabilityTestReport {
1675
- /**
1676
- * @internal
1677
- */
792
+
1678
793
  const filterSensitiveLog: (obj: DeliverabilityTestReport) => any;
1679
794
  }
1680
- /**
1681
- * <p>An object that contains inbox placement data for an email provider.</p>
1682
- */
795
+
1683
796
  export interface PlacementStatistics {
1684
- /**
1685
- * <p>The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.</p>
1686
- */
797
+
1687
798
  InboxPercentage?: number;
1688
- /**
1689
- * <p>The percentage of emails that arrived in recipients' spam or junk mail folders during
1690
- * the predictive inbox placement test.</p>
1691
- */
799
+
1692
800
  SpamPercentage?: number;
1693
- /**
1694
- * <p>The percentage of emails that didn't arrive in recipients' inboxes at all during the
1695
- * predictive inbox placement test.</p>
1696
- */
801
+
1697
802
  MissingPercentage?: number;
1698
- /**
1699
- * <p>The percentage of emails that were authenticated by using Sender Policy Framework
1700
- * (SPF) during the predictive inbox placement test.</p>
1701
- */
803
+
1702
804
  SpfPercentage?: number;
1703
- /**
1704
- * <p>The percentage of emails that were authenticated by using DomainKeys Identified Mail
1705
- * (DKIM) during the predictive inbox placement test.</p>
1706
- */
805
+
1707
806
  DkimPercentage?: number;
1708
807
  }
1709
808
  export declare namespace PlacementStatistics {
1710
- /**
1711
- * @internal
1712
- */
809
+
1713
810
  const filterSensitiveLog: (obj: PlacementStatistics) => any;
1714
811
  }
1715
- /**
1716
- * <p>An object that describes how email sent during the predictive inbox placement test was handled by a certain
1717
- * email provider.</p>
1718
- */
812
+
1719
813
  export interface IspPlacement {
1720
- /**
1721
- * <p>The name of the email provider that the inbox placement data applies to.</p>
1722
- */
814
+
1723
815
  IspName?: string;
1724
- /**
1725
- * <p>An object that contains inbox placement metrics for a specific email provider.</p>
1726
- */
816
+
1727
817
  PlacementStatistics?: PlacementStatistics;
1728
818
  }
1729
819
  export declare namespace IspPlacement {
1730
- /**
1731
- * @internal
1732
- */
820
+
1733
821
  const filterSensitiveLog: (obj: IspPlacement) => any;
1734
822
  }
1735
- /**
1736
- * <p>The results of the predictive inbox placement test.</p>
1737
- */
823
+
1738
824
  export interface GetDeliverabilityTestReportResponse {
1739
- /**
1740
- * <p>An object that contains the results of the predictive inbox placement test.</p>
1741
- */
825
+
1742
826
  DeliverabilityTestReport: DeliverabilityTestReport | undefined;
1743
- /**
1744
- * <p>An object that specifies how many test messages that were sent during the predictive inbox placement test were
1745
- * delivered to recipients' inboxes, how many were sent to recipients' spam folders, and
1746
- * how many weren't delivered.</p>
1747
- */
827
+
1748
828
  OverallPlacement: PlacementStatistics | undefined;
1749
- /**
1750
- * <p>An object that describes how the test email was handled by several email providers,
1751
- * including Gmail, Hotmail, Yahoo, AOL, and others.</p>
1752
- */
829
+
1753
830
  IspPlacements: IspPlacement[] | undefined;
1754
- /**
1755
- * <p>An object that contains the message that you sent when you performed this
1756
- * predictive inbox placement test.</p>
1757
- */
831
+
1758
832
  Message?: string;
1759
- /**
1760
- * <p>An array of objects that define the tags (keys and values) that are associated with
1761
- * the predictive inbox placement test.</p>
1762
- */
833
+
1763
834
  Tags?: Tag[];
1764
835
  }
1765
836
  export declare namespace GetDeliverabilityTestReportResponse {
1766
- /**
1767
- * @internal
1768
- */
837
+
1769
838
  const filterSensitiveLog: (obj: GetDeliverabilityTestReportResponse) => any;
1770
839
  }
1771
- /**
1772
- * <p>Retrieve all the deliverability data for a specific campaign. This data is available
1773
- * for a campaign only if the campaign sent email by using a domain that the
1774
- * Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>
1775
- * operation).</p>
1776
- */
840
+
1777
841
  export interface GetDomainDeliverabilityCampaignRequest {
1778
- /**
1779
- * <p>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this
1780
- * identifier to a campaign. This value is not the same as the campaign identifier that
1781
- * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the
1782
- * Amazon Pinpoint console.</p>
1783
- */
842
+
1784
843
  CampaignId: string | undefined;
1785
844
  }
1786
845
  export declare namespace GetDomainDeliverabilityCampaignRequest {
1787
- /**
1788
- * @internal
1789
- */
846
+
1790
847
  const filterSensitiveLog: (obj: GetDomainDeliverabilityCampaignRequest) => any;
1791
848
  }
1792
- /**
1793
- * <p>An object that contains the deliverability data for a specific campaign. This data is
1794
- * available for a campaign only if the campaign sent email by using a domain that the
1795
- * Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>
1796
- * operation).</p>
1797
- */
849
+
1798
850
  export interface DomainDeliverabilityCampaign {
1799
- /**
1800
- * <p>The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this
1801
- * identifier to a campaign. This value is not the same as the campaign identifier that
1802
- * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the
1803
- * Amazon Pinpoint console.</p>
1804
- */
851
+
1805
852
  CampaignId?: string;
1806
- /**
1807
- * <p>The URL of an image that contains a snapshot of the email message that was
1808
- * sent.</p>
1809
- */
853
+
1810
854
  ImageUrl?: string;
1811
- /**
1812
- * <p>The subject line, or title, of the email message.</p>
1813
- */
855
+
1814
856
  Subject?: string;
1815
- /**
1816
- * <p>The verified email address that the email message was sent from.</p>
1817
- */
857
+
1818
858
  FromAddress?: string;
1819
- /**
1820
- * <p>The IP addresses that were used to send the email message.</p>
1821
- */
859
+
1822
860
  SendingIps?: string[];
1823
- /**
1824
- * <p>The first time, in Unix time format, when the email message was delivered to any
1825
- * recipient's inbox. This value can help you determine how long it took for a campaign to
1826
- * deliver an email message.</p>
1827
- */
861
+
1828
862
  FirstSeenDateTime?: Date;
1829
- /**
1830
- * <p>The last time, in Unix time format, when the email message was delivered to any
1831
- * recipient's inbox. This value can help you determine how long it took for a campaign to
1832
- * deliver an email message.</p>
1833
- */
863
+
1834
864
  LastSeenDateTime?: Date;
1835
- /**
1836
- * <p>The number of email messages that were delivered to recipients’ inboxes.</p>
1837
- */
865
+
1838
866
  InboxCount?: number;
1839
- /**
1840
- * <p>The number of email messages that were delivered to recipients' spam or junk mail
1841
- * folders.</p>
1842
- */
867
+
1843
868
  SpamCount?: number;
1844
- /**
1845
- * <p>The percentage of email messages that were opened by recipients. Due to technical
1846
- * limitations, this value only includes recipients who opened the message by using an
1847
- * email client that supports images.</p>
1848
- */
869
+
1849
870
  ReadRate?: number;
1850
- /**
1851
- * <p>The percentage of email messages that were deleted by recipients, without being opened
1852
- * first. Due to technical limitations, this value only includes recipients who opened the
1853
- * message by using an email client that supports images.</p>
1854
- */
871
+
1855
872
  DeleteRate?: number;
1856
- /**
1857
- * <p>The percentage of email messages that were opened and then deleted by recipients. Due
1858
- * to technical limitations, this value only includes recipients who opened the message by
1859
- * using an email client that supports images.</p>
1860
- */
873
+
1861
874
  ReadDeleteRate?: number;
1862
- /**
1863
- * <p>The projected number of recipients that the email message was sent to.</p>
1864
- */
875
+
1865
876
  ProjectedVolume?: number;
1866
- /**
1867
- * <p>The major email providers who handled the email message.</p>
1868
- */
877
+
1869
878
  Esps?: string[];
1870
879
  }
1871
880
  export declare namespace DomainDeliverabilityCampaign {
1872
- /**
1873
- * @internal
1874
- */
881
+
1875
882
  const filterSensitiveLog: (obj: DomainDeliverabilityCampaign) => any;
1876
883
  }
1877
- /**
1878
- * <p>An object that contains all the deliverability data for a specific campaign. This data
1879
- * is available for a campaign only if the campaign sent email by using a domain that the
1880
- * Deliverability dashboard is enabled for (<code>PutDeliverabilityDashboardOption</code>
1881
- * operation).</p>
1882
- */
884
+
1883
885
  export interface GetDomainDeliverabilityCampaignResponse {
1884
- /**
1885
- * <p>An object that contains the deliverability data for the campaign.</p>
1886
- */
886
+
1887
887
  DomainDeliverabilityCampaign: DomainDeliverabilityCampaign | undefined;
1888
888
  }
1889
889
  export declare namespace GetDomainDeliverabilityCampaignResponse {
1890
- /**
1891
- * @internal
1892
- */
890
+
1893
891
  const filterSensitiveLog: (obj: GetDomainDeliverabilityCampaignResponse) => any;
1894
892
  }
1895
- /**
1896
- * <p>A request to obtain deliverability metrics for a domain.</p>
1897
- */
893
+
1898
894
  export interface GetDomainStatisticsReportRequest {
1899
- /**
1900
- * <p>The domain that you want to obtain deliverability metrics for.</p>
1901
- */
895
+
1902
896
  Domain: string | undefined;
1903
- /**
1904
- * <p>The first day (in Unix time) that you want to obtain domain deliverability metrics
1905
- * for.</p>
1906
- */
897
+
1907
898
  StartDate: Date | undefined;
1908
- /**
1909
- * <p>The last day (in Unix time) that you want to obtain domain deliverability metrics for.
1910
- * The <code>EndDate</code> that you specify has to be less than or equal to 30 days after
1911
- * the <code>StartDate</code>.</p>
1912
- */
899
+
1913
900
  EndDate: Date | undefined;
1914
901
  }
1915
902
  export declare namespace GetDomainStatisticsReportRequest {
1916
- /**
1917
- * @internal
1918
- */
903
+
1919
904
  const filterSensitiveLog: (obj: GetDomainStatisticsReportRequest) => any;
1920
905
  }
1921
- /**
1922
- * <p>An object that contains inbox placement data for email sent from one of your email
1923
- * domains to a specific email provider.</p>
1924
- */
906
+
1925
907
  export interface DomainIspPlacement {
1926
- /**
1927
- * <p>The name of the email provider that the inbox placement data applies to.</p>
1928
- */
908
+
1929
909
  IspName?: string;
1930
- /**
1931
- * <p>The total number of messages that were sent from the selected domain to the specified
1932
- * email provider that arrived in recipients' inboxes.</p>
1933
- */
910
+
1934
911
  InboxRawCount?: number;
1935
- /**
1936
- * <p>The total number of messages that were sent from the selected domain to the specified
1937
- * email provider that arrived in recipients' spam or junk mail folders.</p>
1938
- */
912
+
1939
913
  SpamRawCount?: number;
1940
- /**
1941
- * <p>The percentage of messages that were sent from the selected domain to the specified
1942
- * email provider that arrived in recipients' inboxes.</p>
1943
- */
914
+
1944
915
  InboxPercentage?: number;
1945
- /**
1946
- * <p>The percentage of messages that were sent from the selected domain to the specified
1947
- * email provider that arrived in recipients' spam or junk mail folders.</p>
1948
- */
916
+
1949
917
  SpamPercentage?: number;
1950
918
  }
1951
919
  export declare namespace DomainIspPlacement {
1952
- /**
1953
- * @internal
1954
- */
920
+
1955
921
  const filterSensitiveLog: (obj: DomainIspPlacement) => any;
1956
922
  }
1957
- /**
1958
- * <p>An object that contains information about the amount of email that was delivered to
1959
- * recipients.</p>
1960
- */
923
+
1961
924
  export interface VolumeStatistics {
1962
- /**
1963
- * <p>The total number of emails that arrived in recipients' inboxes.</p>
1964
- */
925
+
1965
926
  InboxRawCount?: number;
1966
- /**
1967
- * <p>The total number of emails that arrived in recipients' spam or junk mail
1968
- * folders.</p>
1969
- */
927
+
1970
928
  SpamRawCount?: number;
1971
- /**
1972
- * <p>An estimate of the percentage of emails sent from the current domain that will arrive
1973
- * in recipients' inboxes.</p>
1974
- */
929
+
1975
930
  ProjectedInbox?: number;
1976
- /**
1977
- * <p>An estimate of the percentage of emails sent from the current domain that will arrive
1978
- * in recipients' spam or junk mail folders.</p>
1979
- */
931
+
1980
932
  ProjectedSpam?: number;
1981
933
  }
1982
934
  export declare namespace VolumeStatistics {
1983
- /**
1984
- * @internal
1985
- */
935
+
1986
936
  const filterSensitiveLog: (obj: VolumeStatistics) => any;
1987
937
  }
1988
- /**
1989
- * <p>An object that contains information about the volume of email sent on each day of the
1990
- * analysis period.</p>
1991
- */
938
+
1992
939
  export interface DailyVolume {
1993
- /**
1994
- * <p>The date that the DailyVolume metrics apply to, in Unix time.</p>
1995
- */
940
+
1996
941
  StartDate?: Date;
1997
- /**
1998
- * <p>An object that contains inbox placement metrics for a specific day in the analysis
1999
- * period.</p>
2000
- */
942
+
2001
943
  VolumeStatistics?: VolumeStatistics;
2002
- /**
2003
- * <p>An object that contains inbox placement metrics for a specified day in the analysis
2004
- * period, broken out by the recipient's email provider.</p>
2005
- */
944
+
2006
945
  DomainIspPlacements?: DomainIspPlacement[];
2007
946
  }
2008
947
  export declare namespace DailyVolume {
2009
- /**
2010
- * @internal
2011
- */
948
+
2012
949
  const filterSensitiveLog: (obj: DailyVolume) => any;
2013
950
  }
2014
- /**
2015
- * <p>An object that contains information about email that was sent from the selected
2016
- * domain.</p>
2017
- */
951
+
2018
952
  export interface OverallVolume {
2019
- /**
2020
- * <p>An object that contains information about the numbers of messages that arrived in
2021
- * recipients' inboxes and junk mail folders.</p>
2022
- */
953
+
2023
954
  VolumeStatistics?: VolumeStatistics;
2024
- /**
2025
- * <p>The percentage of emails that were sent from the domain that were read by their
2026
- * recipients.</p>
2027
- */
955
+
2028
956
  ReadRatePercent?: number;
2029
- /**
2030
- * <p>An object that contains inbox and junk mail placement metrics for individual email
2031
- * providers.</p>
2032
- */
957
+
2033
958
  DomainIspPlacements?: DomainIspPlacement[];
2034
959
  }
2035
960
  export declare namespace OverallVolume {
2036
- /**
2037
- * @internal
2038
- */
961
+
2039
962
  const filterSensitiveLog: (obj: OverallVolume) => any;
2040
963
  }
2041
- /**
2042
- * <p>An object that includes statistics that are related to the domain that you
2043
- * specified.</p>
2044
- */
964
+
2045
965
  export interface GetDomainStatisticsReportResponse {
2046
- /**
2047
- * <p>An object that contains deliverability metrics for the domain that you specified. The
2048
- * data in this object is a summary of all of the data that was collected from the
2049
- * <code>StartDate</code> to the <code>EndDate</code>.</p>
2050
- */
966
+
2051
967
  OverallVolume: OverallVolume | undefined;
2052
- /**
2053
- * <p>An object that contains deliverability metrics for the domain that you specified. This
2054
- * object contains data for each day, starting on the <code>StartDate</code> and ending on
2055
- * the <code>EndDate</code>.</p>
2056
- */
968
+
2057
969
  DailyVolumes: DailyVolume[] | undefined;
2058
970
  }
2059
971
  export declare namespace GetDomainStatisticsReportResponse {
2060
- /**
2061
- * @internal
2062
- */
972
+
2063
973
  const filterSensitiveLog: (obj: GetDomainStatisticsReportResponse) => any;
2064
974
  }
2065
- /**
2066
- * <p>A request to return details about an email identity.</p>
2067
- */
975
+
2068
976
  export interface GetEmailIdentityRequest {
2069
- /**
2070
- * <p>The email identity that you want to retrieve details for.</p>
2071
- */
977
+
2072
978
  EmailIdentity: string | undefined;
2073
979
  }
2074
980
  export declare namespace GetEmailIdentityRequest {
2075
- /**
2076
- * @internal
2077
- */
981
+
2078
982
  const filterSensitiveLog: (obj: GetEmailIdentityRequest) => any;
2079
983
  }
2080
984
  export declare enum BehaviorOnMxFailure {
@@ -2087,1100 +991,502 @@ export declare enum MailFromDomainStatus {
2087
991
  SUCCESS = "SUCCESS",
2088
992
  TEMPORARY_FAILURE = "TEMPORARY_FAILURE"
2089
993
  }
2090
- /**
2091
- * <p>A list of attributes that are associated with a MAIL FROM domain.</p>
2092
- */
994
+
2093
995
  export interface MailFromAttributes {
2094
- /**
2095
- * <p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>
2096
- */
996
+
2097
997
  MailFromDomain: string | undefined;
2098
- /**
2099
- * <p>The status of the MAIL FROM domain. This status can have the following values:</p>
2100
- * <ul>
2101
- * <li>
2102
- * <p>
2103
- * <code>PENDING</code> – Amazon Pinpoint hasn't started searching for the MX record
2104
- * yet.</p>
2105
- * </li>
2106
- * <li>
2107
- * <p>
2108
- * <code>SUCCESS</code> – Amazon Pinpoint detected the required MX record for the
2109
- * MAIL FROM domain.</p>
2110
- * </li>
2111
- * <li>
2112
- * <p>
2113
- * <code>FAILED</code> – Amazon Pinpoint can't find the required MX record, or the
2114
- * record no longer exists.</p>
2115
- * </li>
2116
- * <li>
2117
- * <p>
2118
- * <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which
2119
- * prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.</p>
2120
- * </li>
2121
- * </ul>
2122
- */
998
+
2123
999
  MailFromDomainStatus: MailFromDomainStatus | string | undefined;
2124
- /**
2125
- * <p>The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom
2126
- * MAIL FROM domain. When you set this value to <code>UseDefaultValue</code>, Amazon Pinpoint uses
2127
- * <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
2128
- * to <code>RejectMessage</code>, Amazon Pinpoint returns a <code>MailFromDomainNotVerified</code>
2129
- * error, and doesn't attempt to deliver the email.</p>
2130
- * <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the
2131
- * <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>
2132
- * states.</p>
2133
- */
1000
+
2134
1001
  BehaviorOnMxFailure: BehaviorOnMxFailure | string | undefined;
2135
1002
  }
2136
1003
  export declare namespace MailFromAttributes {
2137
- /**
2138
- * @internal
2139
- */
1004
+
2140
1005
  const filterSensitiveLog: (obj: MailFromAttributes) => any;
2141
1006
  }
2142
- /**
2143
- * <p>Details about an email identity.</p>
2144
- */
1007
+
2145
1008
  export interface GetEmailIdentityResponse {
2146
- /**
2147
- * <p>The email identity type.</p>
2148
- */
1009
+
2149
1010
  IdentityType?: IdentityType | string;
2150
- /**
2151
- * <p>The feedback forwarding configuration for the identity.</p>
2152
- * <p>If the value is <code>true</code>, Amazon Pinpoint sends you email notifications when bounce or
2153
- * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
2154
- * in the Return-Path header of the original email.</p>
2155
- * <p>When you set this value to <code>false</code>, Amazon Pinpoint sends notifications through other
2156
- * mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're
2157
- * required to have a method of tracking bounces and complaints. If you haven't set up
2158
- * another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email
2159
- * notification when these events occur (even if this setting is disabled).</p>
2160
- */
1011
+
2161
1012
  FeedbackForwardingStatus?: boolean;
2162
- /**
2163
- * <p>Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email
2164
- * from verified email addresses or domains. For more information about verifying
2165
- * identities, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>
2166
- */
1013
+
2167
1014
  VerifiedForSendingStatus?: boolean;
2168
- /**
2169
- * <p>An object that contains information about the DKIM attributes for the identity. This
2170
- * object includes the tokens that you use to create the CNAME records that are required to
2171
- * complete the DKIM verification process.</p>
2172
- */
1015
+
2173
1016
  DkimAttributes?: DkimAttributes;
2174
- /**
2175
- * <p>An object that contains information about the Mail-From attributes for the email
2176
- * identity.</p>
2177
- */
1017
+
2178
1018
  MailFromAttributes?: MailFromAttributes;
2179
- /**
2180
- * <p>An array of objects that define the tags (keys and values) that are associated with
2181
- * the email identity.</p>
2182
- */
1019
+
2183
1020
  Tags?: Tag[];
2184
1021
  }
2185
1022
  export declare namespace GetEmailIdentityResponse {
2186
- /**
2187
- * @internal
2188
- */
1023
+
2189
1024
  const filterSensitiveLog: (obj: GetEmailIdentityResponse) => any;
2190
1025
  }
2191
- /**
2192
- * <p>A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current
2193
- * AWS Region.</p>
2194
- */
1026
+
2195
1027
  export interface ListConfigurationSetsRequest {
2196
- /**
2197
- * <p>A token returned from a previous call to <code>ListConfigurationSets</code> to
2198
- * indicate the position in the list of configuration sets.</p>
2199
- */
1028
+
2200
1029
  NextToken?: string;
2201
- /**
2202
- * <p>The number of results to show in a single call to <code>ListConfigurationSets</code>.
2203
- * If the number of results is larger than the number you specified in this parameter, then
2204
- * the response includes a <code>NextToken</code> element, which you can use to obtain
2205
- * additional results.</p>
2206
- */
1030
+
2207
1031
  PageSize?: number;
2208
1032
  }
2209
1033
  export declare namespace ListConfigurationSetsRequest {
2210
- /**
2211
- * @internal
2212
- */
1034
+
2213
1035
  const filterSensitiveLog: (obj: ListConfigurationSetsRequest) => any;
2214
1036
  }
2215
- /**
2216
- * <p>A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.</p>
2217
- */
1037
+
2218
1038
  export interface ListConfigurationSetsResponse {
2219
- /**
2220
- * <p>An array that contains all of the configuration sets in your Amazon Pinpoint account in the
2221
- * current AWS Region.</p>
2222
- */
1039
+
2223
1040
  ConfigurationSets?: string[];
2224
- /**
2225
- * <p>A token that indicates that there are additional configuration sets to list. To view
2226
- * additional configuration sets, issue another request to
2227
- * <code>ListConfigurationSets</code>, and pass this token in the
2228
- * <code>NextToken</code> parameter.</p>
2229
- */
1041
+
2230
1042
  NextToken?: string;
2231
1043
  }
2232
1044
  export declare namespace ListConfigurationSetsResponse {
2233
- /**
2234
- * @internal
2235
- */
1045
+
2236
1046
  const filterSensitiveLog: (obj: ListConfigurationSetsResponse) => any;
2237
1047
  }
2238
- /**
2239
- * <p>A request to obtain a list of dedicated IP pools.</p>
2240
- */
1048
+
2241
1049
  export interface ListDedicatedIpPoolsRequest {
2242
- /**
2243
- * <p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate
2244
- * the position in the list of dedicated IP pools.</p>
2245
- */
1050
+
2246
1051
  NextToken?: string;
2247
- /**
2248
- * <p>The number of results to show in a single call to <code>ListDedicatedIpPools</code>.
2249
- * If the number of results is larger than the number you specified in this parameter, then
2250
- * the response includes a <code>NextToken</code> element, which you can use to obtain
2251
- * additional results.</p>
2252
- */
1052
+
2253
1053
  PageSize?: number;
2254
1054
  }
2255
1055
  export declare namespace ListDedicatedIpPoolsRequest {
2256
- /**
2257
- * @internal
2258
- */
1056
+
2259
1057
  const filterSensitiveLog: (obj: ListDedicatedIpPoolsRequest) => any;
2260
1058
  }
2261
- /**
2262
- * <p>A list of dedicated IP pools.</p>
2263
- */
1059
+
2264
1060
  export interface ListDedicatedIpPoolsResponse {
2265
- /**
2266
- * <p>A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint
2267
- * account.</p>
2268
- */
1061
+
2269
1062
  DedicatedIpPools?: string[];
2270
- /**
2271
- * <p>A token that indicates that there are additional IP pools to list. To view additional
2272
- * IP pools, issue another request to <code>ListDedicatedIpPools</code>, passing this token
2273
- * in the <code>NextToken</code> parameter.</p>
2274
- */
1063
+
2275
1064
  NextToken?: string;
2276
1065
  }
2277
1066
  export declare namespace ListDedicatedIpPoolsResponse {
2278
- /**
2279
- * @internal
2280
- */
1067
+
2281
1068
  const filterSensitiveLog: (obj: ListDedicatedIpPoolsResponse) => any;
2282
1069
  }
2283
- /**
2284
- * <p>A request to list all of the predictive inbox placement tests that you've performed.</p>
2285
- */
1070
+
2286
1071
  export interface ListDeliverabilityTestReportsRequest {
2287
- /**
2288
- * <p>A token returned from a previous call to <code>ListDeliverabilityTestReports</code> to
2289
- * indicate the position in the list of predictive inbox placement tests.</p>
2290
- */
1072
+
2291
1073
  NextToken?: string;
2292
- /**
2293
- * <p>The number of results to show in a single call to
2294
- * <code>ListDeliverabilityTestReports</code>. If the number of results is larger than
2295
- * the number you specified in this parameter, then the response includes a
2296
- * <code>NextToken</code> element, which you can use to obtain additional
2297
- * results.</p>
2298
- * <p>The value you specify has to be at least 0, and can be no more than 1000.</p>
2299
- */
1074
+
2300
1075
  PageSize?: number;
2301
1076
  }
2302
1077
  export declare namespace ListDeliverabilityTestReportsRequest {
2303
- /**
2304
- * @internal
2305
- */
1078
+
2306
1079
  const filterSensitiveLog: (obj: ListDeliverabilityTestReportsRequest) => any;
2307
1080
  }
2308
- /**
2309
- * <p>A list of the predictive inbox placement test reports that are available for your account, regardless of
2310
- * whether or not those tests are complete.</p>
2311
- */
1081
+
2312
1082
  export interface ListDeliverabilityTestReportsResponse {
2313
- /**
2314
- * <p>An object that contains a lists of predictive inbox placement tests that you've performed.</p>
2315
- */
1083
+
2316
1084
  DeliverabilityTestReports: DeliverabilityTestReport[] | undefined;
2317
- /**
2318
- * <p>A token that indicates that there are additional predictive inbox placement tests to list. To view additional
2319
- * predictive inbox placement tests, issue another request to <code>ListDeliverabilityTestReports</code>, and pass
2320
- * this token in the <code>NextToken</code> parameter.</p>
2321
- */
1085
+
2322
1086
  NextToken?: string;
2323
1087
  }
2324
1088
  export declare namespace ListDeliverabilityTestReportsResponse {
2325
- /**
2326
- * @internal
2327
- */
1089
+
2328
1090
  const filterSensitiveLog: (obj: ListDeliverabilityTestReportsResponse) => any;
2329
1091
  }
2330
- /**
2331
- * <p>Retrieve deliverability data for all the campaigns that used a specific domain to send
2332
- * email during a specified time range. This data is available for a domain only if you
2333
- * enabled the Deliverability dashboard (<code>PutDeliverabilityDashboardOption</code> operation)
2334
- * for the domain.</p>
2335
- */
1092
+
2336
1093
  export interface ListDomainDeliverabilityCampaignsRequest {
2337
- /**
2338
- * <p>The first day, in Unix time format, that you want to obtain deliverability data
2339
- * for.</p>
2340
- */
1094
+
2341
1095
  StartDate: Date | undefined;
2342
- /**
2343
- * <p>The last day, in Unix time format, that you want to obtain deliverability data for.
2344
- * This value has to be less than or equal to 30 days after the value of the
2345
- * <code>StartDate</code> parameter.</p>
2346
- */
1096
+
2347
1097
  EndDate: Date | undefined;
2348
- /**
2349
- * <p>The domain to obtain deliverability data for.</p>
2350
- */
1098
+
2351
1099
  SubscribedDomain: string | undefined;
2352
- /**
2353
- * <p>A token that’s returned from a previous call to the
2354
- * <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
2355
- * position of a campaign in the list of campaigns.</p>
2356
- */
1100
+
2357
1101
  NextToken?: string;
2358
- /**
2359
- * <p>The maximum number of results to include in response to a single call to the
2360
- * <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results
2361
- * is larger than the number that you specify in this parameter, the response includes a
2362
- * <code>NextToken</code> element, which you can use to obtain additional
2363
- * results.</p>
2364
- */
1102
+
2365
1103
  PageSize?: number;
2366
1104
  }
2367
1105
  export declare namespace ListDomainDeliverabilityCampaignsRequest {
2368
- /**
2369
- * @internal
2370
- */
1106
+
2371
1107
  const filterSensitiveLog: (obj: ListDomainDeliverabilityCampaignsRequest) => any;
2372
1108
  }
2373
- /**
2374
- * <p>An array of objects that provide deliverability data for all the campaigns that used a
2375
- * specific domain to send email during a specified time range. This data is available for
2376
- * a domain only if you enabled the Deliverability dashboard
2377
- * (<code>PutDeliverabilityDashboardOption</code> operation) for the domain.</p>
2378
- */
1109
+
2379
1110
  export interface ListDomainDeliverabilityCampaignsResponse {
2380
- /**
2381
- * <p>An array of responses, one for each campaign that used the domain to send email during
2382
- * the specified time range.</p>
2383
- */
1111
+
2384
1112
  DomainDeliverabilityCampaigns: DomainDeliverabilityCampaign[] | undefined;
2385
- /**
2386
- * <p>A token that’s returned from a previous call to the
2387
- * <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the
2388
- * position of the campaign in the list of campaigns.</p>
2389
- */
1113
+
2390
1114
  NextToken?: string;
2391
1115
  }
2392
1116
  export declare namespace ListDomainDeliverabilityCampaignsResponse {
2393
- /**
2394
- * @internal
2395
- */
1117
+
2396
1118
  const filterSensitiveLog: (obj: ListDomainDeliverabilityCampaignsResponse) => any;
2397
1119
  }
2398
- /**
2399
- * <p>A request to list all of the email identities associated with your Amazon Pinpoint account. This
2400
- * list includes identities that you've already verified, identities that are unverified,
2401
- * and identities that were verified in the past, but are no longer verified.</p>
2402
- */
1120
+
2403
1121
  export interface ListEmailIdentitiesRequest {
2404
- /**
2405
- * <p>A token returned from a previous call to <code>ListEmailIdentities</code> to indicate
2406
- * the position in the list of identities.</p>
2407
- */
1122
+
2408
1123
  NextToken?: string;
2409
- /**
2410
- * <p>The number of results to show in a single call to <code>ListEmailIdentities</code>. If
2411
- * the number of results is larger than the number you specified in this parameter, then
2412
- * the response includes a <code>NextToken</code> element, which you can use to obtain
2413
- * additional results.</p>
2414
- * <p>The value you specify has to be at least 0, and can be no more than 1000.</p>
2415
- */
1124
+
2416
1125
  PageSize?: number;
2417
1126
  }
2418
1127
  export declare namespace ListEmailIdentitiesRequest {
2419
- /**
2420
- * @internal
2421
- */
1128
+
2422
1129
  const filterSensitiveLog: (obj: ListEmailIdentitiesRequest) => any;
2423
1130
  }
2424
- /**
2425
- * <p>Information about an email identity.</p>
2426
- */
1131
+
2427
1132
  export interface IdentityInfo {
2428
- /**
2429
- * <p>The email identity type. The identity type can be one of the following:</p>
2430
- * <ul>
2431
- * <li>
2432
- * <p>
2433
- * <code>EMAIL_ADDRESS</code> – The identity is an email address.</p>
2434
- * </li>
2435
- * <li>
2436
- * <p>
2437
- * <code>DOMAIN</code> – The identity is a domain.</p>
2438
- * </li>
2439
- * <li>
2440
- * <p>
2441
- * <code>MANAGED_DOMAIN</code> – The identity is a domain that is managed
2442
- * by AWS.</p>
2443
- * </li>
2444
- * </ul>
2445
- */
1133
+
2446
1134
  IdentityType?: IdentityType | string;
2447
- /**
2448
- * <p>The address or domain of the identity.</p>
2449
- */
1135
+
2450
1136
  IdentityName?: string;
2451
- /**
2452
- * <p>Indicates whether or not you can send email from the identity.</p>
2453
- * <p>In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before
2454
- * you can send email from an identity, you have to demostrate that you own the identity,
2455
- * and that you authorize Amazon Pinpoint to send email from that identity.</p>
2456
- */
1137
+
2457
1138
  SendingEnabled?: boolean;
2458
1139
  }
2459
1140
  export declare namespace IdentityInfo {
2460
- /**
2461
- * @internal
2462
- */
1141
+
2463
1142
  const filterSensitiveLog: (obj: IdentityInfo) => any;
2464
1143
  }
2465
- /**
2466
- * <p>A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint,
2467
- * regardless of whether or not those identities were successfully verified.</p>
2468
- */
1144
+
2469
1145
  export interface ListEmailIdentitiesResponse {
2470
- /**
2471
- * <p>An array that includes all of the identities associated with your Amazon Pinpoint
2472
- * account.</p>
2473
- */
1146
+
2474
1147
  EmailIdentities?: IdentityInfo[];
2475
- /**
2476
- * <p>A token that indicates that there are additional configuration sets to list. To view
2477
- * additional configuration sets, issue another request to
2478
- * <code>ListEmailIdentities</code>, and pass this token in the <code>NextToken</code>
2479
- * parameter.</p>
2480
- */
1148
+
2481
1149
  NextToken?: string;
2482
1150
  }
2483
1151
  export declare namespace ListEmailIdentitiesResponse {
2484
- /**
2485
- * @internal
2486
- */
1152
+
2487
1153
  const filterSensitiveLog: (obj: ListEmailIdentitiesResponse) => any;
2488
1154
  }
2489
1155
  export interface ListTagsForResourceRequest {
2490
- /**
2491
- * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
2492
- * information for.</p>
2493
- */
1156
+
2494
1157
  ResourceArn: string | undefined;
2495
1158
  }
2496
1159
  export declare namespace ListTagsForResourceRequest {
2497
- /**
2498
- * @internal
2499
- */
1160
+
2500
1161
  const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2501
1162
  }
2502
1163
  export interface ListTagsForResourceResponse {
2503
- /**
2504
- * <p>An array that lists all the tags that are associated with the resource. Each tag
2505
- * consists of a required tag key (<code>Key</code>) and an associated tag value
2506
- * (<code>Value</code>)</p>
2507
- */
1164
+
2508
1165
  Tags: Tag[] | undefined;
2509
1166
  }
2510
1167
  export declare namespace ListTagsForResourceResponse {
2511
- /**
2512
- * @internal
2513
- */
1168
+
2514
1169
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2515
1170
  }
2516
- /**
2517
- * <p>A request to enable or disable the automatic IP address warm-up feature.</p>
2518
- */
1171
+
2519
1172
  export interface PutAccountDedicatedIpWarmupAttributesRequest {
2520
- /**
2521
- * <p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are
2522
- * associated with your Amazon Pinpoint account in the current AWS Region. Set to <code>true</code>
2523
- * to enable the automatic warm-up feature, or set to <code>false</code> to disable
2524
- * it.</p>
2525
- */
1173
+
2526
1174
  AutoWarmupEnabled?: boolean;
2527
1175
  }
2528
1176
  export declare namespace PutAccountDedicatedIpWarmupAttributesRequest {
2529
- /**
2530
- * @internal
2531
- */
1177
+
2532
1178
  const filterSensitiveLog: (obj: PutAccountDedicatedIpWarmupAttributesRequest) => any;
2533
1179
  }
2534
- /**
2535
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2536
- * fails.</p>
2537
- */
1180
+
2538
1181
  export interface PutAccountDedicatedIpWarmupAttributesResponse {
2539
1182
  }
2540
1183
  export declare namespace PutAccountDedicatedIpWarmupAttributesResponse {
2541
- /**
2542
- * @internal
2543
- */
1184
+
2544
1185
  const filterSensitiveLog: (obj: PutAccountDedicatedIpWarmupAttributesResponse) => any;
2545
1186
  }
2546
- /**
2547
- * <p>A request to change the ability of your account to send email.</p>
2548
- */
1187
+
2549
1188
  export interface PutAccountSendingAttributesRequest {
2550
- /**
2551
- * <p>Enables or disables your account's ability to send email. Set to <code>true</code> to
2552
- * enable email sending, or set to <code>false</code> to disable email sending.</p>
2553
- * <note>
2554
- * <p>If AWS paused your account's ability to send email, you can't use this operation
2555
- * to resume your account's ability to send email.</p>
2556
- * </note>
2557
- */
1189
+
2558
1190
  SendingEnabled?: boolean;
2559
1191
  }
2560
1192
  export declare namespace PutAccountSendingAttributesRequest {
2561
- /**
2562
- * @internal
2563
- */
1193
+
2564
1194
  const filterSensitiveLog: (obj: PutAccountSendingAttributesRequest) => any;
2565
1195
  }
2566
- /**
2567
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2568
- * fails.</p>
2569
- */
1196
+
2570
1197
  export interface PutAccountSendingAttributesResponse {
2571
1198
  }
2572
1199
  export declare namespace PutAccountSendingAttributesResponse {
2573
- /**
2574
- * @internal
2575
- */
1200
+
2576
1201
  const filterSensitiveLog: (obj: PutAccountSendingAttributesResponse) => any;
2577
1202
  }
2578
- /**
2579
- * <p>A request to associate a configuration set with a dedicated IP pool.</p>
2580
- */
1203
+
2581
1204
  export interface PutConfigurationSetDeliveryOptionsRequest {
2582
- /**
2583
- * <p>The name of the configuration set that you want to associate with a dedicated IP
2584
- * pool.</p>
2585
- */
1205
+
2586
1206
  ConfigurationSetName: string | undefined;
2587
- /**
2588
- * <p>Specifies whether messages that use the configuration set are required to use
2589
- * Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
2590
- * delivered if a TLS connection can be established. If the value is <code>Optional</code>,
2591
- * messages can be delivered in plain text if a TLS connection can't be established.</p>
2592
- */
1207
+
2593
1208
  TlsPolicy?: TlsPolicy | string;
2594
- /**
2595
- * <p>The name of the dedicated IP pool that you want to associate with the configuration
2596
- * set.</p>
2597
- */
1209
+
2598
1210
  SendingPoolName?: string;
2599
1211
  }
2600
1212
  export declare namespace PutConfigurationSetDeliveryOptionsRequest {
2601
- /**
2602
- * @internal
2603
- */
1213
+
2604
1214
  const filterSensitiveLog: (obj: PutConfigurationSetDeliveryOptionsRequest) => any;
2605
1215
  }
2606
- /**
2607
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2608
- * fails.</p>
2609
- */
1216
+
2610
1217
  export interface PutConfigurationSetDeliveryOptionsResponse {
2611
1218
  }
2612
1219
  export declare namespace PutConfigurationSetDeliveryOptionsResponse {
2613
- /**
2614
- * @internal
2615
- */
1220
+
2616
1221
  const filterSensitiveLog: (obj: PutConfigurationSetDeliveryOptionsResponse) => any;
2617
1222
  }
2618
- /**
2619
- * <p>A request to enable or disable tracking of reputation metrics for a configuration
2620
- * set.</p>
2621
- */
1223
+
2622
1224
  export interface PutConfigurationSetReputationOptionsRequest {
2623
- /**
2624
- * <p>The name of the configuration set that you want to enable or disable reputation metric
2625
- * tracking for.</p>
2626
- */
1225
+
2627
1226
  ConfigurationSetName: string | undefined;
2628
- /**
2629
- * <p>If <code>true</code>, tracking of reputation metrics is enabled for the configuration
2630
- * set. If <code>false</code>, tracking of reputation metrics is disabled for the
2631
- * configuration set.</p>
2632
- */
1227
+
2633
1228
  ReputationMetricsEnabled?: boolean;
2634
1229
  }
2635
1230
  export declare namespace PutConfigurationSetReputationOptionsRequest {
2636
- /**
2637
- * @internal
2638
- */
1231
+
2639
1232
  const filterSensitiveLog: (obj: PutConfigurationSetReputationOptionsRequest) => any;
2640
1233
  }
2641
- /**
2642
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2643
- * fails.</p>
2644
- */
1234
+
2645
1235
  export interface PutConfigurationSetReputationOptionsResponse {
2646
1236
  }
2647
1237
  export declare namespace PutConfigurationSetReputationOptionsResponse {
2648
- /**
2649
- * @internal
2650
- */
1238
+
2651
1239
  const filterSensitiveLog: (obj: PutConfigurationSetReputationOptionsResponse) => any;
2652
1240
  }
2653
- /**
2654
- * <p>A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
2655
- * configuration set.</p>
2656
- */
1241
+
2657
1242
  export interface PutConfigurationSetSendingOptionsRequest {
2658
- /**
2659
- * <p>The name of the configuration set that you want to enable or disable email sending
2660
- * for.</p>
2661
- */
1243
+
2662
1244
  ConfigurationSetName: string | undefined;
2663
- /**
2664
- * <p>If <code>true</code>, email sending is enabled for the configuration set. If
2665
- * <code>false</code>, email sending is disabled for the configuration set.</p>
2666
- */
1245
+
2667
1246
  SendingEnabled?: boolean;
2668
1247
  }
2669
1248
  export declare namespace PutConfigurationSetSendingOptionsRequest {
2670
- /**
2671
- * @internal
2672
- */
1249
+
2673
1250
  const filterSensitiveLog: (obj: PutConfigurationSetSendingOptionsRequest) => any;
2674
1251
  }
2675
- /**
2676
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2677
- * fails.</p>
2678
- */
1252
+
2679
1253
  export interface PutConfigurationSetSendingOptionsResponse {
2680
1254
  }
2681
1255
  export declare namespace PutConfigurationSetSendingOptionsResponse {
2682
- /**
2683
- * @internal
2684
- */
1256
+
2685
1257
  const filterSensitiveLog: (obj: PutConfigurationSetSendingOptionsResponse) => any;
2686
1258
  }
2687
- /**
2688
- * <p>A request to add a custom domain for tracking open and click events to a configuration
2689
- * set.</p>
2690
- */
1259
+
2691
1260
  export interface PutConfigurationSetTrackingOptionsRequest {
2692
- /**
2693
- * <p>The name of the configuration set that you want to add a custom tracking domain
2694
- * to.</p>
2695
- */
1261
+
2696
1262
  ConfigurationSetName: string | undefined;
2697
- /**
2698
- * <p>The domain that you want to use to track open and click events.</p>
2699
- */
1263
+
2700
1264
  CustomRedirectDomain?: string;
2701
1265
  }
2702
1266
  export declare namespace PutConfigurationSetTrackingOptionsRequest {
2703
- /**
2704
- * @internal
2705
- */
1267
+
2706
1268
  const filterSensitiveLog: (obj: PutConfigurationSetTrackingOptionsRequest) => any;
2707
1269
  }
2708
- /**
2709
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2710
- * fails.</p>
2711
- */
1270
+
2712
1271
  export interface PutConfigurationSetTrackingOptionsResponse {
2713
1272
  }
2714
1273
  export declare namespace PutConfigurationSetTrackingOptionsResponse {
2715
- /**
2716
- * @internal
2717
- */
1274
+
2718
1275
  const filterSensitiveLog: (obj: PutConfigurationSetTrackingOptionsResponse) => any;
2719
1276
  }
2720
- /**
2721
- * <p>A request to move a dedicated IP address to a dedicated IP pool.</p>
2722
- */
1277
+
2723
1278
  export interface PutDedicatedIpInPoolRequest {
2724
- /**
2725
- * <p>The IP address that you want to move to the dedicated IP pool. The value you specify
2726
- * has to be a dedicated IP address that's associated with your Amazon Pinpoint account.</p>
2727
- */
1279
+
2728
1280
  Ip: string | undefined;
2729
- /**
2730
- * <p>The name of the IP pool that you want to add the dedicated IP address to. You have to
2731
- * specify an IP pool that already exists.</p>
2732
- */
1281
+
2733
1282
  DestinationPoolName: string | undefined;
2734
1283
  }
2735
1284
  export declare namespace PutDedicatedIpInPoolRequest {
2736
- /**
2737
- * @internal
2738
- */
1285
+
2739
1286
  const filterSensitiveLog: (obj: PutDedicatedIpInPoolRequest) => any;
2740
1287
  }
2741
- /**
2742
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2743
- * fails.</p>
2744
- */
1288
+
2745
1289
  export interface PutDedicatedIpInPoolResponse {
2746
1290
  }
2747
1291
  export declare namespace PutDedicatedIpInPoolResponse {
2748
- /**
2749
- * @internal
2750
- */
1292
+
2751
1293
  const filterSensitiveLog: (obj: PutDedicatedIpInPoolResponse) => any;
2752
1294
  }
2753
- /**
2754
- * <p>A request to change the warm-up attributes for a dedicated IP address. This operation
2755
- * is useful when you want to resume the warm-up process for an existing IP address.</p>
2756
- */
1295
+
2757
1296
  export interface PutDedicatedIpWarmupAttributesRequest {
2758
- /**
2759
- * <p>The dedicated IP address that you want to update the warm-up attributes for.</p>
2760
- */
1297
+
2761
1298
  Ip: string | undefined;
2762
- /**
2763
- * <p>The warm-up percentage that you want to associate with the dedicated IP
2764
- * address.</p>
2765
- */
1299
+
2766
1300
  WarmupPercentage: number | undefined;
2767
1301
  }
2768
1302
  export declare namespace PutDedicatedIpWarmupAttributesRequest {
2769
- /**
2770
- * @internal
2771
- */
1303
+
2772
1304
  const filterSensitiveLog: (obj: PutDedicatedIpWarmupAttributesRequest) => any;
2773
1305
  }
2774
- /**
2775
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2776
- * fails.</p>
2777
- */
1306
+
2778
1307
  export interface PutDedicatedIpWarmupAttributesResponse {
2779
1308
  }
2780
1309
  export declare namespace PutDedicatedIpWarmupAttributesResponse {
2781
- /**
2782
- * @internal
2783
- */
1310
+
2784
1311
  const filterSensitiveLog: (obj: PutDedicatedIpWarmupAttributesResponse) => any;
2785
1312
  }
2786
- /**
2787
- * <p>Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the
2788
- * Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for
2789
- * the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform
2790
- * predictive inbox placement tests.</p>
2791
- * <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition
2792
- * to any other fees that you accrue by using Amazon Pinpoint. For more information about the
2793
- * features and cost of a Deliverability dashboard subscription, see <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>
2794
- */
1313
+
2795
1314
  export interface PutDeliverabilityDashboardOptionRequest {
2796
- /**
2797
- * <p>Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the
2798
- * dashboard, set this value to <code>true</code>.</p>
2799
- */
1315
+
2800
1316
  DashboardEnabled: boolean | undefined;
2801
- /**
2802
- * <p>An array of objects, one for each verified domain that you use to send email and
2803
- * enabled the Deliverability dashboard for.</p>
2804
- */
1317
+
2805
1318
  SubscribedDomains?: DomainDeliverabilityTrackingOption[];
2806
1319
  }
2807
1320
  export declare namespace PutDeliverabilityDashboardOptionRequest {
2808
- /**
2809
- * @internal
2810
- */
1321
+
2811
1322
  const filterSensitiveLog: (obj: PutDeliverabilityDashboardOptionRequest) => any;
2812
1323
  }
2813
- /**
2814
- * <p>A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint
2815
- * account.</p>
2816
- */
1324
+
2817
1325
  export interface PutDeliverabilityDashboardOptionResponse {
2818
1326
  }
2819
1327
  export declare namespace PutDeliverabilityDashboardOptionResponse {
2820
- /**
2821
- * @internal
2822
- */
1328
+
2823
1329
  const filterSensitiveLog: (obj: PutDeliverabilityDashboardOptionResponse) => any;
2824
1330
  }
2825
- /**
2826
- * <p>A request to enable or disable DKIM signing of email that you send from an email
2827
- * identity.</p>
2828
- */
1331
+
2829
1332
  export interface PutEmailIdentityDkimAttributesRequest {
2830
- /**
2831
- * <p>The email identity that you want to change the DKIM settings for.</p>
2832
- */
1333
+
2833
1334
  EmailIdentity: string | undefined;
2834
- /**
2835
- * <p>Sets the DKIM signing configuration for the identity.</p>
2836
- * <p>When you set this value <code>true</code>, then the messages that Amazon Pinpoint sends from the
2837
- * identity are DKIM-signed. When you set this value to <code>false</code>, then the
2838
- * messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.</p>
2839
- */
1335
+
2840
1336
  SigningEnabled?: boolean;
2841
1337
  }
2842
1338
  export declare namespace PutEmailIdentityDkimAttributesRequest {
2843
- /**
2844
- * @internal
2845
- */
1339
+
2846
1340
  const filterSensitiveLog: (obj: PutEmailIdentityDkimAttributesRequest) => any;
2847
1341
  }
2848
- /**
2849
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2850
- * fails.</p>
2851
- */
1342
+
2852
1343
  export interface PutEmailIdentityDkimAttributesResponse {
2853
1344
  }
2854
1345
  export declare namespace PutEmailIdentityDkimAttributesResponse {
2855
- /**
2856
- * @internal
2857
- */
1346
+
2858
1347
  const filterSensitiveLog: (obj: PutEmailIdentityDkimAttributesResponse) => any;
2859
1348
  }
2860
- /**
2861
- * <p>A request to set the attributes that control how bounce and complaint events are
2862
- * processed.</p>
2863
- */
1349
+
2864
1350
  export interface PutEmailIdentityFeedbackAttributesRequest {
2865
- /**
2866
- * <p>The email identity that you want to configure bounce and complaint feedback forwarding
2867
- * for.</p>
2868
- */
1351
+
2869
1352
  EmailIdentity: string | undefined;
2870
- /**
2871
- * <p>Sets the feedback forwarding configuration for the identity.</p>
2872
- * <p>If the value is <code>true</code>, Amazon Pinpoint sends you email notifications when bounce or
2873
- * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
2874
- * in the Return-Path header of the original email.</p>
2875
- * <p>When you set this value to <code>false</code>, Amazon Pinpoint sends notifications through other
2876
- * mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're
2877
- * required to have a method of tracking bounces and complaints. If you haven't set up
2878
- * another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email
2879
- * notification when these events occur (even if this setting is disabled).</p>
2880
- */
1353
+
2881
1354
  EmailForwardingEnabled?: boolean;
2882
1355
  }
2883
1356
  export declare namespace PutEmailIdentityFeedbackAttributesRequest {
2884
- /**
2885
- * @internal
2886
- */
1357
+
2887
1358
  const filterSensitiveLog: (obj: PutEmailIdentityFeedbackAttributesRequest) => any;
2888
1359
  }
2889
- /**
2890
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2891
- * fails.</p>
2892
- */
1360
+
2893
1361
  export interface PutEmailIdentityFeedbackAttributesResponse {
2894
1362
  }
2895
1363
  export declare namespace PutEmailIdentityFeedbackAttributesResponse {
2896
- /**
2897
- * @internal
2898
- */
1364
+
2899
1365
  const filterSensitiveLog: (obj: PutEmailIdentityFeedbackAttributesResponse) => any;
2900
1366
  }
2901
- /**
2902
- * <p>A request to configure the custom MAIL FROM domain for a verified identity.</p>
2903
- */
1367
+
2904
1368
  export interface PutEmailIdentityMailFromAttributesRequest {
2905
- /**
2906
- * <p>The verified email identity that you want to set up the custom MAIL FROM domain
2907
- * for.</p>
2908
- */
1369
+
2909
1370
  EmailIdentity: string | undefined;
2910
- /**
2911
- * <p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM
2912
- * domain must meet the following criteria:</p>
2913
- * <ul>
2914
- * <li>
2915
- * <p>It has to be a subdomain of the verified identity.</p>
2916
- * </li>
2917
- * <li>
2918
- * <p>It can't be used to receive email.</p>
2919
- * </li>
2920
- * <li>
2921
- * <p>It can't be used in a "From" address if the MAIL FROM domain is a destination
2922
- * for feedback forwarding emails.</p>
2923
- * </li>
2924
- * </ul>
2925
- */
1371
+
2926
1372
  MailFromDomain?: string;
2927
- /**
2928
- * <p>The action that you want Amazon Pinpoint to take if it can't read the required MX record when
2929
- * you send an email. When you set this value to <code>UseDefaultValue</code>, Amazon Pinpoint uses
2930
- * <i>amazonses.com</i> as the MAIL FROM domain. When you set this value
2931
- * to <code>RejectMessage</code>, Amazon Pinpoint returns a <code>MailFromDomainNotVerified</code>
2932
- * error, and doesn't attempt to deliver the email.</p>
2933
- * <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the
2934
- * <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>
2935
- * states.</p>
2936
- */
1373
+
2937
1374
  BehaviorOnMxFailure?: BehaviorOnMxFailure | string;
2938
1375
  }
2939
1376
  export declare namespace PutEmailIdentityMailFromAttributesRequest {
2940
- /**
2941
- * @internal
2942
- */
1377
+
2943
1378
  const filterSensitiveLog: (obj: PutEmailIdentityMailFromAttributesRequest) => any;
2944
1379
  }
2945
- /**
2946
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
2947
- * fails.</p>
2948
- */
1380
+
2949
1381
  export interface PutEmailIdentityMailFromAttributesResponse {
2950
1382
  }
2951
1383
  export declare namespace PutEmailIdentityMailFromAttributesResponse {
2952
- /**
2953
- * @internal
2954
- */
1384
+
2955
1385
  const filterSensitiveLog: (obj: PutEmailIdentityMailFromAttributesResponse) => any;
2956
1386
  }
2957
- /**
2958
- * <p>An object that describes the recipients for an email.</p>
2959
- */
1387
+
2960
1388
  export interface Destination {
2961
- /**
2962
- * <p>An array that contains the email addresses of the "To" recipients for the
2963
- * email.</p>
2964
- */
1389
+
2965
1390
  ToAddresses?: string[];
2966
- /**
2967
- * <p>An array that contains the email addresses of the "CC" (carbon copy) recipients for
2968
- * the email.</p>
2969
- */
1391
+
2970
1392
  CcAddresses?: string[];
2971
- /**
2972
- * <p>An array that contains the email addresses of the "BCC" (blind carbon copy) recipients
2973
- * for the email.</p>
2974
- */
1393
+
2975
1394
  BccAddresses?: string[];
2976
1395
  }
2977
1396
  export declare namespace Destination {
2978
- /**
2979
- * @internal
2980
- */
1397
+
2981
1398
  const filterSensitiveLog: (obj: Destination) => any;
2982
1399
  }
2983
- /**
2984
- * <p>Contains the name and value of a tag that you apply to an email. You can use message
2985
- * tags when you publish email sending events.
2986
- * </p>
2987
- */
1400
+
2988
1401
  export interface MessageTag {
2989
- /**
2990
- * <p>The name of the message tag. The message tag name has to meet the following
2991
- * criteria:</p>
2992
- * <ul>
2993
- * <li>
2994
- * <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
2995
- * underscores (_), or dashes (-).</p>
2996
- * </li>
2997
- * <li>
2998
- * <p>It can contain no more than 256 characters.</p>
2999
- * </li>
3000
- * </ul>
3001
- */
1402
+
3002
1403
  Name: string | undefined;
3003
- /**
3004
- * <p>The value of the message tag. The message tag value has to meet the following
3005
- * criteria:</p>
3006
- * <ul>
3007
- * <li>
3008
- * <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
3009
- * underscores (_), or dashes (-).</p>
3010
- * </li>
3011
- * <li>
3012
- * <p>It can contain no more than 256 characters.</p>
3013
- * </li>
3014
- * </ul>
3015
- */
1404
+
3016
1405
  Value: string | undefined;
3017
1406
  }
3018
1407
  export declare namespace MessageTag {
3019
- /**
3020
- * @internal
3021
- */
1408
+
3022
1409
  const filterSensitiveLog: (obj: MessageTag) => any;
3023
1410
  }
3024
- /**
3025
- * <p>A request to send an email message.</p>
3026
- */
1411
+
3027
1412
  export interface SendEmailRequest {
3028
- /**
3029
- * <p>The email address that you want to use as the "From" address for the email. The
3030
- * address that you specify has to be verified.
3031
- * </p>
3032
- */
1413
+
3033
1414
  FromEmailAddress?: string;
3034
- /**
3035
- * <p>An object that contains the recipients of the email message.</p>
3036
- */
1415
+
3037
1416
  Destination: Destination | undefined;
3038
- /**
3039
- * <p>The "Reply-to" email addresses for the message. When the recipient replies to the
3040
- * message, each Reply-to address receives the reply.</p>
3041
- */
1417
+
3042
1418
  ReplyToAddresses?: string[];
3043
- /**
3044
- * <p>The address that Amazon Pinpoint should send bounce and complaint notifications to.</p>
3045
- */
1419
+
3046
1420
  FeedbackForwardingEmailAddress?: string;
3047
- /**
3048
- * <p>An object that contains the body of the message. You can send either a Simple message
3049
- * or a Raw message.</p>
3050
- */
1421
+
3051
1422
  Content: EmailContent | undefined;
3052
- /**
3053
- * <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
3054
- * using the <code>SendEmail</code> operation. Tags correspond to characteristics of the
3055
- * email that you define, so that you can publish email sending events. </p>
3056
- */
1423
+
3057
1424
  EmailTags?: MessageTag[];
3058
- /**
3059
- * <p>The name of the configuration set that you want to use when sending the email.</p>
3060
- */
1425
+
3061
1426
  ConfigurationSetName?: string;
3062
1427
  }
3063
1428
  export declare namespace SendEmailRequest {
3064
- /**
3065
- * @internal
3066
- */
1429
+
3067
1430
  const filterSensitiveLog: (obj: SendEmailRequest) => any;
3068
1431
  }
3069
- /**
3070
- * <p>A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.</p>
3071
- */
1432
+
3072
1433
  export interface SendEmailResponse {
3073
- /**
3074
- * <p>A unique identifier for the message that is generated when Amazon Pinpoint accepts the
3075
- * message.</p>
3076
- * <note>
3077
- * <p>It is possible for Amazon Pinpoint to accept a message without sending it. This can happen
3078
- * when the message you're trying to send has an attachment doesn't pass a virus check,
3079
- * or when you send a templated email that contains invalid personalization content,
3080
- * for example.</p>
3081
- * </note>
3082
- */
1434
+
3083
1435
  MessageId?: string;
3084
1436
  }
3085
1437
  export declare namespace SendEmailResponse {
3086
- /**
3087
- * @internal
3088
- */
1438
+
3089
1439
  const filterSensitiveLog: (obj: SendEmailResponse) => any;
3090
1440
  }
3091
1441
  export interface TagResourceRequest {
3092
- /**
3093
- * <p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags
3094
- * to.</p>
3095
- */
1442
+
3096
1443
  ResourceArn: string | undefined;
3097
- /**
3098
- * <p>A list of the tags that you want to add to the resource. A tag consists of a required
3099
- * tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum
3100
- * length of a tag key is 128 characters. The maximum length of a tag value is 256
3101
- * characters.</p>
3102
- */
1444
+
3103
1445
  Tags: Tag[] | undefined;
3104
1446
  }
3105
1447
  export declare namespace TagResourceRequest {
3106
- /**
3107
- * @internal
3108
- */
1448
+
3109
1449
  const filterSensitiveLog: (obj: TagResourceRequest) => any;
3110
1450
  }
3111
1451
  export interface TagResourceResponse {
3112
1452
  }
3113
1453
  export declare namespace TagResourceResponse {
3114
- /**
3115
- * @internal
3116
- */
1454
+
3117
1455
  const filterSensitiveLog: (obj: TagResourceResponse) => any;
3118
1456
  }
3119
1457
  export interface UntagResourceRequest {
3120
- /**
3121
- * <p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more
3122
- * tags from.</p>
3123
- */
1458
+
3124
1459
  ResourceArn: string | undefined;
3125
- /**
3126
- * <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
3127
- * key, the action removes both that key and its associated tag value.</p>
3128
- * <p>To remove more than one tag from the resource, append the <code>TagKeys</code>
3129
- * parameter and argument for each additional tag to remove, separated by an ampersand. For
3130
- * example:
3131
- * <code>/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2</code>
3132
- * </p>
3133
- */
1460
+
3134
1461
  TagKeys: string[] | undefined;
3135
1462
  }
3136
1463
  export declare namespace UntagResourceRequest {
3137
- /**
3138
- * @internal
3139
- */
1464
+
3140
1465
  const filterSensitiveLog: (obj: UntagResourceRequest) => any;
3141
1466
  }
3142
1467
  export interface UntagResourceResponse {
3143
1468
  }
3144
1469
  export declare namespace UntagResourceResponse {
3145
- /**
3146
- * @internal
3147
- */
1470
+
3148
1471
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
3149
1472
  }
3150
- /**
3151
- * <p>A request to change the settings for an event destination for a configuration
3152
- * set.</p>
3153
- */
1473
+
3154
1474
  export interface UpdateConfigurationSetEventDestinationRequest {
3155
- /**
3156
- * <p>The name of the configuration set that contains the event destination that you want to
3157
- * modify.</p>
3158
- */
1475
+
3159
1476
  ConfigurationSetName: string | undefined;
3160
- /**
3161
- * <p>The name of the event destination that you want to modify.</p>
3162
- */
1477
+
3163
1478
  EventDestinationName: string | undefined;
3164
- /**
3165
- * <p>An object that defines the event destination.</p>
3166
- */
1479
+
3167
1480
  EventDestination: EventDestinationDefinition | undefined;
3168
1481
  }
3169
1482
  export declare namespace UpdateConfigurationSetEventDestinationRequest {
3170
- /**
3171
- * @internal
3172
- */
1483
+
3173
1484
  const filterSensitiveLog: (obj: UpdateConfigurationSetEventDestinationRequest) => any;
3174
1485
  }
3175
- /**
3176
- * <p>An HTTP 200 response if the request succeeds, or an error message if the request
3177
- * fails.</p>
3178
- */
1486
+
3179
1487
  export interface UpdateConfigurationSetEventDestinationResponse {
3180
1488
  }
3181
1489
  export declare namespace UpdateConfigurationSetEventDestinationResponse {
3182
- /**
3183
- * @internal
3184
- */
1490
+
3185
1491
  const filterSensitiveLog: (obj: UpdateConfigurationSetEventDestinationResponse) => any;
3186
1492
  }