@aws-sdk/client-pinpoint 3.319.0 → 3.320.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/Pinpoint.js +6 -0
  3. package/dist-cjs/commands/GetJourneyRunExecutionActivityMetricsCommand.js +45 -0
  4. package/dist-cjs/commands/GetJourneyRunExecutionMetricsCommand.js +45 -0
  5. package/dist-cjs/commands/GetJourneyRunsCommand.js +45 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_1.js +7 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +226 -4
  10. package/dist-es/Pinpoint.js +6 -0
  11. package/dist-es/commands/GetJourneyRunExecutionActivityMetricsCommand.js +41 -0
  12. package/dist-es/commands/GetJourneyRunExecutionMetricsCommand.js +41 -0
  13. package/dist-es/commands/GetJourneyRunsCommand.js +41 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_1.js +6 -1
  17. package/dist-es/protocols/Aws_restJson1.js +216 -0
  18. package/dist-types/Pinpoint.d.ts +21 -0
  19. package/dist-types/PinpointClient.d.ts +5 -2
  20. package/dist-types/commands/CreateCampaignCommand.d.ts +33 -33
  21. package/dist-types/commands/CreateImportJobCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -10
  23. package/dist-types/commands/CreateJourneyCommand.d.ts +19 -19
  24. package/dist-types/commands/CreatePushTemplateCommand.d.ts +5 -5
  25. package/dist-types/commands/CreateSegmentCommand.d.ts +16 -16
  26. package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +89 -0
  27. package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +88 -0
  28. package/dist-types/commands/GetJourneyRunsCommand.d.ts +87 -0
  29. package/dist-types/commands/PutEventsCommand.d.ts +1 -1
  30. package/dist-types/commands/SendMessagesCommand.d.ts +7 -7
  31. package/dist-types/commands/SendUsersMessagesCommand.d.ts +6 -6
  32. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateCampaignCommand.d.ts +33 -33
  34. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +10 -10
  37. package/dist-types/commands/UpdateJourneyCommand.d.ts +19 -19
  38. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +5 -5
  40. package/dist-types/commands/UpdateSegmentCommand.d.ts +16 -16
  41. package/dist-types/commands/index.d.ts +3 -0
  42. package/dist-types/models/models_0.d.ts +30 -26
  43. package/dist-types/models/models_1.d.ts +215 -3
  44. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  45. package/dist-types/ts3.4/Pinpoint.d.ts +57 -0
  46. package/dist-types/ts3.4/PinpointClient.d.ts +18 -0
  47. package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +41 -0
  48. package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +41 -0
  49. package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +37 -0
  50. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  52. package/dist-types/ts3.4/models/models_1.d.ts +68 -0
  53. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  54. package/package.json +1 -1
@@ -36,7 +36,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
36
36
  * "STRING_VALUE",
37
37
  * ],
38
38
  * },
39
- * ChannelType: "STRING_VALUE",
39
+ * ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
40
40
  * Demographic: { // EndpointDemographic
41
41
  * AppVersion: "STRING_VALUE",
42
42
  * Locale: "STRING_VALUE",
@@ -37,7 +37,7 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
37
37
  * "STRING_VALUE",
38
38
  * ],
39
39
  * },
40
- * ChannelType: "STRING_VALUE",
40
+ * ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
41
41
  * Demographic: { // EndpointDemographic
42
42
  * AppVersion: "STRING_VALUE",
43
43
  * Locale: "STRING_VALUE",
@@ -33,53 +33,53 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
33
33
  * { // InAppMessageContent
34
34
  * BackgroundColor: "STRING_VALUE",
35
35
  * BodyConfig: { // InAppMessageBodyConfig
36
- * Alignment: "STRING_VALUE", // required
36
+ * Alignment: "LEFT" || "CENTER" || "RIGHT", // required
37
37
  * Body: "STRING_VALUE", // required
38
38
  * TextColor: "STRING_VALUE", // required
39
39
  * },
40
40
  * HeaderConfig: { // InAppMessageHeaderConfig
41
- * Alignment: "STRING_VALUE", // required
41
+ * Alignment: "LEFT" || "CENTER" || "RIGHT", // required
42
42
  * Header: "STRING_VALUE", // required
43
43
  * TextColor: "STRING_VALUE", // required
44
44
  * },
45
45
  * ImageUrl: "STRING_VALUE",
46
46
  * PrimaryBtn: { // InAppMessageButton
47
47
  * Android: { // OverrideButtonConfiguration
48
- * ButtonAction: "STRING_VALUE", // required
48
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
49
49
  * Link: "STRING_VALUE",
50
50
  * },
51
51
  * DefaultConfig: { // DefaultButtonConfiguration
52
52
  * BackgroundColor: "STRING_VALUE",
53
53
  * BorderRadius: Number("int"),
54
- * ButtonAction: "STRING_VALUE", // required
54
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
55
55
  * Link: "STRING_VALUE",
56
56
  * Text: "STRING_VALUE", // required
57
57
  * TextColor: "STRING_VALUE",
58
58
  * },
59
59
  * IOS: {
60
- * ButtonAction: "STRING_VALUE", // required
60
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
61
61
  * Link: "STRING_VALUE",
62
62
  * },
63
63
  * Web: {
64
- * ButtonAction: "STRING_VALUE", // required
64
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
65
65
  * Link: "STRING_VALUE",
66
66
  * },
67
67
  * },
68
68
  * SecondaryBtn: {
69
69
  * Android: {
70
- * ButtonAction: "STRING_VALUE", // required
70
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
71
71
  * Link: "STRING_VALUE",
72
72
  * },
73
73
  * DefaultConfig: {
74
74
  * BackgroundColor: "STRING_VALUE",
75
75
  * BorderRadius: Number("int"),
76
- * ButtonAction: "STRING_VALUE", // required
76
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
77
77
  * Link: "STRING_VALUE",
78
78
  * Text: "STRING_VALUE", // required
79
79
  * TextColor: "STRING_VALUE",
80
80
  * },
81
81
  * IOS: {
82
- * ButtonAction: "STRING_VALUE", // required
82
+ * ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
83
83
  * Link: "STRING_VALUE",
84
84
  * },
85
85
  * Web: "<OverrideButtonConfiguration>",
@@ -89,7 +89,7 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
89
89
  * CustomConfig: { // MapOf__string
90
90
  * "<keys>": "STRING_VALUE",
91
91
  * },
92
- * Layout: "STRING_VALUE",
92
+ * Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
93
93
  * tags: {
94
94
  * "<keys>": "STRING_VALUE",
95
95
  * },
@@ -35,7 +35,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
35
35
  * CUSTOM: { // CustomMessageActivity
36
36
  * DeliveryUri: "STRING_VALUE",
37
37
  * EndpointTypes: [ // ListOf__EndpointTypesElement
38
- * "STRING_VALUE",
38
+ * "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
39
39
  * ],
40
40
  * MessageConfig: { // JourneyCustomMessage
41
41
  * Data: "STRING_VALUE",
@@ -52,14 +52,14 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
52
52
  * Dimensions: { // EventDimensions
53
53
  * Attributes: { // MapOfAttributeDimension
54
54
  * "<keys>": { // AttributeDimension
55
- * AttributeType: "STRING_VALUE",
55
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
56
56
  * Values: [ // ListOf__string // required
57
57
  * "STRING_VALUE",
58
58
  * ],
59
59
  * },
60
60
  * },
61
61
  * EventType: { // SetDimension
62
- * DimensionType: "STRING_VALUE",
62
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
63
63
  * Values: [ // required
64
64
  * "STRING_VALUE",
65
65
  * ],
@@ -79,7 +79,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
79
79
  * SegmentDimensions: { // SegmentDimensions
80
80
  * Attributes: {
81
81
  * "<keys>": {
82
- * AttributeType: "STRING_VALUE",
82
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
83
83
  * Values: [ // required
84
84
  * "STRING_VALUE",
85
85
  * ],
@@ -87,29 +87,29 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
87
87
  * },
88
88
  * Behavior: { // SegmentBehaviors
89
89
  * Recency: { // RecencyDimension
90
- * Duration: "STRING_VALUE", // required
91
- * RecencyType: "STRING_VALUE", // required
90
+ * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
91
+ * RecencyType: "ACTIVE" || "INACTIVE", // required
92
92
  * },
93
93
  * },
94
94
  * Demographic: { // SegmentDemographics
95
95
  * AppVersion: {
96
- * DimensionType: "STRING_VALUE",
96
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
97
97
  * Values: [ // required
98
98
  * "STRING_VALUE",
99
99
  * ],
100
100
  * },
101
101
  * Channel: {
102
- * DimensionType: "STRING_VALUE",
102
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
103
103
  * Values: [ // required
104
104
  * "STRING_VALUE",
105
105
  * ],
106
106
  * },
107
107
  * DeviceType: {
108
- * DimensionType: "STRING_VALUE",
108
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
109
109
  * Values: "<ListOf__string>", // required
110
110
  * },
111
111
  * Make: {
112
- * DimensionType: "STRING_VALUE",
112
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
113
113
  * Values: "<ListOf__string>", // required
114
114
  * },
115
115
  * Model: "<SetDimension>",
@@ -133,14 +133,14 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
133
133
  * },
134
134
  * UserAttributes: {
135
135
  * "<keys>": {
136
- * AttributeType: "STRING_VALUE",
136
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
137
137
  * Values: "<ListOf__string>", // required
138
138
  * },
139
139
  * },
140
140
  * },
141
141
  * },
142
142
  * ],
143
- * Operator: "STRING_VALUE",
143
+ * Operator: "ALL" || "ANY",
144
144
  * },
145
145
  * EvaluationWaitTime: { // WaitTime
146
146
  * WaitFor: "STRING_VALUE",
@@ -170,7 +170,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
170
170
  * Dimensions: {
171
171
  * Attributes: {
172
172
  * "<keys>": {
173
- * AttributeType: "STRING_VALUE",
173
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
174
174
  * Values: "<ListOf__string>", // required
175
175
  * },
176
176
  * },
@@ -190,14 +190,14 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
190
190
  * SegmentDimensions: {
191
191
  * Attributes: {
192
192
  * "<keys>": {
193
- * AttributeType: "STRING_VALUE",
193
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
194
194
  * Values: "<ListOf__string>", // required
195
195
  * },
196
196
  * },
197
197
  * Behavior: {
198
198
  * Recency: {
199
- * Duration: "STRING_VALUE", // required
200
- * RecencyType: "STRING_VALUE", // required
199
+ * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
200
+ * RecencyType: "ACTIVE" || "INACTIVE", // required
201
201
  * },
202
202
  * },
203
203
  * Demographic: {
@@ -254,7 +254,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
254
254
  * },
255
255
  * SMS: { // SMSMessageActivity
256
256
  * MessageConfig: { // JourneySMSMessage
257
- * MessageType: "STRING_VALUE",
257
+ * MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
258
258
  * OriginationNumber: "STRING_VALUE",
259
259
  * SenderId: "STRING_VALUE",
260
260
  * EntityId: "STRING_VALUE",
@@ -306,7 +306,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
306
306
  * EventType: "<SetDimension>",
307
307
  * Metrics: "<MapOfMetricDimension>",
308
308
  * },
309
- * FilterType: "STRING_VALUE", // required
309
+ * FilterType: "SYSTEM" || "ENDPOINT", // required
310
310
  * },
311
311
  * SegmentId: "STRING_VALUE",
312
312
  * },
@@ -314,7 +314,7 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
314
314
  * SegmentId: "STRING_VALUE", // required
315
315
  * },
316
316
  * },
317
- * State: "STRING_VALUE",
317
+ * State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED",
318
318
  * WaitForQuietTime: true || false,
319
319
  * RefreshOnSegmentUpdate: true || false,
320
320
  * JourneyChannelSettings: { // JourneyChannelSettings
@@ -30,7 +30,7 @@ export interface UpdateJourneyStateCommandOutput extends UpdateJourneyStateRespo
30
30
  * ApplicationId: "STRING_VALUE", // required
31
31
  * JourneyId: "STRING_VALUE", // required
32
32
  * JourneyStateRequest: { // JourneyStateRequest
33
- * State: "STRING_VALUE",
33
+ * State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED",
34
34
  * },
35
35
  * };
36
36
  * const command = new UpdateJourneyStateCommand(input);
@@ -30,7 +30,7 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
30
30
  * CreateNewVersion: true || false,
31
31
  * PushNotificationTemplateRequest: { // PushNotificationTemplateRequest
32
32
  * ADM: { // AndroidPushNotificationTemplate
33
- * Action: "STRING_VALUE",
33
+ * Action: "OPEN_APP" || "DEEP_LINK" || "URL",
34
34
  * Body: "STRING_VALUE",
35
35
  * ImageIconUrl: "STRING_VALUE",
36
36
  * ImageUrl: "STRING_VALUE",
@@ -41,7 +41,7 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
41
41
  * Url: "STRING_VALUE",
42
42
  * },
43
43
  * APNS: { // APNSPushNotificationTemplate
44
- * Action: "STRING_VALUE",
44
+ * Action: "OPEN_APP" || "DEEP_LINK" || "URL",
45
45
  * Body: "STRING_VALUE",
46
46
  * MediaUrl: "STRING_VALUE",
47
47
  * RawContent: "STRING_VALUE",
@@ -50,7 +50,7 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
50
50
  * Url: "STRING_VALUE",
51
51
  * },
52
52
  * Baidu: {
53
- * Action: "STRING_VALUE",
53
+ * Action: "OPEN_APP" || "DEEP_LINK" || "URL",
54
54
  * Body: "STRING_VALUE",
55
55
  * ImageIconUrl: "STRING_VALUE",
56
56
  * ImageUrl: "STRING_VALUE",
@@ -61,7 +61,7 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
61
61
  * Url: "STRING_VALUE",
62
62
  * },
63
63
  * Default: { // DefaultPushNotificationTemplate
64
- * Action: "STRING_VALUE",
64
+ * Action: "OPEN_APP" || "DEEP_LINK" || "URL",
65
65
  * Body: "STRING_VALUE",
66
66
  * Sound: "STRING_VALUE",
67
67
  * Title: "STRING_VALUE",
@@ -69,7 +69,7 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
69
69
  * },
70
70
  * DefaultSubstitutions: "STRING_VALUE",
71
71
  * GCM: {
72
- * Action: "STRING_VALUE",
72
+ * Action: "OPEN_APP" || "DEEP_LINK" || "URL",
73
73
  * Body: "STRING_VALUE",
74
74
  * ImageIconUrl: "STRING_VALUE",
75
75
  * ImageUrl: "STRING_VALUE",
@@ -33,7 +33,7 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
33
33
  * Dimensions: { // SegmentDimensions
34
34
  * Attributes: { // MapOfAttributeDimension
35
35
  * "<keys>": { // AttributeDimension
36
- * AttributeType: "STRING_VALUE",
36
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
37
37
  * Values: [ // ListOf__string // required
38
38
  * "STRING_VALUE",
39
39
  * ],
@@ -41,37 +41,37 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
41
41
  * },
42
42
  * Behavior: { // SegmentBehaviors
43
43
  * Recency: { // RecencyDimension
44
- * Duration: "STRING_VALUE", // required
45
- * RecencyType: "STRING_VALUE", // required
44
+ * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
45
+ * RecencyType: "ACTIVE" || "INACTIVE", // required
46
46
  * },
47
47
  * },
48
48
  * Demographic: { // SegmentDemographics
49
49
  * AppVersion: { // SetDimension
50
- * DimensionType: "STRING_VALUE",
50
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
51
51
  * Values: [ // required
52
52
  * "STRING_VALUE",
53
53
  * ],
54
54
  * },
55
55
  * Channel: {
56
- * DimensionType: "STRING_VALUE",
56
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
57
57
  * Values: [ // required
58
58
  * "STRING_VALUE",
59
59
  * ],
60
60
  * },
61
61
  * DeviceType: {
62
- * DimensionType: "STRING_VALUE",
62
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
63
63
  * Values: [ // required
64
64
  * "STRING_VALUE",
65
65
  * ],
66
66
  * },
67
67
  * Make: {
68
- * DimensionType: "STRING_VALUE",
68
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
69
69
  * Values: [ // required
70
70
  * "STRING_VALUE",
71
71
  * ],
72
72
  * },
73
73
  * Model: {
74
- * DimensionType: "STRING_VALUE",
74
+ * DimensionType: "INCLUSIVE" || "EXCLUSIVE",
75
75
  * Values: "<ListOf__string>", // required
76
76
  * },
77
77
  * Platform: "<SetDimension>",
@@ -94,7 +94,7 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
94
94
  * },
95
95
  * UserAttributes: {
96
96
  * "<keys>": {
97
- * AttributeType: "STRING_VALUE",
97
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
98
98
  * Values: "<ListOf__string>", // required
99
99
  * },
100
100
  * },
@@ -107,14 +107,14 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
107
107
  * {
108
108
  * Attributes: {
109
109
  * "<keys>": {
110
- * AttributeType: "STRING_VALUE",
110
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
111
111
  * Values: "<ListOf__string>", // required
112
112
  * },
113
113
  * },
114
114
  * Behavior: {
115
115
  * Recency: {
116
- * Duration: "STRING_VALUE", // required
117
- * RecencyType: "STRING_VALUE", // required
116
+ * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
117
+ * RecencyType: "ACTIVE" || "INACTIVE", // required
118
118
  * },
119
119
  * },
120
120
  * Demographic: {
@@ -143,7 +143,7 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
143
143
  * },
144
144
  * UserAttributes: {
145
145
  * "<keys>": {
146
- * AttributeType: "STRING_VALUE",
146
+ * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
147
147
  * Values: "<ListOf__string>", // required
148
148
  * },
149
149
  * },
@@ -155,11 +155,11 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met
155
155
  * Version: Number("int"),
156
156
  * },
157
157
  * ],
158
- * SourceType: "STRING_VALUE",
159
- * Type: "STRING_VALUE",
158
+ * SourceType: "ALL" || "ANY" || "NONE",
159
+ * Type: "ALL" || "ANY" || "NONE",
160
160
  * },
161
161
  * ],
162
- * Include: "STRING_VALUE",
162
+ * Include: "ALL" || "ANY" || "NONE",
163
163
  * },
164
164
  * tags: { // MapOf__string
165
165
  * "<keys>": "STRING_VALUE",
@@ -65,6 +65,9 @@ export * from "./GetJourneyCommand";
65
65
  export * from "./GetJourneyDateRangeKpiCommand";
66
66
  export * from "./GetJourneyExecutionActivityMetricsCommand";
67
67
  export * from "./GetJourneyExecutionMetricsCommand";
68
+ export * from "./GetJourneyRunExecutionActivityMetricsCommand";
69
+ export * from "./GetJourneyRunExecutionMetricsCommand";
70
+ export * from "./GetJourneyRunsCommand";
68
71
  export * from "./GetPushTemplateCommand";
69
72
  export * from "./GetRecommenderConfigurationCommand";
70
73
  export * from "./GetRecommenderConfigurationsCommand";
@@ -93,6 +93,10 @@ export interface ActivityResponse {
93
93
  * <p>The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.</p>
94
94
  */
95
95
  TreatmentId?: string;
96
+ /**
97
+ * <p>A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
98
+ */
99
+ ExecutionMetrics?: Record<string, string>;
96
100
  }
97
101
  /**
98
102
  * @public
@@ -2606,45 +2610,45 @@ export interface ChannelsResponse {
2606
2610
  }
2607
2611
  /**
2608
2612
  * @public
2609
- * <p>Closed Days Rule. Part of Journey sending schedule.</p>
2613
+ * <p>Specifies the rule settings for when messages can't be sent.</p>
2610
2614
  */
2611
2615
  export interface ClosedDaysRule {
2612
2616
  /**
2613
- * <p>Name of the rule.</p>
2617
+ * <p>The name of the closed day rule.</p>
2614
2618
  */
2615
2619
  Name?: string;
2616
2620
  /**
2617
- * <p>Start Datetime in ISO 8601 format.</p>
2621
+ * <p>Start DateTime ISO 8601 format</p>
2618
2622
  */
2619
2623
  StartDateTime?: string;
2620
2624
  /**
2621
- * <p>End Datetime in ISO 8601 format.</p>
2625
+ * <p>End DateTime ISO 8601 format</p>
2622
2626
  */
2623
2627
  EndDateTime?: string;
2624
2628
  }
2625
2629
  /**
2626
2630
  * @public
2627
- * <p>The time when journey will stop sending messages.</p>
2631
+ * <p>The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
2628
2632
  */
2629
2633
  export interface ClosedDays {
2630
2634
  /**
2631
- * <p>Rules for Email Channel.</p>
2635
+ * <p>Rules for the Email channel.</p>
2632
2636
  */
2633
2637
  EMAIL?: ClosedDaysRule[];
2634
2638
  /**
2635
- * <p>Rules for SMS Channel.</p>
2639
+ * <p>Rules for the SMS channel.</p>
2636
2640
  */
2637
2641
  SMS?: ClosedDaysRule[];
2638
2642
  /**
2639
- * <p>Rules for Push Channel.</p>
2643
+ * <p>Rules for the Push channel.</p>
2640
2644
  */
2641
2645
  PUSH?: ClosedDaysRule[];
2642
2646
  /**
2643
- * <p>Rules for Voice Channel.</p>
2647
+ * <p>Rules for the Voice channel.</p>
2644
2648
  */
2645
2649
  VOICE?: ClosedDaysRule[];
2646
2650
  /**
2647
- * <p>Rules for Custom Channel.</p>
2651
+ * <p>Rules for the Custom channel.</p>
2648
2652
  */
2649
2653
  CUSTOM?: ClosedDaysRule[];
2650
2654
  }
@@ -3456,41 +3460,41 @@ export declare const DayOfWeek: {
3456
3460
  export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
3457
3461
  /**
3458
3462
  * @public
3459
- * <p>List of OpenHours Rules.</p>
3463
+ * <p>Specifies the start and end time for OpenHours.</p>
3460
3464
  */
3461
3465
  export interface OpenHoursRule {
3462
3466
  /**
3463
- * <p>Local start time in ISO 8601 format.</p>
3467
+ * <p>The start of the scheduled time, in ISO 8601 format, when the channel can send messages.</p>
3464
3468
  */
3465
3469
  StartTime?: string;
3466
3470
  /**
3467
- * <p>Local start time in ISO 8601 format.</p>
3471
+ * <p>The end of the scheduled time, in ISO 8601 format, when the channel can't send messages.</p>
3468
3472
  */
3469
3473
  EndTime?: string;
3470
3474
  }
3471
3475
  /**
3472
3476
  * @public
3473
- * <p>The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
3477
+ * <p>Specifies the times when message are allowed to be sent to endpoints.</p>
3474
3478
  */
3475
3479
  export interface OpenHours {
3476
3480
  /**
3477
- * <p>Rules for Email Channel.</p>
3481
+ * <p>Specifies the schedule settings for the email channel.</p>
3478
3482
  */
3479
3483
  EMAIL?: Record<string, OpenHoursRule[]>;
3480
3484
  /**
3481
- * <p>Rules for SMS Channel.</p>
3485
+ * <p>Specifies the schedule settings for the SMS channel.</p>
3482
3486
  */
3483
3487
  SMS?: Record<string, OpenHoursRule[]>;
3484
3488
  /**
3485
- * <p>Rules for Push Channel.</p>
3489
+ * <p>Specifies the schedule settings for the push channel.</p>
3486
3490
  */
3487
3491
  PUSH?: Record<string, OpenHoursRule[]>;
3488
3492
  /**
3489
- * <p>Rules for Voice Channel.</p>
3493
+ * <p>Specifies the schedule settings for the voice channel.</p>
3490
3494
  */
3491
3495
  VOICE?: Record<string, OpenHoursRule[]>;
3492
3496
  /**
3493
- * <p>Rules for Custom Channel.</p>
3497
+ * <p>Specifies the schedule settings for the custom channel.</p>
3494
3498
  */
3495
3499
  CUSTOM?: Record<string, OpenHoursRule[]>;
3496
3500
  }
@@ -3634,7 +3638,7 @@ export interface WriteJourneyRequest {
3634
3638
  */
3635
3639
  WaitForQuietTime?: boolean;
3636
3640
  /**
3637
- * <p>Specifies whether a journey should be refreshed on segment update.</p>
3641
+ * <p>Indicates whether the journey participants should be refreshed when a segment is updated.</p>
3638
3642
  */
3639
3643
  RefreshOnSegmentUpdate?: boolean;
3640
3644
  /**
@@ -3642,7 +3646,7 @@ export interface WriteJourneyRequest {
3642
3646
  */
3643
3647
  JourneyChannelSettings?: JourneyChannelSettings;
3644
3648
  /**
3645
- * <p>Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)</p>
3649
+ * <p>Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.</p>
3646
3650
  */
3647
3651
  SendingSchedule?: boolean;
3648
3652
  /**
@@ -3733,11 +3737,11 @@ export interface JourneyResponse {
3733
3737
  */
3734
3738
  tags?: Record<string, string>;
3735
3739
  /**
3736
- * <p>Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.</p>
3740
+ * <p>Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.</p>
3737
3741
  */
3738
3742
  WaitForQuietTime?: boolean;
3739
3743
  /**
3740
- * <p>Specifies whether a journey should be refreshed on segment update.</p>
3744
+ * <p>Indicates whether the journey participants should be refreshed when a segment is updated.</p>
3741
3745
  */
3742
3746
  RefreshOnSegmentUpdate?: boolean;
3743
3747
  /**
@@ -3745,15 +3749,15 @@ export interface JourneyResponse {
3745
3749
  */
3746
3750
  JourneyChannelSettings?: JourneyChannelSettings;
3747
3751
  /**
3748
- * <p>Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)</p>
3752
+ * <p>Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.</p>
3749
3753
  */
3750
3754
  SendingSchedule?: boolean;
3751
3755
  /**
3752
- * <p>The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
3756
+ * <p>The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
3753
3757
  */
3754
3758
  OpenHours?: OpenHours;
3755
3759
  /**
3756
- * <p>The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
3760
+ * <p>The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
3757
3761
  */
3758
3762
  ClosedDays?: ClosedDays;
3759
3763
  }