@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,45 +26,45 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
26
26
|
* import { PinpointClient, CreateJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, CreateJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // CreateJourneyRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
-
* WriteJourneyRequest: {
|
|
32
|
-
* Activities: {
|
|
33
|
-
* "<keys>": {
|
|
34
|
-
* CUSTOM: {
|
|
31
|
+
* WriteJourneyRequest: { // WriteJourneyRequest
|
|
32
|
+
* Activities: { // MapOfActivity
|
|
33
|
+
* "<keys>": { // Activity
|
|
34
|
+
* CUSTOM: { // CustomMessageActivity
|
|
35
35
|
* DeliveryUri: "STRING_VALUE",
|
|
36
|
-
* EndpointTypes: [
|
|
36
|
+
* EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
37
37
|
* "STRING_VALUE",
|
|
38
38
|
* ],
|
|
39
|
-
* MessageConfig: {
|
|
39
|
+
* MessageConfig: { // JourneyCustomMessage
|
|
40
40
|
* Data: "STRING_VALUE",
|
|
41
41
|
* },
|
|
42
42
|
* NextActivity: "STRING_VALUE",
|
|
43
43
|
* TemplateName: "STRING_VALUE",
|
|
44
44
|
* TemplateVersion: "STRING_VALUE",
|
|
45
45
|
* },
|
|
46
|
-
* ConditionalSplit: {
|
|
47
|
-
* Condition: {
|
|
48
|
-
* Conditions: [
|
|
49
|
-
* {
|
|
50
|
-
* EventCondition: {
|
|
51
|
-
* Dimensions: {
|
|
52
|
-
* Attributes: {
|
|
53
|
-
* "<keys>": {
|
|
46
|
+
* ConditionalSplit: { // ConditionalSplitActivity
|
|
47
|
+
* Condition: { // Condition
|
|
48
|
+
* Conditions: [ // ListOfSimpleCondition
|
|
49
|
+
* { // SimpleCondition
|
|
50
|
+
* EventCondition: { // EventCondition
|
|
51
|
+
* Dimensions: { // EventDimensions
|
|
52
|
+
* Attributes: { // MapOfAttributeDimension
|
|
53
|
+
* "<keys>": { // AttributeDimension
|
|
54
54
|
* AttributeType: "STRING_VALUE",
|
|
55
|
-
* Values: [ // required
|
|
55
|
+
* Values: [ // ListOf__string // required
|
|
56
56
|
* "STRING_VALUE",
|
|
57
57
|
* ],
|
|
58
58
|
* },
|
|
59
59
|
* },
|
|
60
|
-
* EventType: {
|
|
60
|
+
* EventType: { // SetDimension
|
|
61
61
|
* DimensionType: "STRING_VALUE",
|
|
62
62
|
* Values: [ // required
|
|
63
63
|
* "STRING_VALUE",
|
|
64
64
|
* ],
|
|
65
65
|
* },
|
|
66
|
-
* Metrics: {
|
|
67
|
-
* "<keys>": {
|
|
66
|
+
* Metrics: { // MapOfMetricDimension
|
|
67
|
+
* "<keys>": { // MetricDimension
|
|
68
68
|
* ComparisonOperator: "STRING_VALUE", // required
|
|
69
69
|
* Value: Number("double"), // required
|
|
70
70
|
* },
|
|
@@ -72,10 +72,10 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
72
72
|
* },
|
|
73
73
|
* MessageActivity: "STRING_VALUE",
|
|
74
74
|
* },
|
|
75
|
-
* SegmentCondition: {
|
|
75
|
+
* SegmentCondition: { // SegmentCondition
|
|
76
76
|
* SegmentId: "STRING_VALUE", // required
|
|
77
77
|
* },
|
|
78
|
-
* SegmentDimensions: {
|
|
78
|
+
* SegmentDimensions: { // SegmentDimensions
|
|
79
79
|
* Attributes: {
|
|
80
80
|
* "<keys>": {
|
|
81
81
|
* AttributeType: "STRING_VALUE",
|
|
@@ -84,13 +84,13 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
84
84
|
* ],
|
|
85
85
|
* },
|
|
86
86
|
* },
|
|
87
|
-
* Behavior: {
|
|
88
|
-
* Recency: {
|
|
87
|
+
* Behavior: { // SegmentBehaviors
|
|
88
|
+
* Recency: { // RecencyDimension
|
|
89
89
|
* Duration: "STRING_VALUE", // required
|
|
90
90
|
* RecencyType: "STRING_VALUE", // required
|
|
91
91
|
* },
|
|
92
92
|
* },
|
|
93
|
-
* Demographic: {
|
|
93
|
+
* Demographic: { // SegmentDemographics
|
|
94
94
|
* AppVersion: {
|
|
95
95
|
* DimensionType: "STRING_VALUE",
|
|
96
96
|
* Values: [ // required
|
|
@@ -105,38 +105,19 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
105
105
|
* },
|
|
106
106
|
* DeviceType: {
|
|
107
107
|
* DimensionType: "STRING_VALUE",
|
|
108
|
-
* Values:
|
|
109
|
-
* "STRING_VALUE",
|
|
110
|
-
* ],
|
|
108
|
+
* Values: "<ListOf__string>", // required
|
|
111
109
|
* },
|
|
112
110
|
* Make: {
|
|
113
111
|
* DimensionType: "STRING_VALUE",
|
|
114
|
-
* Values:
|
|
115
|
-
* "STRING_VALUE",
|
|
116
|
-
* ],
|
|
117
|
-
* },
|
|
118
|
-
* Model: {
|
|
119
|
-
* DimensionType: "STRING_VALUE",
|
|
120
|
-
* Values: [ // required
|
|
121
|
-
* "STRING_VALUE",
|
|
122
|
-
* ],
|
|
123
|
-
* },
|
|
124
|
-
* Platform: {
|
|
125
|
-
* DimensionType: "STRING_VALUE",
|
|
126
|
-
* Values: [ // required
|
|
127
|
-
* "STRING_VALUE",
|
|
128
|
-
* ],
|
|
112
|
+
* Values: "<ListOf__string>", // required
|
|
129
113
|
* },
|
|
114
|
+
* Model: "<SetDimension>",
|
|
115
|
+
* Platform: "<SetDimension>",
|
|
130
116
|
* },
|
|
131
|
-
* Location: {
|
|
132
|
-
* Country:
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
* "STRING_VALUE",
|
|
136
|
-
* ],
|
|
137
|
-
* },
|
|
138
|
-
* GPSPoint: {
|
|
139
|
-
* Coordinates: {
|
|
117
|
+
* Location: { // SegmentLocation
|
|
118
|
+
* Country: "<SetDimension>",
|
|
119
|
+
* GPSPoint: { // GPSPointDimension
|
|
120
|
+
* Coordinates: { // GPSCoordinates
|
|
140
121
|
* Latitude: Number("double"), // required
|
|
141
122
|
* Longitude: Number("double"), // required
|
|
142
123
|
* },
|
|
@@ -152,9 +133,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
152
133
|
* UserAttributes: {
|
|
153
134
|
* "<keys>": {
|
|
154
135
|
* AttributeType: "STRING_VALUE",
|
|
155
|
-
* Values:
|
|
156
|
-
* "STRING_VALUE",
|
|
157
|
-
* ],
|
|
136
|
+
* Values: "<ListOf__string>", // required
|
|
158
137
|
* },
|
|
159
138
|
* },
|
|
160
139
|
* },
|
|
@@ -162,7 +141,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
162
141
|
* ],
|
|
163
142
|
* Operator: "STRING_VALUE",
|
|
164
143
|
* },
|
|
165
|
-
* EvaluationWaitTime: {
|
|
144
|
+
* EvaluationWaitTime: { // WaitTime
|
|
166
145
|
* WaitFor: "STRING_VALUE",
|
|
167
146
|
* WaitUntil: "STRING_VALUE",
|
|
168
147
|
* },
|
|
@@ -170,38 +149,31 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
170
149
|
* TrueActivity: "STRING_VALUE",
|
|
171
150
|
* },
|
|
172
151
|
* Description: "STRING_VALUE",
|
|
173
|
-
* EMAIL: {
|
|
174
|
-
* MessageConfig: {
|
|
152
|
+
* EMAIL: { // EmailMessageActivity
|
|
153
|
+
* MessageConfig: { // JourneyEmailMessage
|
|
175
154
|
* FromAddress: "STRING_VALUE",
|
|
176
155
|
* },
|
|
177
156
|
* NextActivity: "STRING_VALUE",
|
|
178
157
|
* TemplateName: "STRING_VALUE",
|
|
179
158
|
* TemplateVersion: "STRING_VALUE",
|
|
180
159
|
* },
|
|
181
|
-
* Holdout: {
|
|
160
|
+
* Holdout: { // HoldoutActivity
|
|
182
161
|
* NextActivity: "STRING_VALUE",
|
|
183
162
|
* Percentage: Number("int"), // required
|
|
184
163
|
* },
|
|
185
|
-
* MultiCondition: {
|
|
186
|
-
* Branches: [
|
|
187
|
-
* {
|
|
164
|
+
* MultiCondition: { // MultiConditionalSplitActivity
|
|
165
|
+
* Branches: [ // ListOfMultiConditionalBranch
|
|
166
|
+
* { // MultiConditionalBranch
|
|
188
167
|
* Condition: {
|
|
189
168
|
* EventCondition: {
|
|
190
169
|
* Dimensions: {
|
|
191
170
|
* Attributes: {
|
|
192
171
|
* "<keys>": {
|
|
193
172
|
* AttributeType: "STRING_VALUE",
|
|
194
|
-
* Values:
|
|
195
|
-
* "STRING_VALUE",
|
|
196
|
-
* ],
|
|
173
|
+
* Values: "<ListOf__string>", // required
|
|
197
174
|
* },
|
|
198
175
|
* },
|
|
199
|
-
* EventType:
|
|
200
|
-
* DimensionType: "STRING_VALUE",
|
|
201
|
-
* Values: [ // required
|
|
202
|
-
* "STRING_VALUE",
|
|
203
|
-
* ],
|
|
204
|
-
* },
|
|
176
|
+
* EventType: "<SetDimension>",
|
|
205
177
|
* Metrics: {
|
|
206
178
|
* "<keys>": {
|
|
207
179
|
* ComparisonOperator: "STRING_VALUE", // required
|
|
@@ -218,9 +190,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
218
190
|
* Attributes: {
|
|
219
191
|
* "<keys>": {
|
|
220
192
|
* AttributeType: "STRING_VALUE",
|
|
221
|
-
* Values:
|
|
222
|
-
* "STRING_VALUE",
|
|
223
|
-
* ],
|
|
193
|
+
* Values: "<ListOf__string>", // required
|
|
224
194
|
* },
|
|
225
195
|
* },
|
|
226
196
|
* Behavior: {
|
|
@@ -230,50 +200,15 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
230
200
|
* },
|
|
231
201
|
* },
|
|
232
202
|
* Demographic: {
|
|
233
|
-
* AppVersion:
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* Channel: {
|
|
240
|
-
* DimensionType: "STRING_VALUE",
|
|
241
|
-
* Values: [ // required
|
|
242
|
-
* "STRING_VALUE",
|
|
243
|
-
* ],
|
|
244
|
-
* },
|
|
245
|
-
* DeviceType: {
|
|
246
|
-
* DimensionType: "STRING_VALUE",
|
|
247
|
-
* Values: [ // required
|
|
248
|
-
* "STRING_VALUE",
|
|
249
|
-
* ],
|
|
250
|
-
* },
|
|
251
|
-
* Make: {
|
|
252
|
-
* DimensionType: "STRING_VALUE",
|
|
253
|
-
* Values: [ // required
|
|
254
|
-
* "STRING_VALUE",
|
|
255
|
-
* ],
|
|
256
|
-
* },
|
|
257
|
-
* Model: {
|
|
258
|
-
* DimensionType: "STRING_VALUE",
|
|
259
|
-
* Values: [ // required
|
|
260
|
-
* "STRING_VALUE",
|
|
261
|
-
* ],
|
|
262
|
-
* },
|
|
263
|
-
* Platform: {
|
|
264
|
-
* DimensionType: "STRING_VALUE",
|
|
265
|
-
* Values: [ // required
|
|
266
|
-
* "STRING_VALUE",
|
|
267
|
-
* ],
|
|
268
|
-
* },
|
|
203
|
+
* AppVersion: "<SetDimension>",
|
|
204
|
+
* Channel: "<SetDimension>",
|
|
205
|
+
* DeviceType: "<SetDimension>",
|
|
206
|
+
* Make: "<SetDimension>",
|
|
207
|
+
* Model: "<SetDimension>",
|
|
208
|
+
* Platform: "<SetDimension>",
|
|
269
209
|
* },
|
|
270
210
|
* Location: {
|
|
271
|
-
* Country:
|
|
272
|
-
* DimensionType: "STRING_VALUE",
|
|
273
|
-
* Values: [ // required
|
|
274
|
-
* "STRING_VALUE",
|
|
275
|
-
* ],
|
|
276
|
-
* },
|
|
211
|
+
* Country: "<SetDimension>",
|
|
277
212
|
* GPSPoint: {
|
|
278
213
|
* Coordinates: {
|
|
279
214
|
* Latitude: Number("double"), // required
|
|
@@ -288,14 +223,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
288
223
|
* Value: Number("double"), // required
|
|
289
224
|
* },
|
|
290
225
|
* },
|
|
291
|
-
* UserAttributes:
|
|
292
|
-
* "<keys>": {
|
|
293
|
-
* AttributeType: "STRING_VALUE",
|
|
294
|
-
* Values: [ // required
|
|
295
|
-
* "STRING_VALUE",
|
|
296
|
-
* ],
|
|
297
|
-
* },
|
|
298
|
-
* },
|
|
226
|
+
* UserAttributes: "<MapOfAttributeDimension>",
|
|
299
227
|
* },
|
|
300
228
|
* },
|
|
301
229
|
* NextActivity: "STRING_VALUE",
|
|
@@ -307,24 +235,24 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
307
235
|
* WaitUntil: "STRING_VALUE",
|
|
308
236
|
* },
|
|
309
237
|
* },
|
|
310
|
-
* PUSH: {
|
|
311
|
-
* MessageConfig: {
|
|
238
|
+
* PUSH: { // PushMessageActivity
|
|
239
|
+
* MessageConfig: { // JourneyPushMessage
|
|
312
240
|
* TimeToLive: "STRING_VALUE",
|
|
313
241
|
* },
|
|
314
242
|
* NextActivity: "STRING_VALUE",
|
|
315
243
|
* TemplateName: "STRING_VALUE",
|
|
316
244
|
* TemplateVersion: "STRING_VALUE",
|
|
317
245
|
* },
|
|
318
|
-
* RandomSplit: {
|
|
319
|
-
* Branches: [
|
|
320
|
-
* {
|
|
246
|
+
* RandomSplit: { // RandomSplitActivity
|
|
247
|
+
* Branches: [ // ListOfRandomSplitEntry
|
|
248
|
+
* { // RandomSplitEntry
|
|
321
249
|
* NextActivity: "STRING_VALUE",
|
|
322
250
|
* Percentage: Number("int"),
|
|
323
251
|
* },
|
|
324
252
|
* ],
|
|
325
253
|
* },
|
|
326
|
-
* SMS: {
|
|
327
|
-
* MessageConfig: {
|
|
254
|
+
* SMS: { // SMSMessageActivity
|
|
255
|
+
* MessageConfig: { // JourneySMSMessage
|
|
328
256
|
* MessageType: "STRING_VALUE",
|
|
329
257
|
* OriginationNumber: "STRING_VALUE",
|
|
330
258
|
* SenderId: "STRING_VALUE",
|
|
@@ -335,21 +263,21 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
335
263
|
* TemplateName: "STRING_VALUE",
|
|
336
264
|
* TemplateVersion: "STRING_VALUE",
|
|
337
265
|
* },
|
|
338
|
-
* Wait: {
|
|
266
|
+
* Wait: { // WaitActivity
|
|
339
267
|
* NextActivity: "STRING_VALUE",
|
|
340
268
|
* WaitTime: {
|
|
341
269
|
* WaitFor: "STRING_VALUE",
|
|
342
270
|
* WaitUntil: "STRING_VALUE",
|
|
343
271
|
* },
|
|
344
272
|
* },
|
|
345
|
-
* ContactCenter: {
|
|
273
|
+
* ContactCenter: { // ContactCenterActivity
|
|
346
274
|
* NextActivity: "STRING_VALUE",
|
|
347
275
|
* },
|
|
348
276
|
* },
|
|
349
277
|
* },
|
|
350
278
|
* CreationDate: "STRING_VALUE",
|
|
351
279
|
* LastModifiedDate: "STRING_VALUE",
|
|
352
|
-
* Limits: {
|
|
280
|
+
* Limits: { // JourneyLimits
|
|
353
281
|
* DailyCap: Number("int"),
|
|
354
282
|
* EndpointReentryCap: Number("int"),
|
|
355
283
|
* MessagesPerSecond: Number("int"),
|
|
@@ -357,34 +285,25 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
357
285
|
* },
|
|
358
286
|
* LocalTime: true || false,
|
|
359
287
|
* Name: "STRING_VALUE", // required
|
|
360
|
-
* QuietTime: {
|
|
288
|
+
* QuietTime: { // QuietTime
|
|
361
289
|
* End: "STRING_VALUE",
|
|
362
290
|
* Start: "STRING_VALUE",
|
|
363
291
|
* },
|
|
364
292
|
* RefreshFrequency: "STRING_VALUE",
|
|
365
|
-
* Schedule: {
|
|
293
|
+
* Schedule: { // JourneySchedule
|
|
366
294
|
* EndTime: new Date("TIMESTAMP"),
|
|
367
295
|
* StartTime: new Date("TIMESTAMP"),
|
|
368
296
|
* Timezone: "STRING_VALUE",
|
|
369
297
|
* },
|
|
370
298
|
* StartActivity: "STRING_VALUE",
|
|
371
|
-
* StartCondition: {
|
|
299
|
+
* StartCondition: { // StartCondition
|
|
372
300
|
* Description: "STRING_VALUE",
|
|
373
|
-
* EventStartCondition: {
|
|
374
|
-
* EventFilter: {
|
|
301
|
+
* EventStartCondition: { // EventStartCondition
|
|
302
|
+
* EventFilter: { // EventFilter
|
|
375
303
|
* Dimensions: {
|
|
376
|
-
* Attributes:
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
* EventType: {
|
|
380
|
-
* DimensionType: "STRING_VALUE",
|
|
381
|
-
* Values: [ // required
|
|
382
|
-
* "<ListOf__string>",
|
|
383
|
-
* ],
|
|
384
|
-
* },
|
|
385
|
-
* Metrics: {
|
|
386
|
-
* "<keys>": "<MetricDimension>",
|
|
387
|
-
* },
|
|
304
|
+
* Attributes: "<MapOfAttributeDimension>",
|
|
305
|
+
* EventType: "<SetDimension>",
|
|
306
|
+
* Metrics: "<MapOfMetricDimension>",
|
|
388
307
|
* },
|
|
389
308
|
* FilterType: "STRING_VALUE", // required
|
|
390
309
|
* },
|
|
@@ -397,15 +316,15 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
397
316
|
* State: "STRING_VALUE",
|
|
398
317
|
* WaitForQuietTime: true || false,
|
|
399
318
|
* RefreshOnSegmentUpdate: true || false,
|
|
400
|
-
* JourneyChannelSettings: {
|
|
319
|
+
* JourneyChannelSettings: { // JourneyChannelSettings
|
|
401
320
|
* ConnectCampaignArn: "STRING_VALUE",
|
|
402
321
|
* ConnectCampaignExecutionRoleArn: "STRING_VALUE",
|
|
403
322
|
* },
|
|
404
323
|
* SendingSchedule: true || false,
|
|
405
|
-
* OpenHours: {
|
|
406
|
-
* EMAIL: {
|
|
407
|
-
* "<keys>": [
|
|
408
|
-
* {
|
|
324
|
+
* OpenHours: { // OpenHours
|
|
325
|
+
* EMAIL: { // MapOfListOfOpenHoursRules
|
|
326
|
+
* "<keys>": [ // ListOfOpenHoursRules
|
|
327
|
+
* { // OpenHoursRule
|
|
409
328
|
* StartTime: "STRING_VALUE",
|
|
410
329
|
* EndTime: "STRING_VALUE",
|
|
411
330
|
* },
|
|
@@ -444,9 +363,9 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
444
363
|
* ],
|
|
445
364
|
* },
|
|
446
365
|
* },
|
|
447
|
-
* ClosedDays: {
|
|
448
|
-
* EMAIL: [
|
|
449
|
-
* {
|
|
366
|
+
* ClosedDays: { // ClosedDays
|
|
367
|
+
* EMAIL: [ // ListOfClosedDaysRules
|
|
368
|
+
* { // ClosedDaysRule
|
|
450
369
|
* Name: "STRING_VALUE",
|
|
451
370
|
* StartDateTime: "STRING_VALUE",
|
|
452
371
|
* EndDateTime: "STRING_VALUE",
|
|
@@ -26,9 +26,9 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
26
26
|
* import { PinpointClient, CreatePushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, CreatePushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
30
|
-
* PushNotificationTemplateRequest: {
|
|
31
|
-
* ADM: {
|
|
29
|
+
* const input = { // CreatePushTemplateRequest
|
|
30
|
+
* PushNotificationTemplateRequest: { // PushNotificationTemplateRequest
|
|
31
|
+
* ADM: { // AndroidPushNotificationTemplate
|
|
32
32
|
* Action: "STRING_VALUE",
|
|
33
33
|
* Body: "STRING_VALUE",
|
|
34
34
|
* ImageIconUrl: "STRING_VALUE",
|
|
@@ -39,7 +39,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
39
39
|
* Title: "STRING_VALUE",
|
|
40
40
|
* Url: "STRING_VALUE",
|
|
41
41
|
* },
|
|
42
|
-
* APNS: {
|
|
42
|
+
* APNS: { // APNSPushNotificationTemplate
|
|
43
43
|
* Action: "STRING_VALUE",
|
|
44
44
|
* Body: "STRING_VALUE",
|
|
45
45
|
* MediaUrl: "STRING_VALUE",
|
|
@@ -59,7 +59,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
59
59
|
* Title: "STRING_VALUE",
|
|
60
60
|
* Url: "STRING_VALUE",
|
|
61
61
|
* },
|
|
62
|
-
* Default: {
|
|
62
|
+
* Default: { // DefaultPushNotificationTemplate
|
|
63
63
|
* Action: "STRING_VALUE",
|
|
64
64
|
* Body: "STRING_VALUE",
|
|
65
65
|
* Sound: "STRING_VALUE",
|
|
@@ -79,7 +79,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
79
79
|
* Url: "STRING_VALUE",
|
|
80
80
|
* },
|
|
81
81
|
* RecommenderId: "STRING_VALUE",
|
|
82
|
-
* tags: {
|
|
82
|
+
* tags: { // MapOf__string
|
|
83
83
|
* "<keys>": "STRING_VALUE",
|
|
84
84
|
* },
|
|
85
85
|
* TemplateDescription: "STRING_VALUE",
|
|
@@ -26,9 +26,9 @@ export interface CreateRecommenderConfigurationCommandOutput extends CreateRecom
|
|
|
26
26
|
* import { PinpointClient, CreateRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, CreateRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
30
|
-
* CreateRecommenderConfiguration: {
|
|
31
|
-
* Attributes: {
|
|
29
|
+
* const input = { // CreateRecommenderConfigurationRequest
|
|
30
|
+
* CreateRecommenderConfiguration: { // CreateRecommenderConfigurationShape
|
|
31
|
+
* Attributes: { // MapOf__string
|
|
32
32
|
* "<keys>": "STRING_VALUE",
|
|
33
33
|
* },
|
|
34
34
|
* Description: "STRING_VALUE",
|
|
@@ -26,26 +26,26 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
26
26
|
* import { PinpointClient, CreateSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
27
|
* // const { PinpointClient, CreateSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
28
|
* const client = new PinpointClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // CreateSegmentRequest
|
|
30
30
|
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
-
* WriteSegmentRequest: {
|
|
32
|
-
* Dimensions: {
|
|
33
|
-
* Attributes: {
|
|
34
|
-
* "<keys>": {
|
|
31
|
+
* WriteSegmentRequest: { // WriteSegmentRequest
|
|
32
|
+
* Dimensions: { // SegmentDimensions
|
|
33
|
+
* Attributes: { // MapOfAttributeDimension
|
|
34
|
+
* "<keys>": { // AttributeDimension
|
|
35
35
|
* AttributeType: "STRING_VALUE",
|
|
36
|
-
* Values: [ // required
|
|
36
|
+
* Values: [ // ListOf__string // required
|
|
37
37
|
* "STRING_VALUE",
|
|
38
38
|
* ],
|
|
39
39
|
* },
|
|
40
40
|
* },
|
|
41
|
-
* Behavior: {
|
|
42
|
-
* Recency: {
|
|
41
|
+
* Behavior: { // SegmentBehaviors
|
|
42
|
+
* Recency: { // RecencyDimension
|
|
43
43
|
* Duration: "STRING_VALUE", // required
|
|
44
44
|
* RecencyType: "STRING_VALUE", // required
|
|
45
45
|
* },
|
|
46
46
|
* },
|
|
47
|
-
* Demographic: {
|
|
48
|
-
* AppVersion: {
|
|
47
|
+
* Demographic: { // SegmentDemographics
|
|
48
|
+
* AppVersion: { // SetDimension
|
|
49
49
|
* DimensionType: "STRING_VALUE",
|
|
50
50
|
* Values: [ // required
|
|
51
51
|
* "STRING_VALUE",
|
|
@@ -71,34 +71,22 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
71
71
|
* },
|
|
72
72
|
* Model: {
|
|
73
73
|
* DimensionType: "STRING_VALUE",
|
|
74
|
-
* Values:
|
|
75
|
-
* "STRING_VALUE",
|
|
76
|
-
* ],
|
|
77
|
-
* },
|
|
78
|
-
* Platform: {
|
|
79
|
-
* DimensionType: "STRING_VALUE",
|
|
80
|
-
* Values: [ // required
|
|
81
|
-
* "STRING_VALUE",
|
|
82
|
-
* ],
|
|
74
|
+
* Values: "<ListOf__string>", // required
|
|
83
75
|
* },
|
|
76
|
+
* Platform: "<SetDimension>",
|
|
84
77
|
* },
|
|
85
|
-
* Location: {
|
|
86
|
-
* Country:
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* "STRING_VALUE",
|
|
90
|
-
* ],
|
|
91
|
-
* },
|
|
92
|
-
* GPSPoint: {
|
|
93
|
-
* Coordinates: {
|
|
78
|
+
* Location: { // SegmentLocation
|
|
79
|
+
* Country: "<SetDimension>",
|
|
80
|
+
* GPSPoint: { // GPSPointDimension
|
|
81
|
+
* Coordinates: { // GPSCoordinates
|
|
94
82
|
* Latitude: Number("double"), // required
|
|
95
83
|
* Longitude: Number("double"), // required
|
|
96
84
|
* },
|
|
97
85
|
* RangeInKilometers: Number("double"),
|
|
98
86
|
* },
|
|
99
87
|
* },
|
|
100
|
-
* Metrics: {
|
|
101
|
-
* "<keys>": {
|
|
88
|
+
* Metrics: { // MapOfMetricDimension
|
|
89
|
+
* "<keys>": { // MetricDimension
|
|
102
90
|
* ComparisonOperator: "STRING_VALUE", // required
|
|
103
91
|
* Value: Number("double"), // required
|
|
104
92
|
* },
|
|
@@ -106,24 +94,20 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
106
94
|
* UserAttributes: {
|
|
107
95
|
* "<keys>": {
|
|
108
96
|
* AttributeType: "STRING_VALUE",
|
|
109
|
-
* Values:
|
|
110
|
-
* "STRING_VALUE",
|
|
111
|
-
* ],
|
|
97
|
+
* Values: "<ListOf__string>", // required
|
|
112
98
|
* },
|
|
113
99
|
* },
|
|
114
100
|
* },
|
|
115
101
|
* Name: "STRING_VALUE",
|
|
116
|
-
* SegmentGroups: {
|
|
117
|
-
* Groups: [
|
|
118
|
-
* {
|
|
119
|
-
* Dimensions: [
|
|
102
|
+
* SegmentGroups: { // SegmentGroupList
|
|
103
|
+
* Groups: [ // ListOfSegmentGroup
|
|
104
|
+
* { // SegmentGroup
|
|
105
|
+
* Dimensions: [ // ListOfSegmentDimensions
|
|
120
106
|
* {
|
|
121
107
|
* Attributes: {
|
|
122
108
|
* "<keys>": {
|
|
123
109
|
* AttributeType: "STRING_VALUE",
|
|
124
|
-
* Values:
|
|
125
|
-
* "STRING_VALUE",
|
|
126
|
-
* ],
|
|
110
|
+
* Values: "<ListOf__string>", // required
|
|
127
111
|
* },
|
|
128
112
|
* },
|
|
129
113
|
* Behavior: {
|
|
@@ -133,50 +117,15 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
133
117
|
* },
|
|
134
118
|
* },
|
|
135
119
|
* Demographic: {
|
|
136
|
-
* AppVersion:
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
* Channel: {
|
|
143
|
-
* DimensionType: "STRING_VALUE",
|
|
144
|
-
* Values: [ // required
|
|
145
|
-
* "STRING_VALUE",
|
|
146
|
-
* ],
|
|
147
|
-
* },
|
|
148
|
-
* DeviceType: {
|
|
149
|
-
* DimensionType: "STRING_VALUE",
|
|
150
|
-
* Values: [ // required
|
|
151
|
-
* "STRING_VALUE",
|
|
152
|
-
* ],
|
|
153
|
-
* },
|
|
154
|
-
* Make: {
|
|
155
|
-
* DimensionType: "STRING_VALUE",
|
|
156
|
-
* Values: [ // required
|
|
157
|
-
* "STRING_VALUE",
|
|
158
|
-
* ],
|
|
159
|
-
* },
|
|
160
|
-
* Model: {
|
|
161
|
-
* DimensionType: "STRING_VALUE",
|
|
162
|
-
* Values: [ // required
|
|
163
|
-
* "STRING_VALUE",
|
|
164
|
-
* ],
|
|
165
|
-
* },
|
|
166
|
-
* Platform: {
|
|
167
|
-
* DimensionType: "STRING_VALUE",
|
|
168
|
-
* Values: [ // required
|
|
169
|
-
* "STRING_VALUE",
|
|
170
|
-
* ],
|
|
171
|
-
* },
|
|
120
|
+
* AppVersion: "<SetDimension>",
|
|
121
|
+
* Channel: "<SetDimension>",
|
|
122
|
+
* DeviceType: "<SetDimension>",
|
|
123
|
+
* Make: "<SetDimension>",
|
|
124
|
+
* Model: "<SetDimension>",
|
|
125
|
+
* Platform: "<SetDimension>",
|
|
172
126
|
* },
|
|
173
127
|
* Location: {
|
|
174
|
-
* Country:
|
|
175
|
-
* DimensionType: "STRING_VALUE",
|
|
176
|
-
* Values: [ // required
|
|
177
|
-
* "STRING_VALUE",
|
|
178
|
-
* ],
|
|
179
|
-
* },
|
|
128
|
+
* Country: "<SetDimension>",
|
|
180
129
|
* GPSPoint: {
|
|
181
130
|
* Coordinates: {
|
|
182
131
|
* Latitude: Number("double"), // required
|
|
@@ -194,15 +143,13 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
194
143
|
* UserAttributes: {
|
|
195
144
|
* "<keys>": {
|
|
196
145
|
* AttributeType: "STRING_VALUE",
|
|
197
|
-
* Values:
|
|
198
|
-
* "STRING_VALUE",
|
|
199
|
-
* ],
|
|
146
|
+
* Values: "<ListOf__string>", // required
|
|
200
147
|
* },
|
|
201
148
|
* },
|
|
202
149
|
* },
|
|
203
150
|
* ],
|
|
204
|
-
* SourceSegments: [
|
|
205
|
-
* {
|
|
151
|
+
* SourceSegments: [ // ListOfSegmentReference
|
|
152
|
+
* { // SegmentReference
|
|
206
153
|
* Id: "STRING_VALUE", // required
|
|
207
154
|
* Version: Number("int"),
|
|
208
155
|
* },
|
|
@@ -213,7 +160,7 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
213
160
|
* ],
|
|
214
161
|
* Include: "STRING_VALUE",
|
|
215
162
|
* },
|
|
216
|
-
* tags: {
|
|
163
|
+
* tags: { // MapOf__string
|
|
217
164
|
* "<keys>": "STRING_VALUE",
|
|
218
165
|
* },
|
|
219
166
|
* },
|