@aws-sdk/client-endusermessaging 3.1145.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 (178) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +370 -0
  3. package/dist-cjs/index.js +1645 -0
  4. package/dist-es/EndUserMessaging.js +79 -0
  5. package/dist-es/EndUserMessagingClient.js +47 -0
  6. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  7. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  8. package/dist-es/commandBuilder.js +6 -0
  9. package/dist-es/commands/CreateBrandProfileAttributesCommand.js +4 -0
  10. package/dist-es/commands/CreateBrandProfileCommand.js +4 -0
  11. package/dist-es/commands/CreateBrandProfileFromRegistrationCommand.js +4 -0
  12. package/dist-es/commands/CreateNotifyCodeConfigurationCommand.js +4 -0
  13. package/dist-es/commands/CreateRegistrationsFromBrandProfileCommand.js +4 -0
  14. package/dist-es/commands/DeleteBrandProfileAttributeCommand.js +4 -0
  15. package/dist-es/commands/DeleteBrandProfileCommand.js +4 -0
  16. package/dist-es/commands/DeleteNotifyCodeConfigurationCommand.js +4 -0
  17. package/dist-es/commands/GetBrandProfileAttributeCommand.js +4 -0
  18. package/dist-es/commands/GetBrandProfileCommand.js +4 -0
  19. package/dist-es/commands/GetJobCommand.js +4 -0
  20. package/dist-es/commands/GetNotifyCodeConfigurationCommand.js +4 -0
  21. package/dist-es/commands/ListBrandProfileAttributesCommand.js +4 -0
  22. package/dist-es/commands/ListBrandProfilesCommand.js +4 -0
  23. package/dist-es/commands/ListJobsCommand.js +4 -0
  24. package/dist-es/commands/ListNotifyCodeConfigurationsCommand.js +4 -0
  25. package/dist-es/commands/ListRegistrationsFromBrandProfileCommand.js +4 -0
  26. package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
  27. package/dist-es/commands/SendNotifyCodeVerificationCommand.js +4 -0
  28. package/dist-es/commands/TagResourceCommand.js +4 -0
  29. package/dist-es/commands/UntagResourceCommand.js +4 -0
  30. package/dist-es/commands/UpdateBrandProfileAttributeCommand.js +4 -0
  31. package/dist-es/commands/UpdateBrandProfileCommand.js +4 -0
  32. package/dist-es/commands/UpdateBrandProfileFromRegistrationCommand.js +4 -0
  33. package/dist-es/commands/UpdateNotifyCodeConfigurationCommand.js +4 -0
  34. package/dist-es/commands/UpdateRegistrationsFromBrandProfileCommand.js +4 -0
  35. package/dist-es/commands/ValidateNotifyCodeVerificationCommand.js +4 -0
  36. package/dist-es/commands/index.js +27 -0
  37. package/dist-es/endpoint/EndpointParameters.js +13 -0
  38. package/dist-es/endpoint/bdd.js +46 -0
  39. package/dist-es/endpoint/endpointResolver.js +14 -0
  40. package/dist-es/extensionConfiguration.js +1 -0
  41. package/dist-es/index.js +11 -0
  42. package/dist-es/models/EndUserMessagingServiceException.js +8 -0
  43. package/dist-es/models/enums.js +43 -0
  44. package/dist-es/models/errors.js +99 -0
  45. package/dist-es/models/models_0.js +1 -0
  46. package/dist-es/pagination/Interfaces.js +1 -0
  47. package/dist-es/pagination/ListBrandProfileAttributesPaginator.js +4 -0
  48. package/dist-es/pagination/ListBrandProfilesPaginator.js +4 -0
  49. package/dist-es/pagination/ListJobsPaginator.js +4 -0
  50. package/dist-es/pagination/ListNotifyCodeConfigurationsPaginator.js +4 -0
  51. package/dist-es/pagination/ListRegistrationsFromBrandProfilePaginator.js +4 -0
  52. package/dist-es/pagination/index.js +6 -0
  53. package/dist-es/runtimeConfig.browser.js +29 -0
  54. package/dist-es/runtimeConfig.js +43 -0
  55. package/dist-es/runtimeConfig.native.js +9 -0
  56. package/dist-es/runtimeConfig.shared.js +40 -0
  57. package/dist-es/runtimeExtensions.js +9 -0
  58. package/dist-es/schemas/schemas_0.js +818 -0
  59. package/dist-es/waiters/index.js +2 -0
  60. package/dist-es/waiters/waitForBrandProfileActive.js +58 -0
  61. package/dist-es/waiters/waitForJobSuccess.js +40 -0
  62. package/dist-types/EndUserMessaging.d.ts +256 -0
  63. package/dist-types/EndUserMessagingClient.d.ts +213 -0
  64. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  65. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  66. package/dist-types/commandBuilder.d.ts +18 -0
  67. package/dist-types/commands/CreateBrandProfileAttributesCommand.d.ts +139 -0
  68. package/dist-types/commands/CreateBrandProfileCommand.d.ts +129 -0
  69. package/dist-types/commands/CreateBrandProfileFromRegistrationCommand.d.ts +130 -0
  70. package/dist-types/commands/CreateNotifyCodeConfigurationCommand.d.ts +206 -0
  71. package/dist-types/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +125 -0
  72. package/dist-types/commands/DeleteBrandProfileAttributeCommand.d.ts +110 -0
  73. package/dist-types/commands/DeleteBrandProfileCommand.d.ts +108 -0
  74. package/dist-types/commands/DeleteNotifyCodeConfigurationCommand.d.ts +102 -0
  75. package/dist-types/commands/GetBrandProfileAttributeCommand.d.ts +119 -0
  76. package/dist-types/commands/GetBrandProfileCommand.d.ts +115 -0
  77. package/dist-types/commands/GetJobCommand.d.ts +129 -0
  78. package/dist-types/commands/GetNotifyCodeConfigurationCommand.d.ts +156 -0
  79. package/dist-types/commands/ListBrandProfileAttributesCommand.d.ts +124 -0
  80. package/dist-types/commands/ListBrandProfilesCommand.d.ts +122 -0
  81. package/dist-types/commands/ListJobsCommand.d.ts +133 -0
  82. package/dist-types/commands/ListNotifyCodeConfigurationsCommand.d.ts +159 -0
  83. package/dist-types/commands/ListRegistrationsFromBrandProfileCommand.d.ts +121 -0
  84. package/dist-types/commands/ListTagsForResourceCommand.d.ts +113 -0
  85. package/dist-types/commands/SendNotifyCodeVerificationCommand.d.ts +151 -0
  86. package/dist-types/commands/TagResourceCommand.d.ts +114 -0
  87. package/dist-types/commands/UntagResourceCommand.d.ts +105 -0
  88. package/dist-types/commands/UpdateBrandProfileAttributeCommand.d.ts +127 -0
  89. package/dist-types/commands/UpdateBrandProfileCommand.d.ts +122 -0
  90. package/dist-types/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +123 -0
  91. package/dist-types/commands/UpdateNotifyCodeConfigurationCommand.d.ts +193 -0
  92. package/dist-types/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +127 -0
  93. package/dist-types/commands/ValidateNotifyCodeVerificationCommand.d.ts +104 -0
  94. package/dist-types/commands/index.d.ts +27 -0
  95. package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
  96. package/dist-types/endpoint/bdd.d.ts +2 -0
  97. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  98. package/dist-types/extensionConfiguration.d.ts +9 -0
  99. package/dist-types/index.d.ts +19 -0
  100. package/dist-types/models/EndUserMessagingServiceException.d.ts +14 -0
  101. package/dist-types/models/enums.d.ts +145 -0
  102. package/dist-types/models/errors.d.ts +119 -0
  103. package/dist-types/models/models_0.d.ts +1667 -0
  104. package/dist-types/pagination/Interfaces.d.ts +8 -0
  105. package/dist-types/pagination/ListBrandProfileAttributesPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListBrandProfilesPaginator.d.ts +7 -0
  107. package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
  108. package/dist-types/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +7 -0
  109. package/dist-types/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +7 -0
  110. package/dist-types/pagination/index.d.ts +6 -0
  111. package/dist-types/runtimeConfig.browser.d.ts +57 -0
  112. package/dist-types/runtimeConfig.d.ts +57 -0
  113. package/dist-types/runtimeConfig.native.d.ts +56 -0
  114. package/dist-types/runtimeConfig.shared.d.ts +28 -0
  115. package/dist-types/runtimeExtensions.d.ts +17 -0
  116. package/dist-types/schemas/schemas_0.d.ts +120 -0
  117. package/dist-types/ts3.4/EndUserMessaging.d.ts +515 -0
  118. package/dist-types/ts3.4/EndUserMessagingClient.d.ts +256 -0
  119. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
  120. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
  121. package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
  122. package/dist-types/ts3.4/commands/CreateBrandProfileAttributesCommand.d.ts +42 -0
  123. package/dist-types/ts3.4/commands/CreateBrandProfileCommand.d.ts +39 -0
  124. package/dist-types/ts3.4/commands/CreateBrandProfileFromRegistrationCommand.d.ts +42 -0
  125. package/dist-types/ts3.4/commands/CreateNotifyCodeConfigurationCommand.d.ts +42 -0
  126. package/dist-types/ts3.4/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +42 -0
  127. package/dist-types/ts3.4/commands/DeleteBrandProfileAttributeCommand.d.ts +42 -0
  128. package/dist-types/ts3.4/commands/DeleteBrandProfileCommand.d.ts +39 -0
  129. package/dist-types/ts3.4/commands/DeleteNotifyCodeConfigurationCommand.d.ts +42 -0
  130. package/dist-types/ts3.4/commands/GetBrandProfileAttributeCommand.d.ts +39 -0
  131. package/dist-types/ts3.4/commands/GetBrandProfileCommand.d.ts +38 -0
  132. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +38 -0
  133. package/dist-types/ts3.4/commands/GetNotifyCodeConfigurationCommand.d.ts +42 -0
  134. package/dist-types/ts3.4/commands/ListBrandProfileAttributesCommand.d.ts +42 -0
  135. package/dist-types/ts3.4/commands/ListBrandProfilesCommand.d.ts +38 -0
  136. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +38 -0
  137. package/dist-types/ts3.4/commands/ListNotifyCodeConfigurationsCommand.d.ts +42 -0
  138. package/dist-types/ts3.4/commands/ListRegistrationsFromBrandProfileCommand.d.ts +42 -0
  139. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  140. package/dist-types/ts3.4/commands/SendNotifyCodeVerificationCommand.d.ts +42 -0
  141. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
  142. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
  143. package/dist-types/ts3.4/commands/UpdateBrandProfileAttributeCommand.d.ts +42 -0
  144. package/dist-types/ts3.4/commands/UpdateBrandProfileCommand.d.ts +39 -0
  145. package/dist-types/ts3.4/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +42 -0
  146. package/dist-types/ts3.4/commands/UpdateNotifyCodeConfigurationCommand.d.ts +42 -0
  147. package/dist-types/ts3.4/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +42 -0
  148. package/dist-types/ts3.4/commands/ValidateNotifyCodeVerificationCommand.d.ts +42 -0
  149. package/dist-types/ts3.4/commands/index.d.ts +27 -0
  150. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  151. package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
  152. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  153. package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
  154. package/dist-types/ts3.4/index.d.ts +14 -0
  155. package/dist-types/ts3.4/models/EndUserMessagingServiceException.d.ts +9 -0
  156. package/dist-types/ts3.4/models/enums.d.ts +54 -0
  157. package/dist-types/ts3.4/models/errors.d.ts +47 -0
  158. package/dist-types/ts3.4/models/models_0.d.ts +413 -0
  159. package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
  160. package/dist-types/ts3.4/pagination/ListBrandProfileAttributesPaginator.d.ts +11 -0
  161. package/dist-types/ts3.4/pagination/ListBrandProfilesPaginator.d.ts +11 -0
  162. package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +8 -0
  163. package/dist-types/ts3.4/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +11 -0
  164. package/dist-types/ts3.4/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +11 -0
  165. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  166. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  167. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  168. package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
  169. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
  170. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  171. package/dist-types/ts3.4/schemas/schemas_0.d.ts +115 -0
  172. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  173. package/dist-types/ts3.4/waiters/waitForBrandProfileActive.d.ts +15 -0
  174. package/dist-types/ts3.4/waiters/waitForJobSuccess.d.ts +12 -0
  175. package/dist-types/waiters/index.d.ts +2 -0
  176. package/dist-types/waiters/waitForBrandProfileActive.d.ts +15 -0
  177. package/dist-types/waiters/waitForJobSuccess.d.ts +15 -0
  178. package/package.json +69 -0
@@ -0,0 +1,1667 @@
1
+ import type { BrandProfileAttributeType, CodeType, JobResourceType, JobStatus, NotifyChannel, OnAttributeConflict, Status, VerificationStatus, VoiceMessageBodyTextType } from "./enums";
2
+ /**
3
+ * <p>Specifies an attribute to create for a brand profile.</p>
4
+ * @public
5
+ */
6
+ export interface BrandProfileAttributeInput {
7
+ /**
8
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
9
+ * @public
10
+ */
11
+ attributeName: string | undefined;
12
+ /**
13
+ * <p>The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.</p>
14
+ * @public
15
+ */
16
+ attributeType: BrandProfileAttributeType | undefined;
17
+ /**
18
+ * <p>The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.</p>
19
+ * @public
20
+ */
21
+ attributeValue?: string | undefined;
22
+ /**
23
+ * <p>The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.</p>
24
+ * @public
25
+ */
26
+ attachmentBody?: Uint8Array | undefined;
27
+ /**
28
+ * <p>A description of the attribute.</p>
29
+ * @public
30
+ */
31
+ description?: string | undefined;
32
+ /**
33
+ * <p>The category of the attribute.</p>
34
+ * @public
35
+ */
36
+ category?: string | undefined;
37
+ }
38
+ /**
39
+ * <p>Contains information about an attribute that was created for a brand profile.</p>
40
+ * @public
41
+ */
42
+ export interface BrandProfileAttributeOutput {
43
+ /**
44
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
45
+ * @public
46
+ */
47
+ attributeName: string | undefined;
48
+ /**
49
+ * <p>The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.</p>
50
+ * @public
51
+ */
52
+ attributeType: BrandProfileAttributeType | undefined;
53
+ /**
54
+ * <p>A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.</p>
55
+ * @public
56
+ */
57
+ mediaDownloadUrl?: string | undefined;
58
+ }
59
+ /**
60
+ * <p>Contains summary information about a brand profile attribute in a list response.</p>
61
+ * @public
62
+ */
63
+ export interface BrandProfileAttributeSummary {
64
+ /**
65
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
66
+ * @public
67
+ */
68
+ attributeName: string | undefined;
69
+ /**
70
+ * <p>The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.</p>
71
+ * @public
72
+ */
73
+ attributeType: BrandProfileAttributeType | undefined;
74
+ /**
75
+ * <p>A description of the attribute.</p>
76
+ * @public
77
+ */
78
+ description?: string | undefined;
79
+ /**
80
+ * <p>The category of the attribute.</p>
81
+ * @public
82
+ */
83
+ category?: string | undefined;
84
+ /**
85
+ * <p>The time when the resource was created, in Unix epoch time.</p>
86
+ * @public
87
+ */
88
+ createdAt: Date | undefined;
89
+ /**
90
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
91
+ * @public
92
+ */
93
+ updatedAt: Date | undefined;
94
+ }
95
+ /**
96
+ * <p>Contains information about a brand profile.</p>
97
+ * @public
98
+ */
99
+ export interface BrandProfileInfo {
100
+ /**
101
+ * <p>The unique identifier of the brand profile.</p>
102
+ * @public
103
+ */
104
+ brandProfileId: string | undefined;
105
+ /**
106
+ * <p>The Amazon Resource Name (ARN) of the brand profile.</p>
107
+ * @public
108
+ */
109
+ brandProfileArn: string | undefined;
110
+ /**
111
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
112
+ * @public
113
+ */
114
+ brandProfileName: string | undefined;
115
+ /**
116
+ * <p>The current lifecycle status of the brand profile.</p>
117
+ * @public
118
+ */
119
+ status: Status | undefined;
120
+ /**
121
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
122
+ * @public
123
+ */
124
+ deletionProtectionEnabled: boolean | undefined;
125
+ /**
126
+ * <p>The time when the resource was created, in Unix epoch time.</p>
127
+ * @public
128
+ */
129
+ createdAt: Date | undefined;
130
+ /**
131
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
132
+ * @public
133
+ */
134
+ updatedAt: Date | undefined;
135
+ }
136
+ /**
137
+ * <p>The delivery parameters for the preapproved notify-template route over the SMS or voice channels.</p>
138
+ * @public
139
+ */
140
+ export interface NotifyParameters {
141
+ /**
142
+ * <p>The identifier of a preapproved notify template for the SMS or voice channels.</p>
143
+ * @public
144
+ */
145
+ notifyTemplateId?: string | undefined;
146
+ /**
147
+ * <p>The Amazon Polly voice ID used when the notify template is delivered over the voice channel.</p>
148
+ * @public
149
+ */
150
+ voiceId?: string | undefined;
151
+ }
152
+ /**
153
+ * <p>The delivery parameters for the text channel, which delivers over SMS or RCS.</p>
154
+ * @public
155
+ */
156
+ export interface TextParameters {
157
+ /**
158
+ * <p>The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.</p>
159
+ * @public
160
+ */
161
+ inlineTemplateBody?: string | undefined;
162
+ /**
163
+ * <p>A map of country-specific parameters that control one-time passcode delivery.</p>
164
+ * @public
165
+ */
166
+ destinationCountryParameters?: Record<string, string> | undefined;
167
+ }
168
+ /**
169
+ * <p>The delivery parameters for the voice channel.</p>
170
+ * @public
171
+ */
172
+ export interface VoiceParameters {
173
+ /**
174
+ * <p>The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.</p>
175
+ * @public
176
+ */
177
+ inlineTemplateBody?: string | undefined;
178
+ /**
179
+ * <p>The BCP 47 language code used to render the voice message.</p>
180
+ * @public
181
+ */
182
+ languageCode?: string | undefined;
183
+ /**
184
+ * <p>The Amazon Polly voice ID used for the voice channel.</p>
185
+ * @public
186
+ */
187
+ voiceId?: string | undefined;
188
+ /**
189
+ * <p>The format of the voice message body. Valid values are TEXT and SSML.</p>
190
+ * @public
191
+ */
192
+ voiceMessageBodyTextType?: VoiceMessageBodyTextType | undefined;
193
+ }
194
+ /**
195
+ * <p>The delivery parameters for the WhatsApp channel.</p>
196
+ * @public
197
+ */
198
+ export interface WhatsAppParameters {
199
+ /**
200
+ * <p>The name of the Meta-approved WhatsApp authentication template.</p>
201
+ * @public
202
+ */
203
+ whatsAppTemplateName?: string | undefined;
204
+ /**
205
+ * <p>The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.</p>
206
+ * @public
207
+ */
208
+ languageCode?: string | undefined;
209
+ }
210
+ /**
211
+ * <p>The channel-specific parameters used to render and deliver a one-time passcode. Each member configures the parameters for one delivery route. Populate only the channels that a configuration or send request supports. A notify code configuration can carry every channel at once, and a send request resolves to a single route that selects the matching channel at send time.</p>
212
+ * @public
213
+ */
214
+ export interface ChannelParameters {
215
+ /**
216
+ * <p>The parameters for the text channel, which delivers over SMS or RCS.</p>
217
+ * @public
218
+ */
219
+ text?: TextParameters | undefined;
220
+ /**
221
+ * <p>The parameters for the voice channel.</p>
222
+ * @public
223
+ */
224
+ voice?: VoiceParameters | undefined;
225
+ /**
226
+ * <p>The parameters for the preapproved notify-template route over the SMS or voice channels.</p>
227
+ * @public
228
+ */
229
+ notify?: NotifyParameters | undefined;
230
+ /**
231
+ * <p>The parameters for the WhatsApp channel.</p>
232
+ * @public
233
+ */
234
+ whatsApp?: WhatsAppParameters | undefined;
235
+ }
236
+ /**
237
+ * <p>The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.</p>
238
+ * @public
239
+ */
240
+ export interface CodeConfigurationParameters {
241
+ /**
242
+ * <p>The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.</p>
243
+ * @public
244
+ */
245
+ codeType?: CodeType | undefined;
246
+ /**
247
+ * <p>The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.</p>
248
+ * @public
249
+ */
250
+ codeLength?: number | undefined;
251
+ /**
252
+ * <p>The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.</p>
253
+ * @public
254
+ */
255
+ validityPeriodMinutes?: number | undefined;
256
+ /**
257
+ * <p>The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.</p>
258
+ * @public
259
+ */
260
+ maxAttempts?: number | undefined;
261
+ }
262
+ /**
263
+ * <p>Describes a tag as a key and value pair that you can associate with a resource.</p>
264
+ * @public
265
+ */
266
+ export interface Tag {
267
+ /**
268
+ * <p>The key of the tag.</p>
269
+ * @public
270
+ */
271
+ key: string | undefined;
272
+ /**
273
+ * <p>The value of the tag.</p>
274
+ * @public
275
+ */
276
+ value: string | undefined;
277
+ }
278
+ /**
279
+ * @public
280
+ */
281
+ export interface CreateBrandProfileInput {
282
+ /**
283
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
284
+ * @public
285
+ */
286
+ brandProfileName: string | undefined;
287
+ /**
288
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
289
+ * @public
290
+ */
291
+ clientToken?: string | undefined;
292
+ /**
293
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
294
+ * @public
295
+ */
296
+ deletionProtectionEnabled?: boolean | undefined;
297
+ /**
298
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
299
+ * @public
300
+ */
301
+ tags?: Tag[] | undefined;
302
+ }
303
+ /**
304
+ * @public
305
+ */
306
+ export interface CreateBrandProfileOutput {
307
+ /**
308
+ * <p>The unique identifier of the brand profile.</p>
309
+ * @public
310
+ */
311
+ brandProfileId: string | undefined;
312
+ /**
313
+ * <p>The Amazon Resource Name (ARN) of the brand profile.</p>
314
+ * @public
315
+ */
316
+ brandProfileArn: string | undefined;
317
+ /**
318
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
319
+ * @public
320
+ */
321
+ brandProfileName: string | undefined;
322
+ /**
323
+ * <p>The current lifecycle status of the brand profile.</p>
324
+ * @public
325
+ */
326
+ status: Status | undefined;
327
+ /**
328
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
329
+ * @public
330
+ */
331
+ deletionProtectionEnabled: boolean | undefined;
332
+ /**
333
+ * <p>The time when the resource was created, in Unix epoch time.</p>
334
+ * @public
335
+ */
336
+ createdAt: Date | undefined;
337
+ /**
338
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
339
+ * @public
340
+ */
341
+ updatedAt: Date | undefined;
342
+ /**
343
+ * <p>The number of default attributes that were created for the brand profile.</p>
344
+ * @public
345
+ */
346
+ attributesCreated: number | undefined;
347
+ }
348
+ /**
349
+ * Describes one specific validation failure for an input member.
350
+ * @public
351
+ */
352
+ export interface ValidationExceptionField {
353
+ /**
354
+ * A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.
355
+ * @public
356
+ */
357
+ path: string | undefined;
358
+ /**
359
+ * A detailed description of the validation failure.
360
+ * @public
361
+ */
362
+ message: string | undefined;
363
+ }
364
+ /**
365
+ * @public
366
+ */
367
+ export interface CreateBrandProfileAttributesInput {
368
+ /**
369
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
370
+ * @public
371
+ */
372
+ brandProfileId: string | undefined;
373
+ /**
374
+ * <p>The brand profile attributes.</p>
375
+ * @public
376
+ */
377
+ attributes: BrandProfileAttributeInput[] | undefined;
378
+ /**
379
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
380
+ * @public
381
+ */
382
+ clientToken?: string | undefined;
383
+ }
384
+ /**
385
+ * @public
386
+ */
387
+ export interface CreateBrandProfileAttributesOutput {
388
+ /**
389
+ * <p>The brand profile attributes.</p>
390
+ * @public
391
+ */
392
+ attributes: BrandProfileAttributeOutput[] | undefined;
393
+ }
394
+ /**
395
+ * @public
396
+ */
397
+ export interface CreateBrandProfileFromRegistrationInput {
398
+ /**
399
+ * <p>The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.</p>
400
+ * @public
401
+ */
402
+ registrationId: string | undefined;
403
+ /**
404
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
405
+ * @public
406
+ */
407
+ brandProfileName: string | undefined;
408
+ /**
409
+ * <p>Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.</p>
410
+ * @public
411
+ */
412
+ smartMatch?: boolean | undefined;
413
+ /**
414
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
415
+ * @public
416
+ */
417
+ tags?: Tag[] | undefined;
418
+ /**
419
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
420
+ * @public
421
+ */
422
+ clientToken?: string | undefined;
423
+ }
424
+ /**
425
+ * <p>Pairs an asynchronous job with the resource identifier from your request that the job processes.</p>
426
+ * @public
427
+ */
428
+ export interface JobResult {
429
+ /**
430
+ * <p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>
431
+ * @public
432
+ */
433
+ jobId: string | undefined;
434
+ /**
435
+ * <p>The identifier from your request that this job is processing.</p>
436
+ * @public
437
+ */
438
+ resourceIdentifier: string | undefined;
439
+ }
440
+ /**
441
+ * @public
442
+ */
443
+ export interface CreateBrandProfileFromRegistrationOutput {
444
+ /**
445
+ * <p>The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.</p>
446
+ * @public
447
+ */
448
+ results: JobResult[] | undefined;
449
+ }
450
+ /**
451
+ * @public
452
+ */
453
+ export interface CreateNotifyCodeConfigurationInput {
454
+ /**
455
+ * <p>The name of the notify code configuration.</p>
456
+ * @public
457
+ */
458
+ notifyCodeConfigurationName: string | undefined;
459
+ /**
460
+ * <p>The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.</p>
461
+ * @public
462
+ */
463
+ codeConfigurationParameters?: CodeConfigurationParameters | undefined;
464
+ /**
465
+ * <p>The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.</p>
466
+ * @public
467
+ */
468
+ channelParameters?: ChannelParameters | undefined;
469
+ /**
470
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
471
+ * @public
472
+ */
473
+ deletionProtectionEnabled?: boolean | undefined;
474
+ /**
475
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
476
+ * @public
477
+ */
478
+ clientToken?: string | undefined;
479
+ /**
480
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
481
+ * @public
482
+ */
483
+ tags?: Tag[] | undefined;
484
+ }
485
+ /**
486
+ * <p>Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.</p>
487
+ * @public
488
+ */
489
+ export interface NotifyCodeConfiguration {
490
+ /**
491
+ * <p>The unique identifier of the notify code configuration.</p>
492
+ * @public
493
+ */
494
+ notifyCodeConfigurationId: string | undefined;
495
+ /**
496
+ * <p>The Amazon Resource Name (ARN) of the notify code configuration.</p>
497
+ * @public
498
+ */
499
+ notifyCodeConfigurationArn: string | undefined;
500
+ /**
501
+ * <p>The name of the notify code configuration.</p>
502
+ * @public
503
+ */
504
+ notifyCodeConfigurationName: string | undefined;
505
+ /**
506
+ * <p>The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.</p>
507
+ * @public
508
+ */
509
+ codeConfigurationParameters?: CodeConfigurationParameters | undefined;
510
+ /**
511
+ * <p>The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.</p>
512
+ * @public
513
+ */
514
+ channelParameters?: ChannelParameters | undefined;
515
+ /**
516
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
517
+ * @public
518
+ */
519
+ deletionProtectionEnabled: boolean | undefined;
520
+ /**
521
+ * <p>The time when the resource was created, in Unix epoch time.</p>
522
+ * @public
523
+ */
524
+ createdAt: Date | undefined;
525
+ /**
526
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
527
+ * @public
528
+ */
529
+ updatedAt: Date | undefined;
530
+ }
531
+ /**
532
+ * @public
533
+ */
534
+ export interface CreateNotifyCodeConfigurationOutput {
535
+ /**
536
+ * <p>The notify code configuration resource.</p>
537
+ * @public
538
+ */
539
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
540
+ }
541
+ /**
542
+ * @public
543
+ */
544
+ export interface CreateRegistrationsFromBrandProfileInput {
545
+ /**
546
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
547
+ * @public
548
+ */
549
+ brandProfileId: string | undefined;
550
+ /**
551
+ * <p>The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.</p>
552
+ * @public
553
+ */
554
+ registrationTypes: string[] | undefined;
555
+ /**
556
+ * <p>Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.</p>
557
+ * @public
558
+ */
559
+ smartMatch?: boolean | undefined;
560
+ /**
561
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
562
+ * @public
563
+ */
564
+ clientToken?: string | undefined;
565
+ }
566
+ /**
567
+ * @public
568
+ */
569
+ export interface CreateRegistrationsFromBrandProfileOutput {
570
+ /**
571
+ * <p>The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.</p>
572
+ * @public
573
+ */
574
+ results: JobResult[] | undefined;
575
+ }
576
+ /**
577
+ * @public
578
+ */
579
+ export interface DeleteBrandProfileInput {
580
+ /**
581
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
582
+ * @public
583
+ */
584
+ brandProfileId: string | undefined;
585
+ }
586
+ /**
587
+ * @public
588
+ */
589
+ export interface DeleteBrandProfileOutput {
590
+ /**
591
+ * <p>The unique identifier of the brand profile.</p>
592
+ * @public
593
+ */
594
+ brandProfileId: string | undefined;
595
+ /**
596
+ * <p>The Amazon Resource Name (ARN) of the brand profile.</p>
597
+ * @public
598
+ */
599
+ brandProfileArn: string | undefined;
600
+ }
601
+ /**
602
+ * @public
603
+ */
604
+ export interface DeleteBrandProfileAttributeInput {
605
+ /**
606
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
607
+ * @public
608
+ */
609
+ brandProfileId: string | undefined;
610
+ /**
611
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
612
+ * @public
613
+ */
614
+ attributeName: string | undefined;
615
+ }
616
+ /**
617
+ * @public
618
+ */
619
+ export interface DeleteBrandProfileAttributeOutput {
620
+ /**
621
+ * <p>The unique identifier of the brand profile.</p>
622
+ * @public
623
+ */
624
+ brandProfileId: string | undefined;
625
+ /**
626
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
627
+ * @public
628
+ */
629
+ attributeName: string | undefined;
630
+ }
631
+ /**
632
+ * @public
633
+ */
634
+ export interface DeleteNotifyCodeConfigurationInput {
635
+ /**
636
+ * <p>The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
637
+ * @public
638
+ */
639
+ notifyCodeConfigurationId: string | undefined;
640
+ }
641
+ /**
642
+ * @public
643
+ */
644
+ export interface DeleteNotifyCodeConfigurationOutput {
645
+ }
646
+ /**
647
+ * @public
648
+ */
649
+ export interface GetBrandProfileInput {
650
+ /**
651
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
652
+ * @public
653
+ */
654
+ brandProfileId: string | undefined;
655
+ }
656
+ /**
657
+ * @public
658
+ */
659
+ export interface GetBrandProfileOutput {
660
+ /**
661
+ * <p>The unique identifier of the brand profile.</p>
662
+ * @public
663
+ */
664
+ brandProfileId: string | undefined;
665
+ /**
666
+ * <p>The Amazon Resource Name (ARN) of the brand profile.</p>
667
+ * @public
668
+ */
669
+ brandProfileArn: string | undefined;
670
+ /**
671
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
672
+ * @public
673
+ */
674
+ brandProfileName: string | undefined;
675
+ /**
676
+ * <p>The current lifecycle status of the brand profile.</p>
677
+ * @public
678
+ */
679
+ status: Status | undefined;
680
+ /**
681
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
682
+ * @public
683
+ */
684
+ deletionProtectionEnabled: boolean | undefined;
685
+ /**
686
+ * <p>The time when the resource was created, in Unix epoch time.</p>
687
+ * @public
688
+ */
689
+ createdAt: Date | undefined;
690
+ /**
691
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
692
+ * @public
693
+ */
694
+ updatedAt: Date | undefined;
695
+ }
696
+ /**
697
+ * @public
698
+ */
699
+ export interface GetBrandProfileAttributeInput {
700
+ /**
701
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
702
+ * @public
703
+ */
704
+ brandProfileId: string | undefined;
705
+ /**
706
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
707
+ * @public
708
+ */
709
+ attributeName: string | undefined;
710
+ }
711
+ /**
712
+ * @public
713
+ */
714
+ export interface GetBrandProfileAttributeOutput {
715
+ /**
716
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
717
+ * @public
718
+ */
719
+ attributeName: string | undefined;
720
+ /**
721
+ * <p>The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.</p>
722
+ * @public
723
+ */
724
+ attributeType: BrandProfileAttributeType | undefined;
725
+ /**
726
+ * <p>The text value of the attribute. This value applies to attributes of type TEXT.</p>
727
+ * @public
728
+ */
729
+ attributeValue?: string | undefined;
730
+ /**
731
+ * <p>A description of the attribute.</p>
732
+ * @public
733
+ */
734
+ description?: string | undefined;
735
+ /**
736
+ * <p>The category of the attribute.</p>
737
+ * @public
738
+ */
739
+ category?: string | undefined;
740
+ /**
741
+ * <p>The MIME content type of the attribute media.</p>
742
+ * @public
743
+ */
744
+ mediaContentType?: string | undefined;
745
+ /**
746
+ * <p>The size of the attribute media, in bytes.</p>
747
+ * @public
748
+ */
749
+ mediaSizeBytes?: number | undefined;
750
+ /**
751
+ * <p>A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.</p>
752
+ * @public
753
+ */
754
+ mediaDownloadUrl?: string | undefined;
755
+ /**
756
+ * <p>The time when the resource was created, in Unix epoch time.</p>
757
+ * @public
758
+ */
759
+ createdAt: Date | undefined;
760
+ /**
761
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
762
+ * @public
763
+ */
764
+ updatedAt: Date | undefined;
765
+ }
766
+ /**
767
+ * @public
768
+ */
769
+ export interface GetJobInput {
770
+ /**
771
+ * <p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>
772
+ * @public
773
+ */
774
+ jobId: string | undefined;
775
+ }
776
+ /**
777
+ * <p>Contains information about a resource that was created or updated by an asynchronous job.</p>
778
+ * @public
779
+ */
780
+ export interface JobResource {
781
+ /**
782
+ * <p>The type of the resource that the job created or updated.</p>
783
+ * @public
784
+ */
785
+ resourceType: JobResourceType | undefined;
786
+ /**
787
+ * <p>The identifier of the resource that the job created or updated.</p>
788
+ * @public
789
+ */
790
+ resourceId: string | undefined;
791
+ /**
792
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
793
+ * @public
794
+ */
795
+ resourceArn: string | undefined;
796
+ }
797
+ /**
798
+ * Information about an async job tracked by the service. GetJob returns
799
+ * the full `Job`, which may grow detail-only fields that are not part of
800
+ * the `JobSummary` list view.
801
+ * @public
802
+ */
803
+ export interface Job {
804
+ /**
805
+ * <p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>
806
+ * @public
807
+ */
808
+ jobId: string | undefined;
809
+ /**
810
+ * <p>The current lifecycle status of the job.</p>
811
+ * @public
812
+ */
813
+ status: JobStatus | undefined;
814
+ /**
815
+ * <p>The type of mutating operation that created the job.</p>
816
+ * @public
817
+ */
818
+ operationType: string | undefined;
819
+ /**
820
+ * <p>The time when the resource was created, in Unix epoch time.</p>
821
+ * @public
822
+ */
823
+ createdAt: Date | undefined;
824
+ /**
825
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
826
+ * @public
827
+ */
828
+ updatedAt: Date | undefined;
829
+ /**
830
+ * <p>The brand profile that the job operates on. This value is absent for operations that create a brand profile.</p>
831
+ * @public
832
+ */
833
+ brandProfileId?: string | undefined;
834
+ /**
835
+ * <p>A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.</p>
836
+ * @public
837
+ */
838
+ errorCode?: string | undefined;
839
+ /**
840
+ * <p>A human-readable description of why the job failed. This value is present only when the job status is FAILED.</p>
841
+ * @public
842
+ */
843
+ errorMessage?: string | undefined;
844
+ /**
845
+ * <p>The resources that were created or updated by the job.</p>
846
+ * @public
847
+ */
848
+ resources?: JobResource[] | undefined;
849
+ }
850
+ /**
851
+ * @public
852
+ */
853
+ export interface GetNotifyCodeConfigurationInput {
854
+ /**
855
+ * <p>The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
856
+ * @public
857
+ */
858
+ notifyCodeConfigurationId: string | undefined;
859
+ }
860
+ /**
861
+ * @public
862
+ */
863
+ export interface GetNotifyCodeConfigurationOutput {
864
+ /**
865
+ * <p>The notify code configuration resource.</p>
866
+ * @public
867
+ */
868
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
869
+ }
870
+ /**
871
+ * @public
872
+ */
873
+ export interface ListBrandProfileAttributesInput {
874
+ /**
875
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
876
+ * @public
877
+ */
878
+ brandProfileId: string | undefined;
879
+ /**
880
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
881
+ * @public
882
+ */
883
+ nextToken?: string | undefined;
884
+ /**
885
+ * <p>The maximum number of results to return per page.</p>
886
+ * @public
887
+ */
888
+ maxResults?: number | undefined;
889
+ }
890
+ /**
891
+ * @public
892
+ */
893
+ export interface ListBrandProfileAttributesOutput {
894
+ /**
895
+ * <p>The list of brand profile attributes.</p>
896
+ * @public
897
+ */
898
+ brandProfileAttributes: BrandProfileAttributeSummary[] | undefined;
899
+ /**
900
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
901
+ * @public
902
+ */
903
+ nextToken?: string | undefined;
904
+ }
905
+ /**
906
+ * @public
907
+ */
908
+ export interface ListBrandProfilesInput {
909
+ /**
910
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
911
+ * @public
912
+ */
913
+ nextToken?: string | undefined;
914
+ /**
915
+ * <p>The maximum number of results to return per page.</p>
916
+ * @public
917
+ */
918
+ maxResults?: number | undefined;
919
+ }
920
+ /**
921
+ * @public
922
+ */
923
+ export interface ListBrandProfilesOutput {
924
+ /**
925
+ * <p>The list of brand profiles.</p>
926
+ * @public
927
+ */
928
+ brandProfiles: BrandProfileInfo[] | undefined;
929
+ /**
930
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
931
+ * @public
932
+ */
933
+ nextToken?: string | undefined;
934
+ }
935
+ /**
936
+ * @public
937
+ */
938
+ export interface ListJobsInput {
939
+ /**
940
+ * <p>The maximum number of results to return per page.</p>
941
+ * @public
942
+ */
943
+ maxResults?: number | undefined;
944
+ /**
945
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
946
+ * @public
947
+ */
948
+ nextToken?: string | undefined;
949
+ /**
950
+ * <p>Filters the results to jobs that have the specified status.</p>
951
+ * @public
952
+ */
953
+ status?: JobStatus | undefined;
954
+ /**
955
+ * <p>Filters the results to jobs for the specified brand profile.</p>
956
+ * @public
957
+ */
958
+ brandProfileId?: string | undefined;
959
+ /**
960
+ * <p>Filters the results to jobs of the specified operation type.</p>
961
+ * @public
962
+ */
963
+ operationType?: string | undefined;
964
+ }
965
+ /**
966
+ * <p>Contains summary information about an asynchronous job in a list response.</p>
967
+ * @public
968
+ */
969
+ export interface JobSummary {
970
+ /**
971
+ * <p>The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.</p>
972
+ * @public
973
+ */
974
+ jobId: string | undefined;
975
+ /**
976
+ * <p>The current lifecycle status of the job.</p>
977
+ * @public
978
+ */
979
+ status: JobStatus | undefined;
980
+ /**
981
+ * <p>The type of mutating operation that created the job.</p>
982
+ * @public
983
+ */
984
+ operationType: string | undefined;
985
+ /**
986
+ * <p>The time when the resource was created, in Unix epoch time.</p>
987
+ * @public
988
+ */
989
+ createdAt: Date | undefined;
990
+ /**
991
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
992
+ * @public
993
+ */
994
+ updatedAt: Date | undefined;
995
+ /**
996
+ * <p>The brand profile that the job operates on. This value is absent for operations that create a brand profile.</p>
997
+ * @public
998
+ */
999
+ brandProfileId?: string | undefined;
1000
+ /**
1001
+ * <p>A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.</p>
1002
+ * @public
1003
+ */
1004
+ errorCode?: string | undefined;
1005
+ /**
1006
+ * <p>A human-readable description of why the job failed. This value is present only when the job status is FAILED.</p>
1007
+ * @public
1008
+ */
1009
+ errorMessage?: string | undefined;
1010
+ /**
1011
+ * <p>The resources that were created or updated by the job.</p>
1012
+ * @public
1013
+ */
1014
+ resources?: JobResource[] | undefined;
1015
+ }
1016
+ /**
1017
+ * @public
1018
+ */
1019
+ export interface ListJobsOutput {
1020
+ /**
1021
+ * <p>The list of asynchronous jobs.</p>
1022
+ * @public
1023
+ */
1024
+ jobs: JobSummary[] | undefined;
1025
+ /**
1026
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
1027
+ * @public
1028
+ */
1029
+ nextToken?: string | undefined;
1030
+ }
1031
+ /**
1032
+ * @public
1033
+ */
1034
+ export interface ListNotifyCodeConfigurationsInput {
1035
+ /**
1036
+ * <p>The maximum number of results to return per page.</p>
1037
+ * @public
1038
+ */
1039
+ maxResults?: number | undefined;
1040
+ /**
1041
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
1042
+ * @public
1043
+ */
1044
+ nextToken?: string | undefined;
1045
+ }
1046
+ /**
1047
+ * @public
1048
+ */
1049
+ export interface ListNotifyCodeConfigurationsOutput {
1050
+ /**
1051
+ * <p>The list of notify code configurations.</p>
1052
+ * @public
1053
+ */
1054
+ notifyCodeConfigurations: NotifyCodeConfiguration[] | undefined;
1055
+ /**
1056
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
1057
+ * @public
1058
+ */
1059
+ nextToken?: string | undefined;
1060
+ }
1061
+ /**
1062
+ * @public
1063
+ */
1064
+ export interface ListRegistrationsFromBrandProfileInput {
1065
+ /**
1066
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1067
+ * @public
1068
+ */
1069
+ brandProfileId: string | undefined;
1070
+ /**
1071
+ * <p>The maximum number of results to return per page.</p>
1072
+ * @public
1073
+ */
1074
+ maxResults?: number | undefined;
1075
+ /**
1076
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
1077
+ * @public
1078
+ */
1079
+ nextToken?: string | undefined;
1080
+ }
1081
+ /**
1082
+ * <p>Contains summary information about a registration that is associated with a brand profile.</p>
1083
+ * @public
1084
+ */
1085
+ export interface RegistrationAssociationSummary {
1086
+ /**
1087
+ * <p>The identifier of the registration.</p>
1088
+ * @public
1089
+ */
1090
+ registrationId: string | undefined;
1091
+ /**
1092
+ * <p>The type of the registration, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.</p>
1093
+ * @public
1094
+ */
1095
+ registrationType: string | undefined;
1096
+ /**
1097
+ * <p>The time when the resource was created, in Unix epoch time.</p>
1098
+ * @public
1099
+ */
1100
+ createdAt: Date | undefined;
1101
+ /**
1102
+ * <p>Specifies whether smart matching was used to create the association.</p>
1103
+ * @public
1104
+ */
1105
+ smartMatchUsed: boolean | undefined;
1106
+ }
1107
+ /**
1108
+ * @public
1109
+ */
1110
+ export interface ListRegistrationsFromBrandProfileOutput {
1111
+ /**
1112
+ * <p>The list of registrations that are associated with the brand profile.</p>
1113
+ * @public
1114
+ */
1115
+ registrationAssociations: RegistrationAssociationSummary[] | undefined;
1116
+ /**
1117
+ * <p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>
1118
+ * @public
1119
+ */
1120
+ nextToken?: string | undefined;
1121
+ }
1122
+ /**
1123
+ * @public
1124
+ */
1125
+ export interface ListTagsForResourceInput {
1126
+ /**
1127
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
1128
+ * @public
1129
+ */
1130
+ resourceArn: string | undefined;
1131
+ }
1132
+ /**
1133
+ * @public
1134
+ */
1135
+ export interface ListTagsForResourceOutput {
1136
+ /**
1137
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
1138
+ * @public
1139
+ */
1140
+ tags?: Tag[] | undefined;
1141
+ }
1142
+ /**
1143
+ * @public
1144
+ */
1145
+ export interface SendNotifyCodeVerificationInput {
1146
+ /**
1147
+ * <p>The channel used to deliver the one-time passcode to the recipient.</p>
1148
+ * @public
1149
+ */
1150
+ channel: NotifyChannel | undefined;
1151
+ /**
1152
+ * <p>The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.</p>
1153
+ * @public
1154
+ */
1155
+ destinationIdentity: string | undefined;
1156
+ /**
1157
+ * <p>The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.</p>
1158
+ * @public
1159
+ */
1160
+ originationIdentity: string | undefined;
1161
+ /**
1162
+ * <p>The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.</p>
1163
+ * @public
1164
+ */
1165
+ notifyCodeConfiguration?: string | undefined;
1166
+ /**
1167
+ * <p>The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.</p>
1168
+ * @public
1169
+ */
1170
+ overrideChannelParameters?: ChannelParameters | undefined;
1171
+ /**
1172
+ * <p>The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.</p>
1173
+ * @public
1174
+ */
1175
+ overrideCodeConfigurationParameters?: CodeConfigurationParameters | undefined;
1176
+ /**
1177
+ * <p>The name of the configuration set used to control how delivery events for the message are handled.</p>
1178
+ * @public
1179
+ */
1180
+ configurationSetName?: string | undefined;
1181
+ /**
1182
+ * <p>A map of custom key and value pairs that are propagated to the delivery events for this verification.</p>
1183
+ * @public
1184
+ */
1185
+ context?: Record<string, string> | undefined;
1186
+ /**
1187
+ * <p>A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.</p>
1188
+ * @public
1189
+ */
1190
+ referenceId?: string | undefined;
1191
+ }
1192
+ /**
1193
+ * @public
1194
+ */
1195
+ export interface SendNotifyCodeVerificationOutput {
1196
+ /**
1197
+ * <p>The service-generated identifier for the verification.</p>
1198
+ * @public
1199
+ */
1200
+ verificationId: string | undefined;
1201
+ /**
1202
+ * <p>The service-generated identifier for the message that delivers the one-time passcode.</p>
1203
+ * @public
1204
+ */
1205
+ messageId: string | undefined;
1206
+ }
1207
+ /**
1208
+ * @public
1209
+ */
1210
+ export interface TagResourceInput {
1211
+ /**
1212
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
1213
+ * @public
1214
+ */
1215
+ resourceArn: string | undefined;
1216
+ /**
1217
+ * <p>An array of key and value pair tags that are associated with the resource.</p>
1218
+ * @public
1219
+ */
1220
+ tags: Tag[] | undefined;
1221
+ }
1222
+ /**
1223
+ * @public
1224
+ */
1225
+ export interface TagResourceOutput {
1226
+ }
1227
+ /**
1228
+ * @public
1229
+ */
1230
+ export interface UntagResourceInput {
1231
+ /**
1232
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
1233
+ * @public
1234
+ */
1235
+ resourceArn: string | undefined;
1236
+ /**
1237
+ * <p>The list of tag keys to remove from the resource.</p>
1238
+ * @public
1239
+ */
1240
+ tagKeys: string[] | undefined;
1241
+ }
1242
+ /**
1243
+ * @public
1244
+ */
1245
+ export interface UntagResourceOutput {
1246
+ }
1247
+ /**
1248
+ * @public
1249
+ */
1250
+ export interface UpdateBrandProfileInput {
1251
+ /**
1252
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1253
+ * @public
1254
+ */
1255
+ brandProfileId: string | undefined;
1256
+ /**
1257
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
1258
+ * @public
1259
+ */
1260
+ brandProfileName?: string | undefined;
1261
+ /**
1262
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
1263
+ * @public
1264
+ */
1265
+ deletionProtectionEnabled?: boolean | undefined;
1266
+ }
1267
+ /**
1268
+ * @public
1269
+ */
1270
+ export interface UpdateBrandProfileOutput {
1271
+ /**
1272
+ * <p>The unique identifier of the brand profile.</p>
1273
+ * @public
1274
+ */
1275
+ brandProfileId: string | undefined;
1276
+ /**
1277
+ * <p>The Amazon Resource Name (ARN) of the brand profile.</p>
1278
+ * @public
1279
+ */
1280
+ brandProfileArn: string | undefined;
1281
+ /**
1282
+ * <p>The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.</p>
1283
+ * @public
1284
+ */
1285
+ brandProfileName: string | undefined;
1286
+ /**
1287
+ * <p>The current lifecycle status of the brand profile.</p>
1288
+ * @public
1289
+ */
1290
+ status: Status | undefined;
1291
+ /**
1292
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
1293
+ * @public
1294
+ */
1295
+ deletionProtectionEnabled: boolean | undefined;
1296
+ /**
1297
+ * <p>The time when the resource was created, in Unix epoch time.</p>
1298
+ * @public
1299
+ */
1300
+ createdAt: Date | undefined;
1301
+ /**
1302
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
1303
+ * @public
1304
+ */
1305
+ updatedAt: Date | undefined;
1306
+ }
1307
+ /**
1308
+ * @public
1309
+ */
1310
+ export interface UpdateBrandProfileAttributeInput {
1311
+ /**
1312
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1313
+ * @public
1314
+ */
1315
+ brandProfileId: string | undefined;
1316
+ /**
1317
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
1318
+ * @public
1319
+ */
1320
+ attributeName: string | undefined;
1321
+ /**
1322
+ * <p>The text value of the attribute. This value applies to attributes of type TEXT.</p>
1323
+ * @public
1324
+ */
1325
+ attributeValue?: string | undefined;
1326
+ /**
1327
+ * <p>The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.</p>
1328
+ * @public
1329
+ */
1330
+ attachmentBody?: Uint8Array | undefined;
1331
+ /**
1332
+ * <p>A description of the attribute.</p>
1333
+ * @public
1334
+ */
1335
+ description?: string | undefined;
1336
+ /**
1337
+ * <p>The category of the attribute.</p>
1338
+ * @public
1339
+ */
1340
+ category?: string | undefined;
1341
+ }
1342
+ /**
1343
+ * @public
1344
+ */
1345
+ export interface UpdateBrandProfileAttributeOutput {
1346
+ /**
1347
+ * <p>The name of the brand profile attribute. The name is unique within a brand profile.</p>
1348
+ * @public
1349
+ */
1350
+ attributeName: string | undefined;
1351
+ /**
1352
+ * <p>The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.</p>
1353
+ * @public
1354
+ */
1355
+ attributeType: BrandProfileAttributeType | undefined;
1356
+ /**
1357
+ * <p>The text value of the attribute. This value applies to attributes of type TEXT.</p>
1358
+ * @public
1359
+ */
1360
+ attributeValue?: string | undefined;
1361
+ /**
1362
+ * <p>A description of the attribute.</p>
1363
+ * @public
1364
+ */
1365
+ description?: string | undefined;
1366
+ /**
1367
+ * <p>The category of the attribute.</p>
1368
+ * @public
1369
+ */
1370
+ category?: string | undefined;
1371
+ /**
1372
+ * <p>The MIME content type of the attribute media.</p>
1373
+ * @public
1374
+ */
1375
+ mediaContentType?: string | undefined;
1376
+ /**
1377
+ * <p>The size of the attribute media, in bytes.</p>
1378
+ * @public
1379
+ */
1380
+ mediaSizeBytes?: number | undefined;
1381
+ /**
1382
+ * <p>The time when the resource was created, in Unix epoch time.</p>
1383
+ * @public
1384
+ */
1385
+ createdAt: Date | undefined;
1386
+ /**
1387
+ * <p>The time when the resource was last updated, in Unix epoch time.</p>
1388
+ * @public
1389
+ */
1390
+ updatedAt: Date | undefined;
1391
+ }
1392
+ /**
1393
+ * @public
1394
+ */
1395
+ export interface UpdateBrandProfileFromRegistrationInput {
1396
+ /**
1397
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1398
+ * @public
1399
+ */
1400
+ brandProfileId: string | undefined;
1401
+ /**
1402
+ * <p>The identifier or Amazon Resource Name (ARN) of the registration to import attributes from.</p>
1403
+ * @public
1404
+ */
1405
+ registrationId: string | undefined;
1406
+ /**
1407
+ * <p>Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.</p>
1408
+ * @public
1409
+ */
1410
+ smartMatch?: boolean | undefined;
1411
+ /**
1412
+ * <p>Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.</p>
1413
+ * @public
1414
+ */
1415
+ onAttributeConflict?: OnAttributeConflict | undefined;
1416
+ /**
1417
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
1418
+ * @public
1419
+ */
1420
+ clientToken?: string | undefined;
1421
+ }
1422
+ /**
1423
+ * @public
1424
+ */
1425
+ export interface UpdateBrandProfileFromRegistrationOutput {
1426
+ /**
1427
+ * <p>The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.</p>
1428
+ * @public
1429
+ */
1430
+ results: JobResult[] | undefined;
1431
+ }
1432
+ /**
1433
+ * <p>The updated delivery parameters for the preapproved notify-template route. Absent members preserve the current value, and the empty sentinel on a member clears it.</p>
1434
+ * @public
1435
+ */
1436
+ export interface UpdateNotifyParameters {
1437
+ /**
1438
+ * <p>The updated identifier of a preapproved notify template for the SMS or voice channels. An empty string clears the previously stored value.</p>
1439
+ * @public
1440
+ */
1441
+ notifyTemplateId?: string | undefined;
1442
+ /**
1443
+ * <p>The updated Amazon Polly voice ID. An empty string clears the previously stored value.</p>
1444
+ * @public
1445
+ */
1446
+ voiceId?: string | undefined;
1447
+ }
1448
+ /**
1449
+ * <p>The updated delivery parameters for the text channel. Absent members preserve the current value, and the empty sentinel on a member clears it.</p>
1450
+ * @public
1451
+ */
1452
+ export interface UpdateTextParameters {
1453
+ /**
1454
+ * <p>The updated freeform SMS or RCS template body. An empty string clears the previously stored value.</p>
1455
+ * @public
1456
+ */
1457
+ inlineTemplateBody?: string | undefined;
1458
+ /**
1459
+ * <p>The updated map of country-specific parameters that control one-time passcode delivery. An empty map clears the previously stored value.</p>
1460
+ * @public
1461
+ */
1462
+ destinationCountryParameters?: Record<string, string> | undefined;
1463
+ }
1464
+ /**
1465
+ * <p>The updated delivery parameters for the voice channel. Absent members preserve the current value, and the empty sentinel on a member clears it.</p>
1466
+ * @public
1467
+ */
1468
+ export interface UpdateVoiceParameters {
1469
+ /**
1470
+ * <p>The updated freeform voice template body. An empty string clears the previously stored value.</p>
1471
+ * @public
1472
+ */
1473
+ inlineTemplateBody?: string | undefined;
1474
+ /**
1475
+ * <p>The updated BCP 47 language code. An empty string clears the previously stored value.</p>
1476
+ * @public
1477
+ */
1478
+ languageCode?: string | undefined;
1479
+ /**
1480
+ * <p>The updated Amazon Polly voice ID. An empty string clears the previously stored value.</p>
1481
+ * @public
1482
+ */
1483
+ voiceId?: string | undefined;
1484
+ /**
1485
+ * <p>The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.</p>
1486
+ * @public
1487
+ */
1488
+ voiceMessageBodyTextType?: VoiceMessageBodyTextType | undefined;
1489
+ }
1490
+ /**
1491
+ * <p>The updated delivery parameters for the WhatsApp channel. Absent members preserve the current value, and the empty sentinel on a member clears it.</p>
1492
+ * @public
1493
+ */
1494
+ export interface UpdateWhatsAppParameters {
1495
+ /**
1496
+ * <p>The updated name of the Meta-approved WhatsApp authentication template. An empty string clears the previously stored value.</p>
1497
+ * @public
1498
+ */
1499
+ whatsAppTemplateName?: string | undefined;
1500
+ /**
1501
+ * <p>The updated BCP 47 language code. An empty string clears the previously stored value.</p>
1502
+ * @public
1503
+ */
1504
+ languageCode?: string | undefined;
1505
+ }
1506
+ /**
1507
+ * <p>The updated channel-specific parameters used only when you update a notify code configuration. When you omit a channel, that channel's parameters remain unchanged. When you supply a channel, you can clear individual fields by using the empty-string or empty-map sentinel on a member, or drop the whole channel's parameters by clearing every member. These sentinels apply only when you update a configuration; a create request rejects empty values with a validation error.</p>
1508
+ * @public
1509
+ */
1510
+ export interface UpdateChannelParameters {
1511
+ /**
1512
+ * <p>The text-channel parameters to update. Omit this member to leave the text-channel parameters unchanged.</p>
1513
+ * @public
1514
+ */
1515
+ text?: UpdateTextParameters | undefined;
1516
+ /**
1517
+ * <p>The voice-channel parameters to update. Omit this member to leave the voice-channel parameters unchanged.</p>
1518
+ * @public
1519
+ */
1520
+ voice?: UpdateVoiceParameters | undefined;
1521
+ /**
1522
+ * <p>The notify-template-route parameters to update. Omit this member to leave them unchanged.</p>
1523
+ * @public
1524
+ */
1525
+ notify?: UpdateNotifyParameters | undefined;
1526
+ /**
1527
+ * <p>The WhatsApp-channel parameters to update. Omit this member to leave the WhatsApp-channel parameters unchanged.</p>
1528
+ * @public
1529
+ */
1530
+ whatsApp?: UpdateWhatsAppParameters | undefined;
1531
+ }
1532
+ /**
1533
+ * <p>The loose variant of the passcode policy parameters that is used only when you update a notify code configuration. When you omit a member, its current value is preserved.</p>
1534
+ * @public
1535
+ */
1536
+ export interface UpdateCodeConfigurationParameters {
1537
+ /**
1538
+ * <p>The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.</p>
1539
+ * @public
1540
+ */
1541
+ codeType?: CodeType | undefined;
1542
+ /**
1543
+ * <p>The updated number of characters in the one-time passcode. Valid values range from 4 through 8. Omit this member to preserve the current value.</p>
1544
+ * @public
1545
+ */
1546
+ codeLength?: number | undefined;
1547
+ /**
1548
+ * <p>The updated length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. Omit this member to preserve the current value.</p>
1549
+ * @public
1550
+ */
1551
+ validityPeriodMinutes?: number | undefined;
1552
+ /**
1553
+ * <p>The updated maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. Omit this member to preserve the current value.</p>
1554
+ * @public
1555
+ */
1556
+ maxAttempts?: number | undefined;
1557
+ }
1558
+ /**
1559
+ * @public
1560
+ */
1561
+ export interface UpdateNotifyCodeConfigurationInput {
1562
+ /**
1563
+ * <p>The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1564
+ * @public
1565
+ */
1566
+ notifyCodeConfigurationId: string | undefined;
1567
+ /**
1568
+ * <p>The name of the notify code configuration.</p>
1569
+ * @public
1570
+ */
1571
+ notifyCodeConfigurationName?: string | undefined;
1572
+ /**
1573
+ * <p>The updated passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. When you omit a member, its current value is preserved.</p>
1574
+ * @public
1575
+ */
1576
+ codeConfigurationParameters?: UpdateCodeConfigurationParameters | undefined;
1577
+ /**
1578
+ * <p>The updated channel-specific parameters used to render and deliver the one-time passcode. This is a loose, nested update: when you omit a channel, that channel's parameters remain unchanged. Within a supplied channel, an empty string on a string member, or an empty map on the destination-country parameters, clears the currently stored value, and absent members preserve the current value.</p>
1579
+ * @public
1580
+ */
1581
+ channelParameters?: UpdateChannelParameters | undefined;
1582
+ /**
1583
+ * <p>Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.</p>
1584
+ * @public
1585
+ */
1586
+ deletionProtectionEnabled?: boolean | undefined;
1587
+ }
1588
+ /**
1589
+ * @public
1590
+ */
1591
+ export interface UpdateNotifyCodeConfigurationOutput {
1592
+ /**
1593
+ * <p>The notify code configuration resource.</p>
1594
+ * @public
1595
+ */
1596
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
1597
+ }
1598
+ /**
1599
+ * @public
1600
+ */
1601
+ export interface UpdateRegistrationsFromBrandProfileInput {
1602
+ /**
1603
+ * <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
1604
+ * @public
1605
+ */
1606
+ brandProfileId: string | undefined;
1607
+ /**
1608
+ * <p>The identifiers of the registrations.</p>
1609
+ * @public
1610
+ */
1611
+ registrationIds: string[] | undefined;
1612
+ /**
1613
+ * <p>Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.</p>
1614
+ * @public
1615
+ */
1616
+ smartMatch?: boolean | undefined;
1617
+ /**
1618
+ * <p>Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.</p>
1619
+ * @public
1620
+ */
1621
+ onAttributeConflict?: OnAttributeConflict | undefined;
1622
+ /**
1623
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>
1624
+ * @public
1625
+ */
1626
+ clientToken?: string | undefined;
1627
+ }
1628
+ /**
1629
+ * @public
1630
+ */
1631
+ export interface UpdateRegistrationsFromBrandProfileOutput {
1632
+ /**
1633
+ * <p>The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.</p>
1634
+ * @public
1635
+ */
1636
+ results: JobResult[] | undefined;
1637
+ }
1638
+ /**
1639
+ * @public
1640
+ */
1641
+ export interface ValidateNotifyCodeVerificationInput {
1642
+ /**
1643
+ * <p>The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.</p>
1644
+ * @public
1645
+ */
1646
+ destinationIdentity: string | undefined;
1647
+ /**
1648
+ * <p>The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.</p>
1649
+ * @public
1650
+ */
1651
+ referenceId?: string | undefined;
1652
+ /**
1653
+ * <p>The one-time passcode that the recipient submitted for validation.</p>
1654
+ * @public
1655
+ */
1656
+ code: string | undefined;
1657
+ }
1658
+ /**
1659
+ * @public
1660
+ */
1661
+ export interface ValidateNotifyCodeVerificationOutput {
1662
+ /**
1663
+ * <p>The outcome of the validation attempt. VALID indicates that the submitted passcode matched an active verification. INVALID indicates that the passcode did not match, expired, or exceeded its attempt limit.</p>
1664
+ * @public
1665
+ */
1666
+ status: VerificationStatus | undefined;
1667
+ }