@aws-sdk/client-pinpoint-sms-voice-v2 3.61.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 (280) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +201 -0
  3. package/README.md +221 -0
  4. package/dist-cjs/PinpointSMSVoiceV2.js +652 -0
  5. package/dist-cjs/PinpointSMSVoiceV2Client.js +35 -0
  6. package/dist-cjs/commands/AssociateOriginationIdentityCommand.js +36 -0
  7. package/dist-cjs/commands/CreateConfigurationSetCommand.js +36 -0
  8. package/dist-cjs/commands/CreateEventDestinationCommand.js +36 -0
  9. package/dist-cjs/commands/CreateOptOutListCommand.js +36 -0
  10. package/dist-cjs/commands/CreatePoolCommand.js +36 -0
  11. package/dist-cjs/commands/DeleteConfigurationSetCommand.js +36 -0
  12. package/dist-cjs/commands/DeleteDefaultMessageTypeCommand.js +36 -0
  13. package/dist-cjs/commands/DeleteDefaultSenderIdCommand.js +36 -0
  14. package/dist-cjs/commands/DeleteEventDestinationCommand.js +36 -0
  15. package/dist-cjs/commands/DeleteKeywordCommand.js +36 -0
  16. package/dist-cjs/commands/DeleteOptOutListCommand.js +36 -0
  17. package/dist-cjs/commands/DeleteOptedOutNumberCommand.js +36 -0
  18. package/dist-cjs/commands/DeletePoolCommand.js +36 -0
  19. package/dist-cjs/commands/DeleteTextMessageSpendLimitOverrideCommand.js +36 -0
  20. package/dist-cjs/commands/DeleteVoiceMessageSpendLimitOverrideCommand.js +36 -0
  21. package/dist-cjs/commands/DescribeAccountAttributesCommand.js +36 -0
  22. package/dist-cjs/commands/DescribeAccountLimitsCommand.js +36 -0
  23. package/dist-cjs/commands/DescribeConfigurationSetsCommand.js +36 -0
  24. package/dist-cjs/commands/DescribeKeywordsCommand.js +36 -0
  25. package/dist-cjs/commands/DescribeOptOutListsCommand.js +36 -0
  26. package/dist-cjs/commands/DescribeOptedOutNumbersCommand.js +36 -0
  27. package/dist-cjs/commands/DescribePhoneNumbersCommand.js +36 -0
  28. package/dist-cjs/commands/DescribePoolsCommand.js +36 -0
  29. package/dist-cjs/commands/DescribeSenderIdsCommand.js +36 -0
  30. package/dist-cjs/commands/DescribeSpendLimitsCommand.js +36 -0
  31. package/dist-cjs/commands/DisassociateOriginationIdentityCommand.js +36 -0
  32. package/dist-cjs/commands/ListPoolOriginationIdentitiesCommand.js +36 -0
  33. package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
  34. package/dist-cjs/commands/PutKeywordCommand.js +36 -0
  35. package/dist-cjs/commands/PutOptedOutNumberCommand.js +36 -0
  36. package/dist-cjs/commands/ReleasePhoneNumberCommand.js +36 -0
  37. package/dist-cjs/commands/RequestPhoneNumberCommand.js +36 -0
  38. package/dist-cjs/commands/SendTextMessageCommand.js +36 -0
  39. package/dist-cjs/commands/SendVoiceMessageCommand.js +36 -0
  40. package/dist-cjs/commands/SetDefaultMessageTypeCommand.js +36 -0
  41. package/dist-cjs/commands/SetDefaultSenderIdCommand.js +36 -0
  42. package/dist-cjs/commands/SetTextMessageSpendLimitOverrideCommand.js +36 -0
  43. package/dist-cjs/commands/SetVoiceMessageSpendLimitOverrideCommand.js +36 -0
  44. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  45. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  46. package/dist-cjs/commands/UpdateEventDestinationCommand.js +36 -0
  47. package/dist-cjs/commands/UpdatePhoneNumberCommand.js +36 -0
  48. package/dist-cjs/commands/UpdatePoolCommand.js +36 -0
  49. package/dist-cjs/commands/index.js +46 -0
  50. package/dist-cjs/endpoints.js +131 -0
  51. package/dist-cjs/index.js +11 -0
  52. package/dist-cjs/models/PinpointSMSVoiceV2ServiceException.js +11 -0
  53. package/dist-cjs/models/index.js +4 -0
  54. package/dist-cjs/models/models_0.js +1074 -0
  55. package/dist-cjs/pagination/DescribeAccountAttributesPaginator.js +35 -0
  56. package/dist-cjs/pagination/DescribeAccountLimitsPaginator.js +35 -0
  57. package/dist-cjs/pagination/DescribeConfigurationSetsPaginator.js +35 -0
  58. package/dist-cjs/pagination/DescribeKeywordsPaginator.js +35 -0
  59. package/dist-cjs/pagination/DescribeOptOutListsPaginator.js +35 -0
  60. package/dist-cjs/pagination/DescribeOptedOutNumbersPaginator.js +35 -0
  61. package/dist-cjs/pagination/DescribePhoneNumbersPaginator.js +35 -0
  62. package/dist-cjs/pagination/DescribePoolsPaginator.js +35 -0
  63. package/dist-cjs/pagination/DescribeSenderIdsPaginator.js +35 -0
  64. package/dist-cjs/pagination/DescribeSpendLimitsPaginator.js +35 -0
  65. package/dist-cjs/pagination/Interfaces.js +2 -0
  66. package/dist-cjs/pagination/ListPoolOriginationIdentitiesPaginator.js +35 -0
  67. package/dist-cjs/pagination/index.js +15 -0
  68. package/dist-cjs/protocols/Aws_json1_0.js +4247 -0
  69. package/dist-cjs/runtimeConfig.browser.js +45 -0
  70. package/dist-cjs/runtimeConfig.js +50 -0
  71. package/dist-cjs/runtimeConfig.native.js +16 -0
  72. package/dist-cjs/runtimeConfig.shared.js +17 -0
  73. package/dist-es/PinpointSMSVoiceV2.js +655 -0
  74. package/dist-es/PinpointSMSVoiceV2Client.js +37 -0
  75. package/dist-es/commands/AssociateOriginationIdentityCommand.js +39 -0
  76. package/dist-es/commands/CreateConfigurationSetCommand.js +39 -0
  77. package/dist-es/commands/CreateEventDestinationCommand.js +39 -0
  78. package/dist-es/commands/CreateOptOutListCommand.js +39 -0
  79. package/dist-es/commands/CreatePoolCommand.js +39 -0
  80. package/dist-es/commands/DeleteConfigurationSetCommand.js +39 -0
  81. package/dist-es/commands/DeleteDefaultMessageTypeCommand.js +39 -0
  82. package/dist-es/commands/DeleteDefaultSenderIdCommand.js +39 -0
  83. package/dist-es/commands/DeleteEventDestinationCommand.js +39 -0
  84. package/dist-es/commands/DeleteKeywordCommand.js +39 -0
  85. package/dist-es/commands/DeleteOptOutListCommand.js +39 -0
  86. package/dist-es/commands/DeleteOptedOutNumberCommand.js +39 -0
  87. package/dist-es/commands/DeletePoolCommand.js +39 -0
  88. package/dist-es/commands/DeleteTextMessageSpendLimitOverrideCommand.js +39 -0
  89. package/dist-es/commands/DeleteVoiceMessageSpendLimitOverrideCommand.js +39 -0
  90. package/dist-es/commands/DescribeAccountAttributesCommand.js +39 -0
  91. package/dist-es/commands/DescribeAccountLimitsCommand.js +39 -0
  92. package/dist-es/commands/DescribeConfigurationSetsCommand.js +39 -0
  93. package/dist-es/commands/DescribeKeywordsCommand.js +39 -0
  94. package/dist-es/commands/DescribeOptOutListsCommand.js +39 -0
  95. package/dist-es/commands/DescribeOptedOutNumbersCommand.js +39 -0
  96. package/dist-es/commands/DescribePhoneNumbersCommand.js +39 -0
  97. package/dist-es/commands/DescribePoolsCommand.js +39 -0
  98. package/dist-es/commands/DescribeSenderIdsCommand.js +39 -0
  99. package/dist-es/commands/DescribeSpendLimitsCommand.js +39 -0
  100. package/dist-es/commands/DisassociateOriginationIdentityCommand.js +39 -0
  101. package/dist-es/commands/ListPoolOriginationIdentitiesCommand.js +39 -0
  102. package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
  103. package/dist-es/commands/PutKeywordCommand.js +39 -0
  104. package/dist-es/commands/PutOptedOutNumberCommand.js +39 -0
  105. package/dist-es/commands/ReleasePhoneNumberCommand.js +39 -0
  106. package/dist-es/commands/RequestPhoneNumberCommand.js +39 -0
  107. package/dist-es/commands/SendTextMessageCommand.js +39 -0
  108. package/dist-es/commands/SendVoiceMessageCommand.js +39 -0
  109. package/dist-es/commands/SetDefaultMessageTypeCommand.js +39 -0
  110. package/dist-es/commands/SetDefaultSenderIdCommand.js +39 -0
  111. package/dist-es/commands/SetTextMessageSpendLimitOverrideCommand.js +39 -0
  112. package/dist-es/commands/SetVoiceMessageSpendLimitOverrideCommand.js +39 -0
  113. package/dist-es/commands/TagResourceCommand.js +39 -0
  114. package/dist-es/commands/UntagResourceCommand.js +39 -0
  115. package/dist-es/commands/UpdateEventDestinationCommand.js +39 -0
  116. package/dist-es/commands/UpdatePhoneNumberCommand.js +39 -0
  117. package/dist-es/commands/UpdatePoolCommand.js +39 -0
  118. package/dist-es/commands/index.js +43 -0
  119. package/dist-es/endpoints.js +127 -0
  120. package/dist-es/index.js +6 -0
  121. package/dist-es/models/PinpointSMSVoiceV2ServiceException.js +12 -0
  122. package/dist-es/models/index.js +1 -0
  123. package/dist-es/models/models_0.js +841 -0
  124. package/dist-es/pagination/DescribeAccountAttributesPaginator.js +74 -0
  125. package/dist-es/pagination/DescribeAccountLimitsPaginator.js +74 -0
  126. package/dist-es/pagination/DescribeConfigurationSetsPaginator.js +74 -0
  127. package/dist-es/pagination/DescribeKeywordsPaginator.js +74 -0
  128. package/dist-es/pagination/DescribeOptOutListsPaginator.js +74 -0
  129. package/dist-es/pagination/DescribeOptedOutNumbersPaginator.js +74 -0
  130. package/dist-es/pagination/DescribePhoneNumbersPaginator.js +74 -0
  131. package/dist-es/pagination/DescribePoolsPaginator.js +74 -0
  132. package/dist-es/pagination/DescribeSenderIdsPaginator.js +74 -0
  133. package/dist-es/pagination/DescribeSpendLimitsPaginator.js +74 -0
  134. package/dist-es/pagination/Interfaces.js +1 -0
  135. package/dist-es/pagination/ListPoolOriginationIdentitiesPaginator.js +74 -0
  136. package/dist-es/pagination/index.js +12 -0
  137. package/dist-es/protocols/Aws_json1_0.js +4868 -0
  138. package/dist-es/runtimeConfig.browser.js +26 -0
  139. package/dist-es/runtimeConfig.js +28 -0
  140. package/dist-es/runtimeConfig.native.js +8 -0
  141. package/dist-es/runtimeConfig.shared.js +13 -0
  142. package/dist-types/PinpointSMSVoiceV2.d.ts +517 -0
  143. package/dist-types/PinpointSMSVoiceV2Client.d.ts +202 -0
  144. package/dist-types/commands/AssociateOriginationIdentityCommand.d.ts +39 -0
  145. package/dist-types/commands/CreateConfigurationSetCommand.d.ts +39 -0
  146. package/dist-types/commands/CreateEventDestinationCommand.d.ts +43 -0
  147. package/dist-types/commands/CreateOptOutListCommand.d.ts +43 -0
  148. package/dist-types/commands/CreatePoolCommand.d.ts +43 -0
  149. package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +38 -0
  150. package/dist-types/commands/DeleteDefaultMessageTypeCommand.d.ts +40 -0
  151. package/dist-types/commands/DeleteDefaultSenderIdCommand.d.ts +38 -0
  152. package/dist-types/commands/DeleteEventDestinationCommand.d.ts +39 -0
  153. package/dist-types/commands/DeleteKeywordCommand.d.ts +41 -0
  154. package/dist-types/commands/DeleteOptOutListCommand.d.ts +38 -0
  155. package/dist-types/commands/DeleteOptedOutNumberCommand.d.ts +39 -0
  156. package/dist-types/commands/DeletePoolCommand.d.ts +41 -0
  157. package/dist-types/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +39 -0
  158. package/dist-types/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +39 -0
  159. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +41 -0
  160. package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +42 -0
  161. package/dist-types/commands/DescribeConfigurationSetsCommand.d.ts +41 -0
  162. package/dist-types/commands/DescribeKeywordsCommand.d.ts +42 -0
  163. package/dist-types/commands/DescribeOptOutListsCommand.d.ts +40 -0
  164. package/dist-types/commands/DescribeOptedOutNumbersCommand.d.ts +42 -0
  165. package/dist-types/commands/DescribePhoneNumbersCommand.d.ts +41 -0
  166. package/dist-types/commands/DescribePoolsCommand.d.ts +44 -0
  167. package/dist-types/commands/DescribeSenderIdsCommand.d.ts +40 -0
  168. package/dist-types/commands/DescribeSpendLimitsCommand.d.ts +41 -0
  169. package/dist-types/commands/DisassociateOriginationIdentityCommand.d.ts +37 -0
  170. package/dist-types/commands/ListPoolOriginationIdentitiesCommand.d.ts +37 -0
  171. package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
  172. package/dist-types/commands/PutKeywordCommand.d.ts +42 -0
  173. package/dist-types/commands/PutOptedOutNumberCommand.d.ts +37 -0
  174. package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +38 -0
  175. package/dist-types/commands/RequestPhoneNumberCommand.d.ts +37 -0
  176. package/dist-types/commands/SendTextMessageCommand.d.ts +40 -0
  177. package/dist-types/commands/SendVoiceMessageCommand.d.ts +37 -0
  178. package/dist-types/commands/SetDefaultMessageTypeCommand.d.ts +40 -0
  179. package/dist-types/commands/SetDefaultSenderIdCommand.d.ts +38 -0
  180. package/dist-types/commands/SetTextMessageSpendLimitOverrideCommand.d.ts +37 -0
  181. package/dist-types/commands/SetVoiceMessageSpendLimitOverrideCommand.d.ts +37 -0
  182. package/dist-types/commands/TagResourceCommand.d.ts +40 -0
  183. package/dist-types/commands/UntagResourceCommand.d.ts +37 -0
  184. package/dist-types/commands/UpdateEventDestinationCommand.d.ts +40 -0
  185. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +39 -0
  186. package/dist-types/commands/UpdatePoolCommand.d.ts +38 -0
  187. package/dist-types/commands/index.d.ts +43 -0
  188. package/dist-types/endpoints.d.ts +2 -0
  189. package/dist-types/index.d.ts +6 -0
  190. package/dist-types/models/PinpointSMSVoiceV2ServiceException.d.ts +10 -0
  191. package/dist-types/models/index.d.ts +1 -0
  192. package/dist-types/models/models_0.d.ts +3339 -0
  193. package/dist-types/pagination/DescribeAccountAttributesPaginator.d.ts +4 -0
  194. package/dist-types/pagination/DescribeAccountLimitsPaginator.d.ts +4 -0
  195. package/dist-types/pagination/DescribeConfigurationSetsPaginator.d.ts +4 -0
  196. package/dist-types/pagination/DescribeKeywordsPaginator.d.ts +4 -0
  197. package/dist-types/pagination/DescribeOptOutListsPaginator.d.ts +4 -0
  198. package/dist-types/pagination/DescribeOptedOutNumbersPaginator.d.ts +4 -0
  199. package/dist-types/pagination/DescribePhoneNumbersPaginator.d.ts +4 -0
  200. package/dist-types/pagination/DescribePoolsPaginator.d.ts +4 -0
  201. package/dist-types/pagination/DescribeSenderIdsPaginator.d.ts +4 -0
  202. package/dist-types/pagination/DescribeSpendLimitsPaginator.d.ts +4 -0
  203. package/dist-types/pagination/Interfaces.d.ts +6 -0
  204. package/dist-types/pagination/ListPoolOriginationIdentitiesPaginator.d.ts +4 -0
  205. package/dist-types/pagination/index.d.ts +12 -0
  206. package/dist-types/protocols/Aws_json1_0.d.ts +131 -0
  207. package/dist-types/runtimeConfig.browser.d.ts +40 -0
  208. package/dist-types/runtimeConfig.d.ts +40 -0
  209. package/dist-types/runtimeConfig.native.d.ts +39 -0
  210. package/dist-types/runtimeConfig.shared.d.ts +13 -0
  211. package/dist-types/ts3.4/PinpointSMSVoiceV2.d.ts +220 -0
  212. package/dist-types/ts3.4/PinpointSMSVoiceV2Client.d.ts +116 -0
  213. package/dist-types/ts3.4/commands/AssociateOriginationIdentityCommand.d.ts +17 -0
  214. package/dist-types/ts3.4/commands/CreateConfigurationSetCommand.d.ts +17 -0
  215. package/dist-types/ts3.4/commands/CreateEventDestinationCommand.d.ts +17 -0
  216. package/dist-types/ts3.4/commands/CreateOptOutListCommand.d.ts +17 -0
  217. package/dist-types/ts3.4/commands/CreatePoolCommand.d.ts +17 -0
  218. package/dist-types/ts3.4/commands/DeleteConfigurationSetCommand.d.ts +17 -0
  219. package/dist-types/ts3.4/commands/DeleteDefaultMessageTypeCommand.d.ts +17 -0
  220. package/dist-types/ts3.4/commands/DeleteDefaultSenderIdCommand.d.ts +17 -0
  221. package/dist-types/ts3.4/commands/DeleteEventDestinationCommand.d.ts +17 -0
  222. package/dist-types/ts3.4/commands/DeleteKeywordCommand.d.ts +17 -0
  223. package/dist-types/ts3.4/commands/DeleteOptOutListCommand.d.ts +17 -0
  224. package/dist-types/ts3.4/commands/DeleteOptedOutNumberCommand.d.ts +17 -0
  225. package/dist-types/ts3.4/commands/DeletePoolCommand.d.ts +17 -0
  226. package/dist-types/ts3.4/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +17 -0
  227. package/dist-types/ts3.4/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +17 -0
  228. package/dist-types/ts3.4/commands/DescribeAccountAttributesCommand.d.ts +17 -0
  229. package/dist-types/ts3.4/commands/DescribeAccountLimitsCommand.d.ts +17 -0
  230. package/dist-types/ts3.4/commands/DescribeConfigurationSetsCommand.d.ts +17 -0
  231. package/dist-types/ts3.4/commands/DescribeKeywordsCommand.d.ts +17 -0
  232. package/dist-types/ts3.4/commands/DescribeOptOutListsCommand.d.ts +17 -0
  233. package/dist-types/ts3.4/commands/DescribeOptedOutNumbersCommand.d.ts +17 -0
  234. package/dist-types/ts3.4/commands/DescribePhoneNumbersCommand.d.ts +17 -0
  235. package/dist-types/ts3.4/commands/DescribePoolsCommand.d.ts +17 -0
  236. package/dist-types/ts3.4/commands/DescribeSenderIdsCommand.d.ts +17 -0
  237. package/dist-types/ts3.4/commands/DescribeSpendLimitsCommand.d.ts +17 -0
  238. package/dist-types/ts3.4/commands/DisassociateOriginationIdentityCommand.d.ts +17 -0
  239. package/dist-types/ts3.4/commands/ListPoolOriginationIdentitiesCommand.d.ts +17 -0
  240. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  241. package/dist-types/ts3.4/commands/PutKeywordCommand.d.ts +17 -0
  242. package/dist-types/ts3.4/commands/PutOptedOutNumberCommand.d.ts +17 -0
  243. package/dist-types/ts3.4/commands/ReleasePhoneNumberCommand.d.ts +17 -0
  244. package/dist-types/ts3.4/commands/RequestPhoneNumberCommand.d.ts +17 -0
  245. package/dist-types/ts3.4/commands/SendTextMessageCommand.d.ts +17 -0
  246. package/dist-types/ts3.4/commands/SendVoiceMessageCommand.d.ts +17 -0
  247. package/dist-types/ts3.4/commands/SetDefaultMessageTypeCommand.d.ts +17 -0
  248. package/dist-types/ts3.4/commands/SetDefaultSenderIdCommand.d.ts +17 -0
  249. package/dist-types/ts3.4/commands/SetTextMessageSpendLimitOverrideCommand.d.ts +17 -0
  250. package/dist-types/ts3.4/commands/SetVoiceMessageSpendLimitOverrideCommand.d.ts +17 -0
  251. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  252. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  253. package/dist-types/ts3.4/commands/UpdateEventDestinationCommand.d.ts +17 -0
  254. package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +17 -0
  255. package/dist-types/ts3.4/commands/UpdatePoolCommand.d.ts +17 -0
  256. package/dist-types/ts3.4/commands/index.d.ts +43 -0
  257. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  258. package/dist-types/ts3.4/index.d.ts +6 -0
  259. package/dist-types/ts3.4/models/PinpointSMSVoiceV2ServiceException.d.ts +6 -0
  260. package/dist-types/ts3.4/models/index.d.ts +1 -0
  261. package/dist-types/ts3.4/models/models_0.d.ts +1883 -0
  262. package/dist-types/ts3.4/pagination/DescribeAccountAttributesPaginator.d.ts +4 -0
  263. package/dist-types/ts3.4/pagination/DescribeAccountLimitsPaginator.d.ts +4 -0
  264. package/dist-types/ts3.4/pagination/DescribeConfigurationSetsPaginator.d.ts +4 -0
  265. package/dist-types/ts3.4/pagination/DescribeKeywordsPaginator.d.ts +4 -0
  266. package/dist-types/ts3.4/pagination/DescribeOptOutListsPaginator.d.ts +4 -0
  267. package/dist-types/ts3.4/pagination/DescribeOptedOutNumbersPaginator.d.ts +4 -0
  268. package/dist-types/ts3.4/pagination/DescribePhoneNumbersPaginator.d.ts +4 -0
  269. package/dist-types/ts3.4/pagination/DescribePoolsPaginator.d.ts +4 -0
  270. package/dist-types/ts3.4/pagination/DescribeSenderIdsPaginator.d.ts +4 -0
  271. package/dist-types/ts3.4/pagination/DescribeSpendLimitsPaginator.d.ts +4 -0
  272. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  273. package/dist-types/ts3.4/pagination/ListPoolOriginationIdentitiesPaginator.d.ts +4 -0
  274. package/dist-types/ts3.4/pagination/index.d.ts +12 -0
  275. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +131 -0
  276. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
  277. package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
  278. package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
  279. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
  280. package/package.json +95 -0
@@ -0,0 +1,3339 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { PinpointSMSVoiceV2ServiceException as __BaseException } from "./PinpointSMSVoiceV2ServiceException";
3
+ export declare enum AccessDeniedExceptionReason {
4
+ ACCOUNT_DISABLED = "ACCOUNT_DISABLED",
5
+ INSUFFICIENT_ACCOUNT_REPUTATION = "INSUFFICIENT_ACCOUNT_REPUTATION"
6
+ }
7
+ /**
8
+ * <p>The request was denied because you don't have sufficient permissions to access the
9
+ * resource.</p>
10
+ */
11
+ export declare class AccessDeniedException extends __BaseException {
12
+ readonly name: "AccessDeniedException";
13
+ readonly $fault: "client";
14
+ Message?: string;
15
+ /**
16
+ * <p>The reason for the exception.</p>
17
+ */
18
+ Reason?: AccessDeniedExceptionReason | string;
19
+ /**
20
+ * @internal
21
+ */
22
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
23
+ }
24
+ export declare enum AccountAttributeName {
25
+ ACCOUNT_TIER = "ACCOUNT_TIER"
26
+ }
27
+ /**
28
+ * <p>Displays the attributes associated with a single Amazon Web Services account.</p>
29
+ */
30
+ export interface AccountAttribute {
31
+ /**
32
+ * <p>The name of the account attribute.</p>
33
+ */
34
+ Name: AccountAttributeName | string | undefined;
35
+ /**
36
+ * <p>The value associated with the account attribute name.</p>
37
+ */
38
+ Value: string | undefined;
39
+ }
40
+ export declare namespace AccountAttribute {
41
+ /**
42
+ * @internal
43
+ */
44
+ const filterSensitiveLog: (obj: AccountAttribute) => any;
45
+ }
46
+ export declare enum AccountLimitName {
47
+ CONFIGURATION_SETS = "CONFIGURATION_SETS",
48
+ OPT_OUT_LISTS = "OPT_OUT_LISTS",
49
+ PHONE_NUMBERS = "PHONE_NUMBERS",
50
+ POOLS = "POOLS"
51
+ }
52
+ /**
53
+ * <p>The current resource quotas associated with an Amazon Web Services account.</p>
54
+ */
55
+ export interface AccountLimit {
56
+ /**
57
+ * <p>The name of the attribute to apply the account limit to.</p>
58
+ */
59
+ Name: AccountLimitName | string | undefined;
60
+ /**
61
+ * <p>The current amount that has been spent, in US dollars.</p>
62
+ */
63
+ Used: number | undefined;
64
+ /**
65
+ * <p>The Amazon Web Services set limit for that resource type, in US dollars.</p>
66
+ */
67
+ Max: number | undefined;
68
+ }
69
+ export declare namespace AccountLimit {
70
+ /**
71
+ * @internal
72
+ */
73
+ const filterSensitiveLog: (obj: AccountLimit) => any;
74
+ }
75
+ export interface AssociateOriginationIdentityRequest {
76
+ /**
77
+ * <p>The pool to update with the new Identity. This value can be either the PoolId or
78
+ * PoolArn, and you can find these values using <a>DescribePools</a>.</p>
79
+ */
80
+ PoolId: string | undefined;
81
+ /**
82
+ * <p>The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or
83
+ * SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for
84
+ * PhoneNumberId and PhoneNumberArn, while <a>DescribeSenderIds</a> can be used
85
+ * to get the values for SenderId and SenderIdArn.</p>
86
+ */
87
+ OriginationIdentity: string | undefined;
88
+ /**
89
+ * <p>The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of
90
+ * the origination identity.</p>
91
+ */
92
+ IsoCountryCode: string | undefined;
93
+ /**
94
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
95
+ * request. If you don't specify a client token, a randomly generated token is used for the
96
+ * request to ensure idempotency.</p>
97
+ */
98
+ ClientToken?: string;
99
+ }
100
+ export declare namespace AssociateOriginationIdentityRequest {
101
+ /**
102
+ * @internal
103
+ */
104
+ const filterSensitiveLog: (obj: AssociateOriginationIdentityRequest) => any;
105
+ }
106
+ export interface AssociateOriginationIdentityResult {
107
+ /**
108
+ * <p>The Amazon Resource Name (ARN) of the pool that is now associated with the origination
109
+ * identity.</p>
110
+ */
111
+ PoolArn?: string;
112
+ /**
113
+ * <p>The PoolId of the pool that is now associated with the origination identity.</p>
114
+ */
115
+ PoolId?: string;
116
+ /**
117
+ * <p>The PhoneNumberArn or SenderIdArn of the origination identity.</p>
118
+ */
119
+ OriginationIdentityArn?: string;
120
+ /**
121
+ * <p>The PhoneNumberId or SenderId of the origination identity.</p>
122
+ */
123
+ OriginationIdentity?: string;
124
+ /**
125
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
126
+ * </p>
127
+ */
128
+ IsoCountryCode?: string;
129
+ }
130
+ export declare namespace AssociateOriginationIdentityResult {
131
+ /**
132
+ * @internal
133
+ */
134
+ const filterSensitiveLog: (obj: AssociateOriginationIdentityResult) => any;
135
+ }
136
+ export declare enum ConflictExceptionReason {
137
+ DELETION_PROTECTION_ENABLED = "DELETION_PROTECTION_ENABLED",
138
+ DESTINATION_PHONE_NUMBER_NOT_VERIFIED = "DESTINATION_PHONE_NUMBER_NOT_VERIFIED",
139
+ DESTINATION_PHONE_NUMBER_OPTED_OUT = "DESTINATION_PHONE_NUMBER_OPTED_OUT",
140
+ EVENT_DESTINATION_MISMATCH = "EVENT_DESTINATION_MISMATCH",
141
+ KEYWORD_MISMATCH = "KEYWORD_MISMATCH",
142
+ LAST_PHONE_NUMBER = "LAST_PHONE_NUMBER",
143
+ MESSAGE_TYPE_MISMATCH = "MESSAGE_TYPE_MISMATCH",
144
+ NO_ORIGINATION_IDENTITIES_FOUND = "NO_ORIGINATION_IDENTITIES_FOUND",
145
+ OPT_OUT_LIST_MISMATCH = "OPT_OUT_LIST_MISMATCH",
146
+ PHONE_NUMBER_ASSOCIATED_TO_POOL = "PHONE_NUMBER_ASSOCIATED_TO_POOL",
147
+ PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL = "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL",
148
+ PHONE_NUMBER_NOT_IN_REGISTRATION_REGION = "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION",
149
+ RESOURCE_ALREADY_EXISTS = "RESOURCE_ALREADY_EXISTS",
150
+ RESOURCE_DELETION_NOT_ALLOWED = "RESOURCE_DELETION_NOT_ALLOWED",
151
+ RESOURCE_MODIFICATION_NOT_ALLOWED = "RESOURCE_MODIFICATION_NOT_ALLOWED",
152
+ RESOURCE_NOT_ACTIVE = "RESOURCE_NOT_ACTIVE",
153
+ RESOURCE_NOT_EMPTY = "RESOURCE_NOT_EMPTY",
154
+ SELF_MANAGED_OPT_OUTS_MISMATCH = "SELF_MANAGED_OPT_OUTS_MISMATCH",
155
+ TWO_WAY_CONFIG_MISMATCH = "TWO_WAY_CONFIG_MISMATCH"
156
+ }
157
+ export declare enum ResourceType {
158
+ ACCOUNT = "account",
159
+ CONFIGURATION_SET = "configuration-set",
160
+ EVENT_DESTINATION = "event-destination",
161
+ KEYWORD = "keyword",
162
+ OPTED_OUT_NUMBER = "opted-out-number",
163
+ OPT_OUT_LIST = "opt-out-list",
164
+ PHONE_NUMBER = "phone-number",
165
+ POOL = "pool",
166
+ REGISTRATION = "registration",
167
+ SENDER_ID = "sender-id"
168
+ }
169
+ /**
170
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform
171
+ * more than one operation on the same resource at the same time or it could be that the
172
+ * requested action isn't valid for the current state or configuration of the
173
+ * resource.</p>
174
+ */
175
+ export declare class ConflictException extends __BaseException {
176
+ readonly name: "ConflictException";
177
+ readonly $fault: "client";
178
+ Message?: string;
179
+ /**
180
+ * <p>The reason for the exception.</p>
181
+ */
182
+ Reason?: ConflictExceptionReason | string;
183
+ /**
184
+ * <p>The type of resource that caused the exception.</p>
185
+ */
186
+ ResourceType?: ResourceType | string;
187
+ /**
188
+ * <p>The unique identifier of the request.</p>
189
+ */
190
+ ResourceId?: string;
191
+ /**
192
+ * @internal
193
+ */
194
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
195
+ }
196
+ /**
197
+ * <p>The API encountered an unexpected error and couldn't complete the request. You might
198
+ * be able to successfully issue the request again in the future.</p>
199
+ */
200
+ export declare class InternalServerException extends __BaseException {
201
+ readonly name: "InternalServerException";
202
+ readonly $fault: "server";
203
+ $retryable: {};
204
+ Message?: string;
205
+ /**
206
+ * <p>The unique identifier of the request.</p>
207
+ */
208
+ RequestId?: string;
209
+ /**
210
+ * @internal
211
+ */
212
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
213
+ }
214
+ /**
215
+ * <p>A requested resource couldn't be found.</p>
216
+ */
217
+ export declare class ResourceNotFoundException extends __BaseException {
218
+ readonly name: "ResourceNotFoundException";
219
+ readonly $fault: "client";
220
+ Message?: string;
221
+ /**
222
+ * <p>The type of resource that caused the exception.</p>
223
+ */
224
+ ResourceType?: ResourceType | string;
225
+ /**
226
+ * <p>The unique identifier of the resource.</p>
227
+ */
228
+ ResourceId?: string;
229
+ /**
230
+ * @internal
231
+ */
232
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
233
+ }
234
+ export declare enum ServiceQuotaExceededExceptionReason {
235
+ CONFIGURATION_SETS_PER_ACCOUNT = "CONFIGURATION_SETS_PER_ACCOUNT",
236
+ DAILY_DESTINATION_CALL_LIMIT = "DAILY_DESTINATION_CALL_LIMIT",
237
+ EVENT_DESTINATIONS_PER_CONFIGURATION_SET = "EVENT_DESTINATIONS_PER_CONFIGURATION_SET",
238
+ KEYWORDS_PER_PHONE_NUMBER = "KEYWORDS_PER_PHONE_NUMBER",
239
+ KEYWORDS_PER_POOL = "KEYWORDS_PER_POOL",
240
+ MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT = "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT",
241
+ MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE = "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE",
242
+ OPT_OUT_LISTS_PER_ACCOUNT = "OPT_OUT_LISTS_PER_ACCOUNT",
243
+ ORIGINATION_IDENTITIES_PER_POOL = "ORIGINATION_IDENTITIES_PER_POOL",
244
+ PHONE_NUMBERS_PER_ACCOUNT = "PHONE_NUMBERS_PER_ACCOUNT",
245
+ PHONE_NUMBERS_PER_REGISTRATION = "PHONE_NUMBERS_PER_REGISTRATION",
246
+ POOLS_PER_ACCOUNT = "POOLS_PER_ACCOUNT",
247
+ TAGS_PER_RESOURCE = "TAGS_PER_RESOURCE"
248
+ }
249
+ /**
250
+ * <p>The request would cause a service quota to be exceeded.</p>
251
+ */
252
+ export declare class ServiceQuotaExceededException extends __BaseException {
253
+ readonly name: "ServiceQuotaExceededException";
254
+ readonly $fault: "client";
255
+ Message?: string;
256
+ /**
257
+ * <p>The reason for the exception.</p>
258
+ */
259
+ Reason?: ServiceQuotaExceededExceptionReason | string;
260
+ /**
261
+ * @internal
262
+ */
263
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
264
+ }
265
+ /**
266
+ * <p>An error that occurred because too many requests were sent during a certain amount of
267
+ * time.</p>
268
+ */
269
+ export declare class ThrottlingException extends __BaseException {
270
+ readonly name: "ThrottlingException";
271
+ readonly $fault: "client";
272
+ $retryable: {
273
+ throttling: boolean;
274
+ };
275
+ Message?: string;
276
+ /**
277
+ * @internal
278
+ */
279
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
280
+ }
281
+ /**
282
+ * <p>The field associated with the validation exception.</p>
283
+ */
284
+ export interface ValidationExceptionField {
285
+ /**
286
+ * <p>The name of the field.</p>
287
+ */
288
+ Name: string | undefined;
289
+ /**
290
+ * <p>The message associated with the validation exception with information to help
291
+ * determine its cause.</p>
292
+ */
293
+ Message: string | undefined;
294
+ }
295
+ export declare namespace ValidationExceptionField {
296
+ /**
297
+ * @internal
298
+ */
299
+ const filterSensitiveLog: (obj: ValidationExceptionField) => any;
300
+ }
301
+ export declare enum ValidationExceptionReason {
302
+ CANNOT_ADD_OPTED_OUT_NUMBER = "CANNOT_ADD_OPTED_OUT_NUMBER",
303
+ CANNOT_PARSE = "CANNOT_PARSE",
304
+ COUNTRY_CODE_MISMATCH = "COUNTRY_CODE_MISMATCH",
305
+ DESTINATION_COUNTRY_BLOCKED = "DESTINATION_COUNTRY_BLOCKED",
306
+ FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
307
+ INVALID_ARN = "INVALID_ARN",
308
+ INVALID_FILTER_VALUES = "INVALID_FILTER_VALUES",
309
+ INVALID_IDENTITY_FOR_DESTINATION_COUNTRY = "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY",
310
+ INVALID_NEXT_TOKEN = "INVALID_NEXT_TOKEN",
311
+ INVALID_PARAMETER = "INVALID_PARAMETER",
312
+ MISSING_PARAMETER = "MISSING_PARAMETER",
313
+ OTHER = "OTHER",
314
+ PARAMETERS_CANNOT_BE_USED_TOGETHER = "PARAMETERS_CANNOT_BE_USED_TOGETHER",
315
+ PHONE_NUMBER_CANNOT_BE_OPTED_IN = "PHONE_NUMBER_CANNOT_BE_OPTED_IN",
316
+ PHONE_NUMBER_CANNOT_BE_RELEASED = "PHONE_NUMBER_CANNOT_BE_RELEASED",
317
+ PRICE_OVER_THRESHOLD = "PRICE_OVER_THRESHOLD",
318
+ REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT = "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT",
319
+ SENDER_ID_NOT_REGISTERED = "SENDER_ID_NOT_REGISTERED",
320
+ SENDER_ID_NOT_SUPPORTED = "SENDER_ID_NOT_SUPPORTED",
321
+ TWO_WAY_NOT_ENABLED = "TWO_WAY_NOT_ENABLED",
322
+ TWO_WAY_NOT_SUPPORTED_IN_COUNTRY = "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY",
323
+ TWO_WAY_NOT_SUPPORTED_IN_REGION = "TWO_WAY_NOT_SUPPORTED_IN_REGION",
324
+ TWO_WAY_TOPIC_NOT_PRESENT = "TWO_WAY_TOPIC_NOT_PRESENT",
325
+ UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
326
+ }
327
+ /**
328
+ * <p>A validation exception for a field.</p>
329
+ */
330
+ export declare class ValidationException extends __BaseException {
331
+ readonly name: "ValidationException";
332
+ readonly $fault: "client";
333
+ Message?: string;
334
+ /**
335
+ * <p>The reason for the exception.</p>
336
+ */
337
+ Reason?: ValidationExceptionReason | string;
338
+ /**
339
+ * <p>The field that failed validation.</p>
340
+ */
341
+ Fields?: ValidationExceptionField[];
342
+ /**
343
+ * @internal
344
+ */
345
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
346
+ }
347
+ /**
348
+ * <p>Contains the destination configuration to use when publishing message sending events.
349
+ * </p>
350
+ */
351
+ export interface CloudWatchLogsDestination {
352
+ /**
353
+ * <p>The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role
354
+ * that is able to write event data to an Amazon CloudWatch destination.</p>
355
+ */
356
+ IamRoleArn: string | undefined;
357
+ /**
358
+ * <p>The name of the Amazon CloudWatch log group that you want to record events in. </p>
359
+ */
360
+ LogGroupArn: string | undefined;
361
+ }
362
+ export declare namespace CloudWatchLogsDestination {
363
+ /**
364
+ * @internal
365
+ */
366
+ const filterSensitiveLog: (obj: CloudWatchLogsDestination) => any;
367
+ }
368
+ export declare enum ConfigurationSetFilterName {
369
+ DEFAULT_MESSAGE_TYPE = "default-message-type",
370
+ DEFAULT_SENDER_ID = "default-sender-id",
371
+ EVENT_DESTINATION_NAME = "event-destination-name",
372
+ MATCHING_EVENT_TYPES = "matching-event-types"
373
+ }
374
+ /**
375
+ * <p>The information for configuration sets that meet a specified criteria.</p>
376
+ */
377
+ export interface ConfigurationSetFilter {
378
+ /**
379
+ * <p>The name of the attribute to filter on.</p>
380
+ */
381
+ Name: ConfigurationSetFilterName | string | undefined;
382
+ /**
383
+ * <p>An array values to filter for.</p>
384
+ */
385
+ Values: string[] | undefined;
386
+ }
387
+ export declare namespace ConfigurationSetFilter {
388
+ /**
389
+ * @internal
390
+ */
391
+ const filterSensitiveLog: (obj: ConfigurationSetFilter) => any;
392
+ }
393
+ export declare enum MessageType {
394
+ PROMOTIONAL = "PROMOTIONAL",
395
+ TRANSACTIONAL = "TRANSACTIONAL"
396
+ }
397
+ /**
398
+ * <p>Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event
399
+ * destination.</p>
400
+ * <p>Event destinations, such as Kinesis Data Firehose, are associated with configuration
401
+ * sets, which enable you to publish message sending events.</p>
402
+ */
403
+ export interface KinesisFirehoseDestination {
404
+ /**
405
+ * <p>The ARN of an Amazon Identity and Access Management (IAM) role that is able to write
406
+ * event data to an Amazon Firehose destination.</p>
407
+ */
408
+ IamRoleArn: string | undefined;
409
+ /**
410
+ * <p>The Amazon Resource Name (ARN) of the delivery stream.</p>
411
+ */
412
+ DeliveryStreamArn: string | undefined;
413
+ }
414
+ export declare namespace KinesisFirehoseDestination {
415
+ /**
416
+ * @internal
417
+ */
418
+ const filterSensitiveLog: (obj: KinesisFirehoseDestination) => any;
419
+ }
420
+ export declare enum EventType {
421
+ ALL = "ALL",
422
+ TEXT_ALL = "TEXT_ALL",
423
+ TEXT_BLOCKED = "TEXT_BLOCKED",
424
+ TEXT_CARRIER_BLOCKED = "TEXT_CARRIER_BLOCKED",
425
+ TEXT_CARRIER_UNREACHABLE = "TEXT_CARRIER_UNREACHABLE",
426
+ TEXT_DELIVERED = "TEXT_DELIVERED",
427
+ TEXT_INVALID = "TEXT_INVALID",
428
+ TEXT_INVALID_MESSAGE = "TEXT_INVALID_MESSAGE",
429
+ TEXT_PENDING = "TEXT_PENDING",
430
+ TEXT_QUEUED = "TEXT_QUEUED",
431
+ TEXT_SENT = "TEXT_SENT",
432
+ TEXT_SPAM = "TEXT_SPAM",
433
+ TEXT_SUCCESSFUL = "TEXT_SUCCESSFUL",
434
+ TEXT_TTL_EXPIRED = "TEXT_TTL_EXPIRED",
435
+ TEXT_UNKNOWN = "TEXT_UNKNOWN",
436
+ TEXT_UNREACHABLE = "TEXT_UNREACHABLE",
437
+ VOICE_ALL = "VOICE_ALL",
438
+ VOICE_ANSWERED = "VOICE_ANSWERED",
439
+ VOICE_BUSY = "VOICE_BUSY",
440
+ VOICE_COMPLETED = "VOICE_COMPLETED",
441
+ VOICE_FAILED = "VOICE_FAILED",
442
+ VOICE_INITIATED = "VOICE_INITIATED",
443
+ VOICE_NO_ANSWER = "VOICE_NO_ANSWER",
444
+ VOICE_RINGING = "VOICE_RINGING",
445
+ VOICE_TTL_EXPIRED = "VOICE_TTL_EXPIRED"
446
+ }
447
+ /**
448
+ * <p>An object that defines an Amazon SNS destination for events. You can use
449
+ * Amazon SNS to send notification when certain events occur.</p>
450
+ */
451
+ export interface SnsDestination {
452
+ /**
453
+ * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to
454
+ * publish events to.</p>
455
+ */
456
+ TopicArn: string | undefined;
457
+ }
458
+ export declare namespace SnsDestination {
459
+ /**
460
+ * @internal
461
+ */
462
+ const filterSensitiveLog: (obj: SnsDestination) => any;
463
+ }
464
+ /**
465
+ * <p>Contains information about an event destination.</p>
466
+ * <p>Event destinations are associated with configuration sets, which enable you to publish
467
+ * message sending events to
468
+ * Amazon
469
+ * CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.</p>
470
+ */
471
+ export interface EventDestination {
472
+ /**
473
+ * <p>The name of the EventDestination.</p>
474
+ */
475
+ EventDestinationName: string | undefined;
476
+ /**
477
+ * <p>When set to true events will be logged.</p>
478
+ */
479
+ Enabled: boolean | undefined;
480
+ /**
481
+ * <p>An array of event types that determine which events to log.</p>
482
+ */
483
+ MatchingEventTypes: (EventType | string)[] | undefined;
484
+ /**
485
+ * <p>An object that contains information about an event destination that sends logging
486
+ * events to Amazon CloudWatch logs.</p>
487
+ */
488
+ CloudWatchLogsDestination?: CloudWatchLogsDestination;
489
+ /**
490
+ * <p>An object that contains information about an event destination for logging to Amazon
491
+ * Kinesis Data Firehose.</p>
492
+ */
493
+ KinesisFirehoseDestination?: KinesisFirehoseDestination;
494
+ /**
495
+ * <p>An object that contains information about an event destination that sends logging
496
+ * events to Amazon SNS.</p>
497
+ */
498
+ SnsDestination?: SnsDestination;
499
+ }
500
+ export declare namespace EventDestination {
501
+ /**
502
+ * @internal
503
+ */
504
+ const filterSensitiveLog: (obj: EventDestination) => any;
505
+ }
506
+ /**
507
+ * <p>Information related to a given configuration set in your Amazon Web Services
508
+ * account.</p>
509
+ */
510
+ export interface ConfigurationSetInformation {
511
+ /**
512
+ * <p>The Resource Name (ARN) of the ConfigurationSet.</p>
513
+ */
514
+ ConfigurationSetArn: string | undefined;
515
+ /**
516
+ * <p>The name of the ConfigurationSet.</p>
517
+ */
518
+ ConfigurationSetName: string | undefined;
519
+ /**
520
+ * <p>An array of EventDestination objects that describe any events to log and where to log
521
+ * them.</p>
522
+ */
523
+ EventDestinations: EventDestination[] | undefined;
524
+ /**
525
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
526
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
527
+ * time-sensitive.</p>
528
+ */
529
+ DefaultMessageType?: MessageType | string;
530
+ /**
531
+ * <p>The default sender ID used by the ConfigurationSet.</p>
532
+ */
533
+ DefaultSenderId?: string;
534
+ /**
535
+ * <p>The time when the ConfigurationSet was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
536
+ */
537
+ CreatedTimestamp: Date | undefined;
538
+ }
539
+ export declare namespace ConfigurationSetInformation {
540
+ /**
541
+ * @internal
542
+ */
543
+ const filterSensitiveLog: (obj: ConfigurationSetInformation) => any;
544
+ }
545
+ /**
546
+ * <p>The list of tags to be added to the specified topic.</p>
547
+ */
548
+ export interface Tag {
549
+ /**
550
+ * <p>The key identifier, or name, of the tag.</p>
551
+ */
552
+ Key: string | undefined;
553
+ /**
554
+ * <p>The string value associated with the key of the tag.</p>
555
+ */
556
+ Value: string | undefined;
557
+ }
558
+ export declare namespace Tag {
559
+ /**
560
+ * @internal
561
+ */
562
+ const filterSensitiveLog: (obj: Tag) => any;
563
+ }
564
+ export interface CreateConfigurationSetRequest {
565
+ /**
566
+ * <p>The name to use for the new configuration set.</p>
567
+ */
568
+ ConfigurationSetName: string | undefined;
569
+ /**
570
+ * <p>An array of key and value pair tags that's associated with the new configuration set. </p>
571
+ */
572
+ Tags?: Tag[];
573
+ /**
574
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
575
+ * request. If you don't specify a client token, a randomly generated token is used for the
576
+ * request to ensure idempotency.</p>
577
+ */
578
+ ClientToken?: string;
579
+ }
580
+ export declare namespace CreateConfigurationSetRequest {
581
+ /**
582
+ * @internal
583
+ */
584
+ const filterSensitiveLog: (obj: CreateConfigurationSetRequest) => any;
585
+ }
586
+ export interface CreateConfigurationSetResult {
587
+ /**
588
+ * <p>The Amazon Resource Name (ARN) of the newly created configuration set.</p>
589
+ */
590
+ ConfigurationSetArn?: string;
591
+ /**
592
+ * <p>The name of the new configuration set.</p>
593
+ */
594
+ ConfigurationSetName?: string;
595
+ /**
596
+ * <p>An array of key and value pair tags that's associated with the configuration
597
+ * set.</p>
598
+ */
599
+ Tags?: Tag[];
600
+ /**
601
+ * <p>The time when the configuration set was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
602
+ */
603
+ CreatedTimestamp?: Date;
604
+ }
605
+ export declare namespace CreateConfigurationSetResult {
606
+ /**
607
+ * @internal
608
+ */
609
+ const filterSensitiveLog: (obj: CreateConfigurationSetResult) => any;
610
+ }
611
+ export interface CreateEventDestinationRequest {
612
+ /**
613
+ * <p>Either the name of the configuration set or the configuration set ARN to apply event
614
+ * logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the <a>DescribeConfigurationSets</a> action.</p>
615
+ */
616
+ ConfigurationSetName: string | undefined;
617
+ /**
618
+ * <p>The name that identifies the event destination.</p>
619
+ */
620
+ EventDestinationName: string | undefined;
621
+ /**
622
+ * <p>An array of event types that determine which events to log. If "ALL" is used, then
623
+ * Amazon Pinpoint logs every event type.</p>
624
+ */
625
+ MatchingEventTypes: (EventType | string)[] | undefined;
626
+ /**
627
+ * <p>An object that contains information about an event destination for logging to Amazon
628
+ * CloudWatch logs.</p>
629
+ */
630
+ CloudWatchLogsDestination?: CloudWatchLogsDestination;
631
+ /**
632
+ * <p>An object that contains information about an event destination for logging to Amazon
633
+ * Kinesis Data Firehose.</p>
634
+ */
635
+ KinesisFirehoseDestination?: KinesisFirehoseDestination;
636
+ /**
637
+ * <p>An object that contains information about an event destination for logging to Amazon SNS.</p>
638
+ */
639
+ SnsDestination?: SnsDestination;
640
+ /**
641
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
642
+ * request. If you don't specify a client token, a randomly generated token is used for the
643
+ * request to ensure idempotency.</p>
644
+ */
645
+ ClientToken?: string;
646
+ }
647
+ export declare namespace CreateEventDestinationRequest {
648
+ /**
649
+ * @internal
650
+ */
651
+ const filterSensitiveLog: (obj: CreateEventDestinationRequest) => any;
652
+ }
653
+ export interface CreateEventDestinationResult {
654
+ /**
655
+ * <p>The ARN of the configuration set.</p>
656
+ */
657
+ ConfigurationSetArn?: string;
658
+ /**
659
+ * <p>The name of the configuration set.</p>
660
+ */
661
+ ConfigurationSetName?: string;
662
+ /**
663
+ * <p>The details of the destination where events are logged.</p>
664
+ */
665
+ EventDestination?: EventDestination;
666
+ }
667
+ export declare namespace CreateEventDestinationResult {
668
+ /**
669
+ * @internal
670
+ */
671
+ const filterSensitiveLog: (obj: CreateEventDestinationResult) => any;
672
+ }
673
+ export interface CreateOptOutListRequest {
674
+ /**
675
+ * <p>The name of the new OptOutList.</p>
676
+ */
677
+ OptOutListName: string | undefined;
678
+ /**
679
+ * <p>An array of tags (key and value pairs) to associate with the new OptOutList.</p>
680
+ */
681
+ Tags?: Tag[];
682
+ /**
683
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
684
+ * request. If you don't specify a client token, a randomly generated token is used for the
685
+ * request to ensure idempotency.</p>
686
+ */
687
+ ClientToken?: string;
688
+ }
689
+ export declare namespace CreateOptOutListRequest {
690
+ /**
691
+ * @internal
692
+ */
693
+ const filterSensitiveLog: (obj: CreateOptOutListRequest) => any;
694
+ }
695
+ export interface CreateOptOutListResult {
696
+ /**
697
+ * <p>The Amazon Resource Name (ARN) for the OptOutList.</p>
698
+ */
699
+ OptOutListArn?: string;
700
+ /**
701
+ * <p>The name of the new OptOutList.</p>
702
+ */
703
+ OptOutListName?: string;
704
+ /**
705
+ * <p>An array of tags (key and value pairs) associated with the new OptOutList.</p>
706
+ */
707
+ Tags?: Tag[];
708
+ /**
709
+ * <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
710
+ */
711
+ CreatedTimestamp?: Date;
712
+ }
713
+ export declare namespace CreateOptOutListResult {
714
+ /**
715
+ * @internal
716
+ */
717
+ const filterSensitiveLog: (obj: CreateOptOutListResult) => any;
718
+ }
719
+ export interface CreatePoolRequest {
720
+ /**
721
+ * <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
722
+ * SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for
723
+ * PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used
724
+ * to get the values for SenderId and SenderIdArn.</p>
725
+ */
726
+ OriginationIdentity: string | undefined;
727
+ /**
728
+ * <p>The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of
729
+ * the new pool.</p>
730
+ */
731
+ IsoCountryCode: string | undefined;
732
+ /**
733
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
734
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
735
+ * time-sensitive.</p>
736
+ */
737
+ MessageType: MessageType | string | undefined;
738
+ /**
739
+ * <p>By default this is set to false. When set to true the pool can't be deleted. You can
740
+ * change this value using the <a>UpdatePool</a> action.</p>
741
+ */
742
+ DeletionProtectionEnabled?: boolean;
743
+ /**
744
+ * <p>An array of tags (key and value pairs) associated with the pool.</p>
745
+ */
746
+ Tags?: Tag[];
747
+ /**
748
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
749
+ * request. If you don't specify a client token, a randomly generated token is used for the
750
+ * request to ensure idempotency.</p>
751
+ */
752
+ ClientToken?: string;
753
+ }
754
+ export declare namespace CreatePoolRequest {
755
+ /**
756
+ * @internal
757
+ */
758
+ const filterSensitiveLog: (obj: CreatePoolRequest) => any;
759
+ }
760
+ export declare enum PoolStatus {
761
+ ACTIVE = "ACTIVE",
762
+ CREATING = "CREATING",
763
+ DELETING = "DELETING"
764
+ }
765
+ export interface CreatePoolResult {
766
+ /**
767
+ * <p>The Amazon Resource Name (ARN) for the pool.</p>
768
+ */
769
+ PoolArn?: string;
770
+ /**
771
+ * <p>The unique identifier for the pool.</p>
772
+ */
773
+ PoolId?: string;
774
+ /**
775
+ * <p>The current status of the pool.</p>
776
+ * <ul>
777
+ * <li>
778
+ * <p>CREATING: The pool is currently being created and isn't yet available for
779
+ * use.</p>
780
+ * </li>
781
+ * <li>
782
+ * <p>ACTIVE: The pool is active and available for use.</p>
783
+ * </li>
784
+ * <li>
785
+ * <p>DELETING: The pool is being deleted.</p>
786
+ * </li>
787
+ * </ul>
788
+ */
789
+ Status?: PoolStatus | string;
790
+ /**
791
+ * <p>The type of message for the pool to use.</p>
792
+ */
793
+ MessageType?: MessageType | string;
794
+ /**
795
+ * <p>By default this is set to false. When set to true you can receive incoming text
796
+ * messages from your end recipients.</p>
797
+ */
798
+ TwoWayEnabled?: boolean;
799
+ /**
800
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
801
+ */
802
+ TwoWayChannelArn?: string;
803
+ /**
804
+ * <p>By default this is set to false. When an end recipient sends a message that begins
805
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
806
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
807
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
808
+ * responsible for tracking and honoring opt-out requests.</p>
809
+ */
810
+ SelfManagedOptOutsEnabled?: boolean;
811
+ /**
812
+ * <p>The name of the OptOutList associated with the pool.</p>
813
+ */
814
+ OptOutListName?: string;
815
+ /**
816
+ * <p>Indicates whether shared routes are enabled for the pool.</p>
817
+ */
818
+ SharedRoutesEnabled?: boolean;
819
+ /**
820
+ * <p>When set to true deletion protection is enabled. By default this is set to false.
821
+ * </p>
822
+ */
823
+ DeletionProtectionEnabled?: boolean;
824
+ /**
825
+ * <p>An array of tags (key and value pairs) associated with the pool.</p>
826
+ */
827
+ Tags?: Tag[];
828
+ /**
829
+ * <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
830
+ */
831
+ CreatedTimestamp?: Date;
832
+ }
833
+ export declare namespace CreatePoolResult {
834
+ /**
835
+ * @internal
836
+ */
837
+ const filterSensitiveLog: (obj: CreatePoolResult) => any;
838
+ }
839
+ export interface DeleteConfigurationSetRequest {
840
+ /**
841
+ * <p>The name of the configuration set or the configuration set ARN that you want to
842
+ * delete. The ConfigurationSetName and ConfigurationSetArn can be found using the <a>DescribeConfigurationSets</a> action.</p>
843
+ */
844
+ ConfigurationSetName: string | undefined;
845
+ }
846
+ export declare namespace DeleteConfigurationSetRequest {
847
+ /**
848
+ * @internal
849
+ */
850
+ const filterSensitiveLog: (obj: DeleteConfigurationSetRequest) => any;
851
+ }
852
+ export interface DeleteConfigurationSetResult {
853
+ /**
854
+ * <p>The Amazon Resource Name (ARN) of the deleted configuration set.</p>
855
+ */
856
+ ConfigurationSetArn?: string;
857
+ /**
858
+ * <p>The name of the deleted configuration set.</p>
859
+ */
860
+ ConfigurationSetName?: string;
861
+ /**
862
+ * <p>An array of any EventDestination objects that were associated with the deleted
863
+ * configuration set.</p>
864
+ */
865
+ EventDestinations?: EventDestination[];
866
+ /**
867
+ * <p>The default message type of the configuration set that was deleted.</p>
868
+ */
869
+ DefaultMessageType?: MessageType | string;
870
+ /**
871
+ * <p>The default Sender ID of the configuration set that was deleted.</p>
872
+ */
873
+ DefaultSenderId?: string;
874
+ /**
875
+ * <p>The time that the deleted configuration set was created in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
876
+ */
877
+ CreatedTimestamp?: Date;
878
+ }
879
+ export declare namespace DeleteConfigurationSetResult {
880
+ /**
881
+ * @internal
882
+ */
883
+ const filterSensitiveLog: (obj: DeleteConfigurationSetResult) => any;
884
+ }
885
+ export interface DeleteDefaultMessageTypeRequest {
886
+ /**
887
+ * <p>The name of the configuration set or the configuration set Amazon Resource Name (ARN)
888
+ * to delete the default message type from. The ConfigurationSetName and
889
+ * ConfigurationSetArn can be found using the <a>DescribeConfigurationSets</a>
890
+ * action.</p>
891
+ */
892
+ ConfigurationSetName: string | undefined;
893
+ }
894
+ export declare namespace DeleteDefaultMessageTypeRequest {
895
+ /**
896
+ * @internal
897
+ */
898
+ const filterSensitiveLog: (obj: DeleteDefaultMessageTypeRequest) => any;
899
+ }
900
+ export interface DeleteDefaultMessageTypeResult {
901
+ /**
902
+ * <p>The Amazon Resource Name (ARN) of the configuration set.</p>
903
+ */
904
+ ConfigurationSetArn?: string;
905
+ /**
906
+ * <p>The name of the configuration set.</p>
907
+ */
908
+ ConfigurationSetName?: string;
909
+ /**
910
+ * <p>The current message type for the configuration set.</p>
911
+ */
912
+ MessageType?: MessageType | string;
913
+ }
914
+ export declare namespace DeleteDefaultMessageTypeResult {
915
+ /**
916
+ * @internal
917
+ */
918
+ const filterSensitiveLog: (obj: DeleteDefaultMessageTypeResult) => any;
919
+ }
920
+ export interface DeleteDefaultSenderIdRequest {
921
+ /**
922
+ * <p>The name of the configuration set or the configuration set Amazon Resource Name (ARN)
923
+ * to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn
924
+ * can be found using the <a>DescribeConfigurationSets</a> action.</p>
925
+ */
926
+ ConfigurationSetName: string | undefined;
927
+ }
928
+ export declare namespace DeleteDefaultSenderIdRequest {
929
+ /**
930
+ * @internal
931
+ */
932
+ const filterSensitiveLog: (obj: DeleteDefaultSenderIdRequest) => any;
933
+ }
934
+ export interface DeleteDefaultSenderIdResult {
935
+ /**
936
+ * <p>The Amazon Resource Name (ARN) of the configuration set.</p>
937
+ */
938
+ ConfigurationSetArn?: string;
939
+ /**
940
+ * <p>The name of the configuration set.</p>
941
+ */
942
+ ConfigurationSetName?: string;
943
+ /**
944
+ * <p>The current sender ID for the configuration set.</p>
945
+ */
946
+ SenderId?: string;
947
+ }
948
+ export declare namespace DeleteDefaultSenderIdResult {
949
+ /**
950
+ * @internal
951
+ */
952
+ const filterSensitiveLog: (obj: DeleteDefaultSenderIdResult) => any;
953
+ }
954
+ export interface DeleteEventDestinationRequest {
955
+ /**
956
+ * <p>The name of the configuration set or the configuration set's Amazon Resource Name
957
+ * (ARN) to remove the event destination from. The ConfigurateSetName and
958
+ * ConfigurationSetArn can be found using the <a>DescribeConfigurationSets</a>
959
+ * action.</p>
960
+ */
961
+ ConfigurationSetName: string | undefined;
962
+ /**
963
+ * <p>The name of the event destination to delete.</p>
964
+ */
965
+ EventDestinationName: string | undefined;
966
+ }
967
+ export declare namespace DeleteEventDestinationRequest {
968
+ /**
969
+ * @internal
970
+ */
971
+ const filterSensitiveLog: (obj: DeleteEventDestinationRequest) => any;
972
+ }
973
+ export interface DeleteEventDestinationResult {
974
+ /**
975
+ * <p>The Amazon Resource Name (ARN) of the configuration set.</p>
976
+ */
977
+ ConfigurationSetArn?: string;
978
+ /**
979
+ * <p>The name of the configuration set the event destination was deleted from.</p>
980
+ */
981
+ ConfigurationSetName?: string;
982
+ /**
983
+ * <p>The event destination object that was deleted.</p>
984
+ */
985
+ EventDestination?: EventDestination;
986
+ }
987
+ export declare namespace DeleteEventDestinationResult {
988
+ /**
989
+ * @internal
990
+ */
991
+ const filterSensitiveLog: (obj: DeleteEventDestinationResult) => any;
992
+ }
993
+ export interface DeleteKeywordRequest {
994
+ /**
995
+ * <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or
996
+ * PoolArn. You can use <a>DescribePhoneNumbers</a> to find the values for
997
+ * PhoneNumberId and PhoneNumberArn and <a>DescribePools</a> to find the values
998
+ * of PoolId and PoolArn.</p>
999
+ */
1000
+ OriginationIdentity: string | undefined;
1001
+ /**
1002
+ * <p>The keyword to delete.</p>
1003
+ */
1004
+ Keyword: string | undefined;
1005
+ }
1006
+ export declare namespace DeleteKeywordRequest {
1007
+ /**
1008
+ * @internal
1009
+ */
1010
+ const filterSensitiveLog: (obj: DeleteKeywordRequest) => any;
1011
+ }
1012
+ export declare enum KeywordAction {
1013
+ AUTOMATIC_RESPONSE = "AUTOMATIC_RESPONSE",
1014
+ OPT_IN = "OPT_IN",
1015
+ OPT_OUT = "OPT_OUT"
1016
+ }
1017
+ export interface DeleteKeywordResult {
1018
+ /**
1019
+ * <p>The PhoneNumberArn or PoolArn that the keyword was associated with.</p>
1020
+ */
1021
+ OriginationIdentityArn?: string;
1022
+ /**
1023
+ * <p>The PhoneNumberId or PoolId that the keyword was associated with.</p>
1024
+ */
1025
+ OriginationIdentity?: string;
1026
+ /**
1027
+ * <p>The keyword that was deleted.</p>
1028
+ */
1029
+ Keyword?: string;
1030
+ /**
1031
+ * <p>The message that was associated with the deleted keyword.</p>
1032
+ */
1033
+ KeywordMessage?: string;
1034
+ /**
1035
+ * <p>The action that was associated with the deleted keyword.</p>
1036
+ */
1037
+ KeywordAction?: KeywordAction | string;
1038
+ }
1039
+ export declare namespace DeleteKeywordResult {
1040
+ /**
1041
+ * @internal
1042
+ */
1043
+ const filterSensitiveLog: (obj: DeleteKeywordResult) => any;
1044
+ }
1045
+ export interface DeleteOptedOutNumberRequest {
1046
+ /**
1047
+ * <p>The OptOutListName or OptOutListArn to remove the phone number from.</p>
1048
+ */
1049
+ OptOutListName: string | undefined;
1050
+ /**
1051
+ * <p>The phone number, in E.164 format, to remove from the OptOutList.</p>
1052
+ */
1053
+ OptedOutNumber: string | undefined;
1054
+ }
1055
+ export declare namespace DeleteOptedOutNumberRequest {
1056
+ /**
1057
+ * @internal
1058
+ */
1059
+ const filterSensitiveLog: (obj: DeleteOptedOutNumberRequest) => any;
1060
+ }
1061
+ export interface DeleteOptedOutNumberResult {
1062
+ /**
1063
+ * <p>The OptOutListArn that the phone number was removed from.</p>
1064
+ */
1065
+ OptOutListArn?: string;
1066
+ /**
1067
+ * <p>The OptOutListName that the phone number was removed from.</p>
1068
+ */
1069
+ OptOutListName?: string;
1070
+ /**
1071
+ * <p>The phone number that was removed from the OptOutList.</p>
1072
+ */
1073
+ OptedOutNumber?: string;
1074
+ /**
1075
+ * <p>The time that the number was removed at, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1076
+ */
1077
+ OptedOutTimestamp?: Date;
1078
+ /**
1079
+ * <p>This is true if it was the end user who requested their phone number be removed.
1080
+ * </p>
1081
+ */
1082
+ EndUserOptedOut?: boolean;
1083
+ }
1084
+ export declare namespace DeleteOptedOutNumberResult {
1085
+ /**
1086
+ * @internal
1087
+ */
1088
+ const filterSensitiveLog: (obj: DeleteOptedOutNumberResult) => any;
1089
+ }
1090
+ export interface DeleteOptOutListRequest {
1091
+ /**
1092
+ * <p>The OptOutListName or OptOutListArn of the OptOutList to delete. You can use <a>DescribeOptOutLists</a> to find the values for OptOutListName and
1093
+ * OptOutListArn.</p>
1094
+ */
1095
+ OptOutListName: string | undefined;
1096
+ }
1097
+ export declare namespace DeleteOptOutListRequest {
1098
+ /**
1099
+ * @internal
1100
+ */
1101
+ const filterSensitiveLog: (obj: DeleteOptOutListRequest) => any;
1102
+ }
1103
+ export interface DeleteOptOutListResult {
1104
+ /**
1105
+ * <p>The Amazon Resource Name (ARN) of the OptOutList that was removed.</p>
1106
+ */
1107
+ OptOutListArn?: string;
1108
+ /**
1109
+ * <p>The name of the OptOutList that was removed.</p>
1110
+ */
1111
+ OptOutListName?: string;
1112
+ /**
1113
+ * <p>The time when the OptOutList was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1114
+ */
1115
+ CreatedTimestamp?: Date;
1116
+ }
1117
+ export declare namespace DeleteOptOutListResult {
1118
+ /**
1119
+ * @internal
1120
+ */
1121
+ const filterSensitiveLog: (obj: DeleteOptOutListResult) => any;
1122
+ }
1123
+ export interface DeletePoolRequest {
1124
+ /**
1125
+ * <p>The PoolId or PoolArn of the pool to delete. You can use <a>DescribePools</a> to find the values for PoolId and PoolArn .</p>
1126
+ */
1127
+ PoolId: string | undefined;
1128
+ }
1129
+ export declare namespace DeletePoolRequest {
1130
+ /**
1131
+ * @internal
1132
+ */
1133
+ const filterSensitiveLog: (obj: DeletePoolRequest) => any;
1134
+ }
1135
+ export interface DeletePoolResult {
1136
+ /**
1137
+ * <p>The Amazon Resource Name (ARN) of the pool that was deleted.</p>
1138
+ */
1139
+ PoolArn?: string;
1140
+ /**
1141
+ * <p>The PoolId of the pool that was deleted.</p>
1142
+ */
1143
+ PoolId?: string;
1144
+ /**
1145
+ * <p>The current status of the pool.</p>
1146
+ * <ul>
1147
+ * <li>
1148
+ * <p>CREATING: The pool is currently being created and isn't yet available for
1149
+ * use.</p>
1150
+ * </li>
1151
+ * <li>
1152
+ * <p>ACTIVE: The pool is active and available for use.</p>
1153
+ * </li>
1154
+ * <li>
1155
+ * <p>DELETING: The pool is being deleted.</p>
1156
+ * </li>
1157
+ * </ul>
1158
+ */
1159
+ Status?: PoolStatus | string;
1160
+ /**
1161
+ * <p>The message type that was associated with the deleted pool.</p>
1162
+ */
1163
+ MessageType?: MessageType | string;
1164
+ /**
1165
+ * <p>By default this is set to false. When set to true you can receive incoming text
1166
+ * messages from your end recipients.</p>
1167
+ */
1168
+ TwoWayEnabled?: boolean;
1169
+ /**
1170
+ * <p>The Amazon Resource Name (ARN) of the TwoWayChannel.</p>
1171
+ */
1172
+ TwoWayChannelArn?: string;
1173
+ /**
1174
+ * <p>By default this is set to false. When an end recipient sends a message that begins
1175
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
1176
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
1177
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
1178
+ * responsible for tracking and honoring opt-out requests.</p>
1179
+ */
1180
+ SelfManagedOptOutsEnabled?: boolean;
1181
+ /**
1182
+ * <p>The name of the OptOutList that was associated with the deleted pool.</p>
1183
+ */
1184
+ OptOutListName?: string;
1185
+ /**
1186
+ * <p>Indicates whether shared routes are enabled for the pool.</p>
1187
+ */
1188
+ SharedRoutesEnabled?: boolean;
1189
+ /**
1190
+ * <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1191
+ */
1192
+ CreatedTimestamp?: Date;
1193
+ }
1194
+ export declare namespace DeletePoolResult {
1195
+ /**
1196
+ * @internal
1197
+ */
1198
+ const filterSensitiveLog: (obj: DeletePoolResult) => any;
1199
+ }
1200
+ export interface DeleteTextMessageSpendLimitOverrideRequest {
1201
+ }
1202
+ export declare namespace DeleteTextMessageSpendLimitOverrideRequest {
1203
+ /**
1204
+ * @internal
1205
+ */
1206
+ const filterSensitiveLog: (obj: DeleteTextMessageSpendLimitOverrideRequest) => any;
1207
+ }
1208
+ export interface DeleteTextMessageSpendLimitOverrideResult {
1209
+ /**
1210
+ * <p>The current monthly limit, in US dollars.</p>
1211
+ */
1212
+ MonthlyLimit?: number;
1213
+ }
1214
+ export declare namespace DeleteTextMessageSpendLimitOverrideResult {
1215
+ /**
1216
+ * @internal
1217
+ */
1218
+ const filterSensitiveLog: (obj: DeleteTextMessageSpendLimitOverrideResult) => any;
1219
+ }
1220
+ export interface DeleteVoiceMessageSpendLimitOverrideRequest {
1221
+ }
1222
+ export declare namespace DeleteVoiceMessageSpendLimitOverrideRequest {
1223
+ /**
1224
+ * @internal
1225
+ */
1226
+ const filterSensitiveLog: (obj: DeleteVoiceMessageSpendLimitOverrideRequest) => any;
1227
+ }
1228
+ export interface DeleteVoiceMessageSpendLimitOverrideResult {
1229
+ /**
1230
+ * <p>The current monthly limit, in US dollars.</p>
1231
+ */
1232
+ MonthlyLimit?: number;
1233
+ }
1234
+ export declare namespace DeleteVoiceMessageSpendLimitOverrideResult {
1235
+ /**
1236
+ * @internal
1237
+ */
1238
+ const filterSensitiveLog: (obj: DeleteVoiceMessageSpendLimitOverrideResult) => any;
1239
+ }
1240
+ export interface DescribeAccountAttributesRequest {
1241
+ /**
1242
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1243
+ * value for this field in the initial request.</p>
1244
+ */
1245
+ NextToken?: string;
1246
+ /**
1247
+ * <p>The maximum number of results to return per each request.</p>
1248
+ */
1249
+ MaxResults?: number;
1250
+ }
1251
+ export declare namespace DescribeAccountAttributesRequest {
1252
+ /**
1253
+ * @internal
1254
+ */
1255
+ const filterSensitiveLog: (obj: DescribeAccountAttributesRequest) => any;
1256
+ }
1257
+ export interface DescribeAccountAttributesResult {
1258
+ /**
1259
+ * <p>An array of AccountAttributes objects.</p>
1260
+ */
1261
+ AccountAttributes?: AccountAttribute[];
1262
+ /**
1263
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1264
+ * then there are no more results.</p>
1265
+ */
1266
+ NextToken?: string;
1267
+ }
1268
+ export declare namespace DescribeAccountAttributesResult {
1269
+ /**
1270
+ * @internal
1271
+ */
1272
+ const filterSensitiveLog: (obj: DescribeAccountAttributesResult) => any;
1273
+ }
1274
+ export interface DescribeAccountLimitsRequest {
1275
+ /**
1276
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1277
+ * value for this field in the initial request.</p>
1278
+ */
1279
+ NextToken?: string;
1280
+ /**
1281
+ * <p>The maximum number of results to return per each request.</p>
1282
+ */
1283
+ MaxResults?: number;
1284
+ }
1285
+ export declare namespace DescribeAccountLimitsRequest {
1286
+ /**
1287
+ * @internal
1288
+ */
1289
+ const filterSensitiveLog: (obj: DescribeAccountLimitsRequest) => any;
1290
+ }
1291
+ export interface DescribeAccountLimitsResult {
1292
+ /**
1293
+ * <p>An array of AccountLimit objects that show the current spend limits.</p>
1294
+ */
1295
+ AccountLimits?: AccountLimit[];
1296
+ /**
1297
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1298
+ * then there are no more results.</p>
1299
+ */
1300
+ NextToken?: string;
1301
+ }
1302
+ export declare namespace DescribeAccountLimitsResult {
1303
+ /**
1304
+ * @internal
1305
+ */
1306
+ const filterSensitiveLog: (obj: DescribeAccountLimitsResult) => any;
1307
+ }
1308
+ export interface DescribeConfigurationSetsRequest {
1309
+ /**
1310
+ * <p>An array of strings. Each element can be either a ConfigurationSetName or
1311
+ * ConfigurationSetArn.</p>
1312
+ */
1313
+ ConfigurationSetNames?: string[];
1314
+ /**
1315
+ * <p>An array of filters to apply to the results that are returned.</p>
1316
+ */
1317
+ Filters?: ConfigurationSetFilter[];
1318
+ /**
1319
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1320
+ * value for this field in the initial request.</p>
1321
+ */
1322
+ NextToken?: string;
1323
+ /**
1324
+ * <p>The maximum number of results to return per each request.</p>
1325
+ */
1326
+ MaxResults?: number;
1327
+ }
1328
+ export declare namespace DescribeConfigurationSetsRequest {
1329
+ /**
1330
+ * @internal
1331
+ */
1332
+ const filterSensitiveLog: (obj: DescribeConfigurationSetsRequest) => any;
1333
+ }
1334
+ export interface DescribeConfigurationSetsResult {
1335
+ /**
1336
+ * <p>An array of ConfigurationSets objects.</p>
1337
+ */
1338
+ ConfigurationSets?: ConfigurationSetInformation[];
1339
+ /**
1340
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1341
+ * then there are no more results.</p>
1342
+ */
1343
+ NextToken?: string;
1344
+ }
1345
+ export declare namespace DescribeConfigurationSetsResult {
1346
+ /**
1347
+ * @internal
1348
+ */
1349
+ const filterSensitiveLog: (obj: DescribeConfigurationSetsResult) => any;
1350
+ }
1351
+ export declare enum KeywordFilterName {
1352
+ KEYWORD_ACTION = "keyword-action"
1353
+ }
1354
+ /**
1355
+ * <p>The information for keywords that meet a specified criteria.</p>
1356
+ */
1357
+ export interface KeywordFilter {
1358
+ /**
1359
+ * <p>The name of the attribute to filter on.</p>
1360
+ */
1361
+ Name: KeywordFilterName | string | undefined;
1362
+ /**
1363
+ * <p>An array values to filter for.</p>
1364
+ */
1365
+ Values: string[] | undefined;
1366
+ }
1367
+ export declare namespace KeywordFilter {
1368
+ /**
1369
+ * @internal
1370
+ */
1371
+ const filterSensitiveLog: (obj: KeywordFilter) => any;
1372
+ }
1373
+ export interface DescribeKeywordsRequest {
1374
+ /**
1375
+ * <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
1376
+ * SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for
1377
+ * PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used
1378
+ * to get the values for SenderId and SenderIdArn.</p>
1379
+ */
1380
+ OriginationIdentity: string | undefined;
1381
+ /**
1382
+ * <p>An array of keywords to search for.</p>
1383
+ */
1384
+ Keywords?: string[];
1385
+ /**
1386
+ * <p>An array of keyword filters to filter the results.</p>
1387
+ */
1388
+ Filters?: KeywordFilter[];
1389
+ /**
1390
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1391
+ * value for this field in the initial request.</p>
1392
+ */
1393
+ NextToken?: string;
1394
+ /**
1395
+ * <p>The maximum number of results to return per each request.</p>
1396
+ */
1397
+ MaxResults?: number;
1398
+ }
1399
+ export declare namespace DescribeKeywordsRequest {
1400
+ /**
1401
+ * @internal
1402
+ */
1403
+ const filterSensitiveLog: (obj: DescribeKeywordsRequest) => any;
1404
+ }
1405
+ /**
1406
+ * <p>The information for all keywords in a pool.</p>
1407
+ */
1408
+ export interface KeywordInformation {
1409
+ /**
1410
+ * <p>The keyword as a string.</p>
1411
+ */
1412
+ Keyword: string | undefined;
1413
+ /**
1414
+ * <p>A custom message that can be used with the keyword.</p>
1415
+ */
1416
+ KeywordMessage: string | undefined;
1417
+ /**
1418
+ * <p>The action to perform for the keyword.</p>
1419
+ */
1420
+ KeywordAction: KeywordAction | string | undefined;
1421
+ }
1422
+ export declare namespace KeywordInformation {
1423
+ /**
1424
+ * @internal
1425
+ */
1426
+ const filterSensitiveLog: (obj: KeywordInformation) => any;
1427
+ }
1428
+ export interface DescribeKeywordsResult {
1429
+ /**
1430
+ * <p>The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity. </p>
1431
+ */
1432
+ OriginationIdentityArn?: string;
1433
+ /**
1434
+ * <p>The PhoneNumberId or PoolId that is associated with the OriginationIdentity.</p>
1435
+ */
1436
+ OriginationIdentity?: string;
1437
+ /**
1438
+ * <p>An array of KeywordInformation objects that contain the results.</p>
1439
+ */
1440
+ Keywords?: KeywordInformation[];
1441
+ /**
1442
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1443
+ * then there are no more results.</p>
1444
+ */
1445
+ NextToken?: string;
1446
+ }
1447
+ export declare namespace DescribeKeywordsResult {
1448
+ /**
1449
+ * @internal
1450
+ */
1451
+ const filterSensitiveLog: (obj: DescribeKeywordsResult) => any;
1452
+ }
1453
+ export declare enum OptedOutFilterName {
1454
+ END_USER_OPTED_OUT = "end-user-opted-out"
1455
+ }
1456
+ /**
1457
+ * <p>The information for opted out numbers that meet a specified criteria.</p>
1458
+ */
1459
+ export interface OptedOutFilter {
1460
+ /**
1461
+ * <p>The name of the attribute to filter on.</p>
1462
+ */
1463
+ Name: OptedOutFilterName | string | undefined;
1464
+ /**
1465
+ * <p>An array of values to filter for.</p>
1466
+ */
1467
+ Values: string[] | undefined;
1468
+ }
1469
+ export declare namespace OptedOutFilter {
1470
+ /**
1471
+ * @internal
1472
+ */
1473
+ const filterSensitiveLog: (obj: OptedOutFilter) => any;
1474
+ }
1475
+ export interface DescribeOptedOutNumbersRequest {
1476
+ /**
1477
+ * <p>The OptOutListName or OptOutListArn of the OptOutList. You can use <a>DescribeOptOutLists</a> to find the values for OptOutListName and
1478
+ * OptOutListArn.</p>
1479
+ */
1480
+ OptOutListName: string | undefined;
1481
+ /**
1482
+ * <p>An array of phone numbers to search for in the OptOutList.</p>
1483
+ */
1484
+ OptedOutNumbers?: string[];
1485
+ /**
1486
+ * <p>An array of OptedOutFilter objects to filter the results on.</p>
1487
+ */
1488
+ Filters?: OptedOutFilter[];
1489
+ /**
1490
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1491
+ * value for this field in the initial request.</p>
1492
+ */
1493
+ NextToken?: string;
1494
+ /**
1495
+ * <p>The maximum number of results to return per each request.</p>
1496
+ */
1497
+ MaxResults?: number;
1498
+ }
1499
+ export declare namespace DescribeOptedOutNumbersRequest {
1500
+ /**
1501
+ * @internal
1502
+ */
1503
+ const filterSensitiveLog: (obj: DescribeOptedOutNumbersRequest) => any;
1504
+ }
1505
+ /**
1506
+ * <p>The information for an opted out number in an Amazon Web Services account.</p>
1507
+ */
1508
+ export interface OptedOutNumberInformation {
1509
+ /**
1510
+ * <p>The phone number that is opted out.</p>
1511
+ */
1512
+ OptedOutNumber: string | undefined;
1513
+ /**
1514
+ * <p>The time that the op tout occurred, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1515
+ */
1516
+ OptedOutTimestamp: Date | undefined;
1517
+ /**
1518
+ * <p>This is set to true if it was the end recipient that opted out.</p>
1519
+ */
1520
+ EndUserOptedOut: boolean | undefined;
1521
+ }
1522
+ export declare namespace OptedOutNumberInformation {
1523
+ /**
1524
+ * @internal
1525
+ */
1526
+ const filterSensitiveLog: (obj: OptedOutNumberInformation) => any;
1527
+ }
1528
+ export interface DescribeOptedOutNumbersResult {
1529
+ /**
1530
+ * <p>The Amazon Resource Name (ARN) of the OptOutList.</p>
1531
+ */
1532
+ OptOutListArn?: string;
1533
+ /**
1534
+ * <p>The name of the OptOutList.</p>
1535
+ */
1536
+ OptOutListName?: string;
1537
+ /**
1538
+ * <p>An array of OptedOutNumbersInformation objects that provide information about the
1539
+ * requested OptedOutNumbers.</p>
1540
+ */
1541
+ OptedOutNumbers?: OptedOutNumberInformation[];
1542
+ /**
1543
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1544
+ * then there are no more results.</p>
1545
+ */
1546
+ NextToken?: string;
1547
+ }
1548
+ export declare namespace DescribeOptedOutNumbersResult {
1549
+ /**
1550
+ * @internal
1551
+ */
1552
+ const filterSensitiveLog: (obj: DescribeOptedOutNumbersResult) => any;
1553
+ }
1554
+ export interface DescribeOptOutListsRequest {
1555
+ /**
1556
+ * <p>The OptOutLists to show the details of. This is an array of strings that can be either
1557
+ * the OptOutListName or OptOutListArn.</p>
1558
+ */
1559
+ OptOutListNames?: string[];
1560
+ /**
1561
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1562
+ * value for this field in the initial request.</p>
1563
+ */
1564
+ NextToken?: string;
1565
+ /**
1566
+ * <p>The maximum number of results to return per each request.</p>
1567
+ */
1568
+ MaxResults?: number;
1569
+ }
1570
+ export declare namespace DescribeOptOutListsRequest {
1571
+ /**
1572
+ * @internal
1573
+ */
1574
+ const filterSensitiveLog: (obj: DescribeOptOutListsRequest) => any;
1575
+ }
1576
+ /**
1577
+ * <p>The information for all OptOutList in an Amazon Web Services account.</p>
1578
+ */
1579
+ export interface OptOutListInformation {
1580
+ /**
1581
+ * <p>The Amazon Resource Name (ARN) of the OptOutList.</p>
1582
+ */
1583
+ OptOutListArn: string | undefined;
1584
+ /**
1585
+ * <p>The name of the OptOutList.</p>
1586
+ */
1587
+ OptOutListName: string | undefined;
1588
+ /**
1589
+ * <p>The time when the OutOutList was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1590
+ */
1591
+ CreatedTimestamp: Date | undefined;
1592
+ }
1593
+ export declare namespace OptOutListInformation {
1594
+ /**
1595
+ * @internal
1596
+ */
1597
+ const filterSensitiveLog: (obj: OptOutListInformation) => any;
1598
+ }
1599
+ export interface DescribeOptOutListsResult {
1600
+ /**
1601
+ * <p>An array of OptOutListInformation objects that contain the details for the requested
1602
+ * OptOutLists.</p>
1603
+ */
1604
+ OptOutLists?: OptOutListInformation[];
1605
+ /**
1606
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1607
+ * then there are no more results.</p>
1608
+ */
1609
+ NextToken?: string;
1610
+ }
1611
+ export declare namespace DescribeOptOutListsResult {
1612
+ /**
1613
+ * @internal
1614
+ */
1615
+ const filterSensitiveLog: (obj: DescribeOptOutListsResult) => any;
1616
+ }
1617
+ export declare enum PhoneNumberFilterName {
1618
+ DELETION_PROTECTION_ENABLED = "deletion-protection-enabled",
1619
+ ISO_COUNTRY_CODE = "iso-country-code",
1620
+ MESSAGE_TYPE = "message-type",
1621
+ NUMBER_CAPABILITY = "number-capability",
1622
+ NUMBER_TYPE = "number-type",
1623
+ OPT_OUT_LIST_NAME = "opt-out-list-name",
1624
+ SELF_MANAGED_OPT_OUTS_ENABLED = "self-managed-opt-outs-enabled",
1625
+ STATUS = "status",
1626
+ TWO_WAY_ENABLED = "two-way-enabled"
1627
+ }
1628
+ /**
1629
+ * <p>The information for a phone number that meets a specified criteria.</p>
1630
+ */
1631
+ export interface PhoneNumberFilter {
1632
+ /**
1633
+ * <p>The name of the attribute to filter on.</p>
1634
+ */
1635
+ Name: PhoneNumberFilterName | string | undefined;
1636
+ /**
1637
+ * <p>An array values to filter for.</p>
1638
+ */
1639
+ Values: string[] | undefined;
1640
+ }
1641
+ export declare namespace PhoneNumberFilter {
1642
+ /**
1643
+ * @internal
1644
+ */
1645
+ const filterSensitiveLog: (obj: PhoneNumberFilter) => any;
1646
+ }
1647
+ export interface DescribePhoneNumbersRequest {
1648
+ /**
1649
+ * <p>The unique identifier of phone numbers to find information about. This is an array of
1650
+ * strings that can be either the PhoneNumberId or PhoneNumberArn.</p>
1651
+ */
1652
+ PhoneNumberIds?: string[];
1653
+ /**
1654
+ * <p>An array of PhoneNumberFilter objects to filter the results.</p>
1655
+ */
1656
+ Filters?: PhoneNumberFilter[];
1657
+ /**
1658
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1659
+ * value for this field in the initial request.</p>
1660
+ */
1661
+ NextToken?: string;
1662
+ /**
1663
+ * <p>The maximum number of results to return per each request.</p>
1664
+ */
1665
+ MaxResults?: number;
1666
+ }
1667
+ export declare namespace DescribePhoneNumbersRequest {
1668
+ /**
1669
+ * @internal
1670
+ */
1671
+ const filterSensitiveLog: (obj: DescribePhoneNumbersRequest) => any;
1672
+ }
1673
+ export declare enum NumberCapability {
1674
+ SMS = "SMS",
1675
+ VOICE = "VOICE"
1676
+ }
1677
+ export declare enum NumberType {
1678
+ LONG_CODE = "LONG_CODE",
1679
+ SHORT_CODE = "SHORT_CODE",
1680
+ TEN_DLC = "TEN_DLC",
1681
+ TOLL_FREE = "TOLL_FREE"
1682
+ }
1683
+ export declare enum NumberStatus {
1684
+ ACTIVE = "ACTIVE",
1685
+ ASSOCIATING = "ASSOCIATING",
1686
+ DELETED = "DELETED",
1687
+ DISASSOCIATING = "DISASSOCIATING",
1688
+ PENDING = "PENDING"
1689
+ }
1690
+ /**
1691
+ * <p>The information for a phone number in an Amazon Web Services account.</p>
1692
+ */
1693
+ export interface PhoneNumberInformation {
1694
+ /**
1695
+ * <p>The Amazon Resource Name (ARN) associated with the phone number.</p>
1696
+ */
1697
+ PhoneNumberArn: string | undefined;
1698
+ /**
1699
+ * <p>The unique identifier for the phone number.</p>
1700
+ */
1701
+ PhoneNumberId?: string;
1702
+ /**
1703
+ * <p>The phone number in E.164 format.</p>
1704
+ */
1705
+ PhoneNumber: string | undefined;
1706
+ /**
1707
+ * <p>The current status of the phone number.</p>
1708
+ */
1709
+ Status: NumberStatus | string | undefined;
1710
+ /**
1711
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
1712
+ * </p>
1713
+ */
1714
+ IsoCountryCode: string | undefined;
1715
+ /**
1716
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
1717
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
1718
+ * time-sensitive.</p>
1719
+ */
1720
+ MessageType: MessageType | string | undefined;
1721
+ /**
1722
+ * <p>Describes if the origination identity can be used for text messages, voice calls or
1723
+ * both.</p>
1724
+ */
1725
+ NumberCapabilities: (NumberCapability | string)[] | undefined;
1726
+ /**
1727
+ * <p>The type of phone number.</p>
1728
+ */
1729
+ NumberType: NumberType | string | undefined;
1730
+ /**
1731
+ * <p>The price, in US dollars, to lease the phone number.</p>
1732
+ */
1733
+ MonthlyLeasingPrice: string | undefined;
1734
+ /**
1735
+ * <p>By default this is set to false. When set to true you can receive incoming text
1736
+ * messages from your end recipients using the TwoWayChannelArn.</p>
1737
+ */
1738
+ TwoWayEnabled: boolean | undefined;
1739
+ /**
1740
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
1741
+ */
1742
+ TwoWayChannelArn?: string;
1743
+ /**
1744
+ * <p>When set to false an end recipient sends a message that begins with HELP or STOP to
1745
+ * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
1746
+ * customizable message and adds the end recipient to the OptOutList. When set to true
1747
+ * you're responsible for responding to HELP and STOP requests. You're also responsible for
1748
+ * tracking and honoring opt-out request. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out">Self-managed opt-outs</a>
1749
+ * </p>
1750
+ */
1751
+ SelfManagedOptOutsEnabled: boolean | undefined;
1752
+ /**
1753
+ * <p>The name of the OptOutList associated with the phone number.</p>
1754
+ */
1755
+ OptOutListName: string | undefined;
1756
+ /**
1757
+ * <p>When set to true the phone number can't be deleted.</p>
1758
+ */
1759
+ DeletionProtectionEnabled: boolean | undefined;
1760
+ /**
1761
+ * <p>The unique identifier of the pool associated with the phone number.</p>
1762
+ */
1763
+ PoolId?: string;
1764
+ /**
1765
+ * <p>The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1766
+ */
1767
+ CreatedTimestamp: Date | undefined;
1768
+ }
1769
+ export declare namespace PhoneNumberInformation {
1770
+ /**
1771
+ * @internal
1772
+ */
1773
+ const filterSensitiveLog: (obj: PhoneNumberInformation) => any;
1774
+ }
1775
+ export interface DescribePhoneNumbersResult {
1776
+ /**
1777
+ * <p>An array of PhoneNumberInformation objects that contain the details for the requested
1778
+ * phone numbers.</p>
1779
+ */
1780
+ PhoneNumbers?: PhoneNumberInformation[];
1781
+ /**
1782
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1783
+ * then there are no more results.</p>
1784
+ */
1785
+ NextToken?: string;
1786
+ }
1787
+ export declare namespace DescribePhoneNumbersResult {
1788
+ /**
1789
+ * @internal
1790
+ */
1791
+ const filterSensitiveLog: (obj: DescribePhoneNumbersResult) => any;
1792
+ }
1793
+ export declare enum PoolFilterName {
1794
+ DELETION_PROTECTION_ENABLED = "deletion-protection-enabled",
1795
+ MESSAGE_TYPE = "message-type",
1796
+ OPT_OUT_LIST_NAME = "opt-out-list-name",
1797
+ SELF_MANAGED_OPT_OUTS_ENABLED = "self-managed-opt-outs-enabled",
1798
+ SHARED_ROUTES_ENABLED = "shared-routes-enabled",
1799
+ STATUS = "status",
1800
+ TWO_WAY_ENABLED = "two-way-enabled"
1801
+ }
1802
+ /**
1803
+ * <p>The information for a pool that meets a specified criteria.</p>
1804
+ */
1805
+ export interface PoolFilter {
1806
+ /**
1807
+ * <p>The name of the attribute to filter on.</p>
1808
+ */
1809
+ Name: PoolFilterName | string | undefined;
1810
+ /**
1811
+ * <p>An array values to filter for.</p>
1812
+ */
1813
+ Values: string[] | undefined;
1814
+ }
1815
+ export declare namespace PoolFilter {
1816
+ /**
1817
+ * @internal
1818
+ */
1819
+ const filterSensitiveLog: (obj: PoolFilter) => any;
1820
+ }
1821
+ export interface DescribePoolsRequest {
1822
+ /**
1823
+ * <p>The unique identifier of pools to find. This is an array of strings that can be either
1824
+ * the PoolId or PoolArn.</p>
1825
+ */
1826
+ PoolIds?: string[];
1827
+ /**
1828
+ * <p>An array of PoolFilter objects to filter the results.</p>
1829
+ */
1830
+ Filters?: PoolFilter[];
1831
+ /**
1832
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1833
+ * value for this field in the initial request.</p>
1834
+ */
1835
+ NextToken?: string;
1836
+ /**
1837
+ * <p>The maximum number of results to return per each request.</p>
1838
+ */
1839
+ MaxResults?: number;
1840
+ }
1841
+ export declare namespace DescribePoolsRequest {
1842
+ /**
1843
+ * @internal
1844
+ */
1845
+ const filterSensitiveLog: (obj: DescribePoolsRequest) => any;
1846
+ }
1847
+ /**
1848
+ * <p>The information for a pool in an Amazon Web Services account.</p>
1849
+ */
1850
+ export interface PoolInformation {
1851
+ /**
1852
+ * <p>The Amazon Resource Name (ARN) for the pool.</p>
1853
+ */
1854
+ PoolArn: string | undefined;
1855
+ /**
1856
+ * <p>The unique identifier for the pool.</p>
1857
+ */
1858
+ PoolId: string | undefined;
1859
+ /**
1860
+ * <p>The current status of the pool.</p>
1861
+ */
1862
+ Status: PoolStatus | string | undefined;
1863
+ /**
1864
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
1865
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
1866
+ * time-sensitive.</p>
1867
+ */
1868
+ MessageType: MessageType | string | undefined;
1869
+ /**
1870
+ * <p>When set to true you can receive incoming text messages from your end recipients using
1871
+ * the TwoWayChannelArn.</p>
1872
+ */
1873
+ TwoWayEnabled: boolean | undefined;
1874
+ /**
1875
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
1876
+ */
1877
+ TwoWayChannelArn?: string;
1878
+ /**
1879
+ * <p>When set to false, an end recipient sends a message that begins with HELP or STOP to
1880
+ * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
1881
+ * customizable message and adds the end recipient to the OptOutList. When set to true
1882
+ * you're responsible for responding to HELP and STOP requests. You're also responsible for
1883
+ * tracking and honoring opt-out requests. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out">Self-managed opt-outs</a>
1884
+ * </p>
1885
+ */
1886
+ SelfManagedOptOutsEnabled: boolean | undefined;
1887
+ /**
1888
+ * <p>The name of the OptOutList associated with the pool.</p>
1889
+ */
1890
+ OptOutListName: string | undefined;
1891
+ /**
1892
+ * <p>Allows you to enable shared routes on your pool.</p>
1893
+ * <p>By default, this is set to <code>False</code>. If you set this value to
1894
+ * <code>True</code>, your messages are sent using phone numbers or sender IDs
1895
+ * (depending on the country) that are shared with other Amazon Pinpoint users. In some
1896
+ * countries, such as the United States, senders aren't allowed to use shared routes and
1897
+ * must use a dedicated phone number or short code.</p>
1898
+ */
1899
+ SharedRoutesEnabled: boolean | undefined;
1900
+ /**
1901
+ * <p>When set to true the pool can't be deleted.</p>
1902
+ */
1903
+ DeletionProtectionEnabled: boolean | undefined;
1904
+ /**
1905
+ * <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
1906
+ */
1907
+ CreatedTimestamp: Date | undefined;
1908
+ }
1909
+ export declare namespace PoolInformation {
1910
+ /**
1911
+ * @internal
1912
+ */
1913
+ const filterSensitiveLog: (obj: PoolInformation) => any;
1914
+ }
1915
+ export interface DescribePoolsResult {
1916
+ /**
1917
+ * <p>An array of PoolInformation objects that contain the details for the requested pools. </p>
1918
+ */
1919
+ Pools?: PoolInformation[];
1920
+ /**
1921
+ * <p>The token to be used for the next set of paginated results. If this field is empty
1922
+ * then there are no more results.</p>
1923
+ */
1924
+ NextToken?: string;
1925
+ }
1926
+ export declare namespace DescribePoolsResult {
1927
+ /**
1928
+ * @internal
1929
+ */
1930
+ const filterSensitiveLog: (obj: DescribePoolsResult) => any;
1931
+ }
1932
+ export declare enum SenderIdFilterName {
1933
+ ISO_COUNTRY_CODE = "iso-country-code",
1934
+ MESSAGE_TYPE = "message-type",
1935
+ SENDER_ID = "sender-id"
1936
+ }
1937
+ /**
1938
+ * <p>The information for a sender ID that meets a specified criteria.</p>
1939
+ */
1940
+ export interface SenderIdFilter {
1941
+ /**
1942
+ * <p>The name of the attribute to filter on.</p>
1943
+ */
1944
+ Name: SenderIdFilterName | string | undefined;
1945
+ /**
1946
+ * <p>An array of values to filter for.</p>
1947
+ */
1948
+ Values: string[] | undefined;
1949
+ }
1950
+ export declare namespace SenderIdFilter {
1951
+ /**
1952
+ * @internal
1953
+ */
1954
+ const filterSensitiveLog: (obj: SenderIdFilter) => any;
1955
+ }
1956
+ /**
1957
+ * <p> The alphanumeric sender ID in a specific country that you want to describe. For more
1958
+ * information on sender IDs see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html">Requesting
1959
+ * sender IDs for SMS messaging with Amazon Pinpoint
1960
+ * </a> in the <i>Amazon Pinpoint User Guide</i>.</p>
1961
+ */
1962
+ export interface SenderIdAndCountry {
1963
+ /**
1964
+ * <p>The unique identifier of the sender.</p>
1965
+ */
1966
+ SenderId: string | undefined;
1967
+ /**
1968
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
1969
+ * </p>
1970
+ */
1971
+ IsoCountryCode: string | undefined;
1972
+ }
1973
+ export declare namespace SenderIdAndCountry {
1974
+ /**
1975
+ * @internal
1976
+ */
1977
+ const filterSensitiveLog: (obj: SenderIdAndCountry) => any;
1978
+ }
1979
+ export interface DescribeSenderIdsRequest {
1980
+ /**
1981
+ * <p>An array of SenderIdAndCountry objects to search for.</p>
1982
+ */
1983
+ SenderIds?: SenderIdAndCountry[];
1984
+ /**
1985
+ * <p>An array of SenderIdFilter objects to filter the results.</p>
1986
+ */
1987
+ Filters?: SenderIdFilter[];
1988
+ /**
1989
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
1990
+ * value for this field in the initial request.</p>
1991
+ */
1992
+ NextToken?: string;
1993
+ /**
1994
+ * <p>The maximum number of results to return per each request.</p>
1995
+ */
1996
+ MaxResults?: number;
1997
+ }
1998
+ export declare namespace DescribeSenderIdsRequest {
1999
+ /**
2000
+ * @internal
2001
+ */
2002
+ const filterSensitiveLog: (obj: DescribeSenderIdsRequest) => any;
2003
+ }
2004
+ /**
2005
+ * <p>The information for all SenderIds in an Amazon Web Services account.</p>
2006
+ */
2007
+ export interface SenderIdInformation {
2008
+ /**
2009
+ * <p>The Amazon Resource Name (ARN) associated with the SenderId.</p>
2010
+ */
2011
+ SenderIdArn: string | undefined;
2012
+ /**
2013
+ * <p>The alphanumeric sender ID in a specific country that you'd like to describe.</p>
2014
+ */
2015
+ SenderId: string | undefined;
2016
+ /**
2017
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
2018
+ * </p>
2019
+ */
2020
+ IsoCountryCode: string | undefined;
2021
+ /**
2022
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
2023
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
2024
+ * time-sensitive.</p>
2025
+ */
2026
+ MessageTypes: (MessageType | string)[] | undefined;
2027
+ /**
2028
+ * <p>The monthly leasing price, in US dollars.</p>
2029
+ */
2030
+ MonthlyLeasingPrice: string | undefined;
2031
+ }
2032
+ export declare namespace SenderIdInformation {
2033
+ /**
2034
+ * @internal
2035
+ */
2036
+ const filterSensitiveLog: (obj: SenderIdInformation) => any;
2037
+ }
2038
+ export interface DescribeSenderIdsResult {
2039
+ /**
2040
+ * <p>An array of SernderIdInformation objects that contain the details for the requested
2041
+ * SenderIds.</p>
2042
+ */
2043
+ SenderIds?: SenderIdInformation[];
2044
+ /**
2045
+ * <p>The token to be used for the next set of paginated results. If this field is empty
2046
+ * then there are no more results.</p>
2047
+ */
2048
+ NextToken?: string;
2049
+ }
2050
+ export declare namespace DescribeSenderIdsResult {
2051
+ /**
2052
+ * @internal
2053
+ */
2054
+ const filterSensitiveLog: (obj: DescribeSenderIdsResult) => any;
2055
+ }
2056
+ export interface DescribeSpendLimitsRequest {
2057
+ /**
2058
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
2059
+ * value for this field in the initial request.</p>
2060
+ */
2061
+ NextToken?: string;
2062
+ /**
2063
+ * <p>The maximum number of results to return per each request.</p>
2064
+ */
2065
+ MaxResults?: number;
2066
+ }
2067
+ export declare namespace DescribeSpendLimitsRequest {
2068
+ /**
2069
+ * @internal
2070
+ */
2071
+ const filterSensitiveLog: (obj: DescribeSpendLimitsRequest) => any;
2072
+ }
2073
+ export declare enum SpendLimitName {
2074
+ TEXT_MESSAGE_MONTHLY_SPEND_LIMIT = "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT",
2075
+ VOICE_MESSAGE_MONTHLY_SPEND_LIMIT = "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"
2076
+ }
2077
+ /**
2078
+ * <p>Describes the current Amazon Pinpoint monthly spend limits for sending voice and
2079
+ * text messages. For more information on increasing your monthly spend limit, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html">
2080
+ * Requesting increases to your monthly SMS spending quota for Amazon Pinpoint
2081
+ * </a> in the <i>Amazon Pinpoint User Guide</i>. </p>
2082
+ */
2083
+ export interface SpendLimit {
2084
+ /**
2085
+ * <p>The name for the SpendLimit.</p>
2086
+ */
2087
+ Name: SpendLimitName | string | undefined;
2088
+ /**
2089
+ * <p>The maximum amount of money, in US dollars, that you want to be able to spend sending
2090
+ * messages each month. This value has to be less than or equal to the amount in
2091
+ * <code>MaxLimit</code>. To use this custom limit, <code>Overridden</code> must be set
2092
+ * to true.</p>
2093
+ */
2094
+ EnforcedLimit: number | undefined;
2095
+ /**
2096
+ * <p> The maximum amount of money that you are able to spend to send messages each month,
2097
+ * in US dollars.</p>
2098
+ */
2099
+ MaxLimit: number | undefined;
2100
+ /**
2101
+ * <p>When set to <code>True</code>, the value that has been specified in the
2102
+ * <code>EnforcedLimit</code> is used to determine the maximum amount in US dollars
2103
+ * that can be spent to send messages each month, in US dollars.</p>
2104
+ */
2105
+ Overridden: boolean | undefined;
2106
+ }
2107
+ export declare namespace SpendLimit {
2108
+ /**
2109
+ * @internal
2110
+ */
2111
+ const filterSensitiveLog: (obj: SpendLimit) => any;
2112
+ }
2113
+ export interface DescribeSpendLimitsResult {
2114
+ /**
2115
+ * <p>An array of SpendLimit objects that contain the details for the requested spend
2116
+ * limits.</p>
2117
+ */
2118
+ SpendLimits?: SpendLimit[];
2119
+ /**
2120
+ * <p>The token to be used for the next set of paginated results. If this field is empty
2121
+ * then there are no more results.</p>
2122
+ */
2123
+ NextToken?: string;
2124
+ }
2125
+ export declare namespace DescribeSpendLimitsResult {
2126
+ /**
2127
+ * @internal
2128
+ */
2129
+ const filterSensitiveLog: (obj: DescribeSpendLimitsResult) => any;
2130
+ }
2131
+ export declare enum DestinationCountryParameterKey {
2132
+ IN_ENTITY_ID = "IN_ENTITY_ID",
2133
+ IN_TEMPLATE_ID = "IN_TEMPLATE_ID"
2134
+ }
2135
+ export interface DisassociateOriginationIdentityRequest {
2136
+ /**
2137
+ * <p>The unique identifier for the pool to disassociate with the origination identity. This
2138
+ * value can be either the PoolId or PoolArn.</p>
2139
+ */
2140
+ PoolId: string | undefined;
2141
+ /**
2142
+ * <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
2143
+ * SenderIdArn. You can use <a>DescribePhoneNumbers</a> find the values for
2144
+ * PhoneNumberId and PhoneNumberArn, or use <a>DescribeSenderIds</a> to get the
2145
+ * values for SenderId and SenderIdArn.</p>
2146
+ */
2147
+ OriginationIdentity: string | undefined;
2148
+ /**
2149
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
2150
+ * </p>
2151
+ */
2152
+ IsoCountryCode: string | undefined;
2153
+ /**
2154
+ * <p>Unique, case-sensitive identifier you provide to ensure the idempotency of the
2155
+ * request. If you don't specify a client token, a randomly generated token is used for the
2156
+ * request to ensure idempotency.</p>
2157
+ */
2158
+ ClientToken?: string;
2159
+ }
2160
+ export declare namespace DisassociateOriginationIdentityRequest {
2161
+ /**
2162
+ * @internal
2163
+ */
2164
+ const filterSensitiveLog: (obj: DisassociateOriginationIdentityRequest) => any;
2165
+ }
2166
+ export interface DisassociateOriginationIdentityResult {
2167
+ /**
2168
+ * <p>The Amazon Resource Name (ARN) of the pool.</p>
2169
+ */
2170
+ PoolArn?: string;
2171
+ /**
2172
+ * <p>The PoolId of the pool no longer associated with the origination identity.</p>
2173
+ */
2174
+ PoolId?: string;
2175
+ /**
2176
+ * <p>The PhoneNumberArn or SenderIdArn of the origination identity.</p>
2177
+ */
2178
+ OriginationIdentityArn?: string;
2179
+ /**
2180
+ * <p>The PhoneNumberId or SenderId of the origination identity.</p>
2181
+ */
2182
+ OriginationIdentity?: string;
2183
+ /**
2184
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or
2185
+ * region.</p>
2186
+ */
2187
+ IsoCountryCode?: string;
2188
+ }
2189
+ export declare namespace DisassociateOriginationIdentityResult {
2190
+ /**
2191
+ * @internal
2192
+ */
2193
+ const filterSensitiveLog: (obj: DisassociateOriginationIdentityResult) => any;
2194
+ }
2195
+ export declare enum PoolOriginationIdentitiesFilterName {
2196
+ ISO_COUNTRY_CODE = "iso-country-code",
2197
+ NUMBER_CAPABILITY = "number-capability"
2198
+ }
2199
+ /**
2200
+ * <p>Information about origination identities associated with a pool that meets a specified
2201
+ * criteria.</p>
2202
+ */
2203
+ export interface PoolOriginationIdentitiesFilter {
2204
+ /**
2205
+ * <p>The name of the attribute to filter on.</p>
2206
+ */
2207
+ Name: PoolOriginationIdentitiesFilterName | string | undefined;
2208
+ /**
2209
+ * <p>An array values to filter for.</p>
2210
+ */
2211
+ Values: string[] | undefined;
2212
+ }
2213
+ export declare namespace PoolOriginationIdentitiesFilter {
2214
+ /**
2215
+ * @internal
2216
+ */
2217
+ const filterSensitiveLog: (obj: PoolOriginationIdentitiesFilter) => any;
2218
+ }
2219
+ export interface ListPoolOriginationIdentitiesRequest {
2220
+ /**
2221
+ * <p>The unique identifier for the pool. This value can be either the PoolId or
2222
+ * PoolArn.</p>
2223
+ */
2224
+ PoolId: string | undefined;
2225
+ /**
2226
+ * <p>An array of PoolOriginationIdentitiesFilter objects to filter the results..</p>
2227
+ */
2228
+ Filters?: PoolOriginationIdentitiesFilter[];
2229
+ /**
2230
+ * <p>The token to be used for the next set of paginated results. You don't need to supply a
2231
+ * value for this field in the initial request.</p>
2232
+ */
2233
+ NextToken?: string;
2234
+ /**
2235
+ * <p>The maximum number of results to return per each request.</p>
2236
+ */
2237
+ MaxResults?: number;
2238
+ }
2239
+ export declare namespace ListPoolOriginationIdentitiesRequest {
2240
+ /**
2241
+ * @internal
2242
+ */
2243
+ const filterSensitiveLog: (obj: ListPoolOriginationIdentitiesRequest) => any;
2244
+ }
2245
+ /**
2246
+ * <p>The metadata for an origination identity associated with a pool.</p>
2247
+ */
2248
+ export interface OriginationIdentityMetadata {
2249
+ /**
2250
+ * <p>The Amazon Resource Name (ARN) associated with the origination identity.</p>
2251
+ */
2252
+ OriginationIdentityArn: string | undefined;
2253
+ /**
2254
+ * <p>The unique identifier of the origination identity.</p>
2255
+ */
2256
+ OriginationIdentity: string | undefined;
2257
+ /**
2258
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
2259
+ * </p>
2260
+ */
2261
+ IsoCountryCode: string | undefined;
2262
+ /**
2263
+ * <p>Describes if the origination identity can be used for text messages, voice calls or
2264
+ * both.</p>
2265
+ */
2266
+ NumberCapabilities: (NumberCapability | string)[] | undefined;
2267
+ }
2268
+ export declare namespace OriginationIdentityMetadata {
2269
+ /**
2270
+ * @internal
2271
+ */
2272
+ const filterSensitiveLog: (obj: OriginationIdentityMetadata) => any;
2273
+ }
2274
+ export interface ListPoolOriginationIdentitiesResult {
2275
+ /**
2276
+ * <p>The Amazon Resource Name (ARN) for the pool.</p>
2277
+ */
2278
+ PoolArn?: string;
2279
+ /**
2280
+ * <p>The unique PoolId of the pool.</p>
2281
+ */
2282
+ PoolId?: string;
2283
+ /**
2284
+ * <p>An array of any OriginationIdentityMetadata objects.</p>
2285
+ */
2286
+ OriginationIdentities?: OriginationIdentityMetadata[];
2287
+ /**
2288
+ * <p>The token to be used for the next set of paginated results. If this field is empty
2289
+ * then there are no more results.</p>
2290
+ */
2291
+ NextToken?: string;
2292
+ }
2293
+ export declare namespace ListPoolOriginationIdentitiesResult {
2294
+ /**
2295
+ * @internal
2296
+ */
2297
+ const filterSensitiveLog: (obj: ListPoolOriginationIdentitiesResult) => any;
2298
+ }
2299
+ export interface ListTagsForResourceRequest {
2300
+ /**
2301
+ * <p>The Amazon Resource Name (ARN) of the resource to query for.</p>
2302
+ */
2303
+ ResourceArn: string | undefined;
2304
+ }
2305
+ export declare namespace ListTagsForResourceRequest {
2306
+ /**
2307
+ * @internal
2308
+ */
2309
+ const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2310
+ }
2311
+ export interface ListTagsForResourceResult {
2312
+ /**
2313
+ * <p>The ARN of the resource.</p>
2314
+ */
2315
+ ResourceArn?: string;
2316
+ /**
2317
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
2318
+ */
2319
+ Tags?: Tag[];
2320
+ }
2321
+ export declare namespace ListTagsForResourceResult {
2322
+ /**
2323
+ * @internal
2324
+ */
2325
+ const filterSensitiveLog: (obj: ListTagsForResourceResult) => any;
2326
+ }
2327
+ export interface PutKeywordRequest {
2328
+ /**
2329
+ * <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
2330
+ * SenderIdArn. You can use <a>DescribePhoneNumbers</a> get the values for
2331
+ * PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used
2332
+ * to get the values for SenderId and SenderIdArn.</p>
2333
+ */
2334
+ OriginationIdentity: string | undefined;
2335
+ /**
2336
+ * <p>The new keyword to add.</p>
2337
+ */
2338
+ Keyword: string | undefined;
2339
+ /**
2340
+ * <p>The message associated with the keyword.</p>
2341
+ * <ul>
2342
+ * <li>
2343
+ * <p>AUTOMATIC_RESPONSE: A message is sent to the recipient.</p>
2344
+ * </li>
2345
+ * <li>
2346
+ * <p>OPT_OUT: Keeps the recipient from receiving future messages.</p>
2347
+ * </li>
2348
+ * <li>
2349
+ * <p>OPT_IN: The recipient wants to receive future messages.</p>
2350
+ * </li>
2351
+ * </ul>
2352
+ */
2353
+ KeywordMessage: string | undefined;
2354
+ /**
2355
+ * <p>The action to perform for the new keyword when it is received.</p>
2356
+ */
2357
+ KeywordAction?: KeywordAction | string;
2358
+ }
2359
+ export declare namespace PutKeywordRequest {
2360
+ /**
2361
+ * @internal
2362
+ */
2363
+ const filterSensitiveLog: (obj: PutKeywordRequest) => any;
2364
+ }
2365
+ export interface PutKeywordResult {
2366
+ /**
2367
+ * <p>The PhoneNumberArn or PoolArn that the keyword was associated with.</p>
2368
+ */
2369
+ OriginationIdentityArn?: string;
2370
+ /**
2371
+ * <p>The PhoneNumberId or PoolId that the keyword was associated with.</p>
2372
+ */
2373
+ OriginationIdentity?: string;
2374
+ /**
2375
+ * <p>The keyword that was added.</p>
2376
+ */
2377
+ Keyword?: string;
2378
+ /**
2379
+ * <p>The message associated with the keyword.</p>
2380
+ */
2381
+ KeywordMessage?: string;
2382
+ /**
2383
+ * <p>The action to perform when the keyword is used.</p>
2384
+ */
2385
+ KeywordAction?: KeywordAction | string;
2386
+ }
2387
+ export declare namespace PutKeywordResult {
2388
+ /**
2389
+ * @internal
2390
+ */
2391
+ const filterSensitiveLog: (obj: PutKeywordResult) => any;
2392
+ }
2393
+ export interface PutOptedOutNumberRequest {
2394
+ /**
2395
+ * <p>The OptOutListName or OptOutListArn to add the phone number to.</p>
2396
+ */
2397
+ OptOutListName: string | undefined;
2398
+ /**
2399
+ * <p>The phone number to add to the OptOutList in E.164 format.</p>
2400
+ */
2401
+ OptedOutNumber: string | undefined;
2402
+ }
2403
+ export declare namespace PutOptedOutNumberRequest {
2404
+ /**
2405
+ * @internal
2406
+ */
2407
+ const filterSensitiveLog: (obj: PutOptedOutNumberRequest) => any;
2408
+ }
2409
+ export interface PutOptedOutNumberResult {
2410
+ /**
2411
+ * <p>The OptOutListArn that the phone number was removed from.</p>
2412
+ */
2413
+ OptOutListArn?: string;
2414
+ /**
2415
+ * <p>The OptOutListName that the phone number was removed from.</p>
2416
+ */
2417
+ OptOutListName?: string;
2418
+ /**
2419
+ * <p>The phone number that was added to the OptOutList.</p>
2420
+ */
2421
+ OptedOutNumber?: string;
2422
+ /**
2423
+ * <p>The time that the phone number was added to the OptOutList, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
2424
+ */
2425
+ OptedOutTimestamp?: Date;
2426
+ /**
2427
+ * <p>This is true if it was the end user who requested their phone number be removed.
2428
+ * </p>
2429
+ */
2430
+ EndUserOptedOut?: boolean;
2431
+ }
2432
+ export declare namespace PutOptedOutNumberResult {
2433
+ /**
2434
+ * @internal
2435
+ */
2436
+ const filterSensitiveLog: (obj: PutOptedOutNumberResult) => any;
2437
+ }
2438
+ export interface ReleasePhoneNumberRequest {
2439
+ /**
2440
+ * <p>The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use <a>DescribePhoneNumbers</a> to get the values for PhoneNumberId and
2441
+ * PhoneNumberArn.</p>
2442
+ */
2443
+ PhoneNumberId: string | undefined;
2444
+ }
2445
+ export declare namespace ReleasePhoneNumberRequest {
2446
+ /**
2447
+ * @internal
2448
+ */
2449
+ const filterSensitiveLog: (obj: ReleasePhoneNumberRequest) => any;
2450
+ }
2451
+ export interface ReleasePhoneNumberResult {
2452
+ /**
2453
+ * <p>The PhoneNumberArn of the phone number that was released.</p>
2454
+ */
2455
+ PhoneNumberArn?: string;
2456
+ /**
2457
+ * <p>The PhoneNumberId of the phone number that was released.</p>
2458
+ */
2459
+ PhoneNumberId?: string;
2460
+ /**
2461
+ * <p>The phone number that was released.</p>
2462
+ */
2463
+ PhoneNumber?: string;
2464
+ /**
2465
+ * <p>The current status of the request.</p>
2466
+ */
2467
+ Status?: NumberStatus | string;
2468
+ /**
2469
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or
2470
+ * region.</p>
2471
+ */
2472
+ IsoCountryCode?: string;
2473
+ /**
2474
+ * <p>The message type that was associated with the phone number.</p>
2475
+ */
2476
+ MessageType?: MessageType | string;
2477
+ /**
2478
+ * <p>Specifies if the number could be used for text messages, voice, or both.</p>
2479
+ */
2480
+ NumberCapabilities?: (NumberCapability | string)[];
2481
+ /**
2482
+ * <p>The type of number that was released.</p>
2483
+ */
2484
+ NumberType?: NumberType | string;
2485
+ /**
2486
+ * <p>The monthly price of the phone number, in US dollars.</p>
2487
+ */
2488
+ MonthlyLeasingPrice?: string;
2489
+ /**
2490
+ * <p>By default this is set to false. When set to true you can receive incoming text
2491
+ * messages from your end recipients.</p>
2492
+ */
2493
+ TwoWayEnabled?: boolean;
2494
+ /**
2495
+ * <p>The Amazon Resource Name (ARN) of the TwoWayChannel.</p>
2496
+ */
2497
+ TwoWayChannelArn?: string;
2498
+ /**
2499
+ * <p>By default this is set to false. When an end recipient sends a message that begins
2500
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
2501
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
2502
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
2503
+ * responsible for tracking and honoring opt-out requests.</p>
2504
+ */
2505
+ SelfManagedOptOutsEnabled?: boolean;
2506
+ /**
2507
+ * <p>The name of the OptOutList that was associated with the phone number.</p>
2508
+ */
2509
+ OptOutListName?: string;
2510
+ /**
2511
+ * <p>The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
2512
+ */
2513
+ CreatedTimestamp?: Date;
2514
+ }
2515
+ export declare namespace ReleasePhoneNumberResult {
2516
+ /**
2517
+ * @internal
2518
+ */
2519
+ const filterSensitiveLog: (obj: ReleasePhoneNumberResult) => any;
2520
+ }
2521
+ export declare enum RequestableNumberType {
2522
+ LONG_CODE = "LONG_CODE",
2523
+ TEN_DLC = "TEN_DLC",
2524
+ TOLL_FREE = "TOLL_FREE"
2525
+ }
2526
+ export interface RequestPhoneNumberRequest {
2527
+ /**
2528
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
2529
+ * </p>
2530
+ */
2531
+ IsoCountryCode: string | undefined;
2532
+ /**
2533
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
2534
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
2535
+ * time-sensitive.</p>
2536
+ */
2537
+ MessageType: MessageType | string | undefined;
2538
+ /**
2539
+ * <p>Indicates if the phone number will be used for text messages, voice messages, or both. </p>
2540
+ */
2541
+ NumberCapabilities: (NumberCapability | string)[] | undefined;
2542
+ /**
2543
+ * <p>The type of phone number to request.</p>
2544
+ */
2545
+ NumberType: RequestableNumberType | string | undefined;
2546
+ /**
2547
+ * <p>The name of the OptOutList to associate with the phone number. You can use the
2548
+ * OutOutListName or OptPutListArn.</p>
2549
+ */
2550
+ OptOutListName?: string;
2551
+ /**
2552
+ * <p>The pool to associated with the phone number. You can use the PoolId or PoolArn. </p>
2553
+ */
2554
+ PoolId?: string;
2555
+ /**
2556
+ * <p>Use this field to attach your phone number for an external registration
2557
+ * process.</p>
2558
+ */
2559
+ RegistrationId?: string;
2560
+ /**
2561
+ * <p>By default this is set to false. When set to true the phone number can't be
2562
+ * deleted.</p>
2563
+ */
2564
+ DeletionProtectionEnabled?: boolean;
2565
+ /**
2566
+ * <p>An array of tags (key and value pairs) associate with the requested phone number.
2567
+ * </p>
2568
+ */
2569
+ Tags?: Tag[];
2570
+ /**
2571
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
2572
+ * request. If you don't specify a client token, a randomly generated token is used for the
2573
+ * request to ensure idempotency.</p>
2574
+ */
2575
+ ClientToken?: string;
2576
+ }
2577
+ export declare namespace RequestPhoneNumberRequest {
2578
+ /**
2579
+ * @internal
2580
+ */
2581
+ const filterSensitiveLog: (obj: RequestPhoneNumberRequest) => any;
2582
+ }
2583
+ export interface RequestPhoneNumberResult {
2584
+ /**
2585
+ * <p>The Amazon Resource Name (ARN) of the requested phone number.</p>
2586
+ */
2587
+ PhoneNumberArn?: string;
2588
+ /**
2589
+ * <p>The unique identifier of the new phone number.</p>
2590
+ */
2591
+ PhoneNumberId?: string;
2592
+ /**
2593
+ * <p>The new phone number that was requested.</p>
2594
+ */
2595
+ PhoneNumber?: string;
2596
+ /**
2597
+ * <p>The current status of the request.</p>
2598
+ */
2599
+ Status?: NumberStatus | string;
2600
+ /**
2601
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
2602
+ * </p>
2603
+ */
2604
+ IsoCountryCode?: string;
2605
+ /**
2606
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
2607
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
2608
+ * time-sensitive.</p>
2609
+ */
2610
+ MessageType?: MessageType | string;
2611
+ /**
2612
+ * <p>Indicates if the phone number will be used for text messages, voice messages or both.
2613
+ * </p>
2614
+ */
2615
+ NumberCapabilities?: (NumberCapability | string)[];
2616
+ /**
2617
+ * <p>The type of number that was released.</p>
2618
+ */
2619
+ NumberType?: RequestableNumberType | string;
2620
+ /**
2621
+ * <p>The monthly price, in US dollars, to lease the phone number.</p>
2622
+ */
2623
+ MonthlyLeasingPrice?: string;
2624
+ /**
2625
+ * <p>By default this is set to false. When set to true you can receive incoming text
2626
+ * messages from your end recipients.</p>
2627
+ */
2628
+ TwoWayEnabled?: boolean;
2629
+ /**
2630
+ * <p>The ARN used to identify the two way channel.</p>
2631
+ */
2632
+ TwoWayChannelArn?: string;
2633
+ /**
2634
+ * <p>By default this is set to false. When an end recipient sends a message that begins
2635
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
2636
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
2637
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
2638
+ * responsible for tracking and honoring opt-out requests.</p>
2639
+ */
2640
+ SelfManagedOptOutsEnabled?: boolean;
2641
+ /**
2642
+ * <p>The name of the OptOutList that is associated with the requested phone number.</p>
2643
+ */
2644
+ OptOutListName?: string;
2645
+ /**
2646
+ * <p>By default this is set to false. When set to true the phone number can't be deleted.
2647
+ * </p>
2648
+ */
2649
+ DeletionProtectionEnabled?: boolean;
2650
+ /**
2651
+ * <p>The unique identifier of the pool associated with the phone number </p>
2652
+ */
2653
+ PoolId?: string;
2654
+ /**
2655
+ * <p>An array of key and value pair tags that are associated with the phone number.</p>
2656
+ */
2657
+ Tags?: Tag[];
2658
+ /**
2659
+ * <p>The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
2660
+ */
2661
+ CreatedTimestamp?: Date;
2662
+ }
2663
+ export declare namespace RequestPhoneNumberResult {
2664
+ /**
2665
+ * @internal
2666
+ */
2667
+ const filterSensitiveLog: (obj: RequestPhoneNumberResult) => any;
2668
+ }
2669
+ export interface SendTextMessageRequest {
2670
+ /**
2671
+ * <p>The destination phone number in E.164 format.</p>
2672
+ */
2673
+ DestinationPhoneNumber: string | undefined;
2674
+ /**
2675
+ * <p>The origination identity of the message. This can be either the PhoneNumber,
2676
+ * PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</p>
2677
+ */
2678
+ OriginationIdentity?: string;
2679
+ /**
2680
+ * <p>The body of the text message.</p>
2681
+ */
2682
+ MessageBody?: string;
2683
+ /**
2684
+ * <p>The type of message. Valid values are
2685
+ * TRANSACTIONAL
2686
+ * for messages that are critical or time-sensitive and PROMOTIONAL for messages that
2687
+ * aren't critical or time-sensitive.</p>
2688
+ */
2689
+ MessageType?: MessageType | string;
2690
+ /**
2691
+ * <p>When you register a short code in the US, you must specify a program name. If you
2692
+ * don’t have a US short code, omit this attribute.</p>
2693
+ */
2694
+ Keyword?: string;
2695
+ /**
2696
+ * <p>The name of the configuration set to use. This can be either the ConfigurationSetName
2697
+ * or ConfigurationSetArn.</p>
2698
+ */
2699
+ ConfigurationSetName?: string;
2700
+ /**
2701
+ * <p>The maximum amount that you want to spend, in US dollars, per each text message part.
2702
+ * A text message can contain multiple parts.</p>
2703
+ */
2704
+ MaxPrice?: string;
2705
+ /**
2706
+ * <p>How long the text message is valid for. By default this is 72 hours.</p>
2707
+ */
2708
+ TimeToLive?: number;
2709
+ /**
2710
+ * <p>You can specify custom data in this field. If you do, that data is logged to the event
2711
+ * destination.</p>
2712
+ */
2713
+ Context?: {
2714
+ [key: string]: string;
2715
+ };
2716
+ /**
2717
+ * <p>This field is used for any country-specific registration requirements. Currently, this
2718
+ * setting is only used when you send messages to recipients in India using a sender ID.
2719
+ * For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html">Special requirements for sending SMS messages to recipients in India</a>.
2720
+ * </p>
2721
+ */
2722
+ DestinationCountryParameters?: {
2723
+ [key: string]: string;
2724
+ };
2725
+ /**
2726
+ * <p>When set to true, the message is checked and validated, but isn't sent to the end
2727
+ * recipient.</p>
2728
+ */
2729
+ DryRun?: boolean;
2730
+ }
2731
+ export declare namespace SendTextMessageRequest {
2732
+ /**
2733
+ * @internal
2734
+ */
2735
+ const filterSensitiveLog: (obj: SendTextMessageRequest) => any;
2736
+ }
2737
+ export interface SendTextMessageResult {
2738
+ /**
2739
+ * <p>The unique identifier for the message.</p>
2740
+ */
2741
+ MessageId?: string;
2742
+ }
2743
+ export declare namespace SendTextMessageResult {
2744
+ /**
2745
+ * @internal
2746
+ */
2747
+ const filterSensitiveLog: (obj: SendTextMessageResult) => any;
2748
+ }
2749
+ export declare enum VoiceMessageBodyTextType {
2750
+ SSML = "SSML",
2751
+ TEXT = "TEXT"
2752
+ }
2753
+ export declare enum VoiceId {
2754
+ AMY = "AMY",
2755
+ ASTRID = "ASTRID",
2756
+ BIANCA = "BIANCA",
2757
+ BRIAN = "BRIAN",
2758
+ CAMILA = "CAMILA",
2759
+ CARLA = "CARLA",
2760
+ CARMEN = "CARMEN",
2761
+ CELINE = "CELINE",
2762
+ CHANTAL = "CHANTAL",
2763
+ CONCHITA = "CONCHITA",
2764
+ CRISTIANO = "CRISTIANO",
2765
+ DORA = "DORA",
2766
+ EMMA = "EMMA",
2767
+ ENRIQUE = "ENRIQUE",
2768
+ EWA = "EWA",
2769
+ FILIZ = "FILIZ",
2770
+ GERAINT = "GERAINT",
2771
+ GIORGIO = "GIORGIO",
2772
+ GWYNETH = "GWYNETH",
2773
+ HANS = "HANS",
2774
+ INES = "INES",
2775
+ IVY = "IVY",
2776
+ JACEK = "JACEK",
2777
+ JAN = "JAN",
2778
+ JOANNA = "JOANNA",
2779
+ JOEY = "JOEY",
2780
+ JUSTIN = "JUSTIN",
2781
+ KARL = "KARL",
2782
+ KENDRA = "KENDRA",
2783
+ KIMBERLY = "KIMBERLY",
2784
+ LEA = "LEA",
2785
+ LIV = "LIV",
2786
+ LOTTE = "LOTTE",
2787
+ LUCIA = "LUCIA",
2788
+ LUPE = "LUPE",
2789
+ MADS = "MADS",
2790
+ MAJA = "MAJA",
2791
+ MARLENE = "MARLENE",
2792
+ MATHIEU = "MATHIEU",
2793
+ MATTHEW = "MATTHEW",
2794
+ MAXIM = "MAXIM",
2795
+ MIA = "MIA",
2796
+ MIGUEL = "MIGUEL",
2797
+ MIZUKI = "MIZUKI",
2798
+ NAJA = "NAJA",
2799
+ NICOLE = "NICOLE",
2800
+ PENELOPE = "PENELOPE",
2801
+ RAVEENA = "RAVEENA",
2802
+ RICARDO = "RICARDO",
2803
+ RUBEN = "RUBEN",
2804
+ RUSSELL = "RUSSELL",
2805
+ SALLI = "SALLI",
2806
+ SEOYEON = "SEOYEON",
2807
+ TAKUMI = "TAKUMI",
2808
+ TATYANA = "TATYANA",
2809
+ VICKI = "VICKI",
2810
+ VITORIA = "VITORIA",
2811
+ ZEINA = "ZEINA",
2812
+ ZHIYU = "ZHIYU"
2813
+ }
2814
+ export interface SendVoiceMessageRequest {
2815
+ /**
2816
+ * <p>The destination phone number in E.164 format.</p>
2817
+ */
2818
+ DestinationPhoneNumber: string | undefined;
2819
+ /**
2820
+ * <p>The origination identity to use for the voice call. This can be the PhoneNumber,
2821
+ * PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.</p>
2822
+ */
2823
+ OriginationIdentity: string | undefined;
2824
+ /**
2825
+ * <p>The text to convert to a voice message.</p>
2826
+ */
2827
+ MessageBody?: string;
2828
+ /**
2829
+ * <p>Specifies if the MessageBody field contains text or <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">speech synthesis
2830
+ * markup language (SSML)</a>.</p>
2831
+ * <ul>
2832
+ * <li>
2833
+ * <p>TEXT: This is the default value. When used the maximum character limit is
2834
+ * 3000.</p>
2835
+ * </li>
2836
+ * <li>
2837
+ * <p>SSML: When used the maximum character limit is 6000 including SSML
2838
+ * tagging.</p>
2839
+ * </li>
2840
+ * </ul>
2841
+ */
2842
+ MessageBodyTextType?: VoiceMessageBodyTextType | string;
2843
+ /**
2844
+ * <p>The voice for the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly</a>
2845
+ * service to use. By default this is set to "MATTHEW".</p>
2846
+ */
2847
+ VoiceId?: VoiceId | string;
2848
+ /**
2849
+ * <p>The name of the configuration set to use. This can be either the ConfigurationSetName
2850
+ * or ConfigurationSetArn.</p>
2851
+ */
2852
+ ConfigurationSetName?: string;
2853
+ /**
2854
+ * <p>The maximum amount to spend per voice message, in US dollars.</p>
2855
+ */
2856
+ MaxPricePerMinute?: string;
2857
+ /**
2858
+ * <p>How long the voice message is valid for. By default this is 72 hours.</p>
2859
+ */
2860
+ TimeToLive?: number;
2861
+ /**
2862
+ * <p>You can specify custom data in this field. If you do, that data is logged to the event
2863
+ * destination.</p>
2864
+ */
2865
+ Context?: {
2866
+ [key: string]: string;
2867
+ };
2868
+ /**
2869
+ * <p>When set to true, the message is checked and validated, but isn't sent to the end
2870
+ * recipient.</p>
2871
+ */
2872
+ DryRun?: boolean;
2873
+ }
2874
+ export declare namespace SendVoiceMessageRequest {
2875
+ /**
2876
+ * @internal
2877
+ */
2878
+ const filterSensitiveLog: (obj: SendVoiceMessageRequest) => any;
2879
+ }
2880
+ export interface SendVoiceMessageResult {
2881
+ /**
2882
+ * <p>The unique identifier for the message.</p>
2883
+ */
2884
+ MessageId?: string;
2885
+ }
2886
+ export declare namespace SendVoiceMessageResult {
2887
+ /**
2888
+ * @internal
2889
+ */
2890
+ const filterSensitiveLog: (obj: SendVoiceMessageResult) => any;
2891
+ }
2892
+ export interface SetDefaultMessageTypeRequest {
2893
+ /**
2894
+ * <p>The configuration set to update with a new default message type. This field can be the
2895
+ * ConsigurationSetName or ConfigurationSetArn.</p>
2896
+ */
2897
+ ConfigurationSetName: string | undefined;
2898
+ /**
2899
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
2900
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
2901
+ * time-sensitive.</p>
2902
+ */
2903
+ MessageType: MessageType | string | undefined;
2904
+ }
2905
+ export declare namespace SetDefaultMessageTypeRequest {
2906
+ /**
2907
+ * @internal
2908
+ */
2909
+ const filterSensitiveLog: (obj: SetDefaultMessageTypeRequest) => any;
2910
+ }
2911
+ export interface SetDefaultMessageTypeResult {
2912
+ /**
2913
+ * <p>The Amazon Resource Name (ARN) of the updated configuration set.</p>
2914
+ */
2915
+ ConfigurationSetArn?: string;
2916
+ /**
2917
+ * <p>The name of the configuration set that was updated.</p>
2918
+ */
2919
+ ConfigurationSetName?: string;
2920
+ /**
2921
+ * <p>The new default message type of the configuration set.</p>
2922
+ */
2923
+ MessageType?: MessageType | string;
2924
+ }
2925
+ export declare namespace SetDefaultMessageTypeResult {
2926
+ /**
2927
+ * @internal
2928
+ */
2929
+ const filterSensitiveLog: (obj: SetDefaultMessageTypeResult) => any;
2930
+ }
2931
+ export interface SetDefaultSenderIdRequest {
2932
+ /**
2933
+ * <p>The configuration set to updated with a new default SenderId. This field can be the
2934
+ * ConsigurationSetName or ConfigurationSetArn.</p>
2935
+ */
2936
+ ConfigurationSetName: string | undefined;
2937
+ /**
2938
+ * <p>The current sender ID for the configuration set. When sending a text message to a
2939
+ * destination country which supports SenderIds, the default sender ID on the configuration
2940
+ * set specified on <a>SendTextMessage</a> will be used if no dedicated
2941
+ * origination phone numbers or registered SenderIds are available in your account, instead
2942
+ * of a generic sender ID, such as 'NOTICE'.</p>
2943
+ */
2944
+ SenderId: string | undefined;
2945
+ }
2946
+ export declare namespace SetDefaultSenderIdRequest {
2947
+ /**
2948
+ * @internal
2949
+ */
2950
+ const filterSensitiveLog: (obj: SetDefaultSenderIdRequest) => any;
2951
+ }
2952
+ export interface SetDefaultSenderIdResult {
2953
+ /**
2954
+ * <p>The Amazon Resource Name (ARN) of the updated configuration set.</p>
2955
+ */
2956
+ ConfigurationSetArn?: string;
2957
+ /**
2958
+ * <p>The name of the configuration set that was updated.</p>
2959
+ */
2960
+ ConfigurationSetName?: string;
2961
+ /**
2962
+ * <p>The default sender ID to set for the ConfigurationSet.</p>
2963
+ */
2964
+ SenderId?: string;
2965
+ }
2966
+ export declare namespace SetDefaultSenderIdResult {
2967
+ /**
2968
+ * @internal
2969
+ */
2970
+ const filterSensitiveLog: (obj: SetDefaultSenderIdResult) => any;
2971
+ }
2972
+ export interface SetTextMessageSpendLimitOverrideRequest {
2973
+ /**
2974
+ * <p>The new monthly limit to enforce on text messages.</p>
2975
+ */
2976
+ MonthlyLimit: number | undefined;
2977
+ }
2978
+ export declare namespace SetTextMessageSpendLimitOverrideRequest {
2979
+ /**
2980
+ * @internal
2981
+ */
2982
+ const filterSensitiveLog: (obj: SetTextMessageSpendLimitOverrideRequest) => any;
2983
+ }
2984
+ export interface SetTextMessageSpendLimitOverrideResult {
2985
+ /**
2986
+ * <p>The current monthly limit to enforce on sending text messages.</p>
2987
+ */
2988
+ MonthlyLimit?: number;
2989
+ }
2990
+ export declare namespace SetTextMessageSpendLimitOverrideResult {
2991
+ /**
2992
+ * @internal
2993
+ */
2994
+ const filterSensitiveLog: (obj: SetTextMessageSpendLimitOverrideResult) => any;
2995
+ }
2996
+ export interface SetVoiceMessageSpendLimitOverrideRequest {
2997
+ /**
2998
+ * <p>The new monthly limit to enforce on voice messages.</p>
2999
+ */
3000
+ MonthlyLimit: number | undefined;
3001
+ }
3002
+ export declare namespace SetVoiceMessageSpendLimitOverrideRequest {
3003
+ /**
3004
+ * @internal
3005
+ */
3006
+ const filterSensitiveLog: (obj: SetVoiceMessageSpendLimitOverrideRequest) => any;
3007
+ }
3008
+ export interface SetVoiceMessageSpendLimitOverrideResult {
3009
+ /**
3010
+ * <p>The current monthly limit to enforce on sending voice messages.</p>
3011
+ */
3012
+ MonthlyLimit?: number;
3013
+ }
3014
+ export declare namespace SetVoiceMessageSpendLimitOverrideResult {
3015
+ /**
3016
+ * @internal
3017
+ */
3018
+ const filterSensitiveLog: (obj: SetVoiceMessageSpendLimitOverrideResult) => any;
3019
+ }
3020
+ export interface TagResourceRequest {
3021
+ /**
3022
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3023
+ */
3024
+ ResourceArn: string | undefined;
3025
+ /**
3026
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
3027
+ */
3028
+ Tags: Tag[] | undefined;
3029
+ }
3030
+ export declare namespace TagResourceRequest {
3031
+ /**
3032
+ * @internal
3033
+ */
3034
+ const filterSensitiveLog: (obj: TagResourceRequest) => any;
3035
+ }
3036
+ export interface TagResourceResult {
3037
+ }
3038
+ export declare namespace TagResourceResult {
3039
+ /**
3040
+ * @internal
3041
+ */
3042
+ const filterSensitiveLog: (obj: TagResourceResult) => any;
3043
+ }
3044
+ export interface UntagResourceRequest {
3045
+ /**
3046
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3047
+ */
3048
+ ResourceArn: string | undefined;
3049
+ /**
3050
+ * <p>An array of tag key values to unassociate with the resource.</p>
3051
+ */
3052
+ TagKeys: string[] | undefined;
3053
+ }
3054
+ export declare namespace UntagResourceRequest {
3055
+ /**
3056
+ * @internal
3057
+ */
3058
+ const filterSensitiveLog: (obj: UntagResourceRequest) => any;
3059
+ }
3060
+ export interface UntagResourceResult {
3061
+ }
3062
+ export declare namespace UntagResourceResult {
3063
+ /**
3064
+ * @internal
3065
+ */
3066
+ const filterSensitiveLog: (obj: UntagResourceResult) => any;
3067
+ }
3068
+ export interface UpdateEventDestinationRequest {
3069
+ /**
3070
+ * <p>The configuration set to update with the new event destination. Valid values for this
3071
+ * can be the ConfigurationSetName or ConfigurationSetArn.</p>
3072
+ */
3073
+ ConfigurationSetName: string | undefined;
3074
+ /**
3075
+ * <p>The name to use for the event destination.</p>
3076
+ */
3077
+ EventDestinationName: string | undefined;
3078
+ /**
3079
+ * <p>When set to true logging is enabled.</p>
3080
+ */
3081
+ Enabled?: boolean;
3082
+ /**
3083
+ * <p>An array of event types that determine which events to log.</p>
3084
+ */
3085
+ MatchingEventTypes?: (EventType | string)[];
3086
+ /**
3087
+ * <p>An object that contains information about an event destination that sends data to
3088
+ * CloudWatch Logs.</p>
3089
+ */
3090
+ CloudWatchLogsDestination?: CloudWatchLogsDestination;
3091
+ /**
3092
+ * <p>An object that contains information about an event destination for logging to Kinesis Data Firehose.</p>
3093
+ */
3094
+ KinesisFirehoseDestination?: KinesisFirehoseDestination;
3095
+ /**
3096
+ * <p>An object that contains information about an event destination that sends data to
3097
+ * Amazon SNS.</p>
3098
+ */
3099
+ SnsDestination?: SnsDestination;
3100
+ }
3101
+ export declare namespace UpdateEventDestinationRequest {
3102
+ /**
3103
+ * @internal
3104
+ */
3105
+ const filterSensitiveLog: (obj: UpdateEventDestinationRequest) => any;
3106
+ }
3107
+ export interface UpdateEventDestinationResult {
3108
+ /**
3109
+ * <p>The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.</p>
3110
+ */
3111
+ ConfigurationSetArn?: string;
3112
+ /**
3113
+ * <p>The name of the configuration set.</p>
3114
+ */
3115
+ ConfigurationSetName?: string;
3116
+ /**
3117
+ * <p>An EventDestination object containing the details of where events will be logged.
3118
+ * </p>
3119
+ */
3120
+ EventDestination?: EventDestination;
3121
+ }
3122
+ export declare namespace UpdateEventDestinationResult {
3123
+ /**
3124
+ * @internal
3125
+ */
3126
+ const filterSensitiveLog: (obj: UpdateEventDestinationResult) => any;
3127
+ }
3128
+ export interface UpdatePhoneNumberRequest {
3129
+ /**
3130
+ * <p>The unique identifier of the phone number. Valid values for this field can be either
3131
+ * the PhoneNumberId or PhoneNumberArn.</p>
3132
+ */
3133
+ PhoneNumberId: string | undefined;
3134
+ /**
3135
+ * <p>By default this is set to false. When set to true you can receive incoming text
3136
+ * messages from your end recipients.</p>
3137
+ */
3138
+ TwoWayEnabled?: boolean;
3139
+ /**
3140
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
3141
+ */
3142
+ TwoWayChannelArn?: string;
3143
+ /**
3144
+ * <p>By default this is set to false. When an end recipient sends a message that begins
3145
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
3146
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
3147
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
3148
+ * responsible for tracking and honoring opt-out requests.</p>
3149
+ */
3150
+ SelfManagedOptOutsEnabled?: boolean;
3151
+ /**
3152
+ * <p>The OptOutList to add the phone number to. Valid values for this field can be either
3153
+ * the OutOutListName or OutOutListArn.</p>
3154
+ */
3155
+ OptOutListName?: string;
3156
+ /**
3157
+ * <p>By default this is set to false. When set to true the phone number can't be deleted.
3158
+ * </p>
3159
+ */
3160
+ DeletionProtectionEnabled?: boolean;
3161
+ }
3162
+ export declare namespace UpdatePhoneNumberRequest {
3163
+ /**
3164
+ * @internal
3165
+ */
3166
+ const filterSensitiveLog: (obj: UpdatePhoneNumberRequest) => any;
3167
+ }
3168
+ export interface UpdatePhoneNumberResult {
3169
+ /**
3170
+ * <p>The Amazon Resource Name (ARN) of the updated phone number.</p>
3171
+ */
3172
+ PhoneNumberArn?: string;
3173
+ /**
3174
+ * <p>The unique identifier of the phone number.</p>
3175
+ */
3176
+ PhoneNumberId?: string;
3177
+ /**
3178
+ * <p>The phone number that was updated.</p>
3179
+ */
3180
+ PhoneNumber?: string;
3181
+ /**
3182
+ * <p>The current status of the request.</p>
3183
+ */
3184
+ Status?: NumberStatus | string;
3185
+ /**
3186
+ * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
3187
+ * </p>
3188
+ */
3189
+ IsoCountryCode?: string;
3190
+ /**
3191
+ * <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
3192
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
3193
+ * time-sensitive.</p>
3194
+ */
3195
+ MessageType?: MessageType | string;
3196
+ /**
3197
+ * <p>Specifies if the number could be used for text messages, voice or both.</p>
3198
+ */
3199
+ NumberCapabilities?: (NumberCapability | string)[];
3200
+ /**
3201
+ * <p>The type of number that was requested.</p>
3202
+ */
3203
+ NumberType?: NumberType | string;
3204
+ /**
3205
+ * <p>The monthly leasing price of the phone number, in US dollars.</p>
3206
+ */
3207
+ MonthlyLeasingPrice?: string;
3208
+ /**
3209
+ * <p>By default this is set to false. When set to true you can receive incoming text
3210
+ * messages from your end recipients.</p>
3211
+ */
3212
+ TwoWayEnabled?: boolean;
3213
+ /**
3214
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
3215
+ */
3216
+ TwoWayChannelArn?: string;
3217
+ /**
3218
+ * <p>This is true if self managed opt-out are enabled.</p>
3219
+ */
3220
+ SelfManagedOptOutsEnabled?: boolean;
3221
+ /**
3222
+ * <p>The name of the OptOutList associated with the phone number.</p>
3223
+ */
3224
+ OptOutListName?: string;
3225
+ /**
3226
+ * <p>When set to true the phone number can't be deleted.</p>
3227
+ */
3228
+ DeletionProtectionEnabled?: boolean;
3229
+ /**
3230
+ * <p>The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
3231
+ */
3232
+ CreatedTimestamp?: Date;
3233
+ }
3234
+ export declare namespace UpdatePhoneNumberResult {
3235
+ /**
3236
+ * @internal
3237
+ */
3238
+ const filterSensitiveLog: (obj: UpdatePhoneNumberResult) => any;
3239
+ }
3240
+ export interface UpdatePoolRequest {
3241
+ /**
3242
+ * <p>The unique identifier of the pool to update. Valid values are either the PoolId or
3243
+ * PoolArn.</p>
3244
+ */
3245
+ PoolId: string | undefined;
3246
+ /**
3247
+ * <p>By default this is set to false. When set to true you can receive incoming text
3248
+ * messages from your end recipients.</p>
3249
+ */
3250
+ TwoWayEnabled?: boolean;
3251
+ /**
3252
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
3253
+ */
3254
+ TwoWayChannelArn?: string;
3255
+ /**
3256
+ * <p>By default this is set to false. When an end recipient sends a message that begins
3257
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
3258
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
3259
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
3260
+ * responsible for tracking and honoring opt-out requests.</p>
3261
+ */
3262
+ SelfManagedOptOutsEnabled?: boolean;
3263
+ /**
3264
+ * <p>The OptOutList to associate with the pool. Valid values are either OptOutListName or
3265
+ * OptOutListArn.</p>
3266
+ */
3267
+ OptOutListName?: string;
3268
+ /**
3269
+ * <p>Indicates whether shared routes are enabled for the pool.</p>
3270
+ */
3271
+ SharedRoutesEnabled?: boolean;
3272
+ /**
3273
+ * <p>When set to true the pool can't be deleted.</p>
3274
+ */
3275
+ DeletionProtectionEnabled?: boolean;
3276
+ }
3277
+ export declare namespace UpdatePoolRequest {
3278
+ /**
3279
+ * @internal
3280
+ */
3281
+ const filterSensitiveLog: (obj: UpdatePoolRequest) => any;
3282
+ }
3283
+ export interface UpdatePoolResult {
3284
+ /**
3285
+ * <p>The ARN of the pool.</p>
3286
+ */
3287
+ PoolArn?: string;
3288
+ /**
3289
+ * <p>The unique identifier of the pool.</p>
3290
+ */
3291
+ PoolId?: string;
3292
+ /**
3293
+ * <p>The current status of the pool update request.</p>
3294
+ */
3295
+ Status?: PoolStatus | string;
3296
+ /**
3297
+ * <p>The type of message for the pool to use.</p>
3298
+ */
3299
+ MessageType?: MessageType | string;
3300
+ /**
3301
+ * <p>By default this is set to false. When set to true you can receive incoming text
3302
+ * messages from your end recipients.</p>
3303
+ */
3304
+ TwoWayEnabled?: boolean;
3305
+ /**
3306
+ * <p>The Amazon Resource Name (ARN) of the two way channel.</p>
3307
+ */
3308
+ TwoWayChannelArn?: string;
3309
+ /**
3310
+ * <p>When an end recipient sends a message that begins with HELP or STOP to one of your
3311
+ * dedicated numbers, Amazon Pinpoint automatically replies with a customizable message
3312
+ * and adds the end recipient to the OptOutList. When set to true you're responsible for
3313
+ * responding to HELP and STOP requests. You're also responsible for tracking and honoring
3314
+ * opt-out requests.</p>
3315
+ */
3316
+ SelfManagedOptOutsEnabled?: boolean;
3317
+ /**
3318
+ * <p>The name of the OptOutList associated with the pool.</p>
3319
+ */
3320
+ OptOutListName?: string;
3321
+ /**
3322
+ * <p>Indicates whether shared routes are enabled for the pool.</p>
3323
+ */
3324
+ SharedRoutesEnabled?: boolean;
3325
+ /**
3326
+ * <p>When set to true the pool can't be deleted.</p>
3327
+ */
3328
+ DeletionProtectionEnabled?: boolean;
3329
+ /**
3330
+ * <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
3331
+ */
3332
+ CreatedTimestamp?: Date;
3333
+ }
3334
+ export declare namespace UpdatePoolResult {
3335
+ /**
3336
+ * @internal
3337
+ */
3338
+ const filterSensitiveLog: (obj: UpdatePoolResult) => any;
3339
+ }