@aws-sdk/client-pinpoint 3.321.1 → 3.326.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 +14 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateExportJobCommand.d.ts +27 -0
- package/dist-types/commands/CreateImportJobCommand.d.ts +31 -0
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/CreateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/CreateSmsTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteAppCommand.d.ts +14 -0
- package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +385 -0
- package/dist-types/commands/DeleteEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteEndpointCommand.d.ts +51 -0
- package/dist-types/commands/DeleteEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteJourneyCommand.d.ts +383 -0
- package/dist-types/commands/DeletePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSegmentCommand.d.ts +158 -0
- package/dist-types/commands/DeleteSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/GetAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetAppCommand.d.ts +14 -0
- package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +32 -0
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/GetAppsCommand.d.ts +19 -0
- package/dist-types/commands/GetBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +28 -0
- package/dist-types/commands/GetCampaignCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +390 -0
- package/dist-types/commands/GetCampaignsCommand.d.ts +390 -0
- package/dist-types/commands/GetChannelsCommand.d.ts +20 -0
- package/dist-types/commands/GetEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +22 -0
- package/dist-types/commands/GetEndpointCommand.d.ts +51 -0
- package/dist-types/commands/GetEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/GetExportJobCommand.d.ts +27 -0
- package/dist-types/commands/GetExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +31 -0
- package/dist-types/commands/GetImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +112 -0
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +78 -0
- package/dist-types/commands/GetJourneyCommand.d.ts +383 -0
- package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +15 -0
- package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +13 -0
- package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +16 -0
- package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +14 -0
- package/dist-types/commands/GetJourneyRunsCommand.d.ts +16 -0
- package/dist-types/commands/GetPushTemplateCommand.d.ts +68 -0
- package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +26 -0
- package/dist-types/commands/GetSegmentCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetSegmentVersionCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentVersionsCommand.d.ts +163 -0
- package/dist-types/commands/GetSegmentsCommand.d.ts +163 -0
- package/dist-types/commands/GetSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/GetSmsTemplateCommand.d.ts +20 -0
- package/dist-types/commands/GetUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/GetVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetVoiceTemplateCommand.d.ts +21 -0
- package/dist-types/commands/ListJourneysCommand.d.ts +388 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -0
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +21 -0
- package/dist-types/commands/ListTemplatesCommand.d.ts +23 -0
- package/dist-types/commands/PhoneNumberValidateCommand.d.ts +21 -0
- package/dist-types/commands/PutEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/PutEventsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveAttributesCommand.d.ts +12 -0
- package/dist-types/commands/SendMessagesCommand.d.ts +28 -0
- package/dist-types/commands/SendOTPMessageCommand.d.ts +28 -0
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +21 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/UpdateEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +9 -0
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +383 -0
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/UpdateSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +9 -0
- package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
- package/package.json +16 -16
|
@@ -32,6 +32,387 @@ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataB
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetJourneyCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetJourneyResponse
|
|
36
|
+
* // JourneyResponse: { // JourneyResponse
|
|
37
|
+
* // Activities: { // MapOfActivity
|
|
38
|
+
* // "<keys>": { // Activity
|
|
39
|
+
* // CUSTOM: { // CustomMessageActivity
|
|
40
|
+
* // DeliveryUri: "STRING_VALUE",
|
|
41
|
+
* // EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
42
|
+
* // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
43
|
+
* // ],
|
|
44
|
+
* // MessageConfig: { // JourneyCustomMessage
|
|
45
|
+
* // Data: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // NextActivity: "STRING_VALUE",
|
|
48
|
+
* // TemplateName: "STRING_VALUE",
|
|
49
|
+
* // TemplateVersion: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ConditionalSplit: { // ConditionalSplitActivity
|
|
52
|
+
* // Condition: { // Condition
|
|
53
|
+
* // Conditions: [ // ListOfSimpleCondition
|
|
54
|
+
* // { // SimpleCondition
|
|
55
|
+
* // EventCondition: { // EventCondition
|
|
56
|
+
* // Dimensions: { // EventDimensions
|
|
57
|
+
* // Attributes: { // MapOfAttributeDimension
|
|
58
|
+
* // "<keys>": { // AttributeDimension
|
|
59
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
60
|
+
* // Values: [ // ListOf__string // required
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // EventType: { // SetDimension
|
|
66
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
67
|
+
* // Values: [ // required
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // Metrics: { // MapOfMetricDimension
|
|
72
|
+
* // "<keys>": { // MetricDimension
|
|
73
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
74
|
+
* // Value: Number("double"), // required
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // MessageActivity: "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // SegmentCondition: { // SegmentCondition
|
|
81
|
+
* // SegmentId: "STRING_VALUE", // required
|
|
82
|
+
* // },
|
|
83
|
+
* // SegmentDimensions: { // SegmentDimensions
|
|
84
|
+
* // Attributes: {
|
|
85
|
+
* // "<keys>": {
|
|
86
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
87
|
+
* // Values: [ // required
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // },
|
|
91
|
+
* // },
|
|
92
|
+
* // Behavior: { // SegmentBehaviors
|
|
93
|
+
* // Recency: { // RecencyDimension
|
|
94
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
95
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
96
|
+
* // },
|
|
97
|
+
* // },
|
|
98
|
+
* // Demographic: { // SegmentDemographics
|
|
99
|
+
* // AppVersion: {
|
|
100
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
101
|
+
* // Values: [ // required
|
|
102
|
+
* // "STRING_VALUE",
|
|
103
|
+
* // ],
|
|
104
|
+
* // },
|
|
105
|
+
* // Channel: {
|
|
106
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
107
|
+
* // Values: [ // required
|
|
108
|
+
* // "STRING_VALUE",
|
|
109
|
+
* // ],
|
|
110
|
+
* // },
|
|
111
|
+
* // DeviceType: {
|
|
112
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
113
|
+
* // Values: "<ListOf__string>", // required
|
|
114
|
+
* // },
|
|
115
|
+
* // Make: {
|
|
116
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
117
|
+
* // Values: "<ListOf__string>", // required
|
|
118
|
+
* // },
|
|
119
|
+
* // Model: "<SetDimension>",
|
|
120
|
+
* // Platform: "<SetDimension>",
|
|
121
|
+
* // },
|
|
122
|
+
* // Location: { // SegmentLocation
|
|
123
|
+
* // Country: "<SetDimension>",
|
|
124
|
+
* // GPSPoint: { // GPSPointDimension
|
|
125
|
+
* // Coordinates: { // GPSCoordinates
|
|
126
|
+
* // Latitude: Number("double"), // required
|
|
127
|
+
* // Longitude: Number("double"), // required
|
|
128
|
+
* // },
|
|
129
|
+
* // RangeInKilometers: Number("double"),
|
|
130
|
+
* // },
|
|
131
|
+
* // },
|
|
132
|
+
* // Metrics: {
|
|
133
|
+
* // "<keys>": {
|
|
134
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
135
|
+
* // Value: Number("double"), // required
|
|
136
|
+
* // },
|
|
137
|
+
* // },
|
|
138
|
+
* // UserAttributes: {
|
|
139
|
+
* // "<keys>": {
|
|
140
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
141
|
+
* // Values: "<ListOf__string>", // required
|
|
142
|
+
* // },
|
|
143
|
+
* // },
|
|
144
|
+
* // },
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // Operator: "ALL" || "ANY",
|
|
148
|
+
* // },
|
|
149
|
+
* // EvaluationWaitTime: { // WaitTime
|
|
150
|
+
* // WaitFor: "STRING_VALUE",
|
|
151
|
+
* // WaitUntil: "STRING_VALUE",
|
|
152
|
+
* // },
|
|
153
|
+
* // FalseActivity: "STRING_VALUE",
|
|
154
|
+
* // TrueActivity: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // Description: "STRING_VALUE",
|
|
157
|
+
* // EMAIL: { // EmailMessageActivity
|
|
158
|
+
* // MessageConfig: { // JourneyEmailMessage
|
|
159
|
+
* // FromAddress: "STRING_VALUE",
|
|
160
|
+
* // },
|
|
161
|
+
* // NextActivity: "STRING_VALUE",
|
|
162
|
+
* // TemplateName: "STRING_VALUE",
|
|
163
|
+
* // TemplateVersion: "STRING_VALUE",
|
|
164
|
+
* // },
|
|
165
|
+
* // Holdout: { // HoldoutActivity
|
|
166
|
+
* // NextActivity: "STRING_VALUE",
|
|
167
|
+
* // Percentage: Number("int"), // required
|
|
168
|
+
* // },
|
|
169
|
+
* // MultiCondition: { // MultiConditionalSplitActivity
|
|
170
|
+
* // Branches: [ // ListOfMultiConditionalBranch
|
|
171
|
+
* // { // MultiConditionalBranch
|
|
172
|
+
* // Condition: {
|
|
173
|
+
* // EventCondition: {
|
|
174
|
+
* // Dimensions: {
|
|
175
|
+
* // Attributes: {
|
|
176
|
+
* // "<keys>": {
|
|
177
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
178
|
+
* // Values: "<ListOf__string>", // required
|
|
179
|
+
* // },
|
|
180
|
+
* // },
|
|
181
|
+
* // EventType: "<SetDimension>",
|
|
182
|
+
* // Metrics: {
|
|
183
|
+
* // "<keys>": {
|
|
184
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
185
|
+
* // Value: Number("double"), // required
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // },
|
|
189
|
+
* // MessageActivity: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // SegmentCondition: {
|
|
192
|
+
* // SegmentId: "STRING_VALUE", // required
|
|
193
|
+
* // },
|
|
194
|
+
* // SegmentDimensions: {
|
|
195
|
+
* // Attributes: {
|
|
196
|
+
* // "<keys>": {
|
|
197
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
198
|
+
* // Values: "<ListOf__string>", // required
|
|
199
|
+
* // },
|
|
200
|
+
* // },
|
|
201
|
+
* // Behavior: {
|
|
202
|
+
* // Recency: {
|
|
203
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
204
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
205
|
+
* // },
|
|
206
|
+
* // },
|
|
207
|
+
* // Demographic: {
|
|
208
|
+
* // AppVersion: "<SetDimension>",
|
|
209
|
+
* // Channel: "<SetDimension>",
|
|
210
|
+
* // DeviceType: "<SetDimension>",
|
|
211
|
+
* // Make: "<SetDimension>",
|
|
212
|
+
* // Model: "<SetDimension>",
|
|
213
|
+
* // Platform: "<SetDimension>",
|
|
214
|
+
* // },
|
|
215
|
+
* // Location: {
|
|
216
|
+
* // Country: "<SetDimension>",
|
|
217
|
+
* // GPSPoint: {
|
|
218
|
+
* // Coordinates: {
|
|
219
|
+
* // Latitude: Number("double"), // required
|
|
220
|
+
* // Longitude: Number("double"), // required
|
|
221
|
+
* // },
|
|
222
|
+
* // RangeInKilometers: Number("double"),
|
|
223
|
+
* // },
|
|
224
|
+
* // },
|
|
225
|
+
* // Metrics: {
|
|
226
|
+
* // "<keys>": {
|
|
227
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
228
|
+
* // Value: Number("double"), // required
|
|
229
|
+
* // },
|
|
230
|
+
* // },
|
|
231
|
+
* // UserAttributes: "<MapOfAttributeDimension>",
|
|
232
|
+
* // },
|
|
233
|
+
* // },
|
|
234
|
+
* // NextActivity: "STRING_VALUE",
|
|
235
|
+
* // },
|
|
236
|
+
* // ],
|
|
237
|
+
* // DefaultActivity: "STRING_VALUE",
|
|
238
|
+
* // EvaluationWaitTime: {
|
|
239
|
+
* // WaitFor: "STRING_VALUE",
|
|
240
|
+
* // WaitUntil: "STRING_VALUE",
|
|
241
|
+
* // },
|
|
242
|
+
* // },
|
|
243
|
+
* // PUSH: { // PushMessageActivity
|
|
244
|
+
* // MessageConfig: { // JourneyPushMessage
|
|
245
|
+
* // TimeToLive: "STRING_VALUE",
|
|
246
|
+
* // },
|
|
247
|
+
* // NextActivity: "STRING_VALUE",
|
|
248
|
+
* // TemplateName: "STRING_VALUE",
|
|
249
|
+
* // TemplateVersion: "STRING_VALUE",
|
|
250
|
+
* // },
|
|
251
|
+
* // RandomSplit: { // RandomSplitActivity
|
|
252
|
+
* // Branches: [ // ListOfRandomSplitEntry
|
|
253
|
+
* // { // RandomSplitEntry
|
|
254
|
+
* // NextActivity: "STRING_VALUE",
|
|
255
|
+
* // Percentage: Number("int"),
|
|
256
|
+
* // },
|
|
257
|
+
* // ],
|
|
258
|
+
* // },
|
|
259
|
+
* // SMS: { // SMSMessageActivity
|
|
260
|
+
* // MessageConfig: { // JourneySMSMessage
|
|
261
|
+
* // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
262
|
+
* // OriginationNumber: "STRING_VALUE",
|
|
263
|
+
* // SenderId: "STRING_VALUE",
|
|
264
|
+
* // EntityId: "STRING_VALUE",
|
|
265
|
+
* // TemplateId: "STRING_VALUE",
|
|
266
|
+
* // },
|
|
267
|
+
* // NextActivity: "STRING_VALUE",
|
|
268
|
+
* // TemplateName: "STRING_VALUE",
|
|
269
|
+
* // TemplateVersion: "STRING_VALUE",
|
|
270
|
+
* // },
|
|
271
|
+
* // Wait: { // WaitActivity
|
|
272
|
+
* // NextActivity: "STRING_VALUE",
|
|
273
|
+
* // WaitTime: {
|
|
274
|
+
* // WaitFor: "STRING_VALUE",
|
|
275
|
+
* // WaitUntil: "STRING_VALUE",
|
|
276
|
+
* // },
|
|
277
|
+
* // },
|
|
278
|
+
* // ContactCenter: { // ContactCenterActivity
|
|
279
|
+
* // NextActivity: "STRING_VALUE",
|
|
280
|
+
* // },
|
|
281
|
+
* // },
|
|
282
|
+
* // },
|
|
283
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
284
|
+
* // CreationDate: "STRING_VALUE",
|
|
285
|
+
* // Id: "STRING_VALUE", // required
|
|
286
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
287
|
+
* // Limits: { // JourneyLimits
|
|
288
|
+
* // DailyCap: Number("int"),
|
|
289
|
+
* // EndpointReentryCap: Number("int"),
|
|
290
|
+
* // MessagesPerSecond: Number("int"),
|
|
291
|
+
* // EndpointReentryInterval: "STRING_VALUE",
|
|
292
|
+
* // },
|
|
293
|
+
* // LocalTime: true || false,
|
|
294
|
+
* // Name: "STRING_VALUE", // required
|
|
295
|
+
* // QuietTime: { // QuietTime
|
|
296
|
+
* // End: "STRING_VALUE",
|
|
297
|
+
* // Start: "STRING_VALUE",
|
|
298
|
+
* // },
|
|
299
|
+
* // RefreshFrequency: "STRING_VALUE",
|
|
300
|
+
* // Schedule: { // JourneySchedule
|
|
301
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
302
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
303
|
+
* // Timezone: "STRING_VALUE",
|
|
304
|
+
* // },
|
|
305
|
+
* // StartActivity: "STRING_VALUE",
|
|
306
|
+
* // StartCondition: { // StartCondition
|
|
307
|
+
* // Description: "STRING_VALUE",
|
|
308
|
+
* // EventStartCondition: { // EventStartCondition
|
|
309
|
+
* // EventFilter: { // EventFilter
|
|
310
|
+
* // Dimensions: {
|
|
311
|
+
* // Attributes: "<MapOfAttributeDimension>",
|
|
312
|
+
* // EventType: "<SetDimension>",
|
|
313
|
+
* // Metrics: "<MapOfMetricDimension>",
|
|
314
|
+
* // },
|
|
315
|
+
* // FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
316
|
+
* // },
|
|
317
|
+
* // SegmentId: "STRING_VALUE",
|
|
318
|
+
* // },
|
|
319
|
+
* // SegmentStartCondition: {
|
|
320
|
+
* // SegmentId: "STRING_VALUE", // required
|
|
321
|
+
* // },
|
|
322
|
+
* // },
|
|
323
|
+
* // State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED",
|
|
324
|
+
* // tags: { // MapOf__string
|
|
325
|
+
* // "<keys>": "STRING_VALUE",
|
|
326
|
+
* // },
|
|
327
|
+
* // WaitForQuietTime: true || false,
|
|
328
|
+
* // RefreshOnSegmentUpdate: true || false,
|
|
329
|
+
* // JourneyChannelSettings: { // JourneyChannelSettings
|
|
330
|
+
* // ConnectCampaignArn: "STRING_VALUE",
|
|
331
|
+
* // ConnectCampaignExecutionRoleArn: "STRING_VALUE",
|
|
332
|
+
* // },
|
|
333
|
+
* // SendingSchedule: true || false,
|
|
334
|
+
* // OpenHours: { // OpenHours
|
|
335
|
+
* // EMAIL: { // MapOfListOfOpenHoursRules
|
|
336
|
+
* // "<keys>": [ // ListOfOpenHoursRules
|
|
337
|
+
* // { // OpenHoursRule
|
|
338
|
+
* // StartTime: "STRING_VALUE",
|
|
339
|
+
* // EndTime: "STRING_VALUE",
|
|
340
|
+
* // },
|
|
341
|
+
* // ],
|
|
342
|
+
* // },
|
|
343
|
+
* // SMS: {
|
|
344
|
+
* // "<keys>": [
|
|
345
|
+
* // {
|
|
346
|
+
* // StartTime: "STRING_VALUE",
|
|
347
|
+
* // EndTime: "STRING_VALUE",
|
|
348
|
+
* // },
|
|
349
|
+
* // ],
|
|
350
|
+
* // },
|
|
351
|
+
* // PUSH: {
|
|
352
|
+
* // "<keys>": [
|
|
353
|
+
* // {
|
|
354
|
+
* // StartTime: "STRING_VALUE",
|
|
355
|
+
* // EndTime: "STRING_VALUE",
|
|
356
|
+
* // },
|
|
357
|
+
* // ],
|
|
358
|
+
* // },
|
|
359
|
+
* // VOICE: {
|
|
360
|
+
* // "<keys>": [
|
|
361
|
+
* // {
|
|
362
|
+
* // StartTime: "STRING_VALUE",
|
|
363
|
+
* // EndTime: "STRING_VALUE",
|
|
364
|
+
* // },
|
|
365
|
+
* // ],
|
|
366
|
+
* // },
|
|
367
|
+
* // CUSTOM: {
|
|
368
|
+
* // "<keys>": [
|
|
369
|
+
* // {
|
|
370
|
+
* // StartTime: "STRING_VALUE",
|
|
371
|
+
* // EndTime: "STRING_VALUE",
|
|
372
|
+
* // },
|
|
373
|
+
* // ],
|
|
374
|
+
* // },
|
|
375
|
+
* // },
|
|
376
|
+
* // ClosedDays: { // ClosedDays
|
|
377
|
+
* // EMAIL: [ // ListOfClosedDaysRules
|
|
378
|
+
* // { // ClosedDaysRule
|
|
379
|
+
* // Name: "STRING_VALUE",
|
|
380
|
+
* // StartDateTime: "STRING_VALUE",
|
|
381
|
+
* // EndDateTime: "STRING_VALUE",
|
|
382
|
+
* // },
|
|
383
|
+
* // ],
|
|
384
|
+
* // SMS: [
|
|
385
|
+
* // {
|
|
386
|
+
* // Name: "STRING_VALUE",
|
|
387
|
+
* // StartDateTime: "STRING_VALUE",
|
|
388
|
+
* // EndDateTime: "STRING_VALUE",
|
|
389
|
+
* // },
|
|
390
|
+
* // ],
|
|
391
|
+
* // PUSH: [
|
|
392
|
+
* // {
|
|
393
|
+
* // Name: "STRING_VALUE",
|
|
394
|
+
* // StartDateTime: "STRING_VALUE",
|
|
395
|
+
* // EndDateTime: "STRING_VALUE",
|
|
396
|
+
* // },
|
|
397
|
+
* // ],
|
|
398
|
+
* // VOICE: [
|
|
399
|
+
* // {
|
|
400
|
+
* // Name: "STRING_VALUE",
|
|
401
|
+
* // StartDateTime: "STRING_VALUE",
|
|
402
|
+
* // EndDateTime: "STRING_VALUE",
|
|
403
|
+
* // },
|
|
404
|
+
* // ],
|
|
405
|
+
* // CUSTOM: [
|
|
406
|
+
* // {
|
|
407
|
+
* // Name: "STRING_VALUE",
|
|
408
|
+
* // StartDateTime: "STRING_VALUE",
|
|
409
|
+
* // EndDateTime: "STRING_VALUE",
|
|
410
|
+
* // },
|
|
411
|
+
* // ],
|
|
412
|
+
* // },
|
|
413
|
+
* // },
|
|
414
|
+
* // };
|
|
415
|
+
*
|
|
35
416
|
* ```
|
|
36
417
|
*
|
|
37
418
|
* @param GetJourneyCommandInput - {@link GetJourneyCommandInput}
|
|
@@ -61,6 +442,8 @@ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataB
|
|
|
61
442
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
62
443
|
* <p>Provides information about an API request or response.</p>
|
|
63
444
|
*
|
|
445
|
+
* @throws {@link PinpointServiceException}
|
|
446
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
64
447
|
*
|
|
65
448
|
*/
|
|
66
449
|
export declare class GetJourneyCommand extends $Command<GetJourneyCommandInput, GetJourneyCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -37,6 +37,37 @@ export interface GetJourneyDateRangeKpiCommandOutput extends GetJourneyDateRange
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new GetJourneyDateRangeKpiCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // GetJourneyDateRangeKpiResponse
|
|
41
|
+
* // JourneyDateRangeKpiResponse: { // JourneyDateRangeKpiResponse
|
|
42
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
43
|
+
* // EndTime: new Date("TIMESTAMP"), // required
|
|
44
|
+
* // JourneyId: "STRING_VALUE", // required
|
|
45
|
+
* // KpiName: "STRING_VALUE", // required
|
|
46
|
+
* // KpiResult: { // BaseKpiResult
|
|
47
|
+
* // Rows: [ // ListOfResultRow // required
|
|
48
|
+
* // { // ResultRow
|
|
49
|
+
* // GroupedBys: [ // ListOfResultRowValue // required
|
|
50
|
+
* // { // ResultRowValue
|
|
51
|
+
* // Key: "STRING_VALUE", // required
|
|
52
|
+
* // Type: "STRING_VALUE", // required
|
|
53
|
+
* // Value: "STRING_VALUE", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // Values: [ // required
|
|
57
|
+
* // {
|
|
58
|
+
* // Key: "STRING_VALUE", // required
|
|
59
|
+
* // Type: "STRING_VALUE", // required
|
|
60
|
+
* // Value: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // NextToken: "STRING_VALUE",
|
|
67
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
68
|
+
* // },
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
40
71
|
* ```
|
|
41
72
|
*
|
|
42
73
|
* @param GetJourneyDateRangeKpiCommandInput - {@link GetJourneyDateRangeKpiCommandInput}
|
|
@@ -66,6 +97,8 @@ export interface GetJourneyDateRangeKpiCommandOutput extends GetJourneyDateRange
|
|
|
66
97
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
67
98
|
* <p>Provides information about an API request or response.</p>
|
|
68
99
|
*
|
|
100
|
+
* @throws {@link PinpointServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
69
102
|
*
|
|
70
103
|
*/
|
|
71
104
|
export declare class GetJourneyDateRangeKpiCommand extends $Command<GetJourneyDateRangeKpiCommandInput, GetJourneyDateRangeKpiCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -35,6 +35,19 @@ export interface GetJourneyExecutionActivityMetricsCommandOutput extends GetJour
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new GetJourneyExecutionActivityMetricsCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // GetJourneyExecutionActivityMetricsResponse
|
|
39
|
+
* // JourneyExecutionActivityMetricsResponse: { // JourneyExecutionActivityMetricsResponse
|
|
40
|
+
* // ActivityType: "STRING_VALUE", // required
|
|
41
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
42
|
+
* // JourneyActivityId: "STRING_VALUE", // required
|
|
43
|
+
* // JourneyId: "STRING_VALUE", // required
|
|
44
|
+
* // LastEvaluatedTime: "STRING_VALUE", // required
|
|
45
|
+
* // Metrics: { // MapOf__string // required
|
|
46
|
+
* // "<keys>": "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
38
51
|
* ```
|
|
39
52
|
*
|
|
40
53
|
* @param GetJourneyExecutionActivityMetricsCommandInput - {@link GetJourneyExecutionActivityMetricsCommandInput}
|
|
@@ -64,6 +77,8 @@ export interface GetJourneyExecutionActivityMetricsCommandOutput extends GetJour
|
|
|
64
77
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
65
78
|
* <p>Provides information about an API request or response.</p>
|
|
66
79
|
*
|
|
80
|
+
* @throws {@link PinpointServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
67
82
|
*
|
|
68
83
|
*/
|
|
69
84
|
export declare class GetJourneyExecutionActivityMetricsCommand extends $Command<GetJourneyExecutionActivityMetricsCommandInput, GetJourneyExecutionActivityMetricsCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -34,6 +34,17 @@ export interface GetJourneyExecutionMetricsCommandOutput extends GetJourneyExecu
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new GetJourneyExecutionMetricsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // GetJourneyExecutionMetricsResponse
|
|
38
|
+
* // JourneyExecutionMetricsResponse: { // JourneyExecutionMetricsResponse
|
|
39
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
40
|
+
* // JourneyId: "STRING_VALUE", // required
|
|
41
|
+
* // LastEvaluatedTime: "STRING_VALUE", // required
|
|
42
|
+
* // Metrics: { // MapOf__string // required
|
|
43
|
+
* // "<keys>": "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // },
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
37
48
|
* ```
|
|
38
49
|
*
|
|
39
50
|
* @param GetJourneyExecutionMetricsCommandInput - {@link GetJourneyExecutionMetricsCommandInput}
|
|
@@ -63,6 +74,8 @@ export interface GetJourneyExecutionMetricsCommandOutput extends GetJourneyExecu
|
|
|
63
74
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
64
75
|
* <p>Provides information about an API request or response.</p>
|
|
65
76
|
*
|
|
77
|
+
* @throws {@link PinpointServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
66
79
|
*
|
|
67
80
|
*/
|
|
68
81
|
export declare class GetJourneyExecutionMetricsCommand extends $Command<GetJourneyExecutionMetricsCommandInput, GetJourneyExecutionMetricsCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -36,6 +36,20 @@ export interface GetJourneyRunExecutionActivityMetricsCommandOutput extends GetJ
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new GetJourneyRunExecutionActivityMetricsCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // GetJourneyRunExecutionActivityMetricsResponse
|
|
40
|
+
* // JourneyRunExecutionActivityMetricsResponse: { // JourneyRunExecutionActivityMetricsResponse
|
|
41
|
+
* // ActivityType: "STRING_VALUE", // required
|
|
42
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
43
|
+
* // JourneyActivityId: "STRING_VALUE", // required
|
|
44
|
+
* // JourneyId: "STRING_VALUE", // required
|
|
45
|
+
* // LastEvaluatedTime: "STRING_VALUE", // required
|
|
46
|
+
* // Metrics: { // MapOf__string // required
|
|
47
|
+
* // "<keys>": "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // RunId: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
39
53
|
* ```
|
|
40
54
|
*
|
|
41
55
|
* @param GetJourneyRunExecutionActivityMetricsCommandInput - {@link GetJourneyRunExecutionActivityMetricsCommandInput}
|
|
@@ -65,6 +79,8 @@ export interface GetJourneyRunExecutionActivityMetricsCommandOutput extends GetJ
|
|
|
65
79
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
80
|
* <p>Provides information about an API request or response.</p>
|
|
67
81
|
*
|
|
82
|
+
* @throws {@link PinpointServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
68
84
|
*
|
|
69
85
|
* @example To get the activity execution metrics for a journey run
|
|
70
86
|
* ```javascript
|
|
@@ -35,6 +35,18 @@ export interface GetJourneyRunExecutionMetricsCommandOutput extends GetJourneyRu
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new GetJourneyRunExecutionMetricsCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // GetJourneyRunExecutionMetricsResponse
|
|
39
|
+
* // JourneyRunExecutionMetricsResponse: { // JourneyRunExecutionMetricsResponse
|
|
40
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* // JourneyId: "STRING_VALUE", // required
|
|
42
|
+
* // LastEvaluatedTime: "STRING_VALUE", // required
|
|
43
|
+
* // Metrics: { // MapOf__string // required
|
|
44
|
+
* // "<keys>": "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // RunId: "STRING_VALUE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
38
50
|
* ```
|
|
39
51
|
*
|
|
40
52
|
* @param GetJourneyRunExecutionMetricsCommandInput - {@link GetJourneyRunExecutionMetricsCommandInput}
|
|
@@ -64,6 +76,8 @@ export interface GetJourneyRunExecutionMetricsCommandOutput extends GetJourneyRu
|
|
|
64
76
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
65
77
|
* <p>Provides information about an API request or response.</p>
|
|
66
78
|
*
|
|
79
|
+
* @throws {@link PinpointServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
67
81
|
*
|
|
68
82
|
* @example To get the execution metrics for a journey run
|
|
69
83
|
* ```javascript
|
|
@@ -34,6 +34,20 @@ export interface GetJourneyRunsCommandOutput extends GetJourneyRunsResponse, __M
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new GetJourneyRunsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // GetJourneyRunsResponse
|
|
38
|
+
* // JourneyRunsResponse: { // JourneyRunsResponse
|
|
39
|
+
* // Item: [ // ListOfJourneyRunResponse // required
|
|
40
|
+
* // { // JourneyRunResponse
|
|
41
|
+
* // CreationTime: "STRING_VALUE", // required
|
|
42
|
+
* // LastUpdateTime: "STRING_VALUE", // required
|
|
43
|
+
* // RunId: "STRING_VALUE", // required
|
|
44
|
+
* // Status: "SCHEDULED" || "RUNNING" || "COMPLETED" || "CANCELLED", // required
|
|
45
|
+
* // },
|
|
46
|
+
* // ],
|
|
47
|
+
* // NextToken: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
37
51
|
* ```
|
|
38
52
|
*
|
|
39
53
|
* @param GetJourneyRunsCommandInput - {@link GetJourneyRunsCommandInput}
|
|
@@ -63,6 +77,8 @@ export interface GetJourneyRunsCommandOutput extends GetJourneyRunsResponse, __M
|
|
|
63
77
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
64
78
|
* <p>Provides information about an API request or response.</p>
|
|
65
79
|
*
|
|
80
|
+
* @throws {@link PinpointServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
66
82
|
*
|
|
67
83
|
* @example To get the runs of a journey
|
|
68
84
|
* ```javascript
|