@aws-sdk/client-pinpoint 3.300.0 → 3.301.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.
- package/dist-types/commands/CreateAppCommand.d.ts +3 -3
- package/dist-types/commands/CreateCampaignCommand.d.ts +52 -153
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateExportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +11 -14
- package/dist-types/commands/CreateJourneyCommand.d.ts +77 -158
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +6 -6
- package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/CreateSegmentCommand.d.ts +35 -88
- package/dist-types/commands/CreateSmsTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteAdmChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteApnsChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAppCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEmailChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventStreamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJourneyCommand.d.ts +1 -1
- package/dist-types/commands/DeletePushTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSegmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSmsChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetAdmChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetApnsChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetAppCommand.d.ts +1 -1
- package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +1 -1
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +1 -1
- package/dist-types/commands/GetAppsCommand.d.ts +1 -1
- package/dist-types/commands/GetBaiduChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignsCommand.d.ts +1 -1
- package/dist-types/commands/GetChannelsCommand.d.ts +1 -1
- package/dist-types/commands/GetEmailChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetEndpointCommand.d.ts +1 -1
- package/dist-types/commands/GetEventStreamCommand.d.ts +1 -1
- package/dist-types/commands/GetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetGcmChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +1 -1
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetJourneyCommand.d.ts +1 -1
- package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +1 -1
- package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +1 -1
- package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +1 -1
- package/dist-types/commands/GetPushTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentVersionsCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentsCommand.d.ts +1 -1
- package/dist-types/commands/GetSmsChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetSmsTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetUserEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/GetVoiceChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetVoiceTemplateCommand.d.ts +1 -1
- package/dist-types/commands/ListJourneysCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/PhoneNumberValidateCommand.d.ts +2 -2
- package/dist-types/commands/PutEventStreamCommand.d.ts +2 -2
- package/dist-types/commands/PutEventsCommand.d.ts +15 -15
- package/dist-types/commands/RemoveAttributesCommand.d.ts +3 -3
- package/dist-types/commands/SendMessagesCommand.d.ts +34 -66
- package/dist-types/commands/SendOTPMessageCommand.d.ts +2 -2
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +30 -56
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAdmChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApnsChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateCampaignCommand.d.ts +52 -153
- package/dist-types/commands/UpdateEmailChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +3 -3
- package/dist-types/commands/UpdateEndpointCommand.d.ts +8 -8
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +10 -10
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +11 -14
- package/dist-types/commands/UpdateJourneyCommand.d.ts +77 -158
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +2 -2
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +6 -6
- package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateSegmentCommand.d.ts +35 -88
- package/dist-types/commands/UpdateSmsChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +3 -3
- package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +2 -2
- package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +3 -3
- package/dist-types/commands/VerifyOTPMessageCommand.d.ts +2 -2
- package/package.json +3 -3
|
@@ -26,20 +26,20 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
26
26
|
* import { PinpointClient, UpdateCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateCampaignRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
31
|
* CampaignId: "STRING_VALUE", // required
|
|
32
|
-
* WriteCampaignRequest: {
|
|
33
|
-
* AdditionalTreatments: [
|
|
34
|
-
* {
|
|
35
|
-
* CustomDeliveryConfiguration: {
|
|
32
|
+
* WriteCampaignRequest: { // WriteCampaignRequest
|
|
33
|
+
* AdditionalTreatments: [ // ListOfWriteTreatmentResource
|
|
34
|
+
* { // WriteTreatmentResource
|
|
35
|
+
* CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
|
|
36
36
|
* DeliveryUri: "STRING_VALUE", // required
|
|
37
|
-
* EndpointTypes: [
|
|
37
|
+
* EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
38
38
|
* "STRING_VALUE",
|
|
39
39
|
* ],
|
|
40
40
|
* },
|
|
41
|
-
* MessageConfiguration: {
|
|
42
|
-
* ADMMessage: {
|
|
41
|
+
* MessageConfiguration: { // MessageConfiguration
|
|
42
|
+
* ADMMessage: { // Message
|
|
43
43
|
* Action: "STRING_VALUE",
|
|
44
44
|
* Body: "STRING_VALUE",
|
|
45
45
|
* ImageIconUrl: "STRING_VALUE",
|
|
@@ -81,7 +81,7 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
81
81
|
* Title: "STRING_VALUE",
|
|
82
82
|
* Url: "STRING_VALUE",
|
|
83
83
|
* },
|
|
84
|
-
* CustomMessage: {
|
|
84
|
+
* CustomMessage: { // CampaignCustomMessage
|
|
85
85
|
* Data: "STRING_VALUE",
|
|
86
86
|
* },
|
|
87
87
|
* DefaultMessage: {
|
|
@@ -98,7 +98,7 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
98
98
|
* Title: "STRING_VALUE",
|
|
99
99
|
* Url: "STRING_VALUE",
|
|
100
100
|
* },
|
|
101
|
-
* EmailMessage: {
|
|
101
|
+
* EmailMessage: { // CampaignEmailMessage
|
|
102
102
|
* Body: "STRING_VALUE",
|
|
103
103
|
* FromAddress: "STRING_VALUE",
|
|
104
104
|
* HtmlBody: "STRING_VALUE",
|
|
@@ -118,7 +118,7 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
118
118
|
* Title: "STRING_VALUE",
|
|
119
119
|
* Url: "STRING_VALUE",
|
|
120
120
|
* },
|
|
121
|
-
* SMSMessage: {
|
|
121
|
+
* SMSMessage: { // CampaignSmsMessage
|
|
122
122
|
* Body: "STRING_VALUE",
|
|
123
123
|
* MessageType: "STRING_VALUE",
|
|
124
124
|
* OriginationNumber: "STRING_VALUE",
|
|
@@ -126,28 +126,28 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
126
126
|
* EntityId: "STRING_VALUE",
|
|
127
127
|
* TemplateId: "STRING_VALUE",
|
|
128
128
|
* },
|
|
129
|
-
* InAppMessage: {
|
|
129
|
+
* InAppMessage: { // CampaignInAppMessage
|
|
130
130
|
* Body: "STRING_VALUE",
|
|
131
|
-
* Content: [
|
|
132
|
-
* {
|
|
131
|
+
* Content: [ // ListOfInAppMessageContent
|
|
132
|
+
* { // InAppMessageContent
|
|
133
133
|
* BackgroundColor: "STRING_VALUE",
|
|
134
|
-
* BodyConfig: {
|
|
134
|
+
* BodyConfig: { // InAppMessageBodyConfig
|
|
135
135
|
* Alignment: "STRING_VALUE", // required
|
|
136
136
|
* Body: "STRING_VALUE", // required
|
|
137
137
|
* TextColor: "STRING_VALUE", // required
|
|
138
138
|
* },
|
|
139
|
-
* HeaderConfig: {
|
|
139
|
+
* HeaderConfig: { // InAppMessageHeaderConfig
|
|
140
140
|
* Alignment: "STRING_VALUE", // required
|
|
141
141
|
* Header: "STRING_VALUE", // required
|
|
142
142
|
* TextColor: "STRING_VALUE", // required
|
|
143
143
|
* },
|
|
144
144
|
* ImageUrl: "STRING_VALUE",
|
|
145
|
-
* PrimaryBtn: {
|
|
146
|
-
* Android: {
|
|
145
|
+
* PrimaryBtn: { // InAppMessageButton
|
|
146
|
+
* Android: { // OverrideButtonConfiguration
|
|
147
147
|
* ButtonAction: "STRING_VALUE", // required
|
|
148
148
|
* Link: "STRING_VALUE",
|
|
149
149
|
* },
|
|
150
|
-
* DefaultConfig: {
|
|
150
|
+
* DefaultConfig: { // DefaultButtonConfiguration
|
|
151
151
|
* BackgroundColor: "STRING_VALUE",
|
|
152
152
|
* BorderRadius: Number("int"),
|
|
153
153
|
* ButtonAction: "STRING_VALUE", // required
|
|
@@ -181,39 +181,36 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
181
181
|
* ButtonAction: "STRING_VALUE", // required
|
|
182
182
|
* Link: "STRING_VALUE",
|
|
183
183
|
* },
|
|
184
|
-
* Web:
|
|
185
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
186
|
-
* Link: "STRING_VALUE",
|
|
187
|
-
* },
|
|
184
|
+
* Web: "<OverrideButtonConfiguration>",
|
|
188
185
|
* },
|
|
189
186
|
* },
|
|
190
187
|
* ],
|
|
191
|
-
* CustomConfig: {
|
|
188
|
+
* CustomConfig: { // MapOf__string
|
|
192
189
|
* "<keys>": "STRING_VALUE",
|
|
193
190
|
* },
|
|
194
191
|
* Layout: "STRING_VALUE",
|
|
195
192
|
* },
|
|
196
193
|
* },
|
|
197
|
-
* Schedule: {
|
|
194
|
+
* Schedule: { // Schedule
|
|
198
195
|
* EndTime: "STRING_VALUE",
|
|
199
|
-
* EventFilter: {
|
|
200
|
-
* Dimensions: {
|
|
201
|
-
* Attributes: {
|
|
202
|
-
* "<keys>": {
|
|
196
|
+
* EventFilter: { // CampaignEventFilter
|
|
197
|
+
* Dimensions: { // EventDimensions
|
|
198
|
+
* Attributes: { // MapOfAttributeDimension
|
|
199
|
+
* "<keys>": { // AttributeDimension
|
|
203
200
|
* AttributeType: "STRING_VALUE",
|
|
204
|
-
* Values: [ // required
|
|
201
|
+
* Values: [ // ListOf__string // required
|
|
205
202
|
* "STRING_VALUE",
|
|
206
203
|
* ],
|
|
207
204
|
* },
|
|
208
205
|
* },
|
|
209
|
-
* EventType: {
|
|
206
|
+
* EventType: { // SetDimension
|
|
210
207
|
* DimensionType: "STRING_VALUE",
|
|
211
208
|
* Values: [ // required
|
|
212
209
|
* "STRING_VALUE",
|
|
213
210
|
* ],
|
|
214
211
|
* },
|
|
215
|
-
* Metrics: {
|
|
216
|
-
* "<keys>": {
|
|
212
|
+
* Metrics: { // MapOfMetricDimension
|
|
213
|
+
* "<keys>": { // MetricDimension
|
|
217
214
|
* ComparisonOperator: "STRING_VALUE", // required
|
|
218
215
|
* Value: Number("double"), // required
|
|
219
216
|
* },
|
|
@@ -223,7 +220,7 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
223
220
|
* },
|
|
224
221
|
* Frequency: "STRING_VALUE",
|
|
225
222
|
* IsLocalTime: true || false,
|
|
226
|
-
* QuietTime: {
|
|
223
|
+
* QuietTime: { // QuietTime
|
|
227
224
|
* End: "STRING_VALUE",
|
|
228
225
|
* Start: "STRING_VALUE",
|
|
229
226
|
* },
|
|
@@ -231,8 +228,8 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
231
228
|
* Timezone: "STRING_VALUE",
|
|
232
229
|
* },
|
|
233
230
|
* SizePercent: Number("int"), // required
|
|
234
|
-
* TemplateConfiguration: {
|
|
235
|
-
* EmailTemplate: {
|
|
231
|
+
* TemplateConfiguration: { // TemplateConfiguration
|
|
232
|
+
* EmailTemplate: { // Template
|
|
236
233
|
* Name: "STRING_VALUE",
|
|
237
234
|
* Version: "STRING_VALUE",
|
|
238
235
|
* },
|
|
@@ -261,13 +258,13 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
261
258
|
* },
|
|
262
259
|
* Description: "STRING_VALUE",
|
|
263
260
|
* HoldoutPercent: Number("int"),
|
|
264
|
-
* Hook: {
|
|
261
|
+
* Hook: { // CampaignHook
|
|
265
262
|
* LambdaFunctionName: "STRING_VALUE",
|
|
266
263
|
* Mode: "STRING_VALUE",
|
|
267
264
|
* WebUrl: "STRING_VALUE",
|
|
268
265
|
* },
|
|
269
266
|
* IsPaused: true || false,
|
|
270
|
-
* Limits: {
|
|
267
|
+
* Limits: { // CampaignLimits
|
|
271
268
|
* Daily: Number("int"),
|
|
272
269
|
* MaximumDuration: Number("int"),
|
|
273
270
|
* MessagesPerSecond: Number("int"),
|
|
@@ -275,85 +272,20 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
275
272
|
* Session: Number("int"),
|
|
276
273
|
* },
|
|
277
274
|
* MessageConfiguration: {
|
|
278
|
-
* ADMMessage:
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
* ImageIconUrl: "STRING_VALUE",
|
|
282
|
-
* ImageSmallIconUrl: "STRING_VALUE",
|
|
283
|
-
* ImageUrl: "STRING_VALUE",
|
|
284
|
-
* JsonBody: "STRING_VALUE",
|
|
285
|
-
* MediaUrl: "STRING_VALUE",
|
|
286
|
-
* RawContent: "STRING_VALUE",
|
|
287
|
-
* SilentPush: true || false,
|
|
288
|
-
* TimeToLive: Number("int"),
|
|
289
|
-
* Title: "STRING_VALUE",
|
|
290
|
-
* Url: "STRING_VALUE",
|
|
291
|
-
* },
|
|
292
|
-
* APNSMessage: {
|
|
293
|
-
* Action: "STRING_VALUE",
|
|
294
|
-
* Body: "STRING_VALUE",
|
|
295
|
-
* ImageIconUrl: "STRING_VALUE",
|
|
296
|
-
* ImageSmallIconUrl: "STRING_VALUE",
|
|
297
|
-
* ImageUrl: "STRING_VALUE",
|
|
298
|
-
* JsonBody: "STRING_VALUE",
|
|
299
|
-
* MediaUrl: "STRING_VALUE",
|
|
300
|
-
* RawContent: "STRING_VALUE",
|
|
301
|
-
* SilentPush: true || false,
|
|
302
|
-
* TimeToLive: Number("int"),
|
|
303
|
-
* Title: "STRING_VALUE",
|
|
304
|
-
* Url: "STRING_VALUE",
|
|
305
|
-
* },
|
|
306
|
-
* BaiduMessage: {
|
|
307
|
-
* Action: "STRING_VALUE",
|
|
308
|
-
* Body: "STRING_VALUE",
|
|
309
|
-
* ImageIconUrl: "STRING_VALUE",
|
|
310
|
-
* ImageSmallIconUrl: "STRING_VALUE",
|
|
311
|
-
* ImageUrl: "STRING_VALUE",
|
|
312
|
-
* JsonBody: "STRING_VALUE",
|
|
313
|
-
* MediaUrl: "STRING_VALUE",
|
|
314
|
-
* RawContent: "STRING_VALUE",
|
|
315
|
-
* SilentPush: true || false,
|
|
316
|
-
* TimeToLive: Number("int"),
|
|
317
|
-
* Title: "STRING_VALUE",
|
|
318
|
-
* Url: "STRING_VALUE",
|
|
319
|
-
* },
|
|
275
|
+
* ADMMessage: "<Message>",
|
|
276
|
+
* APNSMessage: "<Message>",
|
|
277
|
+
* BaiduMessage: "<Message>",
|
|
320
278
|
* CustomMessage: {
|
|
321
279
|
* Data: "STRING_VALUE",
|
|
322
280
|
* },
|
|
323
|
-
* DefaultMessage:
|
|
324
|
-
* Action: "STRING_VALUE",
|
|
325
|
-
* Body: "STRING_VALUE",
|
|
326
|
-
* ImageIconUrl: "STRING_VALUE",
|
|
327
|
-
* ImageSmallIconUrl: "STRING_VALUE",
|
|
328
|
-
* ImageUrl: "STRING_VALUE",
|
|
329
|
-
* JsonBody: "STRING_VALUE",
|
|
330
|
-
* MediaUrl: "STRING_VALUE",
|
|
331
|
-
* RawContent: "STRING_VALUE",
|
|
332
|
-
* SilentPush: true || false,
|
|
333
|
-
* TimeToLive: Number("int"),
|
|
334
|
-
* Title: "STRING_VALUE",
|
|
335
|
-
* Url: "STRING_VALUE",
|
|
336
|
-
* },
|
|
281
|
+
* DefaultMessage: "<Message>",
|
|
337
282
|
* EmailMessage: {
|
|
338
283
|
* Body: "STRING_VALUE",
|
|
339
284
|
* FromAddress: "STRING_VALUE",
|
|
340
285
|
* HtmlBody: "STRING_VALUE",
|
|
341
286
|
* Title: "STRING_VALUE",
|
|
342
287
|
* },
|
|
343
|
-
* GCMMessage:
|
|
344
|
-
* Action: "STRING_VALUE",
|
|
345
|
-
* Body: "STRING_VALUE",
|
|
346
|
-
* ImageIconUrl: "STRING_VALUE",
|
|
347
|
-
* ImageSmallIconUrl: "STRING_VALUE",
|
|
348
|
-
* ImageUrl: "STRING_VALUE",
|
|
349
|
-
* JsonBody: "STRING_VALUE",
|
|
350
|
-
* MediaUrl: "STRING_VALUE",
|
|
351
|
-
* RawContent: "STRING_VALUE",
|
|
352
|
-
* SilentPush: true || false,
|
|
353
|
-
* TimeToLive: Number("int"),
|
|
354
|
-
* Title: "STRING_VALUE",
|
|
355
|
-
* Url: "STRING_VALUE",
|
|
356
|
-
* },
|
|
288
|
+
* GCMMessage: "<Message>",
|
|
357
289
|
* SMSMessage: {
|
|
358
290
|
* Body: "STRING_VALUE",
|
|
359
291
|
* MessageType: "STRING_VALUE",
|
|
@@ -379,10 +311,7 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
379
311
|
* },
|
|
380
312
|
* ImageUrl: "STRING_VALUE",
|
|
381
313
|
* PrimaryBtn: {
|
|
382
|
-
* Android:
|
|
383
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
384
|
-
* Link: "STRING_VALUE",
|
|
385
|
-
* },
|
|
314
|
+
* Android: "<OverrideButtonConfiguration>",
|
|
386
315
|
* DefaultConfig: {
|
|
387
316
|
* BackgroundColor: "STRING_VALUE",
|
|
388
317
|
* BorderRadius: Number("int"),
|
|
@@ -391,20 +320,11 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
391
320
|
* Text: "STRING_VALUE", // required
|
|
392
321
|
* TextColor: "STRING_VALUE",
|
|
393
322
|
* },
|
|
394
|
-
* IOS:
|
|
395
|
-
*
|
|
396
|
-
* Link: "STRING_VALUE",
|
|
397
|
-
* },
|
|
398
|
-
* Web: {
|
|
399
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
400
|
-
* Link: "STRING_VALUE",
|
|
401
|
-
* },
|
|
323
|
+
* IOS: "<OverrideButtonConfiguration>",
|
|
324
|
+
* Web: "<OverrideButtonConfiguration>",
|
|
402
325
|
* },
|
|
403
326
|
* SecondaryBtn: {
|
|
404
|
-
* Android:
|
|
405
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
406
|
-
* Link: "STRING_VALUE",
|
|
407
|
-
* },
|
|
327
|
+
* Android: "<OverrideButtonConfiguration>",
|
|
408
328
|
* DefaultConfig: {
|
|
409
329
|
* BackgroundColor: "STRING_VALUE",
|
|
410
330
|
* BorderRadius: Number("int"),
|
|
@@ -413,14 +333,8 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
413
333
|
* Text: "STRING_VALUE", // required
|
|
414
334
|
* TextColor: "STRING_VALUE",
|
|
415
335
|
* },
|
|
416
|
-
* IOS:
|
|
417
|
-
*
|
|
418
|
-
* Link: "STRING_VALUE",
|
|
419
|
-
* },
|
|
420
|
-
* Web: {
|
|
421
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
422
|
-
* Link: "STRING_VALUE",
|
|
423
|
-
* },
|
|
336
|
+
* IOS: "<OverrideButtonConfiguration>",
|
|
337
|
+
* Web: "<OverrideButtonConfiguration>",
|
|
424
338
|
* },
|
|
425
339
|
* },
|
|
426
340
|
* ],
|
|
@@ -438,16 +352,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
438
352
|
* Attributes: {
|
|
439
353
|
* "<keys>": {
|
|
440
354
|
* AttributeType: "STRING_VALUE",
|
|
441
|
-
* Values:
|
|
442
|
-
* "<ListOf__string>",
|
|
443
|
-
* ],
|
|
355
|
+
* Values: "<ListOf__string>", // required
|
|
444
356
|
* },
|
|
445
357
|
* },
|
|
446
358
|
* EventType: {
|
|
447
359
|
* DimensionType: "STRING_VALUE",
|
|
448
|
-
* Values:
|
|
449
|
-
* "<ListOf__string>",
|
|
450
|
-
* ],
|
|
360
|
+
* Values: "<ListOf__string>", // required
|
|
451
361
|
* },
|
|
452
362
|
* Metrics: {
|
|
453
363
|
* "<keys>": {
|
|
@@ -469,26 +379,15 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
469
379
|
* },
|
|
470
380
|
* SegmentId: "STRING_VALUE",
|
|
471
381
|
* SegmentVersion: Number("int"),
|
|
472
|
-
* tags:
|
|
473
|
-
* "<keys>": "<__string>",
|
|
474
|
-
* },
|
|
382
|
+
* tags: "<MapOf__string>",
|
|
475
383
|
* TemplateConfiguration: {
|
|
476
384
|
* EmailTemplate: {
|
|
477
385
|
* Name: "STRING_VALUE",
|
|
478
386
|
* Version: "STRING_VALUE",
|
|
479
387
|
* },
|
|
480
|
-
* PushTemplate:
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
* },
|
|
484
|
-
* SMSTemplate: {
|
|
485
|
-
* Name: "STRING_VALUE",
|
|
486
|
-
* Version: "STRING_VALUE",
|
|
487
|
-
* },
|
|
488
|
-
* VoiceTemplate: {
|
|
489
|
-
* Name: "STRING_VALUE",
|
|
490
|
-
* Version: "STRING_VALUE",
|
|
491
|
-
* },
|
|
388
|
+
* PushTemplate: "<Template>",
|
|
389
|
+
* SMSTemplate: "<Template>",
|
|
390
|
+
* VoiceTemplate: "<Template>",
|
|
492
391
|
* },
|
|
493
392
|
* TreatmentDescription: "STRING_VALUE",
|
|
494
393
|
* TreatmentName: "STRING_VALUE",
|
|
@@ -26,9 +26,9 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo
|
|
|
26
26
|
* import { PinpointClient, UpdateEmailChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateEmailChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateEmailChannelRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
-
* EmailChannelRequest: {
|
|
31
|
+
* EmailChannelRequest: { // EmailChannelRequest
|
|
32
32
|
* ConfigurationSet: "STRING_VALUE",
|
|
33
33
|
* Enabled: true || false,
|
|
34
34
|
* FromAddress: "STRING_VALUE", // required
|
|
@@ -26,14 +26,14 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes
|
|
|
26
26
|
* import { PinpointClient, UpdateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateEmailTemplateRequest
|
|
30
30
|
* CreateNewVersion: true || false,
|
|
31
|
-
* EmailTemplateRequest: {
|
|
31
|
+
* EmailTemplateRequest: { // EmailTemplateRequest
|
|
32
32
|
* DefaultSubstitutions: "STRING_VALUE",
|
|
33
33
|
* HtmlPart: "STRING_VALUE",
|
|
34
34
|
* RecommenderId: "STRING_VALUE",
|
|
35
35
|
* Subject: "STRING_VALUE",
|
|
36
|
-
* tags: {
|
|
36
|
+
* tags: { // MapOf__string
|
|
37
37
|
* "<keys>": "STRING_VALUE",
|
|
38
38
|
* },
|
|
39
39
|
* TemplateDescription: "STRING_VALUE",
|
|
@@ -26,18 +26,18 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
|
|
|
26
26
|
* import { PinpointClient, UpdateEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateEndpointRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
31
|
* EndpointId: "STRING_VALUE", // required
|
|
32
|
-
* EndpointRequest: {
|
|
32
|
+
* EndpointRequest: { // EndpointRequest
|
|
33
33
|
* Address: "STRING_VALUE",
|
|
34
|
-
* Attributes: {
|
|
35
|
-
* "<keys>": [
|
|
34
|
+
* Attributes: { // MapOfListOf__string
|
|
35
|
+
* "<keys>": [ // ListOf__string
|
|
36
36
|
* "STRING_VALUE",
|
|
37
37
|
* ],
|
|
38
38
|
* },
|
|
39
39
|
* ChannelType: "STRING_VALUE",
|
|
40
|
-
* Demographic: {
|
|
40
|
+
* Demographic: { // EndpointDemographic
|
|
41
41
|
* AppVersion: "STRING_VALUE",
|
|
42
42
|
* Locale: "STRING_VALUE",
|
|
43
43
|
* Make: "STRING_VALUE",
|
|
@@ -49,7 +49,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
|
|
|
49
49
|
* },
|
|
50
50
|
* EffectiveDate: "STRING_VALUE",
|
|
51
51
|
* EndpointStatus: "STRING_VALUE",
|
|
52
|
-
* Location: {
|
|
52
|
+
* Location: { // EndpointLocation
|
|
53
53
|
* City: "STRING_VALUE",
|
|
54
54
|
* Country: "STRING_VALUE",
|
|
55
55
|
* Latitude: Number("double"),
|
|
@@ -57,12 +57,12 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
|
|
|
57
57
|
* PostalCode: "STRING_VALUE",
|
|
58
58
|
* Region: "STRING_VALUE",
|
|
59
59
|
* },
|
|
60
|
-
* Metrics: {
|
|
60
|
+
* Metrics: { // MapOf__double
|
|
61
61
|
* "<keys>": Number("double"),
|
|
62
62
|
* },
|
|
63
63
|
* OptOut: "STRING_VALUE",
|
|
64
64
|
* RequestId: "STRING_VALUE",
|
|
65
|
-
* User: {
|
|
65
|
+
* User: { // EndpointUser
|
|
66
66
|
* UserAttributes: {
|
|
67
67
|
* "<keys>": [
|
|
68
68
|
* "STRING_VALUE",
|
|
@@ -26,19 +26,19 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
|
|
|
26
26
|
* import { PinpointClient, UpdateEndpointsBatchCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateEndpointsBatchCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateEndpointsBatchRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
-
* EndpointBatchRequest: {
|
|
32
|
-
* Item: [ // required
|
|
33
|
-
* {
|
|
31
|
+
* EndpointBatchRequest: { // EndpointBatchRequest
|
|
32
|
+
* Item: [ // ListOfEndpointBatchItem // required
|
|
33
|
+
* { // EndpointBatchItem
|
|
34
34
|
* Address: "STRING_VALUE",
|
|
35
|
-
* Attributes: {
|
|
36
|
-
* "<keys>": [
|
|
35
|
+
* Attributes: { // MapOfListOf__string
|
|
36
|
+
* "<keys>": [ // ListOf__string
|
|
37
37
|
* "STRING_VALUE",
|
|
38
38
|
* ],
|
|
39
39
|
* },
|
|
40
40
|
* ChannelType: "STRING_VALUE",
|
|
41
|
-
* Demographic: {
|
|
41
|
+
* Demographic: { // EndpointDemographic
|
|
42
42
|
* AppVersion: "STRING_VALUE",
|
|
43
43
|
* Locale: "STRING_VALUE",
|
|
44
44
|
* Make: "STRING_VALUE",
|
|
@@ -51,7 +51,7 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
|
|
|
51
51
|
* EffectiveDate: "STRING_VALUE",
|
|
52
52
|
* EndpointStatus: "STRING_VALUE",
|
|
53
53
|
* Id: "STRING_VALUE",
|
|
54
|
-
* Location: {
|
|
54
|
+
* Location: { // EndpointLocation
|
|
55
55
|
* City: "STRING_VALUE",
|
|
56
56
|
* Country: "STRING_VALUE",
|
|
57
57
|
* Latitude: Number("double"),
|
|
@@ -59,12 +59,12 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
|
|
|
59
59
|
* PostalCode: "STRING_VALUE",
|
|
60
60
|
* Region: "STRING_VALUE",
|
|
61
61
|
* },
|
|
62
|
-
* Metrics: {
|
|
62
|
+
* Metrics: { // MapOf__double
|
|
63
63
|
* "<keys>": Number("double"),
|
|
64
64
|
* },
|
|
65
65
|
* OptOut: "STRING_VALUE",
|
|
66
66
|
* RequestId: "STRING_VALUE",
|
|
67
|
-
* User: {
|
|
67
|
+
* User: { // EndpointUser
|
|
68
68
|
* UserAttributes: {
|
|
69
69
|
* "<keys>": [
|
|
70
70
|
* "STRING_VALUE",
|
|
@@ -26,9 +26,9 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse,
|
|
|
26
26
|
* import { PinpointClient, UpdateGcmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateGcmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateGcmChannelRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
-
* GCMChannelRequest: {
|
|
31
|
+
* GCMChannelRequest: { // GCMChannelRequest
|
|
32
32
|
* ApiKey: "STRING_VALUE", // required
|
|
33
33
|
* Enabled: true || false,
|
|
34
34
|
* },
|
|
@@ -26,29 +26,29 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
|
|
|
26
26
|
* import { PinpointClient, UpdateInAppTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateInAppTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateInAppTemplateRequest
|
|
30
30
|
* CreateNewVersion: true || false,
|
|
31
|
-
* InAppTemplateRequest: {
|
|
32
|
-
* Content: [
|
|
33
|
-
* {
|
|
31
|
+
* InAppTemplateRequest: { // InAppTemplateRequest
|
|
32
|
+
* Content: [ // ListOfInAppMessageContent
|
|
33
|
+
* { // InAppMessageContent
|
|
34
34
|
* BackgroundColor: "STRING_VALUE",
|
|
35
|
-
* BodyConfig: {
|
|
35
|
+
* BodyConfig: { // InAppMessageBodyConfig
|
|
36
36
|
* Alignment: "STRING_VALUE", // required
|
|
37
37
|
* Body: "STRING_VALUE", // required
|
|
38
38
|
* TextColor: "STRING_VALUE", // required
|
|
39
39
|
* },
|
|
40
|
-
* HeaderConfig: {
|
|
40
|
+
* HeaderConfig: { // InAppMessageHeaderConfig
|
|
41
41
|
* Alignment: "STRING_VALUE", // required
|
|
42
42
|
* Header: "STRING_VALUE", // required
|
|
43
43
|
* TextColor: "STRING_VALUE", // required
|
|
44
44
|
* },
|
|
45
45
|
* ImageUrl: "STRING_VALUE",
|
|
46
|
-
* PrimaryBtn: {
|
|
47
|
-
* Android: {
|
|
46
|
+
* PrimaryBtn: { // InAppMessageButton
|
|
47
|
+
* Android: { // OverrideButtonConfiguration
|
|
48
48
|
* ButtonAction: "STRING_VALUE", // required
|
|
49
49
|
* Link: "STRING_VALUE",
|
|
50
50
|
* },
|
|
51
|
-
* DefaultConfig: {
|
|
51
|
+
* DefaultConfig: { // DefaultButtonConfiguration
|
|
52
52
|
* BackgroundColor: "STRING_VALUE",
|
|
53
53
|
* BorderRadius: Number("int"),
|
|
54
54
|
* ButtonAction: "STRING_VALUE", // required
|
|
@@ -82,14 +82,11 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
|
|
|
82
82
|
* ButtonAction: "STRING_VALUE", // required
|
|
83
83
|
* Link: "STRING_VALUE",
|
|
84
84
|
* },
|
|
85
|
-
* Web:
|
|
86
|
-
* ButtonAction: "STRING_VALUE", // required
|
|
87
|
-
* Link: "STRING_VALUE",
|
|
88
|
-
* },
|
|
85
|
+
* Web: "<OverrideButtonConfiguration>",
|
|
89
86
|
* },
|
|
90
87
|
* },
|
|
91
88
|
* ],
|
|
92
|
-
* CustomConfig: {
|
|
89
|
+
* CustomConfig: { // MapOf__string
|
|
93
90
|
* "<keys>": "STRING_VALUE",
|
|
94
91
|
* },
|
|
95
92
|
* Layout: "STRING_VALUE",
|