@aws-sdk/client-pinpoint 3.533.0 → 3.540.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 (256) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/Pinpoint.d.ts +4 -1
  6. package/dist-types/PinpointClient.d.ts +1 -1
  7. package/dist-types/commands/CreateAppCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateCampaignCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateEmailTemplateCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateExportJobCommand.d.ts +2 -1
  11. package/dist-types/commands/CreateImportJobCommand.d.ts +2 -1
  12. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +2 -1
  13. package/dist-types/commands/CreateJourneyCommand.d.ts +2 -1
  14. package/dist-types/commands/CreatePushTemplateCommand.d.ts +2 -1
  15. package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +2 -1
  16. package/dist-types/commands/CreateSegmentCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateSmsTemplateCommand.d.ts +2 -1
  18. package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +2 -1
  19. package/dist-types/commands/DeleteAdmChannelCommand.d.ts +2 -1
  20. package/dist-types/commands/DeleteApnsChannelCommand.d.ts +2 -1
  21. package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +2 -1
  22. package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +2 -1
  23. package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +2 -1
  24. package/dist-types/commands/DeleteAppCommand.d.ts +2 -1
  25. package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +2 -1
  26. package/dist-types/commands/DeleteCampaignCommand.d.ts +2 -1
  27. package/dist-types/commands/DeleteEmailChannelCommand.d.ts +2 -1
  28. package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +2 -1
  29. package/dist-types/commands/DeleteEndpointCommand.d.ts +2 -1
  30. package/dist-types/commands/DeleteEventStreamCommand.d.ts +2 -1
  31. package/dist-types/commands/DeleteGcmChannelCommand.d.ts +2 -1
  32. package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +2 -1
  33. package/dist-types/commands/DeleteJourneyCommand.d.ts +2 -1
  34. package/dist-types/commands/DeletePushTemplateCommand.d.ts +2 -1
  35. package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +2 -1
  36. package/dist-types/commands/DeleteSegmentCommand.d.ts +2 -1
  37. package/dist-types/commands/DeleteSmsChannelCommand.d.ts +2 -1
  38. package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +2 -1
  39. package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +2 -1
  40. package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +2 -1
  41. package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +2 -1
  42. package/dist-types/commands/GetAdmChannelCommand.d.ts +2 -1
  43. package/dist-types/commands/GetApnsChannelCommand.d.ts +2 -1
  44. package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +2 -1
  45. package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +2 -1
  46. package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +2 -1
  47. package/dist-types/commands/GetAppCommand.d.ts +2 -1
  48. package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +2 -1
  49. package/dist-types/commands/GetApplicationSettingsCommand.d.ts +2 -1
  50. package/dist-types/commands/GetAppsCommand.d.ts +2 -1
  51. package/dist-types/commands/GetBaiduChannelCommand.d.ts +2 -1
  52. package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +2 -1
  53. package/dist-types/commands/GetCampaignCommand.d.ts +2 -1
  54. package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +2 -1
  55. package/dist-types/commands/GetCampaignVersionCommand.d.ts +2 -1
  56. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +2 -1
  57. package/dist-types/commands/GetCampaignsCommand.d.ts +2 -1
  58. package/dist-types/commands/GetChannelsCommand.d.ts +2 -1
  59. package/dist-types/commands/GetEmailChannelCommand.d.ts +2 -1
  60. package/dist-types/commands/GetEmailTemplateCommand.d.ts +2 -1
  61. package/dist-types/commands/GetEndpointCommand.d.ts +2 -1
  62. package/dist-types/commands/GetEventStreamCommand.d.ts +2 -1
  63. package/dist-types/commands/GetExportJobCommand.d.ts +2 -1
  64. package/dist-types/commands/GetExportJobsCommand.d.ts +2 -1
  65. package/dist-types/commands/GetGcmChannelCommand.d.ts +2 -1
  66. package/dist-types/commands/GetImportJobCommand.d.ts +2 -1
  67. package/dist-types/commands/GetImportJobsCommand.d.ts +2 -1
  68. package/dist-types/commands/GetInAppMessagesCommand.d.ts +2 -1
  69. package/dist-types/commands/GetInAppTemplateCommand.d.ts +2 -1
  70. package/dist-types/commands/GetJourneyCommand.d.ts +2 -1
  71. package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +2 -1
  72. package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +2 -1
  73. package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +2 -1
  74. package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +2 -1
  75. package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +2 -1
  76. package/dist-types/commands/GetJourneyRunsCommand.d.ts +2 -1
  77. package/dist-types/commands/GetPushTemplateCommand.d.ts +2 -1
  78. package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +2 -1
  79. package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +2 -1
  80. package/dist-types/commands/GetSegmentCommand.d.ts +2 -1
  81. package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +2 -1
  82. package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +2 -1
  83. package/dist-types/commands/GetSegmentVersionCommand.d.ts +2 -1
  84. package/dist-types/commands/GetSegmentVersionsCommand.d.ts +2 -1
  85. package/dist-types/commands/GetSegmentsCommand.d.ts +2 -1
  86. package/dist-types/commands/GetSmsChannelCommand.d.ts +2 -1
  87. package/dist-types/commands/GetSmsTemplateCommand.d.ts +2 -1
  88. package/dist-types/commands/GetUserEndpointsCommand.d.ts +2 -1
  89. package/dist-types/commands/GetVoiceChannelCommand.d.ts +2 -1
  90. package/dist-types/commands/GetVoiceTemplateCommand.d.ts +2 -1
  91. package/dist-types/commands/ListJourneysCommand.d.ts +2 -1
  92. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  93. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +2 -1
  94. package/dist-types/commands/ListTemplatesCommand.d.ts +2 -1
  95. package/dist-types/commands/PhoneNumberValidateCommand.d.ts +2 -1
  96. package/dist-types/commands/PutEventStreamCommand.d.ts +2 -1
  97. package/dist-types/commands/PutEventsCommand.d.ts +2 -1
  98. package/dist-types/commands/RemoveAttributesCommand.d.ts +2 -1
  99. package/dist-types/commands/SendMessagesCommand.d.ts +2 -1
  100. package/dist-types/commands/SendOTPMessageCommand.d.ts +2 -1
  101. package/dist-types/commands/SendUsersMessagesCommand.d.ts +2 -1
  102. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  103. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  104. package/dist-types/commands/UpdateAdmChannelCommand.d.ts +2 -1
  105. package/dist-types/commands/UpdateApnsChannelCommand.d.ts +2 -1
  106. package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +2 -1
  107. package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +2 -1
  108. package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +2 -1
  109. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +2 -1
  110. package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +2 -1
  111. package/dist-types/commands/UpdateCampaignCommand.d.ts +2 -1
  112. package/dist-types/commands/UpdateEmailChannelCommand.d.ts +2 -1
  113. package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +2 -1
  114. package/dist-types/commands/UpdateEndpointCommand.d.ts +2 -1
  115. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +2 -1
  116. package/dist-types/commands/UpdateGcmChannelCommand.d.ts +2 -1
  117. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +2 -1
  118. package/dist-types/commands/UpdateJourneyCommand.d.ts +2 -1
  119. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +2 -1
  120. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +2 -1
  121. package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +2 -1
  122. package/dist-types/commands/UpdateSegmentCommand.d.ts +2 -1
  123. package/dist-types/commands/UpdateSmsChannelCommand.d.ts +2 -1
  124. package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +2 -1
  125. package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +2 -1
  126. package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +2 -1
  127. package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +2 -1
  128. package/dist-types/commands/VerifyOTPMessageCommand.d.ts +2 -1
  129. package/dist-types/index.d.ts +0 -1
  130. package/dist-types/models/models_0.d.ts +1282 -1282
  131. package/dist-types/models/models_1.d.ts +508 -508
  132. package/dist-types/ts3.4/Pinpoint.d.ts +3 -0
  133. package/dist-types/ts3.4/commands/CreateAppCommand.d.ts +9 -0
  134. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +9 -0
  135. package/dist-types/ts3.4/commands/CreateEmailTemplateCommand.d.ts +9 -0
  136. package/dist-types/ts3.4/commands/CreateExportJobCommand.d.ts +9 -0
  137. package/dist-types/ts3.4/commands/CreateImportJobCommand.d.ts +9 -0
  138. package/dist-types/ts3.4/commands/CreateInAppTemplateCommand.d.ts +9 -0
  139. package/dist-types/ts3.4/commands/CreateJourneyCommand.d.ts +9 -0
  140. package/dist-types/ts3.4/commands/CreatePushTemplateCommand.d.ts +9 -0
  141. package/dist-types/ts3.4/commands/CreateRecommenderConfigurationCommand.d.ts +9 -0
  142. package/dist-types/ts3.4/commands/CreateSegmentCommand.d.ts +9 -0
  143. package/dist-types/ts3.4/commands/CreateSmsTemplateCommand.d.ts +9 -0
  144. package/dist-types/ts3.4/commands/CreateVoiceTemplateCommand.d.ts +9 -0
  145. package/dist-types/ts3.4/commands/DeleteAdmChannelCommand.d.ts +9 -0
  146. package/dist-types/ts3.4/commands/DeleteApnsChannelCommand.d.ts +9 -0
  147. package/dist-types/ts3.4/commands/DeleteApnsSandboxChannelCommand.d.ts +9 -0
  148. package/dist-types/ts3.4/commands/DeleteApnsVoipChannelCommand.d.ts +9 -0
  149. package/dist-types/ts3.4/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +9 -0
  150. package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +9 -0
  151. package/dist-types/ts3.4/commands/DeleteBaiduChannelCommand.d.ts +9 -0
  152. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +9 -0
  153. package/dist-types/ts3.4/commands/DeleteEmailChannelCommand.d.ts +9 -0
  154. package/dist-types/ts3.4/commands/DeleteEmailTemplateCommand.d.ts +9 -0
  155. package/dist-types/ts3.4/commands/DeleteEndpointCommand.d.ts +9 -0
  156. package/dist-types/ts3.4/commands/DeleteEventStreamCommand.d.ts +9 -0
  157. package/dist-types/ts3.4/commands/DeleteGcmChannelCommand.d.ts +9 -0
  158. package/dist-types/ts3.4/commands/DeleteInAppTemplateCommand.d.ts +9 -0
  159. package/dist-types/ts3.4/commands/DeleteJourneyCommand.d.ts +9 -0
  160. package/dist-types/ts3.4/commands/DeletePushTemplateCommand.d.ts +9 -0
  161. package/dist-types/ts3.4/commands/DeleteRecommenderConfigurationCommand.d.ts +9 -0
  162. package/dist-types/ts3.4/commands/DeleteSegmentCommand.d.ts +9 -0
  163. package/dist-types/ts3.4/commands/DeleteSmsChannelCommand.d.ts +9 -0
  164. package/dist-types/ts3.4/commands/DeleteSmsTemplateCommand.d.ts +9 -0
  165. package/dist-types/ts3.4/commands/DeleteUserEndpointsCommand.d.ts +9 -0
  166. package/dist-types/ts3.4/commands/DeleteVoiceChannelCommand.d.ts +9 -0
  167. package/dist-types/ts3.4/commands/DeleteVoiceTemplateCommand.d.ts +9 -0
  168. package/dist-types/ts3.4/commands/GetAdmChannelCommand.d.ts +9 -0
  169. package/dist-types/ts3.4/commands/GetApnsChannelCommand.d.ts +9 -0
  170. package/dist-types/ts3.4/commands/GetApnsSandboxChannelCommand.d.ts +9 -0
  171. package/dist-types/ts3.4/commands/GetApnsVoipChannelCommand.d.ts +9 -0
  172. package/dist-types/ts3.4/commands/GetApnsVoipSandboxChannelCommand.d.ts +9 -0
  173. package/dist-types/ts3.4/commands/GetAppCommand.d.ts +7 -0
  174. package/dist-types/ts3.4/commands/GetApplicationDateRangeKpiCommand.d.ts +9 -0
  175. package/dist-types/ts3.4/commands/GetApplicationSettingsCommand.d.ts +9 -0
  176. package/dist-types/ts3.4/commands/GetAppsCommand.d.ts +9 -0
  177. package/dist-types/ts3.4/commands/GetBaiduChannelCommand.d.ts +9 -0
  178. package/dist-types/ts3.4/commands/GetCampaignActivitiesCommand.d.ts +9 -0
  179. package/dist-types/ts3.4/commands/GetCampaignCommand.d.ts +9 -0
  180. package/dist-types/ts3.4/commands/GetCampaignDateRangeKpiCommand.d.ts +9 -0
  181. package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +9 -0
  182. package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +9 -0
  183. package/dist-types/ts3.4/commands/GetCampaignsCommand.d.ts +9 -0
  184. package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +9 -0
  185. package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +9 -0
  186. package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +9 -0
  187. package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +9 -0
  188. package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +9 -0
  189. package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +9 -0
  190. package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +9 -0
  191. package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +9 -0
  192. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +9 -0
  193. package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +9 -0
  194. package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +9 -0
  195. package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +9 -0
  196. package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +9 -0
  197. package/dist-types/ts3.4/commands/GetJourneyDateRangeKpiCommand.d.ts +9 -0
  198. package/dist-types/ts3.4/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +9 -0
  199. package/dist-types/ts3.4/commands/GetJourneyExecutionMetricsCommand.d.ts +9 -0
  200. package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +9 -0
  201. package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +9 -0
  202. package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +9 -0
  203. package/dist-types/ts3.4/commands/GetPushTemplateCommand.d.ts +9 -0
  204. package/dist-types/ts3.4/commands/GetRecommenderConfigurationCommand.d.ts +9 -0
  205. package/dist-types/ts3.4/commands/GetRecommenderConfigurationsCommand.d.ts +9 -0
  206. package/dist-types/ts3.4/commands/GetSegmentCommand.d.ts +9 -0
  207. package/dist-types/ts3.4/commands/GetSegmentExportJobsCommand.d.ts +9 -0
  208. package/dist-types/ts3.4/commands/GetSegmentImportJobsCommand.d.ts +9 -0
  209. package/dist-types/ts3.4/commands/GetSegmentVersionCommand.d.ts +9 -0
  210. package/dist-types/ts3.4/commands/GetSegmentVersionsCommand.d.ts +9 -0
  211. package/dist-types/ts3.4/commands/GetSegmentsCommand.d.ts +9 -0
  212. package/dist-types/ts3.4/commands/GetSmsChannelCommand.d.ts +9 -0
  213. package/dist-types/ts3.4/commands/GetSmsTemplateCommand.d.ts +9 -0
  214. package/dist-types/ts3.4/commands/GetUserEndpointsCommand.d.ts +9 -0
  215. package/dist-types/ts3.4/commands/GetVoiceChannelCommand.d.ts +9 -0
  216. package/dist-types/ts3.4/commands/GetVoiceTemplateCommand.d.ts +9 -0
  217. package/dist-types/ts3.4/commands/ListJourneysCommand.d.ts +9 -0
  218. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  219. package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +9 -0
  220. package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +9 -0
  221. package/dist-types/ts3.4/commands/PhoneNumberValidateCommand.d.ts +9 -0
  222. package/dist-types/ts3.4/commands/PutEventStreamCommand.d.ts +9 -0
  223. package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +9 -0
  224. package/dist-types/ts3.4/commands/RemoveAttributesCommand.d.ts +9 -0
  225. package/dist-types/ts3.4/commands/SendMessagesCommand.d.ts +9 -0
  226. package/dist-types/ts3.4/commands/SendOTPMessageCommand.d.ts +9 -0
  227. package/dist-types/ts3.4/commands/SendUsersMessagesCommand.d.ts +9 -0
  228. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  229. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  230. package/dist-types/ts3.4/commands/UpdateAdmChannelCommand.d.ts +9 -0
  231. package/dist-types/ts3.4/commands/UpdateApnsChannelCommand.d.ts +9 -0
  232. package/dist-types/ts3.4/commands/UpdateApnsSandboxChannelCommand.d.ts +9 -0
  233. package/dist-types/ts3.4/commands/UpdateApnsVoipChannelCommand.d.ts +9 -0
  234. package/dist-types/ts3.4/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +9 -0
  235. package/dist-types/ts3.4/commands/UpdateApplicationSettingsCommand.d.ts +9 -0
  236. package/dist-types/ts3.4/commands/UpdateBaiduChannelCommand.d.ts +9 -0
  237. package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +9 -0
  238. package/dist-types/ts3.4/commands/UpdateEmailChannelCommand.d.ts +9 -0
  239. package/dist-types/ts3.4/commands/UpdateEmailTemplateCommand.d.ts +9 -0
  240. package/dist-types/ts3.4/commands/UpdateEndpointCommand.d.ts +9 -0
  241. package/dist-types/ts3.4/commands/UpdateEndpointsBatchCommand.d.ts +9 -0
  242. package/dist-types/ts3.4/commands/UpdateGcmChannelCommand.d.ts +9 -0
  243. package/dist-types/ts3.4/commands/UpdateInAppTemplateCommand.d.ts +9 -0
  244. package/dist-types/ts3.4/commands/UpdateJourneyCommand.d.ts +9 -0
  245. package/dist-types/ts3.4/commands/UpdateJourneyStateCommand.d.ts +9 -0
  246. package/dist-types/ts3.4/commands/UpdatePushTemplateCommand.d.ts +9 -0
  247. package/dist-types/ts3.4/commands/UpdateRecommenderConfigurationCommand.d.ts +9 -0
  248. package/dist-types/ts3.4/commands/UpdateSegmentCommand.d.ts +9 -0
  249. package/dist-types/ts3.4/commands/UpdateSmsChannelCommand.d.ts +9 -0
  250. package/dist-types/ts3.4/commands/UpdateSmsTemplateCommand.d.ts +9 -0
  251. package/dist-types/ts3.4/commands/UpdateTemplateActiveVersionCommand.d.ts +9 -0
  252. package/dist-types/ts3.4/commands/UpdateVoiceChannelCommand.d.ts +9 -0
  253. package/dist-types/ts3.4/commands/UpdateVoiceTemplateCommand.d.ts +9 -0
  254. package/dist-types/ts3.4/commands/VerifyOTPMessageCommand.d.ts +9 -0
  255. package/dist-types/ts3.4/index.d.ts +0 -1
  256. package/package.json +40 -40
@@ -4,8 +4,8 @@ import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPus
4
4
  */
5
5
  export interface GetCampaignVersionResponse {
6
6
  /**
7
- * @public
8
7
  * <p>Provides information about the status, configuration, and other settings for a campaign.</p>
8
+ * @public
9
9
  */
10
10
  CampaignResponse: CampaignResponse | undefined;
11
11
  }
@@ -14,23 +14,23 @@ export interface GetCampaignVersionResponse {
14
14
  */
15
15
  export interface GetCampaignVersionsRequest {
16
16
  /**
17
- * @public
18
17
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
18
+ * @public
19
19
  */
20
20
  ApplicationId: string | undefined;
21
21
  /**
22
- * @public
23
22
  * <p>The unique identifier for the campaign.</p>
23
+ * @public
24
24
  */
25
25
  CampaignId: string | undefined;
26
26
  /**
27
- * @public
28
27
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
28
+ * @public
29
29
  */
30
30
  PageSize?: string;
31
31
  /**
32
- * @public
33
32
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
33
+ * @public
34
34
  */
35
35
  Token?: string;
36
36
  }
@@ -39,8 +39,8 @@ export interface GetCampaignVersionsRequest {
39
39
  */
40
40
  export interface GetCampaignVersionsResponse {
41
41
  /**
42
- * @public
43
42
  * <p>Provides information about the configuration and other settings for all the campaigns that are associated with an application.</p>
43
+ * @public
44
44
  */
45
45
  CampaignsResponse: CampaignsResponse | undefined;
46
46
  }
@@ -49,8 +49,8 @@ export interface GetCampaignVersionsResponse {
49
49
  */
50
50
  export interface GetChannelsRequest {
51
51
  /**
52
- * @public
53
52
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
53
+ * @public
54
54
  */
55
55
  ApplicationId: string | undefined;
56
56
  }
@@ -59,8 +59,8 @@ export interface GetChannelsRequest {
59
59
  */
60
60
  export interface GetChannelsResponse {
61
61
  /**
62
- * @public
63
62
  * <p>Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.</p>
63
+ * @public
64
64
  */
65
65
  ChannelsResponse: ChannelsResponse | undefined;
66
66
  }
@@ -69,8 +69,8 @@ export interface GetChannelsResponse {
69
69
  */
70
70
  export interface GetEmailChannelRequest {
71
71
  /**
72
- * @public
73
72
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
73
+ * @public
74
74
  */
75
75
  ApplicationId: string | undefined;
76
76
  }
@@ -79,8 +79,8 @@ export interface GetEmailChannelRequest {
79
79
  */
80
80
  export interface GetEmailChannelResponse {
81
81
  /**
82
- * @public
83
82
  * <p>Provides information about the status and settings of the email channel for an application.</p>
83
+ * @public
84
84
  */
85
85
  EmailChannelResponse: EmailChannelResponse | undefined;
86
86
  }
@@ -89,13 +89,13 @@ export interface GetEmailChannelResponse {
89
89
  */
90
90
  export interface GetEmailTemplateRequest {
91
91
  /**
92
- * @public
93
92
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
93
+ * @public
94
94
  */
95
95
  TemplateName: string | undefined;
96
96
  /**
97
- * @public
98
97
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
98
+ * @public
99
99
  */
100
100
  Version?: string;
101
101
  }
@@ -104,8 +104,8 @@ export interface GetEmailTemplateRequest {
104
104
  */
105
105
  export interface GetEmailTemplateResponse {
106
106
  /**
107
- * @public
108
107
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
108
+ * @public
109
109
  */
110
110
  EmailTemplateResponse: EmailTemplateResponse | undefined;
111
111
  }
@@ -114,13 +114,13 @@ export interface GetEmailTemplateResponse {
114
114
  */
115
115
  export interface GetEndpointRequest {
116
116
  /**
117
- * @public
118
117
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
118
+ * @public
119
119
  */
120
120
  ApplicationId: string | undefined;
121
121
  /**
122
- * @public
123
122
  * <p>The case insensitive unique identifier for the endpoint. The identifier can't contain <code>$</code>, <code>\{</code> or <code>\}</code>.</p>
123
+ * @public
124
124
  */
125
125
  EndpointId: string | undefined;
126
126
  }
@@ -129,8 +129,8 @@ export interface GetEndpointRequest {
129
129
  */
130
130
  export interface GetEndpointResponse {
131
131
  /**
132
- * @public
133
132
  * <p>Provides information about the channel type and other settings for an endpoint.</p>
133
+ * @public
134
134
  */
135
135
  EndpointResponse: EndpointResponse | undefined;
136
136
  }
@@ -139,8 +139,8 @@ export interface GetEndpointResponse {
139
139
  */
140
140
  export interface GetEventStreamRequest {
141
141
  /**
142
- * @public
143
142
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
143
+ * @public
144
144
  */
145
145
  ApplicationId: string | undefined;
146
146
  }
@@ -149,8 +149,8 @@ export interface GetEventStreamRequest {
149
149
  */
150
150
  export interface GetEventStreamResponse {
151
151
  /**
152
- * @public
153
152
  * <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
153
+ * @public
154
154
  */
155
155
  EventStream: EventStream | undefined;
156
156
  }
@@ -159,13 +159,13 @@ export interface GetEventStreamResponse {
159
159
  */
160
160
  export interface GetExportJobRequest {
161
161
  /**
162
- * @public
163
162
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
163
+ * @public
164
164
  */
165
165
  ApplicationId: string | undefined;
166
166
  /**
167
- * @public
168
167
  * <p>The unique identifier for the job.</p>
168
+ * @public
169
169
  */
170
170
  JobId: string | undefined;
171
171
  }
@@ -174,8 +174,8 @@ export interface GetExportJobRequest {
174
174
  */
175
175
  export interface GetExportJobResponse {
176
176
  /**
177
- * @public
178
177
  * <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
178
+ * @public
179
179
  */
180
180
  ExportJobResponse: ExportJobResponse | undefined;
181
181
  }
@@ -184,18 +184,18 @@ export interface GetExportJobResponse {
184
184
  */
185
185
  export interface GetExportJobsRequest {
186
186
  /**
187
- * @public
188
187
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
188
+ * @public
189
189
  */
190
190
  ApplicationId: string | undefined;
191
191
  /**
192
- * @public
193
192
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
193
+ * @public
194
194
  */
195
195
  PageSize?: string;
196
196
  /**
197
- * @public
198
197
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
198
+ * @public
199
199
  */
200
200
  Token?: string;
201
201
  }
@@ -204,8 +204,8 @@ export interface GetExportJobsRequest {
204
204
  */
205
205
  export interface GetExportJobsResponse {
206
206
  /**
207
- * @public
208
207
  * <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
208
+ * @public
209
209
  */
210
210
  ExportJobsResponse: ExportJobsResponse | undefined;
211
211
  }
@@ -214,8 +214,8 @@ export interface GetExportJobsResponse {
214
214
  */
215
215
  export interface GetGcmChannelRequest {
216
216
  /**
217
- * @public
218
217
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
218
+ * @public
219
219
  */
220
220
  ApplicationId: string | undefined;
221
221
  }
@@ -224,8 +224,8 @@ export interface GetGcmChannelRequest {
224
224
  */
225
225
  export interface GetGcmChannelResponse {
226
226
  /**
227
- * @public
228
227
  * <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
228
+ * @public
229
229
  */
230
230
  GCMChannelResponse: GCMChannelResponse | undefined;
231
231
  }
@@ -234,13 +234,13 @@ export interface GetGcmChannelResponse {
234
234
  */
235
235
  export interface GetImportJobRequest {
236
236
  /**
237
- * @public
238
237
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
238
+ * @public
239
239
  */
240
240
  ApplicationId: string | undefined;
241
241
  /**
242
- * @public
243
242
  * <p>The unique identifier for the job.</p>
243
+ * @public
244
244
  */
245
245
  JobId: string | undefined;
246
246
  }
@@ -249,8 +249,8 @@ export interface GetImportJobRequest {
249
249
  */
250
250
  export interface GetImportJobResponse {
251
251
  /**
252
- * @public
253
252
  * <p>Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.</p>
253
+ * @public
254
254
  */
255
255
  ImportJobResponse: ImportJobResponse | undefined;
256
256
  }
@@ -259,34 +259,34 @@ export interface GetImportJobResponse {
259
259
  */
260
260
  export interface GetImportJobsRequest {
261
261
  /**
262
- * @public
263
262
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
263
+ * @public
264
264
  */
265
265
  ApplicationId: string | undefined;
266
266
  /**
267
- * @public
268
267
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
268
+ * @public
269
269
  */
270
270
  PageSize?: string;
271
271
  /**
272
- * @public
273
272
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
273
+ * @public
274
274
  */
275
275
  Token?: string;
276
276
  }
277
277
  /**
278
- * @public
279
278
  * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
279
+ * @public
280
280
  */
281
281
  export interface ImportJobsResponse {
282
282
  /**
283
- * @public
284
283
  * <p>An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).</p>
284
+ * @public
285
285
  */
286
286
  Item: ImportJobResponse[] | undefined;
287
287
  /**
288
- * @public
289
288
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
289
+ * @public
290
290
  */
291
291
  NextToken?: string;
292
292
  }
@@ -295,8 +295,8 @@ export interface ImportJobsResponse {
295
295
  */
296
296
  export interface GetImportJobsResponse {
297
297
  /**
298
- * @public
299
298
  * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
299
+ * @public
300
300
  */
301
301
  ImportJobsResponse: ImportJobsResponse | undefined;
302
302
  }
@@ -305,112 +305,112 @@ export interface GetImportJobsResponse {
305
305
  */
306
306
  export interface GetInAppMessagesRequest {
307
307
  /**
308
- * @public
309
308
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
309
+ * @public
310
310
  */
311
311
  ApplicationId: string | undefined;
312
312
  /**
313
- * @public
314
313
  * <p>The unique identifier for the endpoint.</p>
314
+ * @public
315
315
  */
316
316
  EndpointId: string | undefined;
317
317
  }
318
318
  /**
319
- * @public
320
319
  * <p>Provides all fields required for building an in-app message.</p>
320
+ * @public
321
321
  */
322
322
  export interface InAppMessage {
323
323
  /**
324
- * @public
325
324
  * <p>In-app message content.</p>
325
+ * @public
326
326
  */
327
327
  Content?: InAppMessageContent[];
328
328
  /**
329
- * @public
330
329
  * <p>Custom config to be sent to SDK.</p>
330
+ * @public
331
331
  */
332
332
  CustomConfig?: Record<string, string>;
333
333
  /**
334
- * @public
335
334
  * <p>The layout of the message.</p>
335
+ * @public
336
336
  */
337
337
  Layout?: Layout;
338
338
  }
339
339
  /**
340
- * @public
341
340
  * <p>Schedule of the campaign.</p>
341
+ * @public
342
342
  */
343
343
  export interface InAppCampaignSchedule {
344
344
  /**
345
- * @public
346
345
  * <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
346
+ * @public
347
347
  */
348
348
  EndDate?: string;
349
349
  /**
350
- * @public
351
350
  * <p>The event filter the SDK has to use to show the in-app message in the application.</p>
351
+ * @public
352
352
  */
353
353
  EventFilter?: CampaignEventFilter;
354
354
  /**
355
- * @public
356
355
  * <p>Time during which the in-app message should not be shown to the user.</p>
356
+ * @public
357
357
  */
358
358
  QuietTime?: QuietTime;
359
359
  }
360
360
  /**
361
- * @public
362
361
  * <p>Targeted in-app message campaign.</p>
362
+ * @public
363
363
  */
364
364
  export interface InAppMessageCampaign {
365
365
  /**
366
- * @public
367
366
  * <p>Campaign id of the corresponding campaign.</p>
367
+ * @public
368
368
  */
369
369
  CampaignId?: string;
370
370
  /**
371
- * @public
372
371
  * <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
372
+ * @public
373
373
  */
374
374
  DailyCap?: number;
375
375
  /**
376
- * @public
377
376
  * <p>In-app message content with all fields required for rendering an in-app message.</p>
377
+ * @public
378
378
  */
379
379
  InAppMessage?: InAppMessage;
380
380
  /**
381
- * @public
382
381
  * <p>Priority of the in-app message.</p>
382
+ * @public
383
383
  */
384
384
  Priority?: number;
385
385
  /**
386
- * @public
387
386
  * <p>Schedule of the campaign.</p>
387
+ * @public
388
388
  */
389
389
  Schedule?: InAppCampaignSchedule;
390
390
  /**
391
- * @public
392
391
  * <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
392
+ * @public
393
393
  */
394
394
  SessionCap?: number;
395
395
  /**
396
- * @public
397
396
  * <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
397
+ * @public
398
398
  */
399
399
  TotalCap?: number;
400
400
  /**
401
- * @public
402
401
  * <p>Treatment id of the campaign.</p>
402
+ * @public
403
403
  */
404
404
  TreatmentId?: string;
405
405
  }
406
406
  /**
407
- * @public
408
407
  * <p>Get in-app messages response object.</p>
408
+ * @public
409
409
  */
410
410
  export interface InAppMessagesResponse {
411
411
  /**
412
- * @public
413
412
  * <p>List of targeted in-app message campaigns.</p>
413
+ * @public
414
414
  */
415
415
  InAppMessageCampaigns?: InAppMessageCampaign[];
416
416
  }
@@ -419,8 +419,8 @@ export interface InAppMessagesResponse {
419
419
  */
420
420
  export interface GetInAppMessagesResponse {
421
421
  /**
422
- * @public
423
422
  * <p>Get in-app messages response object.</p>
423
+ * @public
424
424
  */
425
425
  InAppMessagesResponse: InAppMessagesResponse | undefined;
426
426
  }
@@ -429,74 +429,74 @@ export interface GetInAppMessagesResponse {
429
429
  */
430
430
  export interface GetInAppTemplateRequest {
431
431
  /**
432
- * @public
433
432
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
433
+ * @public
434
434
  */
435
435
  TemplateName: string | undefined;
436
436
  /**
437
- * @public
438
437
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
438
+ * @public
439
439
  */
440
440
  Version?: string;
441
441
  }
442
442
  /**
443
- * @public
444
443
  * <p>In-App Template Response.</p>
444
+ * @public
445
445
  */
446
446
  export interface InAppTemplateResponse {
447
447
  /**
448
- * @public
449
448
  * <p>The resource arn of the template.</p>
449
+ * @public
450
450
  */
451
451
  Arn?: string;
452
452
  /**
453
- * @public
454
453
  * <p>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</p>
454
+ * @public
455
455
  */
456
456
  Content?: InAppMessageContent[];
457
457
  /**
458
- * @public
459
458
  * <p>The creation date of the template.</p>
459
+ * @public
460
460
  */
461
461
  CreationDate: string | undefined;
462
462
  /**
463
- * @public
464
463
  * <p>Custom config to be sent to client.</p>
464
+ * @public
465
465
  */
466
466
  CustomConfig?: Record<string, string>;
467
467
  /**
468
- * @public
469
468
  * <p>The last modified date of the template.</p>
469
+ * @public
470
470
  */
471
471
  LastModifiedDate: string | undefined;
472
472
  /**
473
- * @public
474
473
  * <p>The layout of the message.</p>
474
+ * @public
475
475
  */
476
476
  Layout?: Layout;
477
477
  /**
478
- * @public
479
478
  * <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
479
+ * @public
480
480
  */
481
481
  tags?: Record<string, string>;
482
482
  /**
483
- * @public
484
483
  * <p>The description of the template.</p>
484
+ * @public
485
485
  */
486
486
  TemplateDescription?: string;
487
487
  /**
488
- * @public
489
488
  * <p>The name of the template.</p>
489
+ * @public
490
490
  */
491
491
  TemplateName: string | undefined;
492
492
  /**
493
- * @public
494
493
  * <p>The type of the template.</p>
494
+ * @public
495
495
  */
496
496
  TemplateType: TemplateType | undefined;
497
497
  /**
498
- * @public
499
498
  * <p>The version id of the template.</p>
499
+ * @public
500
500
  */
501
501
  Version?: string;
502
502
  }
@@ -505,8 +505,8 @@ export interface InAppTemplateResponse {
505
505
  */
506
506
  export interface GetInAppTemplateResponse {
507
507
  /**
508
- * @public
509
508
  * <p>In-App Template Response.</p>
509
+ * @public
510
510
  */
511
511
  InAppTemplateResponse: InAppTemplateResponse | undefined;
512
512
  }
@@ -515,13 +515,13 @@ export interface GetInAppTemplateResponse {
515
515
  */
516
516
  export interface GetJourneyRequest {
517
517
  /**
518
- * @public
519
518
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
519
+ * @public
520
520
  */
521
521
  ApplicationId: string | undefined;
522
522
  /**
523
- * @public
524
523
  * <p>The unique identifier for the journey.</p>
524
+ * @public
525
525
  */
526
526
  JourneyId: string | undefined;
527
527
  }
@@ -530,8 +530,8 @@ export interface GetJourneyRequest {
530
530
  */
531
531
  export interface GetJourneyResponse {
532
532
  /**
533
- * @public
534
533
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
534
+ * @public
535
535
  */
536
536
  JourneyResponse: JourneyResponse | undefined;
537
537
  }
@@ -540,79 +540,79 @@ export interface GetJourneyResponse {
540
540
  */
541
541
  export interface GetJourneyDateRangeKpiRequest {
542
542
  /**
543
- * @public
544
543
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
544
+ * @public
545
545
  */
546
546
  ApplicationId: string | undefined;
547
547
  /**
548
- * @public
549
548
  * <p>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</p>
549
+ * @public
550
550
  */
551
551
  EndTime?: Date;
552
552
  /**
553
- * @public
554
553
  * <p>The unique identifier for the journey.</p>
554
+ * @public
555
555
  */
556
556
  JourneyId: string | undefined;
557
557
  /**
558
- * @public
559
558
  * <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
559
+ * @public
560
560
  */
561
561
  KpiName: string | undefined;
562
562
  /**
563
- * @public
564
563
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
564
+ * @public
565
565
  */
566
566
  NextToken?: string;
567
567
  /**
568
- * @public
569
568
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
569
+ * @public
570
570
  */
571
571
  PageSize?: string;
572
572
  /**
573
- * @public
574
573
  * <p>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</p>
574
+ * @public
575
575
  */
576
576
  StartTime?: Date;
577
577
  }
578
578
  /**
579
- * @public
580
579
  * <p>Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.</p>
580
+ * @public
581
581
  */
582
582
  export interface JourneyDateRangeKpiResponse {
583
583
  /**
584
- * @public
585
584
  * <p>The unique identifier for the application that the metric applies to.</p>
585
+ * @public
586
586
  */
587
587
  ApplicationId: string | undefined;
588
588
  /**
589
- * @public
590
589
  * <p>The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>
590
+ * @public
591
591
  */
592
592
  EndTime: Date | undefined;
593
593
  /**
594
- * @public
595
594
  * <p>The unique identifier for the journey that the metric applies to.</p>
595
+ * @public
596
596
  */
597
597
  JourneyId: string | undefined;
598
598
  /**
599
- * @public
600
599
  * <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
600
+ * @public
601
601
  */
602
602
  KpiName: string | undefined;
603
603
  /**
604
- * @public
605
604
  * <p>An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.</p>
605
+ * @public
606
606
  */
607
607
  KpiResult: BaseKpiResult | undefined;
608
608
  /**
609
- * @public
610
609
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.</p>
610
+ * @public
611
611
  */
612
612
  NextToken?: string;
613
613
  /**
614
- * @public
615
614
  * <p>The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>
615
+ * @public
616
616
  */
617
617
  StartTime: Date | undefined;
618
618
  }
@@ -621,8 +621,8 @@ export interface JourneyDateRangeKpiResponse {
621
621
  */
622
622
  export interface GetJourneyDateRangeKpiResponse {
623
623
  /**
624
- * @public
625
624
  * <p>Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.</p>
625
+ * @public
626
626
  */
627
627
  JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponse | undefined;
628
628
  }
@@ -631,64 +631,64 @@ export interface GetJourneyDateRangeKpiResponse {
631
631
  */
632
632
  export interface GetJourneyExecutionActivityMetricsRequest {
633
633
  /**
634
- * @public
635
634
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
635
+ * @public
636
636
  */
637
637
  ApplicationId: string | undefined;
638
638
  /**
639
- * @public
640
639
  * <p>The unique identifier for the journey activity.</p>
640
+ * @public
641
641
  */
642
642
  JourneyActivityId: string | undefined;
643
643
  /**
644
- * @public
645
644
  * <p>The unique identifier for the journey.</p>
645
+ * @public
646
646
  */
647
647
  JourneyId: string | undefined;
648
648
  /**
649
- * @public
650
649
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
650
+ * @public
651
651
  */
652
652
  NextToken?: string;
653
653
  /**
654
- * @public
655
654
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
655
+ * @public
656
656
  */
657
657
  PageSize?: string;
658
658
  }
659
659
  /**
660
- * @public
661
660
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.</p>
661
+ * @public
662
662
  */
663
663
  export interface JourneyExecutionActivityMetricsResponse {
664
664
  /**
665
- * @public
666
665
  * <p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE – For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>
666
+ * @public
667
667
  */
668
668
  ActivityType: string | undefined;
669
669
  /**
670
- * @public
671
670
  * <p>The unique identifier for the application that the metric applies to.</p>
671
+ * @public
672
672
  */
673
673
  ApplicationId: string | undefined;
674
674
  /**
675
- * @public
676
675
  * <p>The unique identifier for the activity that the metric applies to.</p>
676
+ * @public
677
677
  */
678
678
  JourneyActivityId: string | undefined;
679
679
  /**
680
- * @public
681
680
  * <p>The unique identifier for the journey that the metric applies to.</p>
681
+ * @public
682
682
  */
683
683
  JourneyId: string | undefined;
684
684
  /**
685
- * @public
686
685
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.</p>
686
+ * @public
687
687
  */
688
688
  LastEvaluatedTime: string | undefined;
689
689
  /**
690
- * @public
691
690
  * <p>A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
691
+ * @public
692
692
  */
693
693
  Metrics: Record<string, string> | undefined;
694
694
  }
@@ -697,8 +697,8 @@ export interface JourneyExecutionActivityMetricsResponse {
697
697
  */
698
698
  export interface GetJourneyExecutionActivityMetricsResponse {
699
699
  /**
700
- * @public
701
700
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.</p>
701
+ * @public
702
702
  */
703
703
  JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponse | undefined;
704
704
  }
@@ -707,49 +707,49 @@ export interface GetJourneyExecutionActivityMetricsResponse {
707
707
  */
708
708
  export interface GetJourneyExecutionMetricsRequest {
709
709
  /**
710
- * @public
711
710
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
711
+ * @public
712
712
  */
713
713
  ApplicationId: string | undefined;
714
714
  /**
715
- * @public
716
715
  * <p>The unique identifier for the journey.</p>
716
+ * @public
717
717
  */
718
718
  JourneyId: string | undefined;
719
719
  /**
720
- * @public
721
720
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
721
+ * @public
722
722
  */
723
723
  NextToken?: string;
724
724
  /**
725
- * @public
726
725
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
726
+ * @public
727
727
  */
728
728
  PageSize?: string;
729
729
  }
730
730
  /**
731
- * @public
732
731
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.</p>
732
+ * @public
733
733
  */
734
734
  export interface JourneyExecutionMetricsResponse {
735
735
  /**
736
- * @public
737
736
  * <p>The unique identifier for the application that the metric applies to.</p>
737
+ * @public
738
738
  */
739
739
  ApplicationId: string | undefined;
740
740
  /**
741
- * @public
742
741
  * <p>The unique identifier for the journey that the metric applies to.</p>
742
+ * @public
743
743
  */
744
744
  JourneyId: string | undefined;
745
745
  /**
746
- * @public
747
746
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.</p>
747
+ * @public
748
748
  */
749
749
  LastEvaluatedTime: string | undefined;
750
750
  /**
751
- * @public
752
751
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
752
+ * @public
753
753
  */
754
754
  Metrics: Record<string, string> | undefined;
755
755
  }
@@ -758,8 +758,8 @@ export interface JourneyExecutionMetricsResponse {
758
758
  */
759
759
  export interface GetJourneyExecutionMetricsResponse {
760
760
  /**
761
- * @public
762
761
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.</p>
762
+ * @public
763
763
  */
764
764
  JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse | undefined;
765
765
  }
@@ -768,74 +768,74 @@ export interface GetJourneyExecutionMetricsResponse {
768
768
  */
769
769
  export interface GetJourneyRunExecutionActivityMetricsRequest {
770
770
  /**
771
- * @public
772
771
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
772
+ * @public
773
773
  */
774
774
  ApplicationId: string | undefined;
775
775
  /**
776
- * @public
777
776
  * <p>The unique identifier for the journey activity.</p>
777
+ * @public
778
778
  */
779
779
  JourneyActivityId: string | undefined;
780
780
  /**
781
- * @public
782
781
  * <p>The unique identifier for the journey.</p>
782
+ * @public
783
783
  */
784
784
  JourneyId: string | undefined;
785
785
  /**
786
- * @public
787
786
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
787
+ * @public
788
788
  */
789
789
  NextToken?: string;
790
790
  /**
791
- * @public
792
791
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
792
+ * @public
793
793
  */
794
794
  PageSize?: string;
795
795
  /**
796
- * @public
797
796
  * <p>The unique identifier for the journey run.</p>
797
+ * @public
798
798
  */
799
799
  RunId: string | undefined;
800
800
  }
801
801
  /**
802
- * @public
803
802
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
803
+ * @public
804
804
  */
805
805
  export interface JourneyRunExecutionActivityMetricsResponse {
806
806
  /**
807
- * @public
808
807
  * <p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE – For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>
808
+ * @public
809
809
  */
810
810
  ActivityType: string | undefined;
811
811
  /**
812
- * @public
813
812
  * <p>The unique identifier for the application that the metric applies to.</p>
813
+ * @public
814
814
  */
815
815
  ApplicationId: string | undefined;
816
816
  /**
817
- * @public
818
817
  * <p>The unique identifier for the activity that the metric applies to.</p>
818
+ * @public
819
819
  */
820
820
  JourneyActivityId: string | undefined;
821
821
  /**
822
- * @public
823
822
  * <p>The unique identifier for the journey that the metric applies to.</p>
823
+ * @public
824
824
  */
825
825
  JourneyId: string | undefined;
826
826
  /**
827
- * @public
828
827
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.</p>
828
+ * @public
829
829
  */
830
830
  LastEvaluatedTime: string | undefined;
831
831
  /**
832
- * @public
833
832
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see see <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
833
+ * @public
834
834
  */
835
835
  Metrics: Record<string, string> | undefined;
836
836
  /**
837
- * @public
838
837
  * <p>The unique identifier for the journey run that the metric applies to.</p>
838
+ * @public
839
839
  */
840
840
  RunId: string | undefined;
841
841
  }
@@ -844,8 +844,8 @@ export interface JourneyRunExecutionActivityMetricsResponse {
844
844
  */
845
845
  export interface GetJourneyRunExecutionActivityMetricsResponse {
846
846
  /**
847
- * @public
848
847
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
848
+ * @public
849
849
  */
850
850
  JourneyRunExecutionActivityMetricsResponse: JourneyRunExecutionActivityMetricsResponse | undefined;
851
851
  }
@@ -854,59 +854,59 @@ export interface GetJourneyRunExecutionActivityMetricsResponse {
854
854
  */
855
855
  export interface GetJourneyRunExecutionMetricsRequest {
856
856
  /**
857
- * @public
858
857
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
858
+ * @public
859
859
  */
860
860
  ApplicationId: string | undefined;
861
861
  /**
862
- * @public
863
862
  * <p>The unique identifier for the journey.</p>
863
+ * @public
864
864
  */
865
865
  JourneyId: string | undefined;
866
866
  /**
867
- * @public
868
867
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
868
+ * @public
869
869
  */
870
870
  NextToken?: string;
871
871
  /**
872
- * @public
873
872
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
873
+ * @public
874
874
  */
875
875
  PageSize?: string;
876
876
  /**
877
- * @public
878
877
  * <p>The unique identifier for the journey run.</p>
878
+ * @public
879
879
  */
880
880
  RunId: string | undefined;
881
881
  }
882
882
  /**
883
- * @public
884
883
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
884
+ * @public
885
885
  */
886
886
  export interface JourneyRunExecutionMetricsResponse {
887
887
  /**
888
- * @public
889
888
  * <p>The unique identifier for the application that the metric applies to.</p>
889
+ * @public
890
890
  */
891
891
  ApplicationId: string | undefined;
892
892
  /**
893
- * @public
894
893
  * <p>The unique identifier for the journey that the metric applies to.</p>
894
+ * @public
895
895
  */
896
896
  JourneyId: string | undefined;
897
897
  /**
898
- * @public
899
898
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.</p>
899
+ * @public
900
900
  */
901
901
  LastEvaluatedTime: string | undefined;
902
902
  /**
903
- * @public
904
903
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
904
+ * @public
905
905
  */
906
906
  Metrics: Record<string, string> | undefined;
907
907
  /**
908
- * @public
909
908
  * <p>The unique identifier for the journey run that the metric applies to.</p>
909
+ * @public
910
910
  */
911
911
  RunId: string | undefined;
912
912
  }
@@ -915,8 +915,8 @@ export interface JourneyRunExecutionMetricsResponse {
915
915
  */
916
916
  export interface GetJourneyRunExecutionMetricsResponse {
917
917
  /**
918
- * @public
919
918
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
919
+ * @public
920
920
  */
921
921
  JourneyRunExecutionMetricsResponse: JourneyRunExecutionMetricsResponse | undefined;
922
922
  }
@@ -925,23 +925,23 @@ export interface GetJourneyRunExecutionMetricsResponse {
925
925
  */
926
926
  export interface GetJourneyRunsRequest {
927
927
  /**
928
- * @public
929
928
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
929
+ * @public
930
930
  */
931
931
  ApplicationId: string | undefined;
932
932
  /**
933
- * @public
934
933
  * <p>The unique identifier for the journey.</p>
934
+ * @public
935
935
  */
936
936
  JourneyId: string | undefined;
937
937
  /**
938
- * @public
939
938
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
939
+ * @public
940
940
  */
941
941
  PageSize?: string;
942
942
  /**
943
- * @public
944
943
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
944
+ * @public
945
945
  */
946
946
  Token?: string;
947
947
  }
@@ -960,44 +960,44 @@ export declare const JourneyRunStatus: {
960
960
  */
961
961
  export type JourneyRunStatus = (typeof JourneyRunStatus)[keyof typeof JourneyRunStatus];
962
962
  /**
963
- * @public
964
963
  * <p>Provides information from a specified run of a journey.</p>
964
+ * @public
965
965
  */
966
966
  export interface JourneyRunResponse {
967
967
  /**
968
- * @public
969
968
  * <p>The time when the journey run was created or scheduled, in ISO 8601 format.</p>
969
+ * @public
970
970
  */
971
971
  CreationTime: string | undefined;
972
972
  /**
973
- * @public
974
973
  * <p>The last time the journey run was updated, in ISO 8601 format..</p>
974
+ * @public
975
975
  */
976
976
  LastUpdateTime: string | undefined;
977
977
  /**
978
- * @public
979
978
  * <p>The unique identifier for the run.</p>
979
+ * @public
980
980
  */
981
981
  RunId: string | undefined;
982
982
  /**
983
- * @public
984
983
  * <p>The current status of the journey run.</p>
984
+ * @public
985
985
  */
986
986
  Status: JourneyRunStatus | undefined;
987
987
  }
988
988
  /**
989
- * @public
990
989
  * <p>Provides information from all runs of a journey.</p>
990
+ * @public
991
991
  */
992
992
  export interface JourneyRunsResponse {
993
993
  /**
994
- * @public
995
994
  * <p>An array of responses, one for each run of the journey</p>
995
+ * @public
996
996
  */
997
997
  Item: JourneyRunResponse[] | undefined;
998
998
  /**
999
- * @public
1000
999
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1000
+ * @public
1001
1001
  */
1002
1002
  NextToken?: string;
1003
1003
  }
@@ -1006,8 +1006,8 @@ export interface JourneyRunsResponse {
1006
1006
  */
1007
1007
  export interface GetJourneyRunsResponse {
1008
1008
  /**
1009
- * @public
1010
1009
  * <p>Provides information from all runs of a journey.</p>
1010
+ * @public
1011
1011
  */
1012
1012
  JourneyRunsResponse: JourneyRunsResponse | undefined;
1013
1013
  }
@@ -1016,94 +1016,94 @@ export interface GetJourneyRunsResponse {
1016
1016
  */
1017
1017
  export interface GetPushTemplateRequest {
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
1020
+ * @public
1021
1021
  */
1022
1022
  TemplateName: string | undefined;
1023
1023
  /**
1024
- * @public
1025
1024
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1025
+ * @public
1026
1026
  */
1027
1027
  Version?: string;
1028
1028
  }
1029
1029
  /**
1030
- * @public
1031
1030
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
1031
+ * @public
1032
1032
  */
1033
1033
  export interface PushNotificationTemplateResponse {
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1036
+ * @public
1037
1037
  */
1038
1038
  ADM?: AndroidPushNotificationTemplate;
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1041
+ * @public
1042
1042
  */
1043
1043
  APNS?: APNSPushNotificationTemplate;
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  Arn?: string;
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1051
+ * @public
1052
1052
  */
1053
1053
  Baidu?: AndroidPushNotificationTemplate;
1054
1054
  /**
1055
- * @public
1056
1055
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  CreationDate: string | undefined;
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>The default message template that's used for push notification channels.</p>
1061
+ * @public
1062
1062
  */
1063
1063
  Default?: DefaultPushNotificationTemplate;
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  DefaultSubstitutions?: string;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1071
+ * @public
1072
1072
  */
1073
1073
  GCM?: AndroidPushNotificationTemplate;
1074
1074
  /**
1075
- * @public
1076
1075
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  LastModifiedDate: string | undefined;
1079
1079
  /**
1080
- * @public
1081
1080
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
1081
+ * @public
1082
1082
  */
1083
1083
  RecommenderId?: string;
1084
1084
  /**
1085
- * @public
1086
1085
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1086
+ * @public
1087
1087
  */
1088
1088
  tags?: Record<string, string>;
1089
1089
  /**
1090
- * @public
1091
1090
  * <p>The custom description of the message template.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  TemplateDescription?: string;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>The name of the message template.</p>
1096
+ * @public
1097
1097
  */
1098
1098
  TemplateName: string | undefined;
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>
1101
+ * @public
1102
1102
  */
1103
1103
  TemplateType: TemplateType | undefined;
1104
1104
  /**
1105
- * @public
1106
1105
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1106
+ * @public
1107
1107
  */
1108
1108
  Version?: string;
1109
1109
  }
@@ -1112,8 +1112,8 @@ export interface PushNotificationTemplateResponse {
1112
1112
  */
1113
1113
  export interface GetPushTemplateResponse {
1114
1114
  /**
1115
- * @public
1116
1115
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
1116
+ * @public
1117
1117
  */
1118
1118
  PushNotificationTemplateResponse: PushNotificationTemplateResponse | undefined;
1119
1119
  }
@@ -1122,8 +1122,8 @@ export interface GetPushTemplateResponse {
1122
1122
  */
1123
1123
  export interface GetRecommenderConfigurationRequest {
1124
1124
  /**
1125
- * @public
1126
1125
  * <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
1126
+ * @public
1127
1127
  */
1128
1128
  RecommenderId: string | undefined;
1129
1129
  }
@@ -1132,8 +1132,8 @@ export interface GetRecommenderConfigurationRequest {
1132
1132
  */
1133
1133
  export interface GetRecommenderConfigurationResponse {
1134
1134
  /**
1135
- * @public
1136
1135
  * <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
1136
+ * @public
1137
1137
  */
1138
1138
  RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
1139
1139
  }
@@ -1142,29 +1142,29 @@ export interface GetRecommenderConfigurationResponse {
1142
1142
  */
1143
1143
  export interface GetRecommenderConfigurationsRequest {
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  PageSize?: string;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  Token?: string;
1154
1154
  }
1155
1155
  /**
1156
- * @public
1157
1156
  * <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
1157
+ * @public
1158
1158
  */
1159
1159
  export interface ListRecommenderConfigurationsResponse {
1160
1160
  /**
1161
- * @public
1162
1161
  * <p>An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.</p>
1162
+ * @public
1163
1163
  */
1164
1164
  Item: RecommenderConfigurationResponse[] | undefined;
1165
1165
  /**
1166
- * @public
1167
1166
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1167
+ * @public
1168
1168
  */
1169
1169
  NextToken?: string;
1170
1170
  }
@@ -1173,8 +1173,8 @@ export interface ListRecommenderConfigurationsResponse {
1173
1173
  */
1174
1174
  export interface GetRecommenderConfigurationsResponse {
1175
1175
  /**
1176
- * @public
1177
1176
  * <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
1177
+ * @public
1178
1178
  */
1179
1179
  ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponse | undefined;
1180
1180
  }
@@ -1183,13 +1183,13 @@ export interface GetRecommenderConfigurationsResponse {
1183
1183
  */
1184
1184
  export interface GetSegmentRequest {
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1187
+ * @public
1188
1188
  */
1189
1189
  ApplicationId: string | undefined;
1190
1190
  /**
1191
- * @public
1192
1191
  * <p>The unique identifier for the segment.</p>
1192
+ * @public
1193
1193
  */
1194
1194
  SegmentId: string | undefined;
1195
1195
  }
@@ -1198,8 +1198,8 @@ export interface GetSegmentRequest {
1198
1198
  */
1199
1199
  export interface GetSegmentResponse {
1200
1200
  /**
1201
- * @public
1202
1201
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
1202
+ * @public
1203
1203
  */
1204
1204
  SegmentResponse: SegmentResponse | undefined;
1205
1205
  }
@@ -1208,23 +1208,23 @@ export interface GetSegmentResponse {
1208
1208
  */
1209
1209
  export interface GetSegmentExportJobsRequest {
1210
1210
  /**
1211
- * @public
1212
1211
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  ApplicationId: string | undefined;
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1217
+ * @public
1218
1218
  */
1219
1219
  PageSize?: string;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The unique identifier for the segment.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  SegmentId: string | undefined;
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  Token?: string;
1230
1230
  }
@@ -1233,8 +1233,8 @@ export interface GetSegmentExportJobsRequest {
1233
1233
  */
1234
1234
  export interface GetSegmentExportJobsResponse {
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  ExportJobsResponse: ExportJobsResponse | undefined;
1240
1240
  }
@@ -1243,23 +1243,23 @@ export interface GetSegmentExportJobsResponse {
1243
1243
  */
1244
1244
  export interface GetSegmentImportJobsRequest {
1245
1245
  /**
1246
- * @public
1247
1246
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1247
+ * @public
1248
1248
  */
1249
1249
  ApplicationId: string | undefined;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1252
+ * @public
1253
1253
  */
1254
1254
  PageSize?: string;
1255
1255
  /**
1256
- * @public
1257
1256
  * <p>The unique identifier for the segment.</p>
1257
+ * @public
1258
1258
  */
1259
1259
  SegmentId: string | undefined;
1260
1260
  /**
1261
- * @public
1262
1261
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1262
+ * @public
1263
1263
  */
1264
1264
  Token?: string;
1265
1265
  }
@@ -1268,8 +1268,8 @@ export interface GetSegmentImportJobsRequest {
1268
1268
  */
1269
1269
  export interface GetSegmentImportJobsResponse {
1270
1270
  /**
1271
- * @public
1272
1271
  * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
1272
+ * @public
1273
1273
  */
1274
1274
  ImportJobsResponse: ImportJobsResponse | undefined;
1275
1275
  }
@@ -1278,34 +1278,34 @@ export interface GetSegmentImportJobsResponse {
1278
1278
  */
1279
1279
  export interface GetSegmentsRequest {
1280
1280
  /**
1281
- * @public
1282
1281
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1282
+ * @public
1283
1283
  */
1284
1284
  ApplicationId: string | undefined;
1285
1285
  /**
1286
- * @public
1287
1286
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1287
+ * @public
1288
1288
  */
1289
1289
  PageSize?: string;
1290
1290
  /**
1291
- * @public
1292
1291
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1292
+ * @public
1293
1293
  */
1294
1294
  Token?: string;
1295
1295
  }
1296
1296
  /**
1297
- * @public
1298
1297
  * <p>Provides information about all the segments that are associated with an application.</p>
1298
+ * @public
1299
1299
  */
1300
1300
  export interface SegmentsResponse {
1301
1301
  /**
1302
- * @public
1303
1302
  * <p>An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).</p>
1303
+ * @public
1304
1304
  */
1305
1305
  Item: SegmentResponse[] | undefined;
1306
1306
  /**
1307
- * @public
1308
1307
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1308
+ * @public
1309
1309
  */
1310
1310
  NextToken?: string;
1311
1311
  }
@@ -1314,8 +1314,8 @@ export interface SegmentsResponse {
1314
1314
  */
1315
1315
  export interface GetSegmentsResponse {
1316
1316
  /**
1317
- * @public
1318
1317
  * <p>Provides information about all the segments that are associated with an application.</p>
1318
+ * @public
1319
1319
  */
1320
1320
  SegmentsResponse: SegmentsResponse | undefined;
1321
1321
  }
@@ -1324,18 +1324,18 @@ export interface GetSegmentsResponse {
1324
1324
  */
1325
1325
  export interface GetSegmentVersionRequest {
1326
1326
  /**
1327
- * @public
1328
1327
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1328
+ * @public
1329
1329
  */
1330
1330
  ApplicationId: string | undefined;
1331
1331
  /**
1332
- * @public
1333
1332
  * <p>The unique identifier for the segment.</p>
1333
+ * @public
1334
1334
  */
1335
1335
  SegmentId: string | undefined;
1336
1336
  /**
1337
- * @public
1338
1337
  * <p>The unique version number (Version property) for the campaign version.</p>
1338
+ * @public
1339
1339
  */
1340
1340
  Version: string | undefined;
1341
1341
  }
@@ -1344,8 +1344,8 @@ export interface GetSegmentVersionRequest {
1344
1344
  */
1345
1345
  export interface GetSegmentVersionResponse {
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  SegmentResponse: SegmentResponse | undefined;
1351
1351
  }
@@ -1354,23 +1354,23 @@ export interface GetSegmentVersionResponse {
1354
1354
  */
1355
1355
  export interface GetSegmentVersionsRequest {
1356
1356
  /**
1357
- * @public
1358
1357
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1358
+ * @public
1359
1359
  */
1360
1360
  ApplicationId: string | undefined;
1361
1361
  /**
1362
- * @public
1363
1362
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1363
+ * @public
1364
1364
  */
1365
1365
  PageSize?: string;
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>The unique identifier for the segment.</p>
1368
+ * @public
1369
1369
  */
1370
1370
  SegmentId: string | undefined;
1371
1371
  /**
1372
- * @public
1373
1372
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1373
+ * @public
1374
1374
  */
1375
1375
  Token?: string;
1376
1376
  }
@@ -1379,8 +1379,8 @@ export interface GetSegmentVersionsRequest {
1379
1379
  */
1380
1380
  export interface GetSegmentVersionsResponse {
1381
1381
  /**
1382
- * @public
1383
1382
  * <p>Provides information about all the segments that are associated with an application.</p>
1383
+ * @public
1384
1384
  */
1385
1385
  SegmentsResponse: SegmentsResponse | undefined;
1386
1386
  }
@@ -1389,8 +1389,8 @@ export interface GetSegmentVersionsResponse {
1389
1389
  */
1390
1390
  export interface GetSmsChannelRequest {
1391
1391
  /**
1392
- * @public
1393
1392
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1393
+ * @public
1394
1394
  */
1395
1395
  ApplicationId: string | undefined;
1396
1396
  }
@@ -1399,8 +1399,8 @@ export interface GetSmsChannelRequest {
1399
1399
  */
1400
1400
  export interface GetSmsChannelResponse {
1401
1401
  /**
1402
- * @public
1403
1402
  * <p>Provides information about the status and settings of the SMS channel for an application.</p>
1403
+ * @public
1404
1404
  */
1405
1405
  SMSChannelResponse: SMSChannelResponse | undefined;
1406
1406
  }
@@ -1409,74 +1409,74 @@ export interface GetSmsChannelResponse {
1409
1409
  */
1410
1410
  export interface GetSmsTemplateRequest {
1411
1411
  /**
1412
- * @public
1413
1412
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
1413
+ * @public
1414
1414
  */
1415
1415
  TemplateName: string | undefined;
1416
1416
  /**
1417
- * @public
1418
1417
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1418
+ * @public
1419
1419
  */
1420
1420
  Version?: string;
1421
1421
  }
1422
1422
  /**
1423
- * @public
1424
1423
  * <p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
1424
+ * @public
1425
1425
  */
1426
1426
  export interface SMSTemplateResponse {
1427
1427
  /**
1428
- * @public
1429
1428
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1429
+ * @public
1430
1430
  */
1431
1431
  Arn?: string;
1432
1432
  /**
1433
- * @public
1434
1433
  * <p>The message body that's used in text messages that are based on the message template.</p>
1434
+ * @public
1435
1435
  */
1436
1436
  Body?: string;
1437
1437
  /**
1438
- * @public
1439
1438
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1439
+ * @public
1440
1440
  */
1441
1441
  CreationDate: string | undefined;
1442
1442
  /**
1443
- * @public
1444
1443
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1444
+ * @public
1445
1445
  */
1446
1446
  DefaultSubstitutions?: string;
1447
1447
  /**
1448
- * @public
1449
1448
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1449
+ * @public
1450
1450
  */
1451
1451
  LastModifiedDate: string | undefined;
1452
1452
  /**
1453
- * @public
1454
1453
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
1454
+ * @public
1455
1455
  */
1456
1456
  RecommenderId?: string;
1457
1457
  /**
1458
- * @public
1459
1458
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1459
+ * @public
1460
1460
  */
1461
1461
  tags?: Record<string, string>;
1462
1462
  /**
1463
- * @public
1464
1463
  * <p>The custom description of the message template.</p>
1464
+ * @public
1465
1465
  */
1466
1466
  TemplateDescription?: string;
1467
1467
  /**
1468
- * @public
1469
1468
  * <p>The name of the message template.</p>
1469
+ * @public
1470
1470
  */
1471
1471
  TemplateName: string | undefined;
1472
1472
  /**
1473
- * @public
1474
1473
  * <p>The type of channel that the message template is designed for. For an SMS template, this value is SMS.</p>
1474
+ * @public
1475
1475
  */
1476
1476
  TemplateType: TemplateType | undefined;
1477
1477
  /**
1478
- * @public
1479
1478
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1479
+ * @public
1480
1480
  */
1481
1481
  Version?: string;
1482
1482
  }
@@ -1485,8 +1485,8 @@ export interface SMSTemplateResponse {
1485
1485
  */
1486
1486
  export interface GetSmsTemplateResponse {
1487
1487
  /**
1488
- * @public
1489
1488
  * <p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
1489
+ * @public
1490
1490
  */
1491
1491
  SMSTemplateResponse: SMSTemplateResponse | undefined;
1492
1492
  }
@@ -1495,13 +1495,13 @@ export interface GetSmsTemplateResponse {
1495
1495
  */
1496
1496
  export interface GetUserEndpointsRequest {
1497
1497
  /**
1498
- * @public
1499
1498
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1499
+ * @public
1500
1500
  */
1501
1501
  ApplicationId: string | undefined;
1502
1502
  /**
1503
- * @public
1504
1503
  * <p>The unique identifier for the user.</p>
1504
+ * @public
1505
1505
  */
1506
1506
  UserId: string | undefined;
1507
1507
  }
@@ -1510,8 +1510,8 @@ export interface GetUserEndpointsRequest {
1510
1510
  */
1511
1511
  export interface GetUserEndpointsResponse {
1512
1512
  /**
1513
- * @public
1514
1513
  * <p>Provides information about all the endpoints that are associated with a user ID.</p>
1514
+ * @public
1515
1515
  */
1516
1516
  EndpointsResponse: EndpointsResponse | undefined;
1517
1517
  }
@@ -1520,8 +1520,8 @@ export interface GetUserEndpointsResponse {
1520
1520
  */
1521
1521
  export interface GetVoiceChannelRequest {
1522
1522
  /**
1523
- * @public
1524
1523
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1524
+ * @public
1525
1525
  */
1526
1526
  ApplicationId: string | undefined;
1527
1527
  }
@@ -1530,8 +1530,8 @@ export interface GetVoiceChannelRequest {
1530
1530
  */
1531
1531
  export interface GetVoiceChannelResponse {
1532
1532
  /**
1533
- * @public
1534
1533
  * <p>Provides information about the status and settings of the voice channel for an application.</p>
1534
+ * @public
1535
1535
  */
1536
1536
  VoiceChannelResponse: VoiceChannelResponse | undefined;
1537
1537
  }
@@ -1540,79 +1540,79 @@ export interface GetVoiceChannelResponse {
1540
1540
  */
1541
1541
  export interface GetVoiceTemplateRequest {
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
1544
+ * @public
1545
1545
  */
1546
1546
  TemplateName: string | undefined;
1547
1547
  /**
1548
- * @public
1549
1548
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1549
+ * @public
1550
1550
  */
1551
1551
  Version?: string;
1552
1552
  }
1553
1553
  /**
1554
- * @public
1555
1554
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
1555
+ * @public
1556
1556
  */
1557
1557
  export interface VoiceTemplateResponse {
1558
1558
  /**
1559
- * @public
1560
1559
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1560
+ * @public
1561
1561
  */
1562
1562
  Arn?: string;
1563
1563
  /**
1564
- * @public
1565
1564
  * <p>The text of the script that's used in messages that are based on the message template, in plain text format.</p>
1565
+ * @public
1566
1566
  */
1567
1567
  Body?: string;
1568
1568
  /**
1569
- * @public
1570
1569
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1570
+ * @public
1571
1571
  */
1572
1572
  CreationDate: string | undefined;
1573
1573
  /**
1574
- * @public
1575
1574
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1575
+ * @public
1576
1576
  */
1577
1577
  DefaultSubstitutions?: string;
1578
1578
  /**
1579
- * @public
1580
1579
  * <p>The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
1580
+ * @public
1581
1581
  */
1582
1582
  LanguageCode?: string;
1583
1583
  /**
1584
- * @public
1585
1584
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1585
+ * @public
1586
1586
  */
1587
1587
  LastModifiedDate: string | undefined;
1588
1588
  /**
1589
- * @public
1590
1589
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1590
+ * @public
1591
1591
  */
1592
1592
  tags?: Record<string, string>;
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>The custom description of the message template.</p>
1595
+ * @public
1596
1596
  */
1597
1597
  TemplateDescription?: string;
1598
1598
  /**
1599
- * @public
1600
1599
  * <p>The name of the message template.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  TemplateName: string | undefined;
1603
1603
  /**
1604
- * @public
1605
1604
  * <p>The type of channel that the message template is designed for. For a voice template, this value is VOICE.</p>
1605
+ * @public
1606
1606
  */
1607
1607
  TemplateType: TemplateType | undefined;
1608
1608
  /**
1609
- * @public
1610
1609
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1610
+ * @public
1611
1611
  */
1612
1612
  Version?: string;
1613
1613
  /**
1614
- * @public
1615
1614
  * <p>The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
1615
+ * @public
1616
1616
  */
1617
1617
  VoiceId?: string;
1618
1618
  }
@@ -1621,35 +1621,35 @@ export interface VoiceTemplateResponse {
1621
1621
  */
1622
1622
  export interface GetVoiceTemplateResponse {
1623
1623
  /**
1624
- * @public
1625
1624
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
1625
+ * @public
1626
1626
  */
1627
1627
  VoiceTemplateResponse: VoiceTemplateResponse | undefined;
1628
1628
  }
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
1631
+ * @public
1632
1632
  */
1633
1633
  export interface JourneysResponse {
1634
1634
  /**
1635
- * @public
1636
1635
  * <p>An array of responses, one for each journey that's associated with the application.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  Item: JourneyResponse[] | undefined;
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1641
+ * @public
1642
1642
  */
1643
1643
  NextToken?: string;
1644
1644
  }
1645
1645
  /**
1646
- * @public
1647
1646
  * <p>Changes the status of a journey.</p>
1647
+ * @public
1648
1648
  */
1649
1649
  export interface JourneyStateRequest {
1650
1650
  /**
1651
- * @public
1652
1651
  * <p>The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED</p> <p>If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.</p> <p>After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.</p> <p>When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.</p>
1652
+ * @public
1653
1653
  */
1654
1654
  State?: State;
1655
1655
  }
@@ -1658,18 +1658,18 @@ export interface JourneyStateRequest {
1658
1658
  */
1659
1659
  export interface ListJourneysRequest {
1660
1660
  /**
1661
- * @public
1662
1661
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1662
+ * @public
1663
1663
  */
1664
1664
  ApplicationId: string | undefined;
1665
1665
  /**
1666
- * @public
1667
1666
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1667
+ * @public
1668
1668
  */
1669
1669
  PageSize?: string;
1670
1670
  /**
1671
- * @public
1672
1671
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1672
+ * @public
1673
1673
  */
1674
1674
  Token?: string;
1675
1675
  }
@@ -1678,100 +1678,100 @@ export interface ListJourneysRequest {
1678
1678
  */
1679
1679
  export interface ListJourneysResponse {
1680
1680
  /**
1681
- * @public
1682
1681
  * <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
1682
+ * @public
1683
1683
  */
1684
1684
  JourneysResponse: JourneysResponse | undefined;
1685
1685
  }
1686
1686
  /**
1687
- * @public
1688
1687
  * <p>Provides information about a message template that's associated with your Amazon Pinpoint account.</p>
1688
+ * @public
1689
1689
  */
1690
1690
  export interface TemplateResponse {
1691
1691
  /**
1692
- * @public
1693
1692
  * <p>The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.</p>
1693
+ * @public
1694
1694
  */
1695
1695
  Arn?: string;
1696
1696
  /**
1697
- * @public
1698
1697
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1698
+ * @public
1699
1699
  */
1700
1700
  CreationDate: string | undefined;
1701
1701
  /**
1702
- * @public
1703
1702
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
1703
+ * @public
1704
1704
  */
1705
1705
  DefaultSubstitutions?: string;
1706
1706
  /**
1707
- * @public
1708
1707
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1708
+ * @public
1709
1709
  */
1710
1710
  LastModifiedDate: string | undefined;
1711
1711
  /**
1712
- * @public
1713
1712
  * <p>A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
1713
+ * @public
1714
1714
  */
1715
1715
  tags?: Record<string, string>;
1716
1716
  /**
1717
- * @public
1718
1717
  * <p>The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.</p>
1718
+ * @public
1719
1719
  */
1720
1720
  TemplateDescription?: string;
1721
1721
  /**
1722
- * @public
1723
1722
  * <p>The name of the message template.</p>
1723
+ * @public
1724
1724
  */
1725
1725
  TemplateName: string | undefined;
1726
1726
  /**
1727
- * @public
1728
1727
  * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
1728
+ * @public
1729
1729
  */
1730
1730
  TemplateType: TemplateType | undefined;
1731
1731
  /**
1732
- * @public
1733
1732
  * <p>The unique identifier, as an integer, for the active version of the message template.</p>
1733
+ * @public
1734
1734
  */
1735
1735
  Version?: string;
1736
1736
  }
1737
1737
  /**
1738
- * @public
1739
1738
  * <p>Provides information about a specific version of a message template.</p>
1739
+ * @public
1740
1740
  */
1741
1741
  export interface TemplateVersionResponse {
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>The date, in ISO 8601 format, when the version of the message template was created.</p>
1744
+ * @public
1745
1745
  */
1746
1746
  CreationDate: string | undefined;
1747
1747
  /**
1748
- * @public
1749
1748
  * <p>A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1749
+ * @public
1750
1750
  */
1751
1751
  DefaultSubstitutions?: string;
1752
1752
  /**
1753
- * @public
1754
1753
  * <p>The date, in ISO 8601 format, when the version of the message template was last modified.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  LastModifiedDate: string | undefined;
1757
1757
  /**
1758
- * @public
1759
1758
  * <p>The custom description of the version of the message template.</p>
1759
+ * @public
1760
1760
  */
1761
1761
  TemplateDescription?: string;
1762
1762
  /**
1763
- * @public
1764
1763
  * <p>The name of the message template.</p>
1764
+ * @public
1765
1765
  */
1766
1766
  TemplateName: string | undefined;
1767
1767
  /**
1768
- * @public
1769
1768
  * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
1769
+ * @public
1770
1770
  */
1771
1771
  TemplateType: string | undefined;
1772
1772
  /**
1773
- * @public
1774
1773
  * <p>The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.</p>
1774
+ * @public
1775
1775
  */
1776
1776
  Version?: string;
1777
1777
  }
@@ -1780,19 +1780,19 @@ export interface TemplateVersionResponse {
1780
1780
  */
1781
1781
  export interface ListTagsForResourceRequest {
1782
1782
  /**
1783
- * @public
1784
1783
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1784
+ * @public
1785
1785
  */
1786
1786
  ResourceArn: string | undefined;
1787
1787
  }
1788
1788
  /**
1789
- * @public
1790
1789
  * <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
1790
+ * @public
1791
1791
  */
1792
1792
  export interface TagsModel {
1793
1793
  /**
1794
- * @public
1795
1794
  * <p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
1795
+ * @public
1796
1796
  */
1797
1797
  tags: Record<string, string> | undefined;
1798
1798
  }
@@ -1801,8 +1801,8 @@ export interface TagsModel {
1801
1801
  */
1802
1802
  export interface ListTagsForResourceResponse {
1803
1803
  /**
1804
- * @public
1805
1804
  * <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
1805
+ * @public
1806
1806
  */
1807
1807
  TagsModel: TagsModel | undefined;
1808
1808
  }
@@ -1811,39 +1811,39 @@ export interface ListTagsForResourceResponse {
1811
1811
  */
1812
1812
  export interface ListTemplatesRequest {
1813
1813
  /**
1814
- * @public
1815
1814
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1815
+ * @public
1816
1816
  */
1817
1817
  NextToken?: string;
1818
1818
  /**
1819
- * @public
1820
1819
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1820
+ * @public
1821
1821
  */
1822
1822
  PageSize?: string;
1823
1823
  /**
1824
- * @public
1825
1824
  * <p>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.</p>
1825
+ * @public
1826
1826
  */
1827
1827
  Prefix?: string;
1828
1828
  /**
1829
- * @public
1830
1829
  * <p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>
1830
+ * @public
1831
1831
  */
1832
1832
  TemplateType?: string;
1833
1833
  }
1834
1834
  /**
1835
- * @public
1836
1835
  * <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
1836
+ * @public
1837
1837
  */
1838
1838
  export interface TemplatesResponse {
1839
1839
  /**
1840
- * @public
1841
1840
  * <p>An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.</p>
1841
+ * @public
1842
1842
  */
1843
1843
  Item: TemplateResponse[] | undefined;
1844
1844
  /**
1845
- * @public
1846
1845
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1846
+ * @public
1847
1847
  */
1848
1848
  NextToken?: string;
1849
1849
  }
@@ -1852,8 +1852,8 @@ export interface TemplatesResponse {
1852
1852
  */
1853
1853
  export interface ListTemplatesResponse {
1854
1854
  /**
1855
- * @public
1856
1855
  * <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
1856
+ * @public
1857
1857
  */
1858
1858
  TemplatesResponse: TemplatesResponse | undefined;
1859
1859
  }
@@ -1862,49 +1862,49 @@ export interface ListTemplatesResponse {
1862
1862
  */
1863
1863
  export interface ListTemplateVersionsRequest {
1864
1864
  /**
1865
- * @public
1866
1865
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1866
+ * @public
1867
1867
  */
1868
1868
  NextToken?: string;
1869
1869
  /**
1870
- * @public
1871
1870
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  PageSize?: string;
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
1876
+ * @public
1877
1877
  */
1878
1878
  TemplateName: string | undefined;
1879
1879
  /**
1880
- * @public
1881
1880
  * <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
1881
+ * @public
1882
1882
  */
1883
1883
  TemplateType: string | undefined;
1884
1884
  }
1885
1885
  /**
1886
- * @public
1887
1886
  * <p>Provides information about all the versions of a specific message template.</p>
1887
+ * @public
1888
1888
  */
1889
1889
  export interface TemplateVersionsResponse {
1890
1890
  /**
1891
- * @public
1892
1891
  * <p>An array of responses, one for each version of the message template.</p>
1892
+ * @public
1893
1893
  */
1894
1894
  Item: TemplateVersionResponse[] | undefined;
1895
1895
  /**
1896
- * @public
1897
1896
  * <p>The message that's returned from the API for the request to retrieve information about all the versions of the message template.</p>
1897
+ * @public
1898
1898
  */
1899
1899
  Message?: string;
1900
1900
  /**
1901
- * @public
1902
1901
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1902
+ * @public
1903
1903
  */
1904
1904
  NextToken?: string;
1905
1905
  /**
1906
- * @public
1907
1906
  * <p>The unique identifier for the request to retrieve information about all the versions of the message template.</p>
1907
+ * @public
1908
1908
  */
1909
1909
  RequestID?: string;
1910
1910
  }
@@ -1913,194 +1913,194 @@ export interface TemplateVersionsResponse {
1913
1913
  */
1914
1914
  export interface ListTemplateVersionsResponse {
1915
1915
  /**
1916
- * @public
1917
1916
  * <p>Provides information about all the versions of a specific message template.</p>
1917
+ * @public
1918
1918
  */
1919
1919
  TemplateVersionsResponse: TemplateVersionsResponse | undefined;
1920
1920
  }
1921
1921
  /**
1922
- * @public
1923
1922
  * <p>Provides information about the results of sending a message directly to an endpoint address.</p>
1923
+ * @public
1924
1924
  */
1925
1925
  export interface MessageResult {
1926
1926
  /**
1927
- * @public
1928
1927
  * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
1928
+ * @public
1929
1929
  */
1930
1930
  DeliveryStatus: DeliveryStatus | undefined;
1931
1931
  /**
1932
- * @public
1933
1932
  * <p>The unique identifier for the message that was sent.</p>
1933
+ * @public
1934
1934
  */
1935
1935
  MessageId?: string;
1936
1936
  /**
1937
- * @public
1938
1937
  * <p>The downstream service status code for delivering the message.</p>
1938
+ * @public
1939
1939
  */
1940
1940
  StatusCode: number | undefined;
1941
1941
  /**
1942
- * @public
1943
1942
  * <p>The status message for delivering the message.</p>
1943
+ * @public
1944
1944
  */
1945
1945
  StatusMessage?: string;
1946
1946
  /**
1947
- * @public
1948
1947
  * <p>For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.</p>
1948
+ * @public
1949
1949
  */
1950
1950
  UpdatedToken?: string;
1951
1951
  }
1952
1952
  /**
1953
- * @public
1954
1953
  * <p>Specifies the configuration and other settings for a message.</p>
1954
+ * @public
1955
1955
  */
1956
1956
  export interface MessageRequest {
1957
1957
  /**
1958
- * @public
1959
1958
  * <p>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</p>
1959
+ * @public
1960
1960
  */
1961
1961
  Addresses?: Record<string, AddressConfiguration>;
1962
1962
  /**
1963
- * @public
1964
1963
  * <p>A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>
1964
+ * @public
1965
1965
  */
1966
1966
  Context?: Record<string, string>;
1967
1967
  /**
1968
- * @public
1969
1968
  * <p>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</p>
1969
+ * @public
1970
1970
  */
1971
1971
  Endpoints?: Record<string, EndpointSendConfiguration>;
1972
1972
  /**
1973
- * @public
1974
1973
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
1974
+ * @public
1975
1975
  */
1976
1976
  MessageConfiguration: DirectMessageConfiguration | undefined;
1977
1977
  /**
1978
- * @public
1979
1978
  * <p>The message template to use for the message.</p>
1979
+ * @public
1980
1980
  */
1981
1981
  TemplateConfiguration?: TemplateConfiguration;
1982
1982
  /**
1983
- * @public
1984
1983
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
1984
+ * @public
1985
1985
  */
1986
1986
  TraceId?: string;
1987
1987
  }
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
1990
+ * @public
1991
1991
  */
1992
1992
  export interface MessageResponse {
1993
1993
  /**
1994
- * @public
1995
1994
  * <p>The unique identifier for the application that was used to send the message.</p>
1995
+ * @public
1996
1996
  */
1997
1997
  ApplicationId: string | undefined;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.</p>
2000
+ * @public
2001
2001
  */
2002
2002
  EndpointResult?: Record<string, EndpointMessageResult>;
2003
2003
  /**
2004
- * @public
2005
2004
  * <p>The identifier for the original request that the message was delivered for.</p>
2005
+ * @public
2006
2006
  */
2007
2007
  RequestId?: string;
2008
2008
  /**
2009
- * @public
2010
2009
  * <p>A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.</p>
2010
+ * @public
2011
2011
  */
2012
2012
  Result?: Record<string, MessageResult>;
2013
2013
  }
2014
2014
  /**
2015
- * @public
2016
2015
  * <p>Specifies a phone number to validate and retrieve information about.</p>
2016
+ * @public
2017
2017
  */
2018
2018
  export interface NumberValidateRequest {
2019
2019
  /**
2020
- * @public
2021
2020
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
2021
+ * @public
2022
2022
  */
2023
2023
  IsoCountryCode?: string;
2024
2024
  /**
2025
- * @public
2026
2025
  * <p>The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.</p>
2026
+ * @public
2027
2027
  */
2028
2028
  PhoneNumber?: string;
2029
2029
  }
2030
2030
  /**
2031
- * @public
2032
2031
  * <p>Provides information about a phone number.</p>
2032
+ * @public
2033
2033
  */
2034
2034
  export interface NumberValidateResponse {
2035
2035
  /**
2036
- * @public
2037
2036
  * <p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>
2037
+ * @public
2038
2038
  */
2039
2039
  Carrier?: string;
2040
2040
  /**
2041
- * @public
2042
2041
  * <p>The name of the city where the phone number was originally registered.</p>
2042
+ * @public
2043
2043
  */
2044
2044
  City?: string;
2045
2045
  /**
2046
- * @public
2047
2046
  * <p>The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.</p>
2047
+ * @public
2048
2048
  */
2049
2049
  CleansedPhoneNumberE164?: string;
2050
2050
  /**
2051
- * @public
2052
2051
  * <p>The cleansed phone number, in the format for the location where the phone number was originally registered.</p>
2052
+ * @public
2053
2053
  */
2054
2054
  CleansedPhoneNumberNational?: string;
2055
2055
  /**
2056
- * @public
2057
2056
  * <p>The name of the country or region where the phone number was originally registered.</p>
2057
+ * @public
2058
2058
  */
2059
2059
  Country?: string;
2060
2060
  /**
2061
- * @public
2062
2061
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
2062
+ * @public
2063
2063
  */
2064
2064
  CountryCodeIso2?: string;
2065
2065
  /**
2066
- * @public
2067
2066
  * <p>The numeric code for the country or region where the phone number was originally registered.</p>
2067
+ * @public
2068
2068
  */
2069
2069
  CountryCodeNumeric?: string;
2070
2070
  /**
2071
- * @public
2072
2071
  * <p>The name of the county where the phone number was originally registered.</p>
2072
+ * @public
2073
2073
  */
2074
2074
  County?: string;
2075
2075
  /**
2076
- * @public
2077
2076
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.</p>
2077
+ * @public
2078
2078
  */
2079
2079
  OriginalCountryCodeIso2?: string;
2080
2080
  /**
2081
- * @public
2082
2081
  * <p>The phone number that was sent in the request body.</p>
2082
+ * @public
2083
2083
  */
2084
2084
  OriginalPhoneNumber?: string;
2085
2085
  /**
2086
- * @public
2087
2086
  * <p>The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
2088
2087
  * INVALID, PREPAID, and OTHER.</p>
2088
+ * @public
2089
2089
  */
2090
2090
  PhoneType?: string;
2091
2091
  /**
2092
- * @public
2093
2092
  * <p>The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).</p>
2093
+ * @public
2094
2094
  */
2095
2095
  PhoneTypeCode?: number;
2096
2096
  /**
2097
- * @public
2098
2097
  * <p>The time zone for the location where the phone number was originally registered.</p>
2098
+ * @public
2099
2099
  */
2100
2100
  Timezone?: string;
2101
2101
  /**
2102
- * @public
2103
2102
  * <p>The postal or ZIP code for the location where the phone number was originally registered.</p>
2103
+ * @public
2104
2104
  */
2105
2105
  ZipCode?: string;
2106
2106
  }
@@ -2109,8 +2109,8 @@ export interface NumberValidateResponse {
2109
2109
  */
2110
2110
  export interface PhoneNumberValidateRequest {
2111
2111
  /**
2112
- * @public
2113
2112
  * <p>Specifies a phone number to validate and retrieve information about.</p>
2113
+ * @public
2114
2114
  */
2115
2115
  NumberValidateRequest: NumberValidateRequest | undefined;
2116
2116
  }
@@ -2119,8 +2119,8 @@ export interface PhoneNumberValidateRequest {
2119
2119
  */
2120
2120
  export interface PhoneNumberValidateResponse {
2121
2121
  /**
2122
- * @public
2123
2122
  * <p>Provides information about a phone number.</p>
2123
+ * @public
2124
2124
  */
2125
2125
  NumberValidateResponse: NumberValidateResponse | undefined;
2126
2126
  }
@@ -2129,13 +2129,13 @@ export interface PhoneNumberValidateResponse {
2129
2129
  */
2130
2130
  export interface PutEventsRequest {
2131
2131
  /**
2132
- * @public
2133
2132
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2133
+ * @public
2134
2134
  */
2135
2135
  ApplicationId: string | undefined;
2136
2136
  /**
2137
- * @public
2138
2137
  * <p>Specifies a batch of events to process.</p>
2138
+ * @public
2139
2139
  */
2140
2140
  EventsRequest: EventsRequest | undefined;
2141
2141
  }
@@ -2144,26 +2144,26 @@ export interface PutEventsRequest {
2144
2144
  */
2145
2145
  export interface PutEventsResponse {
2146
2146
  /**
2147
- * @public
2148
2147
  * <p>Provides information about endpoints and the events that they're associated with.</p>
2148
+ * @public
2149
2149
  */
2150
2150
  EventsResponse: EventsResponse | undefined;
2151
2151
  }
2152
2152
  /**
2153
- * @public
2154
2153
  * <p>Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.</p>
2154
+ * @public
2155
2155
  */
2156
2156
  export interface WriteEventStream {
2157
2157
  /**
2158
- * @public
2159
2158
  * <p>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.</p> <p>For a Kinesis data stream, the ARN format is: arn:aws:kinesis:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:stream/<replaceable>stream_name</replaceable>
2160
2159
  * </p> <p>For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:deliverystream/<replaceable>stream_name</replaceable>
2161
2160
  * </p>
2161
+ * @public
2162
2162
  */
2163
2163
  DestinationStreamArn: string | undefined;
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.</p>
2166
+ * @public
2167
2167
  */
2168
2168
  RoleArn: string | undefined;
2169
2169
  }
@@ -2172,13 +2172,13 @@ export interface WriteEventStream {
2172
2172
  */
2173
2173
  export interface PutEventStreamRequest {
2174
2174
  /**
2175
- * @public
2176
2175
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2176
+ * @public
2177
2177
  */
2178
2178
  ApplicationId: string | undefined;
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.</p>
2181
+ * @public
2182
2182
  */
2183
2183
  WriteEventStream: WriteEventStream | undefined;
2184
2184
  }
@@ -2187,19 +2187,19 @@ export interface PutEventStreamRequest {
2187
2187
  */
2188
2188
  export interface PutEventStreamResponse {
2189
2189
  /**
2190
- * @public
2191
2190
  * <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
2191
+ * @public
2192
2192
  */
2193
2193
  EventStream: EventStream | undefined;
2194
2194
  }
2195
2195
  /**
2196
- * @public
2197
2196
  * <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
2197
+ * @public
2198
2198
  */
2199
2199
  export interface UpdateAttributesRequest {
2200
2200
  /**
2201
- * @public
2202
2201
  * <p>An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.</p>
2202
+ * @public
2203
2203
  */
2204
2204
  Blacklist?: string[];
2205
2205
  }
@@ -2208,18 +2208,18 @@ export interface UpdateAttributesRequest {
2208
2208
  */
2209
2209
  export interface RemoveAttributesRequest {
2210
2210
  /**
2211
- * @public
2212
2211
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2212
+ * @public
2213
2213
  */
2214
2214
  ApplicationId: string | undefined;
2215
2215
  /**
2216
- * @public
2217
2216
  * <p>The type of attribute or attributes to remove. Valid values are:</p> <ul><li><p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li> <li><p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li> <li><p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li></ul>
2217
+ * @public
2218
2218
  */
2219
2219
  AttributeType: string | undefined;
2220
2220
  /**
2221
- * @public
2222
2221
  * <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
2222
+ * @public
2223
2223
  */
2224
2224
  UpdateAttributesRequest: UpdateAttributesRequest | undefined;
2225
2225
  }
@@ -2228,8 +2228,8 @@ export interface RemoveAttributesRequest {
2228
2228
  */
2229
2229
  export interface RemoveAttributesResponse {
2230
2230
  /**
2231
- * @public
2232
2231
  * <p>Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.</p>
2232
+ * @public
2233
2233
  */
2234
2234
  AttributesResource: AttributesResource | undefined;
2235
2235
  }
@@ -2238,13 +2238,13 @@ export interface RemoveAttributesResponse {
2238
2238
  */
2239
2239
  export interface SendMessagesRequest {
2240
2240
  /**
2241
- * @public
2242
2241
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2242
+ * @public
2243
2243
  */
2244
2244
  ApplicationId: string | undefined;
2245
2245
  /**
2246
- * @public
2247
2246
  * <p>Specifies the configuration and other settings for a message.</p>
2247
+ * @public
2248
2248
  */
2249
2249
  MessageRequest: MessageRequest | undefined;
2250
2250
  }
@@ -2253,69 +2253,69 @@ export interface SendMessagesRequest {
2253
2253
  */
2254
2254
  export interface SendMessagesResponse {
2255
2255
  /**
2256
- * @public
2257
2256
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
2257
+ * @public
2258
2258
  */
2259
2259
  MessageResponse: MessageResponse | undefined;
2260
2260
  }
2261
2261
  /**
2262
- * @public
2263
2262
  * <p>Send OTP message request parameters.</p>
2263
+ * @public
2264
2264
  */
2265
2265
  export interface SendOTPMessageRequestParameters {
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>The attempts allowed to validate an OTP.</p>
2268
+ * @public
2269
2269
  */
2270
2270
  AllowedAttempts?: number;
2271
2271
  /**
2272
- * @public
2273
2272
  * <p>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</p>
2273
+ * @public
2274
2274
  */
2275
2275
  BrandName: string | undefined;
2276
2276
  /**
2277
- * @public
2278
2277
  * <p>Channel type for the OTP message. Supported values: [SMS].</p>
2278
+ * @public
2279
2279
  */
2280
2280
  Channel: string | undefined;
2281
2281
  /**
2282
- * @public
2283
2282
  * <p>The number of characters in the generated OTP.</p>
2283
+ * @public
2284
2284
  */
2285
2285
  CodeLength?: number;
2286
2286
  /**
2287
- * @public
2288
2287
  * <p>The destination identity to send OTP to.</p>
2288
+ * @public
2289
2289
  */
2290
2290
  DestinationIdentity: string | undefined;
2291
2291
  /**
2292
- * @public
2293
2292
  * <p>A unique Entity ID received from DLT after entity registration is approved.</p>
2293
+ * @public
2294
2294
  */
2295
2295
  EntityId?: string;
2296
2296
  /**
2297
- * @public
2298
2297
  * <p>The language to be used for the outgoing message body containing the OTP.</p>
2298
+ * @public
2299
2299
  */
2300
2300
  Language?: string;
2301
2301
  /**
2302
- * @public
2303
2302
  * <p>The origination identity used to send OTP from.</p>
2303
+ * @public
2304
2304
  */
2305
2305
  OriginationIdentity: string | undefined;
2306
2306
  /**
2307
- * @public
2308
2307
  * <p>Developer-specified reference identifier. Required to match during OTP verification.</p>
2308
+ * @public
2309
2309
  */
2310
2310
  ReferenceId: string | undefined;
2311
2311
  /**
2312
- * @public
2313
2312
  * <p>A unique Template ID received from DLT after entity registration is approved.</p>
2313
+ * @public
2314
2314
  */
2315
2315
  TemplateId?: string;
2316
2316
  /**
2317
- * @public
2318
2317
  * <p>The time in minutes before the OTP is no longer valid.</p>
2318
+ * @public
2319
2319
  */
2320
2320
  ValidityPeriod?: number;
2321
2321
  }
@@ -2324,13 +2324,13 @@ export interface SendOTPMessageRequestParameters {
2324
2324
  */
2325
2325
  export interface SendOTPMessageRequest {
2326
2326
  /**
2327
- * @public
2328
2327
  * <p>The unique ID of your Amazon Pinpoint application.</p>
2328
+ * @public
2329
2329
  */
2330
2330
  ApplicationId: string | undefined;
2331
2331
  /**
2332
- * @public
2333
2332
  * <p>Send OTP message request parameters.</p>
2333
+ * @public
2334
2334
  */
2335
2335
  SendOTPMessageRequestParameters: SendOTPMessageRequestParameters | undefined;
2336
2336
  }
@@ -2339,39 +2339,39 @@ export interface SendOTPMessageRequest {
2339
2339
  */
2340
2340
  export interface SendOTPMessageResponse {
2341
2341
  /**
2342
- * @public
2343
2342
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
2343
+ * @public
2344
2344
  */
2345
2345
  MessageResponse: MessageResponse | undefined;
2346
2346
  }
2347
2347
  /**
2348
- * @public
2349
2348
  * <p>Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.</p>
2349
+ * @public
2350
2350
  */
2351
2351
  export interface SendUsersMessageRequest {
2352
2352
  /**
2353
- * @public
2354
2353
  * <p>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.</p>
2354
+ * @public
2355
2355
  */
2356
2356
  Context?: Record<string, string>;
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
2359
+ * @public
2360
2360
  */
2361
2361
  MessageConfiguration: DirectMessageConfiguration | undefined;
2362
2362
  /**
2363
- * @public
2364
2363
  * <p>The message template to use for the message.</p>
2364
+ * @public
2365
2365
  */
2366
2366
  TemplateConfiguration?: TemplateConfiguration;
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  TraceId?: string;
2372
2372
  /**
2373
- * @public
2374
2373
  * <p>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables.</p>
2374
+ * @public
2375
2375
  */
2376
2376
  Users: Record<string, EndpointSendConfiguration> | undefined;
2377
2377
  }
@@ -2380,34 +2380,34 @@ export interface SendUsersMessageRequest {
2380
2380
  */
2381
2381
  export interface SendUsersMessagesRequest {
2382
2382
  /**
2383
- * @public
2384
2383
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2384
+ * @public
2385
2385
  */
2386
2386
  ApplicationId: string | undefined;
2387
2387
  /**
2388
- * @public
2389
2388
  * <p>Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.</p>
2389
+ * @public
2390
2390
  */
2391
2391
  SendUsersMessageRequest: SendUsersMessageRequest | undefined;
2392
2392
  }
2393
2393
  /**
2394
- * @public
2395
2394
  * <p>Provides information about which users and endpoints a message was sent to.</p>
2395
+ * @public
2396
2396
  */
2397
2397
  export interface SendUsersMessageResponse {
2398
2398
  /**
2399
- * @public
2400
2399
  * <p>The unique identifier for the application that was used to send the message.</p>
2400
+ * @public
2401
2401
  */
2402
2402
  ApplicationId: string | undefined;
2403
2403
  /**
2404
- * @public
2405
2404
  * <p>The unique identifier that was assigned to the message request.</p>
2405
+ * @public
2406
2406
  */
2407
2407
  RequestId?: string;
2408
2408
  /**
2409
- * @public
2410
2409
  * <p>An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.</p>
2410
+ * @public
2411
2411
  */
2412
2412
  Result?: Record<string, Record<string, EndpointMessageResult>>;
2413
2413
  }
@@ -2416,8 +2416,8 @@ export interface SendUsersMessageResponse {
2416
2416
  */
2417
2417
  export interface SendUsersMessagesResponse {
2418
2418
  /**
2419
- * @public
2420
2419
  * <p>Provides information about which users and endpoints a message was sent to.</p>
2420
+ * @public
2421
2421
  */
2422
2422
  SendUsersMessageResponse: SendUsersMessageResponse | undefined;
2423
2423
  }
@@ -2426,13 +2426,13 @@ export interface SendUsersMessagesResponse {
2426
2426
  */
2427
2427
  export interface TagResourceRequest {
2428
2428
  /**
2429
- * @public
2430
2429
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2430
+ * @public
2431
2431
  */
2432
2432
  ResourceArn: string | undefined;
2433
2433
  /**
2434
- * @public
2435
2434
  * <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
2435
+ * @public
2436
2436
  */
2437
2437
  TagsModel: TagsModel | undefined;
2438
2438
  }
@@ -2441,13 +2441,13 @@ export interface TagResourceRequest {
2441
2441
  */
2442
2442
  export interface UntagResourceRequest {
2443
2443
  /**
2444
- * @public
2445
2444
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2445
+ * @public
2446
2446
  */
2447
2447
  ResourceArn: string | undefined;
2448
2448
  /**
2449
- * @public
2450
2449
  * <p>The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&amp;).</p>
2450
+ * @public
2451
2451
  */
2452
2452
  TagKeys: string[] | undefined;
2453
2453
  }
@@ -2456,13 +2456,13 @@ export interface UntagResourceRequest {
2456
2456
  */
2457
2457
  export interface UpdateAdmChannelRequest {
2458
2458
  /**
2459
- * @public
2460
2459
  * <p>Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
2460
+ * @public
2461
2461
  */
2462
2462
  ADMChannelRequest: ADMChannelRequest | undefined;
2463
2463
  /**
2464
- * @public
2465
2464
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2465
+ * @public
2466
2466
  */
2467
2467
  ApplicationId: string | undefined;
2468
2468
  }
@@ -2471,8 +2471,8 @@ export interface UpdateAdmChannelRequest {
2471
2471
  */
2472
2472
  export interface UpdateAdmChannelResponse {
2473
2473
  /**
2474
- * @public
2475
2474
  * <p>Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
2475
+ * @public
2476
2476
  */
2477
2477
  ADMChannelResponse: ADMChannelResponse | undefined;
2478
2478
  }
@@ -2481,13 +2481,13 @@ export interface UpdateAdmChannelResponse {
2481
2481
  */
2482
2482
  export interface UpdateApnsChannelRequest {
2483
2483
  /**
2484
- * @public
2485
2484
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
2485
+ * @public
2486
2486
  */
2487
2487
  APNSChannelRequest: APNSChannelRequest | undefined;
2488
2488
  /**
2489
- * @public
2490
2489
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2490
+ * @public
2491
2491
  */
2492
2492
  ApplicationId: string | undefined;
2493
2493
  }
@@ -2496,8 +2496,8 @@ export interface UpdateApnsChannelRequest {
2496
2496
  */
2497
2497
  export interface UpdateApnsChannelResponse {
2498
2498
  /**
2499
- * @public
2500
2499
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
2500
+ * @public
2501
2501
  */
2502
2502
  APNSChannelResponse: APNSChannelResponse | undefined;
2503
2503
  }
@@ -2506,13 +2506,13 @@ export interface UpdateApnsChannelResponse {
2506
2506
  */
2507
2507
  export interface UpdateApnsSandboxChannelRequest {
2508
2508
  /**
2509
- * @public
2510
2509
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
2510
+ * @public
2511
2511
  */
2512
2512
  APNSSandboxChannelRequest: APNSSandboxChannelRequest | undefined;
2513
2513
  /**
2514
- * @public
2515
2514
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2515
+ * @public
2516
2516
  */
2517
2517
  ApplicationId: string | undefined;
2518
2518
  }
@@ -2521,8 +2521,8 @@ export interface UpdateApnsSandboxChannelRequest {
2521
2521
  */
2522
2522
  export interface UpdateApnsSandboxChannelResponse {
2523
2523
  /**
2524
- * @public
2525
2524
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
2525
+ * @public
2526
2526
  */
2527
2527
  APNSSandboxChannelResponse: APNSSandboxChannelResponse | undefined;
2528
2528
  }
@@ -2531,13 +2531,13 @@ export interface UpdateApnsSandboxChannelResponse {
2531
2531
  */
2532
2532
  export interface UpdateApnsVoipChannelRequest {
2533
2533
  /**
2534
- * @public
2535
2534
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
2535
+ * @public
2536
2536
  */
2537
2537
  APNSVoipChannelRequest: APNSVoipChannelRequest | undefined;
2538
2538
  /**
2539
- * @public
2540
2539
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2540
+ * @public
2541
2541
  */
2542
2542
  ApplicationId: string | undefined;
2543
2543
  }
@@ -2546,8 +2546,8 @@ export interface UpdateApnsVoipChannelRequest {
2546
2546
  */
2547
2547
  export interface UpdateApnsVoipChannelResponse {
2548
2548
  /**
2549
- * @public
2550
2549
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
2550
+ * @public
2551
2551
  */
2552
2552
  APNSVoipChannelResponse: APNSVoipChannelResponse | undefined;
2553
2553
  }
@@ -2556,13 +2556,13 @@ export interface UpdateApnsVoipChannelResponse {
2556
2556
  */
2557
2557
  export interface UpdateApnsVoipSandboxChannelRequest {
2558
2558
  /**
2559
- * @public
2560
2559
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
2560
+ * @public
2561
2561
  */
2562
2562
  APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest | undefined;
2563
2563
  /**
2564
- * @public
2565
2564
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2565
+ * @public
2566
2566
  */
2567
2567
  ApplicationId: string | undefined;
2568
2568
  }
@@ -2571,40 +2571,40 @@ export interface UpdateApnsVoipSandboxChannelRequest {
2571
2571
  */
2572
2572
  export interface UpdateApnsVoipSandboxChannelResponse {
2573
2573
  /**
2574
- * @public
2575
2574
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
2575
+ * @public
2576
2576
  */
2577
2577
  APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse | undefined;
2578
2578
  }
2579
2579
  /**
2580
- * @public
2581
2580
  * <p>Specifies the default settings for an application.</p>
2581
+ * @public
2582
2582
  */
2583
2583
  export interface WriteApplicationSettingsRequest {
2584
2584
  /**
2585
- * @public
2586
2585
  * <p>The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.</p> <p>To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource.</p>
2586
+ * @public
2587
2587
  */
2588
2588
  CampaignHook?: CampaignHook;
2589
2589
  /**
2590
- * @public
2591
2590
  * <p>Specifies whether to enable application-related alarms in Amazon CloudWatch.</p>
2591
+ * @public
2592
2592
  */
2593
2593
  CloudWatchMetricsEnabled?: boolean;
2594
2594
  EventTaggingEnabled?: boolean;
2595
2595
  /**
2596
- * @public
2597
2596
  * <p>The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource, respectively.</p>
2597
+ * @public
2598
2598
  */
2599
2599
  Limits?: CampaignLimits;
2600
2600
  /**
2601
- * @public
2602
2601
  * <p>The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).</p></li> <li><p>The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).</p></li></ul> <p>If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.</p> <p>To override the default quiet time settings for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource to define a custom quiet time for the campaign or journey.</p>
2602
+ * @public
2603
2603
  */
2604
2604
  QuietTime?: QuietTime;
2605
2605
  /**
2606
- * @public
2607
2606
  * <p>The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.</p>
2607
+ * @public
2608
2608
  */
2609
2609
  JourneyLimits?: ApplicationSettingsJourneyLimits;
2610
2610
  }
@@ -2613,13 +2613,13 @@ export interface WriteApplicationSettingsRequest {
2613
2613
  */
2614
2614
  export interface UpdateApplicationSettingsRequest {
2615
2615
  /**
2616
- * @public
2617
2616
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2617
+ * @public
2618
2618
  */
2619
2619
  ApplicationId: string | undefined;
2620
2620
  /**
2621
- * @public
2622
2621
  * <p>Specifies the default settings for an application.</p>
2622
+ * @public
2623
2623
  */
2624
2624
  WriteApplicationSettingsRequest: WriteApplicationSettingsRequest | undefined;
2625
2625
  }
@@ -2628,8 +2628,8 @@ export interface UpdateApplicationSettingsRequest {
2628
2628
  */
2629
2629
  export interface UpdateApplicationSettingsResponse {
2630
2630
  /**
2631
- * @public
2632
2631
  * <p>Provides information about an application, including the default settings for an application.</p>
2632
+ * @public
2633
2633
  */
2634
2634
  ApplicationSettingsResource: ApplicationSettingsResource | undefined;
2635
2635
  }
@@ -2638,13 +2638,13 @@ export interface UpdateApplicationSettingsResponse {
2638
2638
  */
2639
2639
  export interface UpdateBaiduChannelRequest {
2640
2640
  /**
2641
- * @public
2642
2641
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2642
+ * @public
2643
2643
  */
2644
2644
  ApplicationId: string | undefined;
2645
2645
  /**
2646
- * @public
2647
2646
  * <p>Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
2647
+ * @public
2648
2648
  */
2649
2649
  BaiduChannelRequest: BaiduChannelRequest | undefined;
2650
2650
  }
@@ -2653,8 +2653,8 @@ export interface UpdateBaiduChannelRequest {
2653
2653
  */
2654
2654
  export interface UpdateBaiduChannelResponse {
2655
2655
  /**
2656
- * @public
2657
2656
  * <p>Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
2657
+ * @public
2658
2658
  */
2659
2659
  BaiduChannelResponse: BaiduChannelResponse | undefined;
2660
2660
  }
@@ -2663,18 +2663,18 @@ export interface UpdateBaiduChannelResponse {
2663
2663
  */
2664
2664
  export interface UpdateCampaignRequest {
2665
2665
  /**
2666
- * @public
2667
2666
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2667
+ * @public
2668
2668
  */
2669
2669
  ApplicationId: string | undefined;
2670
2670
  /**
2671
- * @public
2672
2671
  * <p>The unique identifier for the campaign.</p>
2672
+ * @public
2673
2673
  */
2674
2674
  CampaignId: string | undefined;
2675
2675
  /**
2676
- * @public
2677
2676
  * <p>Specifies the configuration and other settings for a campaign.</p>
2677
+ * @public
2678
2678
  */
2679
2679
  WriteCampaignRequest: WriteCampaignRequest | undefined;
2680
2680
  }
@@ -2683,8 +2683,8 @@ export interface UpdateCampaignRequest {
2683
2683
  */
2684
2684
  export interface UpdateCampaignResponse {
2685
2685
  /**
2686
- * @public
2687
2686
  * <p>Provides information about the status, configuration, and other settings for a campaign.</p>
2687
+ * @public
2688
2688
  */
2689
2689
  CampaignResponse: CampaignResponse | undefined;
2690
2690
  }
@@ -2693,13 +2693,13 @@ export interface UpdateCampaignResponse {
2693
2693
  */
2694
2694
  export interface UpdateEmailChannelRequest {
2695
2695
  /**
2696
- * @public
2697
2696
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2697
+ * @public
2698
2698
  */
2699
2699
  ApplicationId: string | undefined;
2700
2700
  /**
2701
- * @public
2702
2701
  * <p>Specifies the status and settings of the email channel for an application.</p>
2702
+ * @public
2703
2703
  */
2704
2704
  EmailChannelRequest: EmailChannelRequest | undefined;
2705
2705
  }
@@ -2708,8 +2708,8 @@ export interface UpdateEmailChannelRequest {
2708
2708
  */
2709
2709
  export interface UpdateEmailChannelResponse {
2710
2710
  /**
2711
- * @public
2712
2711
  * <p>Provides information about the status and settings of the email channel for an application.</p>
2712
+ * @public
2713
2713
  */
2714
2714
  EmailChannelResponse: EmailChannelResponse | undefined;
2715
2715
  }
@@ -2718,23 +2718,23 @@ export interface UpdateEmailChannelResponse {
2718
2718
  */
2719
2719
  export interface UpdateEmailTemplateRequest {
2720
2720
  /**
2721
- * @public
2722
2721
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2722
+ * @public
2723
2723
  */
2724
2724
  CreateNewVersion?: boolean;
2725
2725
  /**
2726
- * @public
2727
2726
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
2727
+ * @public
2728
2728
  */
2729
2729
  EmailTemplateRequest: EmailTemplateRequest | undefined;
2730
2730
  /**
2731
- * @public
2732
2731
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
2732
+ * @public
2733
2733
  */
2734
2734
  TemplateName: string | undefined;
2735
2735
  /**
2736
- * @public
2737
2736
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2737
+ * @public
2738
2738
  */
2739
2739
  Version?: string;
2740
2740
  }
@@ -2743,8 +2743,8 @@ export interface UpdateEmailTemplateRequest {
2743
2743
  */
2744
2744
  export interface UpdateEmailTemplateResponse {
2745
2745
  /**
2746
- * @public
2747
2746
  * <p>Provides information about an API request or response.</p>
2747
+ * @public
2748
2748
  */
2749
2749
  MessageBody: MessageBody | undefined;
2750
2750
  }
@@ -2753,18 +2753,18 @@ export interface UpdateEmailTemplateResponse {
2753
2753
  */
2754
2754
  export interface UpdateEndpointRequest {
2755
2755
  /**
2756
- * @public
2757
2756
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2757
+ * @public
2758
2758
  */
2759
2759
  ApplicationId: string | undefined;
2760
2760
  /**
2761
- * @public
2762
2761
  * <p>The case insensitive unique identifier for the endpoint. The identifier can't contain <code>$</code>, <code>\{</code> or <code>\}</code>.</p>
2762
+ * @public
2763
2763
  */
2764
2764
  EndpointId: string | undefined;
2765
2765
  /**
2766
- * @public
2767
2766
  * <p>Specifies the channel type and other settings for an endpoint.</p>
2767
+ * @public
2768
2768
  */
2769
2769
  EndpointRequest: EndpointRequest | undefined;
2770
2770
  }
@@ -2773,8 +2773,8 @@ export interface UpdateEndpointRequest {
2773
2773
  */
2774
2774
  export interface UpdateEndpointResponse {
2775
2775
  /**
2776
- * @public
2777
2776
  * <p>Provides information about an API request or response.</p>
2777
+ * @public
2778
2778
  */
2779
2779
  MessageBody: MessageBody | undefined;
2780
2780
  }
@@ -2783,13 +2783,13 @@ export interface UpdateEndpointResponse {
2783
2783
  */
2784
2784
  export interface UpdateEndpointsBatchRequest {
2785
2785
  /**
2786
- * @public
2787
2786
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2787
+ * @public
2788
2788
  */
2789
2789
  ApplicationId: string | undefined;
2790
2790
  /**
2791
- * @public
2792
2791
  * <p>Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.</p>
2792
+ * @public
2793
2793
  */
2794
2794
  EndpointBatchRequest: EndpointBatchRequest | undefined;
2795
2795
  }
@@ -2798,8 +2798,8 @@ export interface UpdateEndpointsBatchRequest {
2798
2798
  */
2799
2799
  export interface UpdateEndpointsBatchResponse {
2800
2800
  /**
2801
- * @public
2802
2801
  * <p>Provides information about an API request or response.</p>
2802
+ * @public
2803
2803
  */
2804
2804
  MessageBody: MessageBody | undefined;
2805
2805
  }
@@ -2808,13 +2808,13 @@ export interface UpdateEndpointsBatchResponse {
2808
2808
  */
2809
2809
  export interface UpdateGcmChannelRequest {
2810
2810
  /**
2811
- * @public
2812
2811
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2812
+ * @public
2813
2813
  */
2814
2814
  ApplicationId: string | undefined;
2815
2815
  /**
2816
- * @public
2817
2816
  * <p>Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
2817
+ * @public
2818
2818
  */
2819
2819
  GCMChannelRequest: GCMChannelRequest | undefined;
2820
2820
  }
@@ -2823,8 +2823,8 @@ export interface UpdateGcmChannelRequest {
2823
2823
  */
2824
2824
  export interface UpdateGcmChannelResponse {
2825
2825
  /**
2826
- * @public
2827
2826
  * <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
2827
+ * @public
2828
2828
  */
2829
2829
  GCMChannelResponse: GCMChannelResponse | undefined;
2830
2830
  }
@@ -2833,23 +2833,23 @@ export interface UpdateGcmChannelResponse {
2833
2833
  */
2834
2834
  export interface UpdateInAppTemplateRequest {
2835
2835
  /**
2836
- * @public
2837
2836
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2837
+ * @public
2838
2838
  */
2839
2839
  CreateNewVersion?: boolean;
2840
2840
  /**
2841
- * @public
2842
2841
  * <p>InApp Template Request.</p>
2842
+ * @public
2843
2843
  */
2844
2844
  InAppTemplateRequest: InAppTemplateRequest | undefined;
2845
2845
  /**
2846
- * @public
2847
2846
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
2847
+ * @public
2848
2848
  */
2849
2849
  TemplateName: string | undefined;
2850
2850
  /**
2851
- * @public
2852
2851
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2852
+ * @public
2853
2853
  */
2854
2854
  Version?: string;
2855
2855
  }
@@ -2858,8 +2858,8 @@ export interface UpdateInAppTemplateRequest {
2858
2858
  */
2859
2859
  export interface UpdateInAppTemplateResponse {
2860
2860
  /**
2861
- * @public
2862
2861
  * <p>Provides information about an API request or response.</p>
2862
+ * @public
2863
2863
  */
2864
2864
  MessageBody: MessageBody | undefined;
2865
2865
  }
@@ -2868,18 +2868,18 @@ export interface UpdateInAppTemplateResponse {
2868
2868
  */
2869
2869
  export interface UpdateJourneyRequest {
2870
2870
  /**
2871
- * @public
2872
2871
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2872
+ * @public
2873
2873
  */
2874
2874
  ApplicationId: string | undefined;
2875
2875
  /**
2876
- * @public
2877
2876
  * <p>The unique identifier for the journey.</p>
2877
+ * @public
2878
2878
  */
2879
2879
  JourneyId: string | undefined;
2880
2880
  /**
2881
- * @public
2882
2881
  * <p>Specifies the configuration and other settings for a journey.</p>
2882
+ * @public
2883
2883
  */
2884
2884
  WriteJourneyRequest: WriteJourneyRequest | undefined;
2885
2885
  }
@@ -2888,8 +2888,8 @@ export interface UpdateJourneyRequest {
2888
2888
  */
2889
2889
  export interface UpdateJourneyResponse {
2890
2890
  /**
2891
- * @public
2892
2891
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
2892
+ * @public
2893
2893
  */
2894
2894
  JourneyResponse: JourneyResponse | undefined;
2895
2895
  }
@@ -2898,18 +2898,18 @@ export interface UpdateJourneyResponse {
2898
2898
  */
2899
2899
  export interface UpdateJourneyStateRequest {
2900
2900
  /**
2901
- * @public
2902
2901
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2902
+ * @public
2903
2903
  */
2904
2904
  ApplicationId: string | undefined;
2905
2905
  /**
2906
- * @public
2907
2906
  * <p>The unique identifier for the journey.</p>
2907
+ * @public
2908
2908
  */
2909
2909
  JourneyId: string | undefined;
2910
2910
  /**
2911
- * @public
2912
2911
  * <p>Changes the status of a journey.</p>
2912
+ * @public
2913
2913
  */
2914
2914
  JourneyStateRequest: JourneyStateRequest | undefined;
2915
2915
  }
@@ -2918,8 +2918,8 @@ export interface UpdateJourneyStateRequest {
2918
2918
  */
2919
2919
  export interface UpdateJourneyStateResponse {
2920
2920
  /**
2921
- * @public
2922
2921
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
2922
+ * @public
2923
2923
  */
2924
2924
  JourneyResponse: JourneyResponse | undefined;
2925
2925
  }
@@ -2928,23 +2928,23 @@ export interface UpdateJourneyStateResponse {
2928
2928
  */
2929
2929
  export interface UpdatePushTemplateRequest {
2930
2930
  /**
2931
- * @public
2932
2931
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2932
+ * @public
2933
2933
  */
2934
2934
  CreateNewVersion?: boolean;
2935
2935
  /**
2936
- * @public
2937
2936
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
2937
+ * @public
2938
2938
  */
2939
2939
  PushNotificationTemplateRequest: PushNotificationTemplateRequest | undefined;
2940
2940
  /**
2941
- * @public
2942
2941
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
2942
+ * @public
2943
2943
  */
2944
2944
  TemplateName: string | undefined;
2945
2945
  /**
2946
- * @public
2947
2946
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2947
+ * @public
2948
2948
  */
2949
2949
  Version?: string;
2950
2950
  }
@@ -2953,59 +2953,59 @@ export interface UpdatePushTemplateRequest {
2953
2953
  */
2954
2954
  export interface UpdatePushTemplateResponse {
2955
2955
  /**
2956
- * @public
2957
2956
  * <p>Provides information about an API request or response.</p>
2957
+ * @public
2958
2958
  */
2959
2959
  MessageBody: MessageBody | undefined;
2960
2960
  }
2961
2961
  /**
2962
- * @public
2963
2962
  * <p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>
2963
+ * @public
2964
2964
  */
2965
2965
  export interface UpdateRecommenderConfigurationShape {
2966
2966
  /**
2967
- * @public
2968
2967
  * <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
2968
+ * @public
2969
2969
  */
2970
2970
  Attributes?: Record<string, string>;
2971
2971
  /**
2972
- * @public
2973
2972
  * <p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</p>
2973
+ * @public
2974
2974
  */
2975
2975
  Description?: string;
2976
2976
  /**
2977
- * @public
2978
2977
  * <p>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p>
2978
+ * @public
2979
2979
  */
2980
2980
  Name?: string;
2981
2981
  /**
2982
- * @public
2983
2982
  * <p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>
2983
+ * @public
2984
2984
  */
2985
2985
  RecommendationProviderIdType?: string;
2986
2986
  /**
2987
- * @public
2988
2987
  * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>
2988
+ * @public
2989
2989
  */
2990
2990
  RecommendationProviderRoleArn: string | undefined;
2991
2991
  /**
2992
- * @public
2993
2992
  * <p>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</p>
2993
+ * @public
2994
2994
  */
2995
2995
  RecommendationProviderUri: string | undefined;
2996
2996
  /**
2997
- * @public
2998
2997
  * <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</p>
2998
+ * @public
2999
2999
  */
3000
3000
  RecommendationTransformerUri?: string;
3001
3001
  /**
3002
- * @public
3003
3002
  * <p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>
3003
+ * @public
3004
3004
  */
3005
3005
  RecommendationsDisplayName?: string;
3006
3006
  /**
3007
- * @public
3008
3007
  * <p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
3008
+ * @public
3009
3009
  */
3010
3010
  RecommendationsPerMessage?: number;
3011
3011
  }
@@ -3014,13 +3014,13 @@ export interface UpdateRecommenderConfigurationShape {
3014
3014
  */
3015
3015
  export interface UpdateRecommenderConfigurationRequest {
3016
3016
  /**
3017
- * @public
3018
3017
  * <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
3018
+ * @public
3019
3019
  */
3020
3020
  RecommenderId: string | undefined;
3021
3021
  /**
3022
- * @public
3023
3022
  * <p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>
3023
+ * @public
3024
3024
  */
3025
3025
  UpdateRecommenderConfiguration: UpdateRecommenderConfigurationShape | undefined;
3026
3026
  }
@@ -3029,8 +3029,8 @@ export interface UpdateRecommenderConfigurationRequest {
3029
3029
  */
3030
3030
  export interface UpdateRecommenderConfigurationResponse {
3031
3031
  /**
3032
- * @public
3033
3032
  * <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
3033
+ * @public
3034
3034
  */
3035
3035
  RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
3036
3036
  }
@@ -3039,18 +3039,18 @@ export interface UpdateRecommenderConfigurationResponse {
3039
3039
  */
3040
3040
  export interface UpdateSegmentRequest {
3041
3041
  /**
3042
- * @public
3043
3042
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
3043
+ * @public
3044
3044
  */
3045
3045
  ApplicationId: string | undefined;
3046
3046
  /**
3047
- * @public
3048
3047
  * <p>The unique identifier for the segment.</p>
3048
+ * @public
3049
3049
  */
3050
3050
  SegmentId: string | undefined;
3051
3051
  /**
3052
- * @public
3053
3052
  * <p>Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.</p>
3053
+ * @public
3054
3054
  */
3055
3055
  WriteSegmentRequest: WriteSegmentRequest | undefined;
3056
3056
  }
@@ -3059,29 +3059,29 @@ export interface UpdateSegmentRequest {
3059
3059
  */
3060
3060
  export interface UpdateSegmentResponse {
3061
3061
  /**
3062
- * @public
3063
3062
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
3063
+ * @public
3064
3064
  */
3065
3065
  SegmentResponse: SegmentResponse | undefined;
3066
3066
  }
3067
3067
  /**
3068
- * @public
3069
3068
  * <p>Specifies the status and settings of the SMS channel for an application.</p>
3069
+ * @public
3070
3070
  */
3071
3071
  export interface SMSChannelRequest {
3072
3072
  /**
3073
- * @public
3074
3073
  * <p>Specifies whether to enable the SMS channel for the application.</p>
3074
+ * @public
3075
3075
  */
3076
3076
  Enabled?: boolean;
3077
3077
  /**
3078
- * @public
3079
3078
  * <p>The identity that you want to display on recipients' devices when they receive messages from the SMS channel.</p>
3079
+ * @public
3080
3080
  */
3081
3081
  SenderId?: string;
3082
3082
  /**
3083
- * @public
3084
3083
  * <p>The registered short code that you want to use when you send messages through the SMS channel.</p>
3084
+ * @public
3085
3085
  */
3086
3086
  ShortCode?: string;
3087
3087
  }
@@ -3090,13 +3090,13 @@ export interface SMSChannelRequest {
3090
3090
  */
3091
3091
  export interface UpdateSmsChannelRequest {
3092
3092
  /**
3093
- * @public
3094
3093
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
3094
+ * @public
3095
3095
  */
3096
3096
  ApplicationId: string | undefined;
3097
3097
  /**
3098
- * @public
3099
3098
  * <p>Specifies the status and settings of the SMS channel for an application.</p>
3099
+ * @public
3100
3100
  */
3101
3101
  SMSChannelRequest: SMSChannelRequest | undefined;
3102
3102
  }
@@ -3105,8 +3105,8 @@ export interface UpdateSmsChannelRequest {
3105
3105
  */
3106
3106
  export interface UpdateSmsChannelResponse {
3107
3107
  /**
3108
- * @public
3109
3108
  * <p>Provides information about the status and settings of the SMS channel for an application.</p>
3109
+ * @public
3110
3110
  */
3111
3111
  SMSChannelResponse: SMSChannelResponse | undefined;
3112
3112
  }
@@ -3115,23 +3115,23 @@ export interface UpdateSmsChannelResponse {
3115
3115
  */
3116
3116
  export interface UpdateSmsTemplateRequest {
3117
3117
  /**
3118
- * @public
3119
3118
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
3119
+ * @public
3120
3120
  */
3121
3121
  CreateNewVersion?: boolean;
3122
3122
  /**
3123
- * @public
3124
3123
  * <p>Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
3124
+ * @public
3125
3125
  */
3126
3126
  SMSTemplateRequest: SMSTemplateRequest | undefined;
3127
3127
  /**
3128
- * @public
3129
3128
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
3129
+ * @public
3130
3130
  */
3131
3131
  TemplateName: string | undefined;
3132
3132
  /**
3133
- * @public
3134
3133
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
3134
+ * @public
3135
3135
  */
3136
3136
  Version?: string;
3137
3137
  }
@@ -3140,19 +3140,19 @@ export interface UpdateSmsTemplateRequest {
3140
3140
  */
3141
3141
  export interface UpdateSmsTemplateResponse {
3142
3142
  /**
3143
- * @public
3144
3143
  * <p>Provides information about an API request or response.</p>
3144
+ * @public
3145
3145
  */
3146
3146
  MessageBody: MessageBody | undefined;
3147
3147
  }
3148
3148
  /**
3149
- * @public
3150
3149
  * <p>Specifies which version of a message template to use as the active version of the template.</p>
3150
+ * @public
3151
3151
  */
3152
3152
  export interface TemplateActiveVersionRequest {
3153
3153
  /**
3154
- * @public
3155
3154
  * <p>The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p>
3155
+ * @public
3156
3156
  */
3157
3157
  Version?: string;
3158
3158
  }
@@ -3161,18 +3161,18 @@ export interface TemplateActiveVersionRequest {
3161
3161
  */
3162
3162
  export interface UpdateTemplateActiveVersionRequest {
3163
3163
  /**
3164
- * @public
3165
3164
  * <p>Specifies which version of a message template to use as the active version of the template.</p>
3165
+ * @public
3166
3166
  */
3167
3167
  TemplateActiveVersionRequest: TemplateActiveVersionRequest | undefined;
3168
3168
  /**
3169
- * @public
3170
3169
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
3170
+ * @public
3171
3171
  */
3172
3172
  TemplateName: string | undefined;
3173
3173
  /**
3174
- * @public
3175
3174
  * <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
3175
+ * @public
3176
3176
  */
3177
3177
  TemplateType: string | undefined;
3178
3178
  }
@@ -3181,19 +3181,19 @@ export interface UpdateTemplateActiveVersionRequest {
3181
3181
  */
3182
3182
  export interface UpdateTemplateActiveVersionResponse {
3183
3183
  /**
3184
- * @public
3185
3184
  * <p>Provides information about an API request or response.</p>
3185
+ * @public
3186
3186
  */
3187
3187
  MessageBody: MessageBody | undefined;
3188
3188
  }
3189
3189
  /**
3190
- * @public
3191
3190
  * <p>Specifies the status and settings of the voice channel for an application.</p>
3191
+ * @public
3192
3192
  */
3193
3193
  export interface VoiceChannelRequest {
3194
3194
  /**
3195
- * @public
3196
3195
  * <p>Specifies whether to enable the voice channel for the application.</p>
3196
+ * @public
3197
3197
  */
3198
3198
  Enabled?: boolean;
3199
3199
  }
@@ -3202,13 +3202,13 @@ export interface VoiceChannelRequest {
3202
3202
  */
3203
3203
  export interface UpdateVoiceChannelRequest {
3204
3204
  /**
3205
- * @public
3206
3205
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
3206
+ * @public
3207
3207
  */
3208
3208
  ApplicationId: string | undefined;
3209
3209
  /**
3210
- * @public
3211
3210
  * <p>Specifies the status and settings of the voice channel for an application.</p>
3211
+ * @public
3212
3212
  */
3213
3213
  VoiceChannelRequest: VoiceChannelRequest | undefined;
3214
3214
  }
@@ -3217,8 +3217,8 @@ export interface UpdateVoiceChannelRequest {
3217
3217
  */
3218
3218
  export interface UpdateVoiceChannelResponse {
3219
3219
  /**
3220
- * @public
3221
3220
  * <p>Provides information about the status and settings of the voice channel for an application.</p>
3221
+ * @public
3222
3222
  */
3223
3223
  VoiceChannelResponse: VoiceChannelResponse | undefined;
3224
3224
  }
@@ -3227,23 +3227,23 @@ export interface UpdateVoiceChannelResponse {
3227
3227
  */
3228
3228
  export interface UpdateVoiceTemplateRequest {
3229
3229
  /**
3230
- * @public
3231
3230
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
3231
+ * @public
3232
3232
  */
3233
3233
  CreateNewVersion?: boolean;
3234
3234
  /**
3235
- * @public
3236
3235
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
3236
+ * @public
3237
3237
  */
3238
3238
  TemplateName: string | undefined;
3239
3239
  /**
3240
- * @public
3241
3240
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
3241
+ * @public
3242
3242
  */
3243
3243
  Version?: string;
3244
3244
  /**
3245
- * @public
3246
3245
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
3246
+ * @public
3247
3247
  */
3248
3248
  VoiceTemplateRequest: VoiceTemplateRequest | undefined;
3249
3249
  }
@@ -3252,29 +3252,29 @@ export interface UpdateVoiceTemplateRequest {
3252
3252
  */
3253
3253
  export interface UpdateVoiceTemplateResponse {
3254
3254
  /**
3255
- * @public
3256
3255
  * <p>Provides information about an API request or response.</p>
3256
+ * @public
3257
3257
  */
3258
3258
  MessageBody: MessageBody | undefined;
3259
3259
  }
3260
3260
  /**
3261
- * @public
3262
3261
  * <p>Verify OTP message request.</p>
3262
+ * @public
3263
3263
  */
3264
3264
  export interface VerifyOTPMessageRequestParameters {
3265
3265
  /**
3266
- * @public
3267
3266
  * <p>The destination identity to send OTP to.</p>
3267
+ * @public
3268
3268
  */
3269
3269
  DestinationIdentity: string | undefined;
3270
3270
  /**
3271
- * @public
3272
3271
  * <p>The OTP the end user provided for verification.</p>
3272
+ * @public
3273
3273
  */
3274
3274
  Otp: string | undefined;
3275
3275
  /**
3276
- * @public
3277
3276
  * <p>The reference identifier provided when the OTP was previously sent.</p>
3277
+ * @public
3278
3278
  */
3279
3279
  ReferenceId: string | undefined;
3280
3280
  }
@@ -3283,24 +3283,24 @@ export interface VerifyOTPMessageRequestParameters {
3283
3283
  */
3284
3284
  export interface VerifyOTPMessageRequest {
3285
3285
  /**
3286
- * @public
3287
3286
  * <p>The unique ID of your Amazon Pinpoint application.</p>
3287
+ * @public
3288
3288
  */
3289
3289
  ApplicationId: string | undefined;
3290
3290
  /**
3291
- * @public
3292
3291
  * <p>Verify OTP message request.</p>
3292
+ * @public
3293
3293
  */
3294
3294
  VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParameters | undefined;
3295
3295
  }
3296
3296
  /**
3297
- * @public
3298
3297
  * <p>Verify OTP Message Response.</p>
3298
+ * @public
3299
3299
  */
3300
3300
  export interface VerificationResponse {
3301
3301
  /**
3302
- * @public
3303
3302
  * <p>Specifies whether the OTP is valid or not.</p>
3303
+ * @public
3304
3304
  */
3305
3305
  Valid?: boolean;
3306
3306
  }
@@ -3309,8 +3309,8 @@ export interface VerificationResponse {
3309
3309
  */
3310
3310
  export interface VerifyOTPMessageResponse {
3311
3311
  /**
3312
- * @public
3313
3312
  * <p>Verify OTP Message Response.</p>
3313
+ * @public
3314
3314
  */
3315
3315
  VerificationResponse: VerificationResponse | undefined;
3316
3316
  }