@aws-sdk/client-pinpoint 3.298.0 → 3.300.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 +8 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +468 -0
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +14 -0
- package/dist-types/commands/CreateExportJobCommand.d.ts +9 -0
- package/dist-types/commands/CreateImportJobCommand.d.ts +13 -0
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +73 -0
- package/dist-types/commands/CreateJourneyCommand.d.ts +457 -0
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +60 -0
- package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +15 -0
- package/dist-types/commands/CreateSegmentCommand.d.ts +192 -0
- package/dist-types/commands/CreateSmsTemplateCommand.d.ts +12 -0
- package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +13 -0
- package/dist-types/commands/DeleteAdmChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteApnsChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAppCommand.d.ts +3 -0
- package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEmailChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEndpointCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEventStreamCommand.d.ts +3 -0
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteJourneyCommand.d.ts +4 -0
- package/dist-types/commands/DeletePushTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/DeleteSegmentCommand.d.ts +4 -0
- package/dist-types/commands/DeleteSmsChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +3 -0
- package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +4 -0
- package/dist-types/commands/GetAdmChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetApnsChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetAppCommand.d.ts +3 -0
- package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +8 -0
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +3 -0
- package/dist-types/commands/GetAppsCommand.d.ts +4 -0
- package/dist-types/commands/GetBaiduChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +6 -0
- package/dist-types/commands/GetCampaignCommand.d.ts +4 -0
- package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +9 -0
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +5 -0
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +6 -0
- package/dist-types/commands/GetCampaignsCommand.d.ts +5 -0
- package/dist-types/commands/GetChannelsCommand.d.ts +3 -0
- package/dist-types/commands/GetEmailChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +4 -0
- package/dist-types/commands/GetEndpointCommand.d.ts +4 -0
- package/dist-types/commands/GetEventStreamCommand.d.ts +3 -0
- package/dist-types/commands/GetExportJobCommand.d.ts +4 -0
- package/dist-types/commands/GetExportJobsCommand.d.ts +5 -0
- package/dist-types/commands/GetGcmChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +4 -0
- package/dist-types/commands/GetImportJobsCommand.d.ts +5 -0
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +4 -0
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +4 -0
- package/dist-types/commands/GetJourneyCommand.d.ts +4 -0
- package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +9 -0
- package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +7 -0
- package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +6 -0
- package/dist-types/commands/GetPushTemplateCommand.d.ts +4 -0
- package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +4 -0
- package/dist-types/commands/GetSegmentCommand.d.ts +4 -0
- package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +6 -0
- package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +6 -0
- package/dist-types/commands/GetSegmentVersionCommand.d.ts +5 -0
- package/dist-types/commands/GetSegmentVersionsCommand.d.ts +6 -0
- package/dist-types/commands/GetSegmentsCommand.d.ts +5 -0
- package/dist-types/commands/GetSmsChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetSmsTemplateCommand.d.ts +4 -0
- package/dist-types/commands/GetUserEndpointsCommand.d.ts +4 -0
- package/dist-types/commands/GetVoiceChannelCommand.d.ts +3 -0
- package/dist-types/commands/GetVoiceTemplateCommand.d.ts +4 -0
- package/dist-types/commands/ListJourneysCommand.d.ts +5 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +6 -0
- package/dist-types/commands/ListTemplatesCommand.d.ts +6 -0
- package/dist-types/commands/PhoneNumberValidateCommand.d.ts +6 -0
- package/dist-types/commands/PutEventStreamCommand.d.ts +7 -0
- package/dist-types/commands/PutEventsCommand.d.ts +74 -0
- package/dist-types/commands/RemoveAttributesCommand.d.ts +9 -0
- package/dist-types/commands/SendMessagesCommand.d.ts +236 -0
- package/dist-types/commands/SendOTPMessageCommand.d.ts +16 -0
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +220 -0
- package/dist-types/commands/TagResourceCommand.d.ts +8 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateAdmChannelCommand.d.ts +8 -0
- package/dist-types/commands/UpdateApnsChannelCommand.d.ts +13 -0
- package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +13 -0
- package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +13 -0
- package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +13 -0
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +23 -0
- package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +8 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +469 -0
- package/dist-types/commands/UpdateEmailChannelCommand.d.ts +10 -0
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +16 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +46 -0
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +50 -0
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +7 -0
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +75 -0
- package/dist-types/commands/UpdateJourneyCommand.d.ts +458 -0
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +7 -0
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +62 -0
- package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/UpdateSegmentCommand.d.ts +193 -0
- package/dist-types/commands/UpdateSmsChannelCommand.d.ts +8 -0
- package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +14 -0
- package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +7 -0
- package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +6 -0
- package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +15 -0
- package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
- package/package.json +12 -12
|
@@ -26,6 +26,242 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
26
26
|
* import { PinpointClient, SendMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, SendMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* MessageRequest: {
|
|
32
|
+
* Addresses: {
|
|
33
|
+
* "<keys>": {
|
|
34
|
+
* BodyOverride: "STRING_VALUE",
|
|
35
|
+
* ChannelType: "STRING_VALUE",
|
|
36
|
+
* Context: {
|
|
37
|
+
* "<keys>": "STRING_VALUE",
|
|
38
|
+
* },
|
|
39
|
+
* RawContent: "STRING_VALUE",
|
|
40
|
+
* Substitutions: {
|
|
41
|
+
* "<keys>": [
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* },
|
|
45
|
+
* TitleOverride: "STRING_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* Context: {
|
|
49
|
+
* "<keys>": "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* Endpoints: {
|
|
52
|
+
* "<keys>": {
|
|
53
|
+
* BodyOverride: "STRING_VALUE",
|
|
54
|
+
* Context: {
|
|
55
|
+
* "<keys>": "STRING_VALUE",
|
|
56
|
+
* },
|
|
57
|
+
* RawContent: "STRING_VALUE",
|
|
58
|
+
* Substitutions: {
|
|
59
|
+
* "<keys>": [
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* },
|
|
63
|
+
* TitleOverride: "STRING_VALUE",
|
|
64
|
+
* },
|
|
65
|
+
* },
|
|
66
|
+
* MessageConfiguration: {
|
|
67
|
+
* ADMMessage: {
|
|
68
|
+
* Action: "STRING_VALUE",
|
|
69
|
+
* Body: "STRING_VALUE",
|
|
70
|
+
* ConsolidationKey: "STRING_VALUE",
|
|
71
|
+
* Data: {
|
|
72
|
+
* "<keys>": "STRING_VALUE",
|
|
73
|
+
* },
|
|
74
|
+
* ExpiresAfter: "STRING_VALUE",
|
|
75
|
+
* IconReference: "STRING_VALUE",
|
|
76
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
77
|
+
* ImageUrl: "STRING_VALUE",
|
|
78
|
+
* MD5: "STRING_VALUE",
|
|
79
|
+
* RawContent: "STRING_VALUE",
|
|
80
|
+
* SilentPush: true || false,
|
|
81
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
82
|
+
* Sound: "STRING_VALUE",
|
|
83
|
+
* Substitutions: {
|
|
84
|
+
* "<keys>": [
|
|
85
|
+
* "STRING_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* },
|
|
88
|
+
* Title: "STRING_VALUE",
|
|
89
|
+
* Url: "STRING_VALUE",
|
|
90
|
+
* },
|
|
91
|
+
* APNSMessage: {
|
|
92
|
+
* APNSPushType: "STRING_VALUE",
|
|
93
|
+
* Action: "STRING_VALUE",
|
|
94
|
+
* Badge: Number("int"),
|
|
95
|
+
* Body: "STRING_VALUE",
|
|
96
|
+
* Category: "STRING_VALUE",
|
|
97
|
+
* CollapseId: "STRING_VALUE",
|
|
98
|
+
* Data: {
|
|
99
|
+
* "<keys>": "STRING_VALUE",
|
|
100
|
+
* },
|
|
101
|
+
* MediaUrl: "STRING_VALUE",
|
|
102
|
+
* PreferredAuthenticationMethod: "STRING_VALUE",
|
|
103
|
+
* Priority: "STRING_VALUE",
|
|
104
|
+
* RawContent: "STRING_VALUE",
|
|
105
|
+
* SilentPush: true || false,
|
|
106
|
+
* Sound: "STRING_VALUE",
|
|
107
|
+
* Substitutions: {
|
|
108
|
+
* "<keys>": [
|
|
109
|
+
* "STRING_VALUE",
|
|
110
|
+
* ],
|
|
111
|
+
* },
|
|
112
|
+
* ThreadId: "STRING_VALUE",
|
|
113
|
+
* TimeToLive: Number("int"),
|
|
114
|
+
* Title: "STRING_VALUE",
|
|
115
|
+
* Url: "STRING_VALUE",
|
|
116
|
+
* },
|
|
117
|
+
* BaiduMessage: {
|
|
118
|
+
* Action: "STRING_VALUE",
|
|
119
|
+
* Body: "STRING_VALUE",
|
|
120
|
+
* Data: {
|
|
121
|
+
* "<keys>": "STRING_VALUE",
|
|
122
|
+
* },
|
|
123
|
+
* IconReference: "STRING_VALUE",
|
|
124
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
125
|
+
* ImageUrl: "STRING_VALUE",
|
|
126
|
+
* RawContent: "STRING_VALUE",
|
|
127
|
+
* SilentPush: true || false,
|
|
128
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
129
|
+
* Sound: "STRING_VALUE",
|
|
130
|
+
* Substitutions: {
|
|
131
|
+
* "<keys>": [
|
|
132
|
+
* "STRING_VALUE",
|
|
133
|
+
* ],
|
|
134
|
+
* },
|
|
135
|
+
* TimeToLive: Number("int"),
|
|
136
|
+
* Title: "STRING_VALUE",
|
|
137
|
+
* Url: "STRING_VALUE",
|
|
138
|
+
* },
|
|
139
|
+
* DefaultMessage: {
|
|
140
|
+
* Body: "STRING_VALUE",
|
|
141
|
+
* Substitutions: {
|
|
142
|
+
* "<keys>": [
|
|
143
|
+
* "STRING_VALUE",
|
|
144
|
+
* ],
|
|
145
|
+
* },
|
|
146
|
+
* },
|
|
147
|
+
* DefaultPushNotificationMessage: {
|
|
148
|
+
* Action: "STRING_VALUE",
|
|
149
|
+
* Body: "STRING_VALUE",
|
|
150
|
+
* Data: {
|
|
151
|
+
* "<keys>": "STRING_VALUE",
|
|
152
|
+
* },
|
|
153
|
+
* SilentPush: true || false,
|
|
154
|
+
* Substitutions: {
|
|
155
|
+
* "<keys>": [
|
|
156
|
+
* "STRING_VALUE",
|
|
157
|
+
* ],
|
|
158
|
+
* },
|
|
159
|
+
* Title: "STRING_VALUE",
|
|
160
|
+
* Url: "STRING_VALUE",
|
|
161
|
+
* },
|
|
162
|
+
* EmailMessage: {
|
|
163
|
+
* Body: "STRING_VALUE",
|
|
164
|
+
* FeedbackForwardingAddress: "STRING_VALUE",
|
|
165
|
+
* FromAddress: "STRING_VALUE",
|
|
166
|
+
* RawEmail: {
|
|
167
|
+
* Data: "BLOB_VALUE",
|
|
168
|
+
* },
|
|
169
|
+
* ReplyToAddresses: [
|
|
170
|
+
* "STRING_VALUE",
|
|
171
|
+
* ],
|
|
172
|
+
* SimpleEmail: {
|
|
173
|
+
* HtmlPart: {
|
|
174
|
+
* Charset: "STRING_VALUE",
|
|
175
|
+
* Data: "STRING_VALUE",
|
|
176
|
+
* },
|
|
177
|
+
* Subject: {
|
|
178
|
+
* Charset: "STRING_VALUE",
|
|
179
|
+
* Data: "STRING_VALUE",
|
|
180
|
+
* },
|
|
181
|
+
* TextPart: {
|
|
182
|
+
* Charset: "STRING_VALUE",
|
|
183
|
+
* Data: "STRING_VALUE",
|
|
184
|
+
* },
|
|
185
|
+
* },
|
|
186
|
+
* Substitutions: {
|
|
187
|
+
* "<keys>": [
|
|
188
|
+
* "STRING_VALUE",
|
|
189
|
+
* ],
|
|
190
|
+
* },
|
|
191
|
+
* },
|
|
192
|
+
* GCMMessage: {
|
|
193
|
+
* Action: "STRING_VALUE",
|
|
194
|
+
* Body: "STRING_VALUE",
|
|
195
|
+
* CollapseKey: "STRING_VALUE",
|
|
196
|
+
* Data: {
|
|
197
|
+
* "<keys>": "STRING_VALUE",
|
|
198
|
+
* },
|
|
199
|
+
* IconReference: "STRING_VALUE",
|
|
200
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
201
|
+
* ImageUrl: "STRING_VALUE",
|
|
202
|
+
* Priority: "STRING_VALUE",
|
|
203
|
+
* RawContent: "STRING_VALUE",
|
|
204
|
+
* RestrictedPackageName: "STRING_VALUE",
|
|
205
|
+
* SilentPush: true || false,
|
|
206
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
207
|
+
* Sound: "STRING_VALUE",
|
|
208
|
+
* Substitutions: {
|
|
209
|
+
* "<keys>": [
|
|
210
|
+
* "STRING_VALUE",
|
|
211
|
+
* ],
|
|
212
|
+
* },
|
|
213
|
+
* TimeToLive: Number("int"),
|
|
214
|
+
* Title: "STRING_VALUE",
|
|
215
|
+
* Url: "STRING_VALUE",
|
|
216
|
+
* },
|
|
217
|
+
* SMSMessage: {
|
|
218
|
+
* Body: "STRING_VALUE",
|
|
219
|
+
* Keyword: "STRING_VALUE",
|
|
220
|
+
* MediaUrl: "STRING_VALUE",
|
|
221
|
+
* MessageType: "STRING_VALUE",
|
|
222
|
+
* OriginationNumber: "STRING_VALUE",
|
|
223
|
+
* SenderId: "STRING_VALUE",
|
|
224
|
+
* Substitutions: {
|
|
225
|
+
* "<keys>": [
|
|
226
|
+
* "STRING_VALUE",
|
|
227
|
+
* ],
|
|
228
|
+
* },
|
|
229
|
+
* EntityId: "STRING_VALUE",
|
|
230
|
+
* TemplateId: "STRING_VALUE",
|
|
231
|
+
* },
|
|
232
|
+
* VoiceMessage: {
|
|
233
|
+
* Body: "STRING_VALUE",
|
|
234
|
+
* LanguageCode: "STRING_VALUE",
|
|
235
|
+
* OriginationNumber: "STRING_VALUE",
|
|
236
|
+
* Substitutions: {
|
|
237
|
+
* "<keys>": [
|
|
238
|
+
* "STRING_VALUE",
|
|
239
|
+
* ],
|
|
240
|
+
* },
|
|
241
|
+
* VoiceId: "STRING_VALUE",
|
|
242
|
+
* },
|
|
243
|
+
* },
|
|
244
|
+
* TemplateConfiguration: {
|
|
245
|
+
* EmailTemplate: {
|
|
246
|
+
* Name: "STRING_VALUE",
|
|
247
|
+
* Version: "STRING_VALUE",
|
|
248
|
+
* },
|
|
249
|
+
* PushTemplate: {
|
|
250
|
+
* Name: "STRING_VALUE",
|
|
251
|
+
* Version: "STRING_VALUE",
|
|
252
|
+
* },
|
|
253
|
+
* SMSTemplate: {
|
|
254
|
+
* Name: "STRING_VALUE",
|
|
255
|
+
* Version: "STRING_VALUE",
|
|
256
|
+
* },
|
|
257
|
+
* VoiceTemplate: {
|
|
258
|
+
* Name: "STRING_VALUE",
|
|
259
|
+
* Version: "STRING_VALUE",
|
|
260
|
+
* },
|
|
261
|
+
* },
|
|
262
|
+
* TraceId: "STRING_VALUE",
|
|
263
|
+
* },
|
|
264
|
+
* };
|
|
29
265
|
* const command = new SendMessagesCommand(input);
|
|
30
266
|
* const response = await client.send(command);
|
|
31
267
|
* ```
|
|
@@ -26,6 +26,22 @@ export interface SendOTPMessageCommandOutput extends SendOTPMessageResponse, __M
|
|
|
26
26
|
* import { PinpointClient, SendOTPMessageCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, SendOTPMessageCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* SendOTPMessageRequestParameters: {
|
|
32
|
+
* AllowedAttempts: Number("int"),
|
|
33
|
+
* BrandName: "STRING_VALUE", // required
|
|
34
|
+
* Channel: "STRING_VALUE", // required
|
|
35
|
+
* CodeLength: Number("int"),
|
|
36
|
+
* DestinationIdentity: "STRING_VALUE", // required
|
|
37
|
+
* EntityId: "STRING_VALUE",
|
|
38
|
+
* Language: "STRING_VALUE",
|
|
39
|
+
* OriginationIdentity: "STRING_VALUE", // required
|
|
40
|
+
* ReferenceId: "STRING_VALUE", // required
|
|
41
|
+
* TemplateId: "STRING_VALUE",
|
|
42
|
+
* ValidityPeriod: Number("int"),
|
|
43
|
+
* },
|
|
44
|
+
* };
|
|
29
45
|
* const command = new SendOTPMessageCommand(input);
|
|
30
46
|
* const response = await client.send(command);
|
|
31
47
|
* ```
|
|
@@ -26,6 +26,226 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
26
26
|
* import { PinpointClient, SendUsersMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, SendUsersMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* SendUsersMessageRequest: {
|
|
32
|
+
* Context: {
|
|
33
|
+
* "<keys>": "STRING_VALUE",
|
|
34
|
+
* },
|
|
35
|
+
* MessageConfiguration: {
|
|
36
|
+
* ADMMessage: {
|
|
37
|
+
* Action: "STRING_VALUE",
|
|
38
|
+
* Body: "STRING_VALUE",
|
|
39
|
+
* ConsolidationKey: "STRING_VALUE",
|
|
40
|
+
* Data: {
|
|
41
|
+
* "<keys>": "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* ExpiresAfter: "STRING_VALUE",
|
|
44
|
+
* IconReference: "STRING_VALUE",
|
|
45
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
46
|
+
* ImageUrl: "STRING_VALUE",
|
|
47
|
+
* MD5: "STRING_VALUE",
|
|
48
|
+
* RawContent: "STRING_VALUE",
|
|
49
|
+
* SilentPush: true || false,
|
|
50
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
51
|
+
* Sound: "STRING_VALUE",
|
|
52
|
+
* Substitutions: {
|
|
53
|
+
* "<keys>": [
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* },
|
|
57
|
+
* Title: "STRING_VALUE",
|
|
58
|
+
* Url: "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* APNSMessage: {
|
|
61
|
+
* APNSPushType: "STRING_VALUE",
|
|
62
|
+
* Action: "STRING_VALUE",
|
|
63
|
+
* Badge: Number("int"),
|
|
64
|
+
* Body: "STRING_VALUE",
|
|
65
|
+
* Category: "STRING_VALUE",
|
|
66
|
+
* CollapseId: "STRING_VALUE",
|
|
67
|
+
* Data: {
|
|
68
|
+
* "<keys>": "STRING_VALUE",
|
|
69
|
+
* },
|
|
70
|
+
* MediaUrl: "STRING_VALUE",
|
|
71
|
+
* PreferredAuthenticationMethod: "STRING_VALUE",
|
|
72
|
+
* Priority: "STRING_VALUE",
|
|
73
|
+
* RawContent: "STRING_VALUE",
|
|
74
|
+
* SilentPush: true || false,
|
|
75
|
+
* Sound: "STRING_VALUE",
|
|
76
|
+
* Substitutions: {
|
|
77
|
+
* "<keys>": [
|
|
78
|
+
* "STRING_VALUE",
|
|
79
|
+
* ],
|
|
80
|
+
* },
|
|
81
|
+
* ThreadId: "STRING_VALUE",
|
|
82
|
+
* TimeToLive: Number("int"),
|
|
83
|
+
* Title: "STRING_VALUE",
|
|
84
|
+
* Url: "STRING_VALUE",
|
|
85
|
+
* },
|
|
86
|
+
* BaiduMessage: {
|
|
87
|
+
* Action: "STRING_VALUE",
|
|
88
|
+
* Body: "STRING_VALUE",
|
|
89
|
+
* Data: {
|
|
90
|
+
* "<keys>": "STRING_VALUE",
|
|
91
|
+
* },
|
|
92
|
+
* IconReference: "STRING_VALUE",
|
|
93
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
94
|
+
* ImageUrl: "STRING_VALUE",
|
|
95
|
+
* RawContent: "STRING_VALUE",
|
|
96
|
+
* SilentPush: true || false,
|
|
97
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
98
|
+
* Sound: "STRING_VALUE",
|
|
99
|
+
* Substitutions: {
|
|
100
|
+
* "<keys>": [
|
|
101
|
+
* "STRING_VALUE",
|
|
102
|
+
* ],
|
|
103
|
+
* },
|
|
104
|
+
* TimeToLive: Number("int"),
|
|
105
|
+
* Title: "STRING_VALUE",
|
|
106
|
+
* Url: "STRING_VALUE",
|
|
107
|
+
* },
|
|
108
|
+
* DefaultMessage: {
|
|
109
|
+
* Body: "STRING_VALUE",
|
|
110
|
+
* Substitutions: {
|
|
111
|
+
* "<keys>": [
|
|
112
|
+
* "STRING_VALUE",
|
|
113
|
+
* ],
|
|
114
|
+
* },
|
|
115
|
+
* },
|
|
116
|
+
* DefaultPushNotificationMessage: {
|
|
117
|
+
* Action: "STRING_VALUE",
|
|
118
|
+
* Body: "STRING_VALUE",
|
|
119
|
+
* Data: {
|
|
120
|
+
* "<keys>": "STRING_VALUE",
|
|
121
|
+
* },
|
|
122
|
+
* SilentPush: true || false,
|
|
123
|
+
* Substitutions: {
|
|
124
|
+
* "<keys>": [
|
|
125
|
+
* "STRING_VALUE",
|
|
126
|
+
* ],
|
|
127
|
+
* },
|
|
128
|
+
* Title: "STRING_VALUE",
|
|
129
|
+
* Url: "STRING_VALUE",
|
|
130
|
+
* },
|
|
131
|
+
* EmailMessage: {
|
|
132
|
+
* Body: "STRING_VALUE",
|
|
133
|
+
* FeedbackForwardingAddress: "STRING_VALUE",
|
|
134
|
+
* FromAddress: "STRING_VALUE",
|
|
135
|
+
* RawEmail: {
|
|
136
|
+
* Data: "BLOB_VALUE",
|
|
137
|
+
* },
|
|
138
|
+
* ReplyToAddresses: [
|
|
139
|
+
* "STRING_VALUE",
|
|
140
|
+
* ],
|
|
141
|
+
* SimpleEmail: {
|
|
142
|
+
* HtmlPart: {
|
|
143
|
+
* Charset: "STRING_VALUE",
|
|
144
|
+
* Data: "STRING_VALUE",
|
|
145
|
+
* },
|
|
146
|
+
* Subject: {
|
|
147
|
+
* Charset: "STRING_VALUE",
|
|
148
|
+
* Data: "STRING_VALUE",
|
|
149
|
+
* },
|
|
150
|
+
* TextPart: {
|
|
151
|
+
* Charset: "STRING_VALUE",
|
|
152
|
+
* Data: "STRING_VALUE",
|
|
153
|
+
* },
|
|
154
|
+
* },
|
|
155
|
+
* Substitutions: {
|
|
156
|
+
* "<keys>": [
|
|
157
|
+
* "STRING_VALUE",
|
|
158
|
+
* ],
|
|
159
|
+
* },
|
|
160
|
+
* },
|
|
161
|
+
* GCMMessage: {
|
|
162
|
+
* Action: "STRING_VALUE",
|
|
163
|
+
* Body: "STRING_VALUE",
|
|
164
|
+
* CollapseKey: "STRING_VALUE",
|
|
165
|
+
* Data: {
|
|
166
|
+
* "<keys>": "STRING_VALUE",
|
|
167
|
+
* },
|
|
168
|
+
* IconReference: "STRING_VALUE",
|
|
169
|
+
* ImageIconUrl: "STRING_VALUE",
|
|
170
|
+
* ImageUrl: "STRING_VALUE",
|
|
171
|
+
* Priority: "STRING_VALUE",
|
|
172
|
+
* RawContent: "STRING_VALUE",
|
|
173
|
+
* RestrictedPackageName: "STRING_VALUE",
|
|
174
|
+
* SilentPush: true || false,
|
|
175
|
+
* SmallImageIconUrl: "STRING_VALUE",
|
|
176
|
+
* Sound: "STRING_VALUE",
|
|
177
|
+
* Substitutions: {
|
|
178
|
+
* "<keys>": [
|
|
179
|
+
* "STRING_VALUE",
|
|
180
|
+
* ],
|
|
181
|
+
* },
|
|
182
|
+
* TimeToLive: Number("int"),
|
|
183
|
+
* Title: "STRING_VALUE",
|
|
184
|
+
* Url: "STRING_VALUE",
|
|
185
|
+
* },
|
|
186
|
+
* SMSMessage: {
|
|
187
|
+
* Body: "STRING_VALUE",
|
|
188
|
+
* Keyword: "STRING_VALUE",
|
|
189
|
+
* MediaUrl: "STRING_VALUE",
|
|
190
|
+
* MessageType: "STRING_VALUE",
|
|
191
|
+
* OriginationNumber: "STRING_VALUE",
|
|
192
|
+
* SenderId: "STRING_VALUE",
|
|
193
|
+
* Substitutions: {
|
|
194
|
+
* "<keys>": [
|
|
195
|
+
* "STRING_VALUE",
|
|
196
|
+
* ],
|
|
197
|
+
* },
|
|
198
|
+
* EntityId: "STRING_VALUE",
|
|
199
|
+
* TemplateId: "STRING_VALUE",
|
|
200
|
+
* },
|
|
201
|
+
* VoiceMessage: {
|
|
202
|
+
* Body: "STRING_VALUE",
|
|
203
|
+
* LanguageCode: "STRING_VALUE",
|
|
204
|
+
* OriginationNumber: "STRING_VALUE",
|
|
205
|
+
* Substitutions: {
|
|
206
|
+
* "<keys>": [
|
|
207
|
+
* "STRING_VALUE",
|
|
208
|
+
* ],
|
|
209
|
+
* },
|
|
210
|
+
* VoiceId: "STRING_VALUE",
|
|
211
|
+
* },
|
|
212
|
+
* },
|
|
213
|
+
* TemplateConfiguration: {
|
|
214
|
+
* EmailTemplate: {
|
|
215
|
+
* Name: "STRING_VALUE",
|
|
216
|
+
* Version: "STRING_VALUE",
|
|
217
|
+
* },
|
|
218
|
+
* PushTemplate: {
|
|
219
|
+
* Name: "STRING_VALUE",
|
|
220
|
+
* Version: "STRING_VALUE",
|
|
221
|
+
* },
|
|
222
|
+
* SMSTemplate: {
|
|
223
|
+
* Name: "STRING_VALUE",
|
|
224
|
+
* Version: "STRING_VALUE",
|
|
225
|
+
* },
|
|
226
|
+
* VoiceTemplate: {
|
|
227
|
+
* Name: "STRING_VALUE",
|
|
228
|
+
* Version: "STRING_VALUE",
|
|
229
|
+
* },
|
|
230
|
+
* },
|
|
231
|
+
* TraceId: "STRING_VALUE",
|
|
232
|
+
* Users: { // required
|
|
233
|
+
* "<keys>": {
|
|
234
|
+
* BodyOverride: "STRING_VALUE",
|
|
235
|
+
* Context: {
|
|
236
|
+
* "<keys>": "STRING_VALUE",
|
|
237
|
+
* },
|
|
238
|
+
* RawContent: "STRING_VALUE",
|
|
239
|
+
* Substitutions: {
|
|
240
|
+
* "<keys>": [
|
|
241
|
+
* "STRING_VALUE",
|
|
242
|
+
* ],
|
|
243
|
+
* },
|
|
244
|
+
* TitleOverride: "STRING_VALUE",
|
|
245
|
+
* },
|
|
246
|
+
* },
|
|
247
|
+
* },
|
|
248
|
+
* };
|
|
29
249
|
* const command = new SendUsersMessagesCommand(input);
|
|
30
250
|
* const response = await client.send(command);
|
|
31
251
|
* ```
|
|
@@ -26,6 +26,14 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
26
26
|
* import { PinpointClient, TagResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, TagResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
31
|
+
* TagsModel: {
|
|
32
|
+
* tags: { // required
|
|
33
|
+
* "<keys>": "STRING_VALUE",
|
|
34
|
+
* },
|
|
35
|
+
* },
|
|
36
|
+
* };
|
|
29
37
|
* const command = new TagResourceCommand(input);
|
|
30
38
|
* const response = await client.send(command);
|
|
31
39
|
* ```
|
|
@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
26
26
|
* import { PinpointClient, UntagResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UntagResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
31
|
+
* TagKeys: [ // required
|
|
32
|
+
* "STRING_VALUE",
|
|
33
|
+
* ],
|
|
34
|
+
* };
|
|
29
35
|
* const command = new UntagResourceCommand(input);
|
|
30
36
|
* const response = await client.send(command);
|
|
31
37
|
* ```
|
|
@@ -26,6 +26,14 @@ export interface UpdateAdmChannelCommandOutput extends UpdateAdmChannelResponse,
|
|
|
26
26
|
* import { PinpointClient, UpdateAdmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateAdmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ADMChannelRequest: {
|
|
31
|
+
* ClientId: "STRING_VALUE", // required
|
|
32
|
+
* ClientSecret: "STRING_VALUE", // required
|
|
33
|
+
* Enabled: true || false,
|
|
34
|
+
* },
|
|
35
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
29
37
|
* const command = new UpdateAdmChannelCommand(input);
|
|
30
38
|
* const response = await client.send(command);
|
|
31
39
|
* ```
|
|
@@ -26,6 +26,19 @@ export interface UpdateApnsChannelCommandOutput extends UpdateApnsChannelRespons
|
|
|
26
26
|
* import { PinpointClient, UpdateApnsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateApnsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* APNSChannelRequest: {
|
|
31
|
+
* BundleId: "STRING_VALUE",
|
|
32
|
+
* Certificate: "STRING_VALUE",
|
|
33
|
+
* DefaultAuthenticationMethod: "STRING_VALUE",
|
|
34
|
+
* Enabled: true || false,
|
|
35
|
+
* PrivateKey: "STRING_VALUE",
|
|
36
|
+
* TeamId: "STRING_VALUE",
|
|
37
|
+
* TokenKey: "STRING_VALUE",
|
|
38
|
+
* TokenKeyId: "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
29
42
|
* const command = new UpdateApnsChannelCommand(input);
|
|
30
43
|
* const response = await client.send(command);
|
|
31
44
|
* ```
|
|
@@ -26,6 +26,19 @@ export interface UpdateApnsSandboxChannelCommandOutput extends UpdateApnsSandbox
|
|
|
26
26
|
* import { PinpointClient, UpdateApnsSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateApnsSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* APNSSandboxChannelRequest: {
|
|
31
|
+
* BundleId: "STRING_VALUE",
|
|
32
|
+
* Certificate: "STRING_VALUE",
|
|
33
|
+
* DefaultAuthenticationMethod: "STRING_VALUE",
|
|
34
|
+
* Enabled: true || false,
|
|
35
|
+
* PrivateKey: "STRING_VALUE",
|
|
36
|
+
* TeamId: "STRING_VALUE",
|
|
37
|
+
* TokenKey: "STRING_VALUE",
|
|
38
|
+
* TokenKeyId: "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
29
42
|
* const command = new UpdateApnsSandboxChannelCommand(input);
|
|
30
43
|
* const response = await client.send(command);
|
|
31
44
|
* ```
|
|
@@ -26,6 +26,19 @@ export interface UpdateApnsVoipChannelCommandOutput extends UpdateApnsVoipChanne
|
|
|
26
26
|
* import { PinpointClient, UpdateApnsVoipChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateApnsVoipChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* APNSVoipChannelRequest: {
|
|
31
|
+
* BundleId: "STRING_VALUE",
|
|
32
|
+
* Certificate: "STRING_VALUE",
|
|
33
|
+
* DefaultAuthenticationMethod: "STRING_VALUE",
|
|
34
|
+
* Enabled: true || false,
|
|
35
|
+
* PrivateKey: "STRING_VALUE",
|
|
36
|
+
* TeamId: "STRING_VALUE",
|
|
37
|
+
* TokenKey: "STRING_VALUE",
|
|
38
|
+
* TokenKeyId: "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
29
42
|
* const command = new UpdateApnsVoipChannelCommand(input);
|
|
30
43
|
* const response = await client.send(command);
|
|
31
44
|
* ```
|
|
@@ -26,6 +26,19 @@ export interface UpdateApnsVoipSandboxChannelCommandOutput extends UpdateApnsVoi
|
|
|
26
26
|
* import { PinpointClient, UpdateApnsVoipSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateApnsVoipSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* APNSVoipSandboxChannelRequest: {
|
|
31
|
+
* BundleId: "STRING_VALUE",
|
|
32
|
+
* Certificate: "STRING_VALUE",
|
|
33
|
+
* DefaultAuthenticationMethod: "STRING_VALUE",
|
|
34
|
+
* Enabled: true || false,
|
|
35
|
+
* PrivateKey: "STRING_VALUE",
|
|
36
|
+
* TeamId: "STRING_VALUE",
|
|
37
|
+
* TokenKey: "STRING_VALUE",
|
|
38
|
+
* TokenKeyId: "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
29
42
|
* const command = new UpdateApnsVoipSandboxChannelCommand(input);
|
|
30
43
|
* const response = await client.send(command);
|
|
31
44
|
* ```
|
|
@@ -26,6 +26,29 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
|
|
|
26
26
|
* import { PinpointClient, UpdateApplicationSettingsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateApplicationSettingsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* WriteApplicationSettingsRequest: {
|
|
32
|
+
* CampaignHook: {
|
|
33
|
+
* LambdaFunctionName: "STRING_VALUE",
|
|
34
|
+
* Mode: "STRING_VALUE",
|
|
35
|
+
* WebUrl: "STRING_VALUE",
|
|
36
|
+
* },
|
|
37
|
+
* CloudWatchMetricsEnabled: true || false,
|
|
38
|
+
* EventTaggingEnabled: true || false,
|
|
39
|
+
* Limits: {
|
|
40
|
+
* Daily: Number("int"),
|
|
41
|
+
* MaximumDuration: Number("int"),
|
|
42
|
+
* MessagesPerSecond: Number("int"),
|
|
43
|
+
* Total: Number("int"),
|
|
44
|
+
* Session: Number("int"),
|
|
45
|
+
* },
|
|
46
|
+
* QuietTime: {
|
|
47
|
+
* End: "STRING_VALUE",
|
|
48
|
+
* Start: "STRING_VALUE",
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* };
|
|
29
52
|
* const command = new UpdateApplicationSettingsCommand(input);
|
|
30
53
|
* const response = await client.send(command);
|
|
31
54
|
* ```
|
|
@@ -26,6 +26,14 @@ export interface UpdateBaiduChannelCommandOutput extends UpdateBaiduChannelRespo
|
|
|
26
26
|
* import { PinpointClient, UpdateBaiduChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, UpdateBaiduChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = {
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* BaiduChannelRequest: {
|
|
32
|
+
* ApiKey: "STRING_VALUE", // required
|
|
33
|
+
* Enabled: true || false,
|
|
34
|
+
* SecretKey: "STRING_VALUE", // required
|
|
35
|
+
* },
|
|
36
|
+
* };
|
|
29
37
|
* const command = new UpdateBaiduChannelCommand(input);
|
|
30
38
|
* const response = await client.send(command);
|
|
31
39
|
* ```
|