@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.
Files changed (123) hide show
  1. package/dist-types/commands/CreateAppCommand.d.ts +14 -0
  2. package/dist-types/commands/CreateCampaignCommand.d.ts +385 -0
  3. package/dist-types/commands/CreateEmailTemplateCommand.d.ts +10 -0
  4. package/dist-types/commands/CreateExportJobCommand.d.ts +27 -0
  5. package/dist-types/commands/CreateImportJobCommand.d.ts +31 -0
  6. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -0
  7. package/dist-types/commands/CreateJourneyCommand.d.ts +383 -0
  8. package/dist-types/commands/CreatePushTemplateCommand.d.ts +10 -0
  9. package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +21 -0
  10. package/dist-types/commands/CreateSegmentCommand.d.ts +158 -0
  11. package/dist-types/commands/CreateSmsTemplateCommand.d.ts +10 -0
  12. package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +10 -0
  13. package/dist-types/commands/DeleteAdmChannelCommand.d.ts +17 -0
  14. package/dist-types/commands/DeleteApnsChannelCommand.d.ts +19 -0
  15. package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +19 -0
  16. package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +19 -0
  17. package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +19 -0
  18. package/dist-types/commands/DeleteAppCommand.d.ts +14 -0
  19. package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +18 -0
  20. package/dist-types/commands/DeleteCampaignCommand.d.ts +385 -0
  21. package/dist-types/commands/DeleteEmailChannelCommand.d.ts +22 -0
  22. package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +9 -0
  23. package/dist-types/commands/DeleteEndpointCommand.d.ts +51 -0
  24. package/dist-types/commands/DeleteEventStreamCommand.d.ts +13 -0
  25. package/dist-types/commands/DeleteGcmChannelCommand.d.ts +18 -0
  26. package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +9 -0
  27. package/dist-types/commands/DeleteJourneyCommand.d.ts +383 -0
  28. package/dist-types/commands/DeletePushTemplateCommand.d.ts +9 -0
  29. package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +21 -0
  30. package/dist-types/commands/DeleteSegmentCommand.d.ts +158 -0
  31. package/dist-types/commands/DeleteSmsChannelCommand.d.ts +21 -0
  32. package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +9 -0
  33. package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +55 -0
  34. package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +17 -0
  35. package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +9 -0
  36. package/dist-types/commands/GetAdmChannelCommand.d.ts +17 -0
  37. package/dist-types/commands/GetApnsChannelCommand.d.ts +19 -0
  38. package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +19 -0
  39. package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +19 -0
  40. package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +19 -0
  41. package/dist-types/commands/GetAppCommand.d.ts +14 -0
  42. package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +32 -0
  43. package/dist-types/commands/GetApplicationSettingsCommand.d.ts +25 -0
  44. package/dist-types/commands/GetAppsCommand.d.ts +19 -0
  45. package/dist-types/commands/GetBaiduChannelCommand.d.ts +18 -0
  46. package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +28 -0
  47. package/dist-types/commands/GetCampaignCommand.d.ts +385 -0
  48. package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +33 -0
  49. package/dist-types/commands/GetCampaignVersionCommand.d.ts +385 -0
  50. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +390 -0
  51. package/dist-types/commands/GetCampaignsCommand.d.ts +390 -0
  52. package/dist-types/commands/GetChannelsCommand.d.ts +20 -0
  53. package/dist-types/commands/GetEmailChannelCommand.d.ts +22 -0
  54. package/dist-types/commands/GetEmailTemplateCommand.d.ts +22 -0
  55. package/dist-types/commands/GetEndpointCommand.d.ts +51 -0
  56. package/dist-types/commands/GetEventStreamCommand.d.ts +13 -0
  57. package/dist-types/commands/GetExportJobCommand.d.ts +27 -0
  58. package/dist-types/commands/GetExportJobsCommand.d.ts +32 -0
  59. package/dist-types/commands/GetGcmChannelCommand.d.ts +18 -0
  60. package/dist-types/commands/GetImportJobCommand.d.ts +31 -0
  61. package/dist-types/commands/GetImportJobsCommand.d.ts +36 -0
  62. package/dist-types/commands/GetInAppMessagesCommand.d.ts +112 -0
  63. package/dist-types/commands/GetInAppTemplateCommand.d.ts +78 -0
  64. package/dist-types/commands/GetJourneyCommand.d.ts +383 -0
  65. package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +33 -0
  66. package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +15 -0
  67. package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +13 -0
  68. package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +16 -0
  69. package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +14 -0
  70. package/dist-types/commands/GetJourneyRunsCommand.d.ts +16 -0
  71. package/dist-types/commands/GetPushTemplateCommand.d.ts +68 -0
  72. package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +21 -0
  73. package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +26 -0
  74. package/dist-types/commands/GetSegmentCommand.d.ts +158 -0
  75. package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +32 -0
  76. package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +36 -0
  77. package/dist-types/commands/GetSegmentVersionCommand.d.ts +158 -0
  78. package/dist-types/commands/GetSegmentVersionsCommand.d.ts +163 -0
  79. package/dist-types/commands/GetSegmentsCommand.d.ts +163 -0
  80. package/dist-types/commands/GetSmsChannelCommand.d.ts +21 -0
  81. package/dist-types/commands/GetSmsTemplateCommand.d.ts +20 -0
  82. package/dist-types/commands/GetUserEndpointsCommand.d.ts +55 -0
  83. package/dist-types/commands/GetVoiceChannelCommand.d.ts +17 -0
  84. package/dist-types/commands/GetVoiceTemplateCommand.d.ts +21 -0
  85. package/dist-types/commands/ListJourneysCommand.d.ts +388 -0
  86. package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -0
  87. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +21 -0
  88. package/dist-types/commands/ListTemplatesCommand.d.ts +23 -0
  89. package/dist-types/commands/PhoneNumberValidateCommand.d.ts +21 -0
  90. package/dist-types/commands/PutEventStreamCommand.d.ts +13 -0
  91. package/dist-types/commands/PutEventsCommand.d.ts +21 -0
  92. package/dist-types/commands/RemoveAttributesCommand.d.ts +12 -0
  93. package/dist-types/commands/SendMessagesCommand.d.ts +28 -0
  94. package/dist-types/commands/SendOTPMessageCommand.d.ts +28 -0
  95. package/dist-types/commands/SendUsersMessagesCommand.d.ts +21 -0
  96. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  97. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  98. package/dist-types/commands/UpdateAdmChannelCommand.d.ts +17 -0
  99. package/dist-types/commands/UpdateApnsChannelCommand.d.ts +19 -0
  100. package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +19 -0
  101. package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +19 -0
  102. package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +19 -0
  103. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +25 -0
  104. package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +18 -0
  105. package/dist-types/commands/UpdateCampaignCommand.d.ts +385 -0
  106. package/dist-types/commands/UpdateEmailChannelCommand.d.ts +22 -0
  107. package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +9 -0
  108. package/dist-types/commands/UpdateEndpointCommand.d.ts +9 -0
  109. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +9 -0
  110. package/dist-types/commands/UpdateGcmChannelCommand.d.ts +18 -0
  111. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +9 -0
  112. package/dist-types/commands/UpdateJourneyCommand.d.ts +383 -0
  113. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +383 -0
  114. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +9 -0
  115. package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +21 -0
  116. package/dist-types/commands/UpdateSegmentCommand.d.ts +158 -0
  117. package/dist-types/commands/UpdateSmsChannelCommand.d.ts +21 -0
  118. package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +9 -0
  119. package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +9 -0
  120. package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +17 -0
  121. package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +9 -0
  122. package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
  123. package/package.json +16 -16
@@ -32,6 +32,23 @@ export interface GetAppsCommandOutput extends GetAppsResponse, __MetadataBearer
32
32
  * };
33
33
  * const command = new GetAppsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetAppsResponse
36
+ * // ApplicationsResponse: { // ApplicationsResponse
37
+ * // Item: [ // ListOfApplicationResponse
38
+ * // { // ApplicationResponse
39
+ * // Arn: "STRING_VALUE", // required
40
+ * // Id: "STRING_VALUE", // required
41
+ * // Name: "STRING_VALUE", // required
42
+ * // tags: { // MapOf__string
43
+ * // "<keys>": "STRING_VALUE",
44
+ * // },
45
+ * // CreationDate: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // },
50
+ * // };
51
+ *
35
52
  * ```
36
53
  *
37
54
  * @param GetAppsCommandInput - {@link GetAppsCommandInput}
@@ -61,6 +78,8 @@ export interface GetAppsCommandOutput extends GetAppsResponse, __MetadataBearer
61
78
  * @throws {@link TooManyRequestsException} (client fault)
62
79
  * <p>Provides information about an API request or response.</p>
63
80
  *
81
+ * @throws {@link PinpointServiceException}
82
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
64
83
  *
65
84
  */
66
85
  export declare class GetAppsCommand extends $Command<GetAppsCommandInput, GetAppsCommandOutput, PinpointClientResolvedConfig> {
@@ -31,6 +31,22 @@ export interface GetBaiduChannelCommandOutput extends GetBaiduChannelResponse, _
31
31
  * };
32
32
  * const command = new GetBaiduChannelCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetBaiduChannelResponse
35
+ * // BaiduChannelResponse: { // BaiduChannelResponse
36
+ * // ApplicationId: "STRING_VALUE",
37
+ * // CreationDate: "STRING_VALUE",
38
+ * // Credential: "STRING_VALUE", // required
39
+ * // Enabled: true || false,
40
+ * // HasCredential: true || false,
41
+ * // Id: "STRING_VALUE",
42
+ * // IsArchived: true || false,
43
+ * // LastModifiedBy: "STRING_VALUE",
44
+ * // LastModifiedDate: "STRING_VALUE",
45
+ * // Platform: "STRING_VALUE", // required
46
+ * // Version: Number("int"),
47
+ * // },
48
+ * // };
49
+ *
34
50
  * ```
35
51
  *
36
52
  * @param GetBaiduChannelCommandInput - {@link GetBaiduChannelCommandInput}
@@ -60,6 +76,8 @@ export interface GetBaiduChannelCommandOutput extends GetBaiduChannelResponse, _
60
76
  * @throws {@link TooManyRequestsException} (client fault)
61
77
  * <p>Provides information about an API request or response.</p>
62
78
  *
79
+ * @throws {@link PinpointServiceException}
80
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
63
81
  *
64
82
  */
65
83
  export declare class GetBaiduChannelCommand extends $Command<GetBaiduChannelCommandInput, GetBaiduChannelCommandOutput, PinpointClientResolvedConfig> {
@@ -34,6 +34,32 @@ export interface GetCampaignActivitiesCommandOutput extends GetCampaignActivitie
34
34
  * };
35
35
  * const command = new GetCampaignActivitiesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetCampaignActivitiesResponse
38
+ * // ActivitiesResponse: { // ActivitiesResponse
39
+ * // Item: [ // ListOfActivityResponse // required
40
+ * // { // ActivityResponse
41
+ * // ApplicationId: "STRING_VALUE", // required
42
+ * // CampaignId: "STRING_VALUE", // required
43
+ * // End: "STRING_VALUE",
44
+ * // Id: "STRING_VALUE", // required
45
+ * // Result: "STRING_VALUE",
46
+ * // ScheduledStart: "STRING_VALUE",
47
+ * // Start: "STRING_VALUE",
48
+ * // State: "STRING_VALUE",
49
+ * // SuccessfulEndpointCount: Number("int"),
50
+ * // TimezonesCompletedCount: Number("int"),
51
+ * // TimezonesTotalCount: Number("int"),
52
+ * // TotalEndpointCount: Number("int"),
53
+ * // TreatmentId: "STRING_VALUE",
54
+ * // ExecutionMetrics: { // MapOf__string
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // NextToken: "STRING_VALUE",
60
+ * // },
61
+ * // };
62
+ *
37
63
  * ```
38
64
  *
39
65
  * @param GetCampaignActivitiesCommandInput - {@link GetCampaignActivitiesCommandInput}
@@ -63,6 +89,8 @@ export interface GetCampaignActivitiesCommandOutput extends GetCampaignActivitie
63
89
  * @throws {@link TooManyRequestsException} (client fault)
64
90
  * <p>Provides information about an API request or response.</p>
65
91
  *
92
+ * @throws {@link PinpointServiceException}
93
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
66
94
  *
67
95
  */
68
96
  export declare class GetCampaignActivitiesCommand extends $Command<GetCampaignActivitiesCommandInput, GetCampaignActivitiesCommandOutput, PinpointClientResolvedConfig> {
@@ -32,6 +32,389 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
32
32
  * };
33
33
  * const command = new GetCampaignCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetCampaignResponse
36
+ * // CampaignResponse: { // CampaignResponse
37
+ * // AdditionalTreatments: [ // ListOfTreatmentResource
38
+ * // { // TreatmentResource
39
+ * // CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
40
+ * // DeliveryUri: "STRING_VALUE", // required
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
+ * // },
45
+ * // Id: "STRING_VALUE", // required
46
+ * // MessageConfiguration: { // MessageConfiguration
47
+ * // ADMMessage: { // Message
48
+ * // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
49
+ * // Body: "STRING_VALUE",
50
+ * // ImageIconUrl: "STRING_VALUE",
51
+ * // ImageSmallIconUrl: "STRING_VALUE",
52
+ * // ImageUrl: "STRING_VALUE",
53
+ * // JsonBody: "STRING_VALUE",
54
+ * // MediaUrl: "STRING_VALUE",
55
+ * // RawContent: "STRING_VALUE",
56
+ * // SilentPush: true || false,
57
+ * // TimeToLive: Number("int"),
58
+ * // Title: "STRING_VALUE",
59
+ * // Url: "STRING_VALUE",
60
+ * // },
61
+ * // APNSMessage: {
62
+ * // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
63
+ * // Body: "STRING_VALUE",
64
+ * // ImageIconUrl: "STRING_VALUE",
65
+ * // ImageSmallIconUrl: "STRING_VALUE",
66
+ * // ImageUrl: "STRING_VALUE",
67
+ * // JsonBody: "STRING_VALUE",
68
+ * // MediaUrl: "STRING_VALUE",
69
+ * // RawContent: "STRING_VALUE",
70
+ * // SilentPush: true || false,
71
+ * // TimeToLive: Number("int"),
72
+ * // Title: "STRING_VALUE",
73
+ * // Url: "STRING_VALUE",
74
+ * // },
75
+ * // BaiduMessage: {
76
+ * // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
77
+ * // Body: "STRING_VALUE",
78
+ * // ImageIconUrl: "STRING_VALUE",
79
+ * // ImageSmallIconUrl: "STRING_VALUE",
80
+ * // ImageUrl: "STRING_VALUE",
81
+ * // JsonBody: "STRING_VALUE",
82
+ * // MediaUrl: "STRING_VALUE",
83
+ * // RawContent: "STRING_VALUE",
84
+ * // SilentPush: true || false,
85
+ * // TimeToLive: Number("int"),
86
+ * // Title: "STRING_VALUE",
87
+ * // Url: "STRING_VALUE",
88
+ * // },
89
+ * // CustomMessage: { // CampaignCustomMessage
90
+ * // Data: "STRING_VALUE",
91
+ * // },
92
+ * // DefaultMessage: {
93
+ * // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
94
+ * // Body: "STRING_VALUE",
95
+ * // ImageIconUrl: "STRING_VALUE",
96
+ * // ImageSmallIconUrl: "STRING_VALUE",
97
+ * // ImageUrl: "STRING_VALUE",
98
+ * // JsonBody: "STRING_VALUE",
99
+ * // MediaUrl: "STRING_VALUE",
100
+ * // RawContent: "STRING_VALUE",
101
+ * // SilentPush: true || false,
102
+ * // TimeToLive: Number("int"),
103
+ * // Title: "STRING_VALUE",
104
+ * // Url: "STRING_VALUE",
105
+ * // },
106
+ * // EmailMessage: { // CampaignEmailMessage
107
+ * // Body: "STRING_VALUE",
108
+ * // FromAddress: "STRING_VALUE",
109
+ * // HtmlBody: "STRING_VALUE",
110
+ * // Title: "STRING_VALUE",
111
+ * // },
112
+ * // GCMMessage: {
113
+ * // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
114
+ * // Body: "STRING_VALUE",
115
+ * // ImageIconUrl: "STRING_VALUE",
116
+ * // ImageSmallIconUrl: "STRING_VALUE",
117
+ * // ImageUrl: "STRING_VALUE",
118
+ * // JsonBody: "STRING_VALUE",
119
+ * // MediaUrl: "STRING_VALUE",
120
+ * // RawContent: "STRING_VALUE",
121
+ * // SilentPush: true || false,
122
+ * // TimeToLive: Number("int"),
123
+ * // Title: "STRING_VALUE",
124
+ * // Url: "STRING_VALUE",
125
+ * // },
126
+ * // SMSMessage: { // CampaignSmsMessage
127
+ * // Body: "STRING_VALUE",
128
+ * // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
129
+ * // OriginationNumber: "STRING_VALUE",
130
+ * // SenderId: "STRING_VALUE",
131
+ * // EntityId: "STRING_VALUE",
132
+ * // TemplateId: "STRING_VALUE",
133
+ * // },
134
+ * // InAppMessage: { // CampaignInAppMessage
135
+ * // Body: "STRING_VALUE",
136
+ * // Content: [ // ListOfInAppMessageContent
137
+ * // { // InAppMessageContent
138
+ * // BackgroundColor: "STRING_VALUE",
139
+ * // BodyConfig: { // InAppMessageBodyConfig
140
+ * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
141
+ * // Body: "STRING_VALUE", // required
142
+ * // TextColor: "STRING_VALUE", // required
143
+ * // },
144
+ * // HeaderConfig: { // InAppMessageHeaderConfig
145
+ * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
146
+ * // Header: "STRING_VALUE", // required
147
+ * // TextColor: "STRING_VALUE", // required
148
+ * // },
149
+ * // ImageUrl: "STRING_VALUE",
150
+ * // PrimaryBtn: { // InAppMessageButton
151
+ * // Android: { // OverrideButtonConfiguration
152
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
153
+ * // Link: "STRING_VALUE",
154
+ * // },
155
+ * // DefaultConfig: { // DefaultButtonConfiguration
156
+ * // BackgroundColor: "STRING_VALUE",
157
+ * // BorderRadius: Number("int"),
158
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
159
+ * // Link: "STRING_VALUE",
160
+ * // Text: "STRING_VALUE", // required
161
+ * // TextColor: "STRING_VALUE",
162
+ * // },
163
+ * // IOS: {
164
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
165
+ * // Link: "STRING_VALUE",
166
+ * // },
167
+ * // Web: {
168
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
169
+ * // Link: "STRING_VALUE",
170
+ * // },
171
+ * // },
172
+ * // SecondaryBtn: {
173
+ * // Android: {
174
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
175
+ * // Link: "STRING_VALUE",
176
+ * // },
177
+ * // DefaultConfig: {
178
+ * // BackgroundColor: "STRING_VALUE",
179
+ * // BorderRadius: Number("int"),
180
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
181
+ * // Link: "STRING_VALUE",
182
+ * // Text: "STRING_VALUE", // required
183
+ * // TextColor: "STRING_VALUE",
184
+ * // },
185
+ * // IOS: {
186
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
187
+ * // Link: "STRING_VALUE",
188
+ * // },
189
+ * // Web: "<OverrideButtonConfiguration>",
190
+ * // },
191
+ * // },
192
+ * // ],
193
+ * // CustomConfig: { // MapOf__string
194
+ * // "<keys>": "STRING_VALUE",
195
+ * // },
196
+ * // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
197
+ * // },
198
+ * // },
199
+ * // Schedule: { // Schedule
200
+ * // EndTime: "STRING_VALUE",
201
+ * // EventFilter: { // CampaignEventFilter
202
+ * // Dimensions: { // EventDimensions
203
+ * // Attributes: { // MapOfAttributeDimension
204
+ * // "<keys>": { // AttributeDimension
205
+ * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
206
+ * // Values: [ // ListOf__string // required
207
+ * // "STRING_VALUE",
208
+ * // ],
209
+ * // },
210
+ * // },
211
+ * // EventType: { // SetDimension
212
+ * // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
213
+ * // Values: [ // required
214
+ * // "STRING_VALUE",
215
+ * // ],
216
+ * // },
217
+ * // Metrics: { // MapOfMetricDimension
218
+ * // "<keys>": { // MetricDimension
219
+ * // ComparisonOperator: "STRING_VALUE", // required
220
+ * // Value: Number("double"), // required
221
+ * // },
222
+ * // },
223
+ * // },
224
+ * // FilterType: "SYSTEM" || "ENDPOINT", // required
225
+ * // },
226
+ * // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
227
+ * // IsLocalTime: true || false,
228
+ * // QuietTime: { // QuietTime
229
+ * // End: "STRING_VALUE",
230
+ * // Start: "STRING_VALUE",
231
+ * // },
232
+ * // StartTime: "STRING_VALUE", // required
233
+ * // Timezone: "STRING_VALUE",
234
+ * // },
235
+ * // SizePercent: Number("int"), // required
236
+ * // State: { // CampaignState
237
+ * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
238
+ * // },
239
+ * // TemplateConfiguration: { // TemplateConfiguration
240
+ * // EmailTemplate: { // Template
241
+ * // Name: "STRING_VALUE",
242
+ * // Version: "STRING_VALUE",
243
+ * // },
244
+ * // PushTemplate: {
245
+ * // Name: "STRING_VALUE",
246
+ * // Version: "STRING_VALUE",
247
+ * // },
248
+ * // SMSTemplate: {
249
+ * // Name: "STRING_VALUE",
250
+ * // Version: "STRING_VALUE",
251
+ * // },
252
+ * // VoiceTemplate: {
253
+ * // Name: "STRING_VALUE",
254
+ * // Version: "STRING_VALUE",
255
+ * // },
256
+ * // },
257
+ * // TreatmentDescription: "STRING_VALUE",
258
+ * // TreatmentName: "STRING_VALUE",
259
+ * // },
260
+ * // ],
261
+ * // ApplicationId: "STRING_VALUE", // required
262
+ * // Arn: "STRING_VALUE", // required
263
+ * // CreationDate: "STRING_VALUE", // required
264
+ * // CustomDeliveryConfiguration: {
265
+ * // DeliveryUri: "STRING_VALUE", // required
266
+ * // EndpointTypes: [
267
+ * // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
268
+ * // ],
269
+ * // },
270
+ * // DefaultState: {
271
+ * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
272
+ * // },
273
+ * // Description: "STRING_VALUE",
274
+ * // HoldoutPercent: Number("int"),
275
+ * // Hook: { // CampaignHook
276
+ * // LambdaFunctionName: "STRING_VALUE",
277
+ * // Mode: "DELIVERY" || "FILTER",
278
+ * // WebUrl: "STRING_VALUE",
279
+ * // },
280
+ * // Id: "STRING_VALUE", // required
281
+ * // IsPaused: true || false,
282
+ * // LastModifiedDate: "STRING_VALUE", // required
283
+ * // Limits: { // CampaignLimits
284
+ * // Daily: Number("int"),
285
+ * // MaximumDuration: Number("int"),
286
+ * // MessagesPerSecond: Number("int"),
287
+ * // Total: Number("int"),
288
+ * // Session: Number("int"),
289
+ * // },
290
+ * // MessageConfiguration: {
291
+ * // ADMMessage: "<Message>",
292
+ * // APNSMessage: "<Message>",
293
+ * // BaiduMessage: "<Message>",
294
+ * // CustomMessage: {
295
+ * // Data: "STRING_VALUE",
296
+ * // },
297
+ * // DefaultMessage: "<Message>",
298
+ * // EmailMessage: {
299
+ * // Body: "STRING_VALUE",
300
+ * // FromAddress: "STRING_VALUE",
301
+ * // HtmlBody: "STRING_VALUE",
302
+ * // Title: "STRING_VALUE",
303
+ * // },
304
+ * // GCMMessage: "<Message>",
305
+ * // SMSMessage: {
306
+ * // Body: "STRING_VALUE",
307
+ * // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
308
+ * // OriginationNumber: "STRING_VALUE",
309
+ * // SenderId: "STRING_VALUE",
310
+ * // EntityId: "STRING_VALUE",
311
+ * // TemplateId: "STRING_VALUE",
312
+ * // },
313
+ * // InAppMessage: {
314
+ * // Body: "STRING_VALUE",
315
+ * // Content: [
316
+ * // {
317
+ * // BackgroundColor: "STRING_VALUE",
318
+ * // BodyConfig: {
319
+ * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
320
+ * // Body: "STRING_VALUE", // required
321
+ * // TextColor: "STRING_VALUE", // required
322
+ * // },
323
+ * // HeaderConfig: {
324
+ * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
325
+ * // Header: "STRING_VALUE", // required
326
+ * // TextColor: "STRING_VALUE", // required
327
+ * // },
328
+ * // ImageUrl: "STRING_VALUE",
329
+ * // PrimaryBtn: {
330
+ * // Android: "<OverrideButtonConfiguration>",
331
+ * // DefaultConfig: {
332
+ * // BackgroundColor: "STRING_VALUE",
333
+ * // BorderRadius: Number("int"),
334
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
335
+ * // Link: "STRING_VALUE",
336
+ * // Text: "STRING_VALUE", // required
337
+ * // TextColor: "STRING_VALUE",
338
+ * // },
339
+ * // IOS: "<OverrideButtonConfiguration>",
340
+ * // Web: "<OverrideButtonConfiguration>",
341
+ * // },
342
+ * // SecondaryBtn: {
343
+ * // Android: "<OverrideButtonConfiguration>",
344
+ * // DefaultConfig: {
345
+ * // BackgroundColor: "STRING_VALUE",
346
+ * // BorderRadius: Number("int"),
347
+ * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
348
+ * // Link: "STRING_VALUE",
349
+ * // Text: "STRING_VALUE", // required
350
+ * // TextColor: "STRING_VALUE",
351
+ * // },
352
+ * // IOS: "<OverrideButtonConfiguration>",
353
+ * // Web: "<OverrideButtonConfiguration>",
354
+ * // },
355
+ * // },
356
+ * // ],
357
+ * // CustomConfig: {
358
+ * // "<keys>": "STRING_VALUE",
359
+ * // },
360
+ * // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
361
+ * // },
362
+ * // },
363
+ * // Name: "STRING_VALUE",
364
+ * // Schedule: {
365
+ * // EndTime: "STRING_VALUE",
366
+ * // EventFilter: {
367
+ * // Dimensions: {
368
+ * // Attributes: {
369
+ * // "<keys>": {
370
+ * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
371
+ * // Values: "<ListOf__string>", // required
372
+ * // },
373
+ * // },
374
+ * // EventType: {
375
+ * // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
376
+ * // Values: "<ListOf__string>", // required
377
+ * // },
378
+ * // Metrics: {
379
+ * // "<keys>": {
380
+ * // ComparisonOperator: "STRING_VALUE", // required
381
+ * // Value: Number("double"), // required
382
+ * // },
383
+ * // },
384
+ * // },
385
+ * // FilterType: "SYSTEM" || "ENDPOINT", // required
386
+ * // },
387
+ * // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
388
+ * // IsLocalTime: true || false,
389
+ * // QuietTime: {
390
+ * // End: "STRING_VALUE",
391
+ * // Start: "STRING_VALUE",
392
+ * // },
393
+ * // StartTime: "STRING_VALUE", // required
394
+ * // Timezone: "STRING_VALUE",
395
+ * // },
396
+ * // SegmentId: "STRING_VALUE", // required
397
+ * // SegmentVersion: Number("int"), // required
398
+ * // State: {
399
+ * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
400
+ * // },
401
+ * // tags: "<MapOf__string>",
402
+ * // TemplateConfiguration: {
403
+ * // EmailTemplate: {
404
+ * // Name: "STRING_VALUE",
405
+ * // Version: "STRING_VALUE",
406
+ * // },
407
+ * // PushTemplate: "<Template>",
408
+ * // SMSTemplate: "<Template>",
409
+ * // VoiceTemplate: "<Template>",
410
+ * // },
411
+ * // TreatmentDescription: "STRING_VALUE",
412
+ * // TreatmentName: "STRING_VALUE",
413
+ * // Version: Number("int"),
414
+ * // Priority: Number("int"),
415
+ * // },
416
+ * // };
417
+ *
35
418
  * ```
36
419
  *
37
420
  * @param GetCampaignCommandInput - {@link GetCampaignCommandInput}
@@ -61,6 +444,8 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
61
444
  * @throws {@link TooManyRequestsException} (client fault)
62
445
  * <p>Provides information about an API request or response.</p>
63
446
  *
447
+ * @throws {@link PinpointServiceException}
448
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
64
449
  *
65
450
  */
66
451
  export declare class GetCampaignCommand extends $Command<GetCampaignCommandInput, GetCampaignCommandOutput, PinpointClientResolvedConfig> {
@@ -37,6 +37,37 @@ export interface GetCampaignDateRangeKpiCommandOutput extends GetCampaignDateRan
37
37
  * };
38
38
  * const command = new GetCampaignDateRangeKpiCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // GetCampaignDateRangeKpiResponse
41
+ * // CampaignDateRangeKpiResponse: { // CampaignDateRangeKpiResponse
42
+ * // ApplicationId: "STRING_VALUE", // required
43
+ * // CampaignId: "STRING_VALUE", // required
44
+ * // EndTime: new Date("TIMESTAMP"), // 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 GetCampaignDateRangeKpiCommandInput - {@link GetCampaignDateRangeKpiCommandInput}
@@ -66,6 +97,8 @@ export interface GetCampaignDateRangeKpiCommandOutput extends GetCampaignDateRan
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 GetCampaignDateRangeKpiCommand extends $Command<GetCampaignDateRangeKpiCommandInput, GetCampaignDateRangeKpiCommandOutput, PinpointClientResolvedConfig> {