@aws-sdk/client-pinpoint 3.100.0 → 3.105.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/CHANGELOG.md +11 -0
- package/dist-cjs/PinpointClient.js +2 -0
- package/dist-es/PinpointClient.js +2 -0
- package/dist-types/models/models_0.d.ts +59 -177
- package/dist-types/models/models_1.d.ts +19 -59
- package/dist-types/ts3.4/models/models_0.d.ts +59 -177
- package/dist-types/ts3.4/models/models_1.d.ts +19 -59
- package/package.json +4 -3
|
@@ -179,9 +179,7 @@ export interface EventDimensions {
|
|
|
179
179
|
/**
|
|
180
180
|
* <p>One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.</p>
|
|
181
181
|
*/
|
|
182
|
-
Attributes?:
|
|
183
|
-
[key: string]: AttributeDimension;
|
|
184
|
-
};
|
|
182
|
+
Attributes?: Record<string, AttributeDimension>;
|
|
185
183
|
/**
|
|
186
184
|
* <p>The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
|
|
187
185
|
*/
|
|
@@ -189,9 +187,7 @@ export interface EventDimensions {
|
|
|
189
187
|
/**
|
|
190
188
|
* <p>One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.</p>
|
|
191
189
|
*/
|
|
192
|
-
Metrics?:
|
|
193
|
-
[key: string]: MetricDimension;
|
|
194
|
-
};
|
|
190
|
+
Metrics?: Record<string, MetricDimension>;
|
|
195
191
|
}
|
|
196
192
|
export declare namespace EventDimensions {
|
|
197
193
|
/**
|
|
@@ -376,9 +372,7 @@ export interface SegmentDimensions {
|
|
|
376
372
|
/**
|
|
377
373
|
* <p>One or more custom attributes to use as criteria for the segment.</p>
|
|
378
374
|
*/
|
|
379
|
-
Attributes?:
|
|
380
|
-
[key: string]: AttributeDimension;
|
|
381
|
-
};
|
|
375
|
+
Attributes?: Record<string, AttributeDimension>;
|
|
382
376
|
/**
|
|
383
377
|
* <p>The behavior-based criteria, such as how recently users have used your app, for the segment.</p>
|
|
384
378
|
*/
|
|
@@ -394,15 +388,11 @@ export interface SegmentDimensions {
|
|
|
394
388
|
/**
|
|
395
389
|
* <p>One or more custom metrics to use as criteria for the segment.</p>
|
|
396
390
|
*/
|
|
397
|
-
Metrics?:
|
|
398
|
-
[key: string]: MetricDimension;
|
|
399
|
-
};
|
|
391
|
+
Metrics?: Record<string, MetricDimension>;
|
|
400
392
|
/**
|
|
401
393
|
* <p>One or more custom user attributes to use as criteria for the segment.</p>
|
|
402
394
|
*/
|
|
403
|
-
UserAttributes?:
|
|
404
|
-
[key: string]: AttributeDimension;
|
|
405
|
-
};
|
|
395
|
+
UserAttributes?: Record<string, AttributeDimension>;
|
|
406
396
|
}
|
|
407
397
|
export declare namespace SegmentDimensions {
|
|
408
398
|
/**
|
|
@@ -909,9 +899,7 @@ export interface AddressConfiguration {
|
|
|
909
899
|
/**
|
|
910
900
|
* <p>An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>
|
|
911
901
|
*/
|
|
912
|
-
Context?:
|
|
913
|
-
[key: string]: string;
|
|
914
|
-
};
|
|
902
|
+
Context?: Record<string, string>;
|
|
915
903
|
/**
|
|
916
904
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.</p>
|
|
917
905
|
*/
|
|
@@ -919,9 +907,7 @@ export interface AddressConfiguration {
|
|
|
919
907
|
/**
|
|
920
908
|
* <p>A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.</p>
|
|
921
909
|
*/
|
|
922
|
-
Substitutions?:
|
|
923
|
-
[key: string]: string[];
|
|
924
|
-
};
|
|
910
|
+
Substitutions?: Record<string, string[]>;
|
|
925
911
|
/**
|
|
926
912
|
* <p>The message title to use instead of the default message title. This value overrides the default message title.</p>
|
|
927
913
|
*/
|
|
@@ -1026,9 +1012,7 @@ export interface ADMMessage {
|
|
|
1026
1012
|
/**
|
|
1027
1013
|
* <p>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.</p>
|
|
1028
1014
|
*/
|
|
1029
|
-
Data?:
|
|
1030
|
-
[key: string]: string;
|
|
1031
|
-
};
|
|
1015
|
+
Data?: Record<string, string>;
|
|
1032
1016
|
/**
|
|
1033
1017
|
* <p>The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.</p>
|
|
1034
1018
|
*/
|
|
@@ -1068,9 +1052,7 @@ export interface ADMMessage {
|
|
|
1068
1052
|
/**
|
|
1069
1053
|
* <p>The default message variables to use in the notification message. You can override the default variables with individual address variables.</p>
|
|
1070
1054
|
*/
|
|
1071
|
-
Substitutions?:
|
|
1072
|
-
[key: string]: string[];
|
|
1073
|
-
};
|
|
1055
|
+
Substitutions?: Record<string, string[]>;
|
|
1074
1056
|
/**
|
|
1075
1057
|
* <p>The title to display above the notification message on the recipient's device.</p>
|
|
1076
1058
|
*/
|
|
@@ -1271,9 +1253,7 @@ export interface APNSMessage {
|
|
|
1271
1253
|
/**
|
|
1272
1254
|
* <p>The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.</p>
|
|
1273
1255
|
*/
|
|
1274
|
-
Data?:
|
|
1275
|
-
[key: string]: string;
|
|
1276
|
-
};
|
|
1256
|
+
Data?: Record<string, string>;
|
|
1277
1257
|
/**
|
|
1278
1258
|
* <p>The URL of an image or video to display in the push notification.</p>
|
|
1279
1259
|
*/
|
|
@@ -1301,9 +1281,7 @@ export interface APNSMessage {
|
|
|
1301
1281
|
/**
|
|
1302
1282
|
* <p>The default message variables to use in the notification message. You can override these default variables with individual address variables.</p>
|
|
1303
1283
|
*/
|
|
1304
|
-
Substitutions?:
|
|
1305
|
-
[key: string]: string[];
|
|
1306
|
-
};
|
|
1284
|
+
Substitutions?: Record<string, string[]>;
|
|
1307
1285
|
/**
|
|
1308
1286
|
* <p>The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.</p>
|
|
1309
1287
|
*/
|
|
@@ -1783,9 +1761,7 @@ export interface ApplicationResponse {
|
|
|
1783
1761
|
/**
|
|
1784
1762
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.</p>
|
|
1785
1763
|
*/
|
|
1786
|
-
tags?:
|
|
1787
|
-
[key: string]: string;
|
|
1788
|
-
};
|
|
1764
|
+
tags?: Record<string, string>;
|
|
1789
1765
|
/**
|
|
1790
1766
|
* <p>The date and time when the Application was created.</p>
|
|
1791
1767
|
*/
|
|
@@ -2059,9 +2035,7 @@ export interface BaiduMessage {
|
|
|
2059
2035
|
/**
|
|
2060
2036
|
* <p>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.</p>
|
|
2061
2037
|
*/
|
|
2062
|
-
Data?:
|
|
2063
|
-
[key: string]: string;
|
|
2064
|
-
};
|
|
2038
|
+
Data?: Record<string, string>;
|
|
2065
2039
|
/**
|
|
2066
2040
|
* <p>The icon image name of the asset saved in your app.</p>
|
|
2067
2041
|
*/
|
|
@@ -2093,9 +2067,7 @@ export interface BaiduMessage {
|
|
|
2093
2067
|
/**
|
|
2094
2068
|
* <p>The default message variables to use in the notification message. You can override the default variables with individual address variables.</p>
|
|
2095
2069
|
*/
|
|
2096
|
-
Substitutions?:
|
|
2097
|
-
[key: string]: string[];
|
|
2098
|
-
};
|
|
2070
|
+
Substitutions?: Record<string, string[]>;
|
|
2099
2071
|
/**
|
|
2100
2072
|
* <p>The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).</p>
|
|
2101
2073
|
*/
|
|
@@ -2409,9 +2381,7 @@ export interface CampaignInAppMessage {
|
|
|
2409
2381
|
/**
|
|
2410
2382
|
* <p>Custom config to be sent to client.</p>
|
|
2411
2383
|
*/
|
|
2412
|
-
CustomConfig?:
|
|
2413
|
-
[key: string]: string;
|
|
2414
|
-
};
|
|
2384
|
+
CustomConfig?: Record<string, string>;
|
|
2415
2385
|
/**
|
|
2416
2386
|
* <p>In-app message layout.</p>
|
|
2417
2387
|
*/
|
|
@@ -2834,9 +2804,7 @@ export interface CampaignResponse {
|
|
|
2834
2804
|
/**
|
|
2835
2805
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.</p>
|
|
2836
2806
|
*/
|
|
2837
|
-
tags?:
|
|
2838
|
-
[key: string]: string;
|
|
2839
|
-
};
|
|
2807
|
+
tags?: Record<string, string>;
|
|
2840
2808
|
/**
|
|
2841
2809
|
* <p>The message template that’s used for the campaign.</p>
|
|
2842
2810
|
*/
|
|
@@ -2937,9 +2905,7 @@ export interface ChannelsResponse {
|
|
|
2937
2905
|
/**
|
|
2938
2906
|
* <p>A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.</p>
|
|
2939
2907
|
*/
|
|
2940
|
-
Channels:
|
|
2941
|
-
[key: string]: ChannelResponse;
|
|
2942
|
-
} | undefined;
|
|
2908
|
+
Channels: Record<string, ChannelResponse> | undefined;
|
|
2943
2909
|
}
|
|
2944
2910
|
export declare namespace ChannelsResponse {
|
|
2945
2911
|
/**
|
|
@@ -2977,9 +2943,7 @@ export interface CreateApplicationRequest {
|
|
|
2977
2943
|
/**
|
|
2978
2944
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.</p>
|
|
2979
2945
|
*/
|
|
2980
|
-
tags?:
|
|
2981
|
-
[key: string]: string;
|
|
2982
|
-
};
|
|
2946
|
+
tags?: Record<string, string>;
|
|
2983
2947
|
}
|
|
2984
2948
|
export declare namespace CreateApplicationRequest {
|
|
2985
2949
|
/**
|
|
@@ -3219,9 +3183,7 @@ export interface WriteCampaignRequest {
|
|
|
3219
3183
|
/**
|
|
3220
3184
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.</p>
|
|
3221
3185
|
*/
|
|
3222
|
-
tags?:
|
|
3223
|
-
[key: string]: string;
|
|
3224
|
-
};
|
|
3186
|
+
tags?: Record<string, string>;
|
|
3225
3187
|
/**
|
|
3226
3188
|
* <p>The message template to use for the campaign.</p>
|
|
3227
3189
|
*/
|
|
@@ -3296,9 +3258,7 @@ export interface EmailTemplateRequest {
|
|
|
3296
3258
|
/**
|
|
3297
3259
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
3298
3260
|
*/
|
|
3299
|
-
tags?:
|
|
3300
|
-
[key: string]: string;
|
|
3301
|
-
};
|
|
3261
|
+
tags?: Record<string, string>;
|
|
3302
3262
|
/**
|
|
3303
3263
|
* <p>A custom description of the message template.</p>
|
|
3304
3264
|
*/
|
|
@@ -3713,9 +3673,7 @@ export interface InAppTemplateRequest {
|
|
|
3713
3673
|
/**
|
|
3714
3674
|
* <p>Custom config to be sent to client.</p>
|
|
3715
3675
|
*/
|
|
3716
|
-
CustomConfig?:
|
|
3717
|
-
[key: string]: string;
|
|
3718
|
-
};
|
|
3676
|
+
CustomConfig?: Record<string, string>;
|
|
3719
3677
|
/**
|
|
3720
3678
|
* <p>The layout of the message.</p>
|
|
3721
3679
|
*/
|
|
@@ -3723,9 +3681,7 @@ export interface InAppTemplateRequest {
|
|
|
3723
3681
|
/**
|
|
3724
3682
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
3725
3683
|
*/
|
|
3726
|
-
tags?:
|
|
3727
|
-
[key: string]: string;
|
|
3728
|
-
};
|
|
3684
|
+
tags?: Record<string, string>;
|
|
3729
3685
|
/**
|
|
3730
3686
|
* <p>The description of the template.</p>
|
|
3731
3687
|
*/
|
|
@@ -3935,9 +3891,7 @@ export interface WriteJourneyRequest {
|
|
|
3935
3891
|
/**
|
|
3936
3892
|
* <p>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.</p>
|
|
3937
3893
|
*/
|
|
3938
|
-
Activities?:
|
|
3939
|
-
[key: string]: Activity;
|
|
3940
|
-
};
|
|
3894
|
+
Activities?: Record<string, Activity>;
|
|
3941
3895
|
/**
|
|
3942
3896
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|
3943
3897
|
*/
|
|
@@ -4024,9 +3978,7 @@ export interface JourneyResponse {
|
|
|
4024
3978
|
/**
|
|
4025
3979
|
* <p>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.</p>
|
|
4026
3980
|
*/
|
|
4027
|
-
Activities?:
|
|
4028
|
-
[key: string]: Activity;
|
|
4029
|
-
};
|
|
3981
|
+
Activities?: Record<string, Activity>;
|
|
4030
3982
|
/**
|
|
4031
3983
|
* <p>The unique identifier for the application that the journey applies to.</p>
|
|
4032
3984
|
*/
|
|
@@ -4082,9 +4034,7 @@ export interface JourneyResponse {
|
|
|
4082
4034
|
/**
|
|
4083
4035
|
* <p>This object is not used or supported.</p>
|
|
4084
4036
|
*/
|
|
4085
|
-
tags?:
|
|
4086
|
-
[key: string]: string;
|
|
4087
|
-
};
|
|
4037
|
+
tags?: Record<string, string>;
|
|
4088
4038
|
/**
|
|
4089
4039
|
* <p>Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.</p>
|
|
4090
4040
|
*/
|
|
@@ -4182,9 +4132,7 @@ export interface PushNotificationTemplateRequest {
|
|
|
4182
4132
|
/**
|
|
4183
4133
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
4184
4134
|
*/
|
|
4185
|
-
tags?:
|
|
4186
|
-
[key: string]: string;
|
|
4187
|
-
};
|
|
4135
|
+
tags?: Record<string, string>;
|
|
4188
4136
|
/**
|
|
4189
4137
|
* <p>A custom description of the message template.</p>
|
|
4190
4138
|
*/
|
|
@@ -4231,9 +4179,7 @@ export interface CreateRecommenderConfigurationShape {
|
|
|
4231
4179
|
/**
|
|
4232
4180
|
* <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
|
|
4233
4181
|
*/
|
|
4234
|
-
Attributes?:
|
|
4235
|
-
[key: string]: string;
|
|
4236
|
-
};
|
|
4182
|
+
Attributes?: Record<string, string>;
|
|
4237
4183
|
/**
|
|
4238
4184
|
* <p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</p>
|
|
4239
4185
|
*/
|
|
@@ -4292,9 +4238,7 @@ export interface RecommenderConfigurationResponse {
|
|
|
4292
4238
|
/**
|
|
4293
4239
|
* <p>A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
|
|
4294
4240
|
*/
|
|
4295
|
-
Attributes?:
|
|
4296
|
-
[key: string]: string;
|
|
4297
|
-
};
|
|
4241
|
+
Attributes?: Record<string, string>;
|
|
4298
4242
|
/**
|
|
4299
4243
|
* <p>The date, in extended ISO 8601 format, when the configuration was created for the recommender model.</p>
|
|
4300
4244
|
*/
|
|
@@ -4457,9 +4401,7 @@ export interface WriteSegmentRequest {
|
|
|
4457
4401
|
/**
|
|
4458
4402
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.</p>
|
|
4459
4403
|
*/
|
|
4460
|
-
tags?:
|
|
4461
|
-
[key: string]: string;
|
|
4462
|
-
};
|
|
4404
|
+
tags?: Record<string, string>;
|
|
4463
4405
|
}
|
|
4464
4406
|
export declare namespace WriteSegmentRequest {
|
|
4465
4407
|
/**
|
|
@@ -4490,9 +4432,7 @@ export interface SegmentImportResource {
|
|
|
4490
4432
|
/**
|
|
4491
4433
|
* <p>The number of channel types in the endpoint definitions that were imported to create the segment.</p>
|
|
4492
4434
|
*/
|
|
4493
|
-
ChannelCounts?:
|
|
4494
|
-
[key: string]: number;
|
|
4495
|
-
};
|
|
4435
|
+
ChannelCounts?: Record<string, number>;
|
|
4496
4436
|
/**
|
|
4497
4437
|
* <p>(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.</p>
|
|
4498
4438
|
*/
|
|
@@ -4571,9 +4511,7 @@ export interface SegmentResponse {
|
|
|
4571
4511
|
/**
|
|
4572
4512
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.</p>
|
|
4573
4513
|
*/
|
|
4574
|
-
tags?:
|
|
4575
|
-
[key: string]: string;
|
|
4576
|
-
};
|
|
4514
|
+
tags?: Record<string, string>;
|
|
4577
4515
|
/**
|
|
4578
4516
|
* <p>The version number of the segment.</p>
|
|
4579
4517
|
*/
|
|
@@ -4616,9 +4554,7 @@ export interface SMSTemplateRequest {
|
|
|
4616
4554
|
/**
|
|
4617
4555
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
4618
4556
|
*/
|
|
4619
|
-
tags?:
|
|
4620
|
-
[key: string]: string;
|
|
4621
|
-
};
|
|
4557
|
+
tags?: Record<string, string>;
|
|
4622
4558
|
/**
|
|
4623
4559
|
* <p>A custom description of the message template.</p>
|
|
4624
4560
|
*/
|
|
@@ -4677,9 +4613,7 @@ export interface VoiceTemplateRequest {
|
|
|
4677
4613
|
/**
|
|
4678
4614
|
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
4679
4615
|
*/
|
|
4680
|
-
tags?:
|
|
4681
|
-
[key: string]: string;
|
|
4682
|
-
};
|
|
4616
|
+
tags?: Record<string, string>;
|
|
4683
4617
|
/**
|
|
4684
4618
|
* <p>A custom description of the message template.</p>
|
|
4685
4619
|
*/
|
|
@@ -4734,9 +4668,7 @@ export interface DefaultMessage {
|
|
|
4734
4668
|
/**
|
|
4735
4669
|
* <p>The default message variables to use in the message. You can override these default variables with individual address variables.</p>
|
|
4736
4670
|
*/
|
|
4737
|
-
Substitutions?:
|
|
4738
|
-
[key: string]: string[];
|
|
4739
|
-
};
|
|
4671
|
+
Substitutions?: Record<string, string[]>;
|
|
4740
4672
|
}
|
|
4741
4673
|
export declare namespace DefaultMessage {
|
|
4742
4674
|
/**
|
|
@@ -4759,9 +4691,7 @@ export interface DefaultPushNotificationMessage {
|
|
|
4759
4691
|
/**
|
|
4760
4692
|
* <p>The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.</p>
|
|
4761
4693
|
*/
|
|
4762
|
-
Data?:
|
|
4763
|
-
[key: string]: string;
|
|
4764
|
-
};
|
|
4694
|
+
Data?: Record<string, string>;
|
|
4765
4695
|
/**
|
|
4766
4696
|
* <p>Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.</p>
|
|
4767
4697
|
*/
|
|
@@ -4769,9 +4699,7 @@ export interface DefaultPushNotificationMessage {
|
|
|
4769
4699
|
/**
|
|
4770
4700
|
* <p>The default message variables to use in the notification message. You can override the default variables with individual address variables.</p>
|
|
4771
4701
|
*/
|
|
4772
|
-
Substitutions?:
|
|
4773
|
-
[key: string]: string[];
|
|
4774
|
-
};
|
|
4702
|
+
Substitutions?: Record<string, string[]>;
|
|
4775
4703
|
/**
|
|
4776
4704
|
* <p>The default title to display above the notification message on a recipient's device.</p>
|
|
4777
4705
|
*/
|
|
@@ -5226,9 +5154,7 @@ export interface EndpointUser {
|
|
|
5226
5154
|
/**
|
|
5227
5155
|
* <p>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>
|
|
5228
5156
|
*/
|
|
5229
|
-
UserAttributes?:
|
|
5230
|
-
[key: string]: string[];
|
|
5231
|
-
};
|
|
5157
|
+
UserAttributes?: Record<string, string[]>;
|
|
5232
5158
|
/**
|
|
5233
5159
|
* <p>The unique identifier for the user.</p>
|
|
5234
5160
|
*/
|
|
@@ -5255,9 +5181,7 @@ export interface EndpointResponse {
|
|
|
5255
5181
|
/**
|
|
5256
5182
|
* <p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.</p>
|
|
5257
5183
|
*/
|
|
5258
|
-
Attributes?:
|
|
5259
|
-
[key: string]: string[];
|
|
5260
|
-
};
|
|
5184
|
+
Attributes?: Record<string, string[]>;
|
|
5261
5185
|
/**
|
|
5262
5186
|
* <p>The channel that's used when sending messages or push notifications to the endpoint.</p>
|
|
5263
5187
|
*/
|
|
@@ -5293,9 +5217,7 @@ export interface EndpointResponse {
|
|
|
5293
5217
|
/**
|
|
5294
5218
|
* <p>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.</p>
|
|
5295
5219
|
*/
|
|
5296
|
-
Metrics?:
|
|
5297
|
-
[key: string]: number;
|
|
5298
|
-
};
|
|
5220
|
+
Metrics?: Record<string, number>;
|
|
5299
5221
|
/**
|
|
5300
5222
|
* <p>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.</p>
|
|
5301
5223
|
*/
|
|
@@ -5965,9 +5887,7 @@ export interface EmailMessage {
|
|
|
5965
5887
|
/**
|
|
5966
5888
|
* <p>The default message variables to use in the email message. You can override the default variables with individual address variables.</p>
|
|
5967
5889
|
*/
|
|
5968
|
-
Substitutions?:
|
|
5969
|
-
[key: string]: string[];
|
|
5970
|
-
};
|
|
5890
|
+
Substitutions?: Record<string, string[]>;
|
|
5971
5891
|
}
|
|
5972
5892
|
export declare namespace EmailMessage {
|
|
5973
5893
|
/**
|
|
@@ -5994,9 +5914,7 @@ export interface GCMMessage {
|
|
|
5994
5914
|
/**
|
|
5995
5915
|
* <p>The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.</p>
|
|
5996
5916
|
*/
|
|
5997
|
-
Data?:
|
|
5998
|
-
[key: string]: string;
|
|
5999
|
-
};
|
|
5917
|
+
Data?: Record<string, string>;
|
|
6000
5918
|
/**
|
|
6001
5919
|
* <p>The icon image name of the asset saved in your app.</p>
|
|
6002
5920
|
*/
|
|
@@ -6036,9 +5954,7 @@ export interface GCMMessage {
|
|
|
6036
5954
|
/**
|
|
6037
5955
|
* <p>The default message variables to use in the notification message. You can override the default variables with individual address variables.</p>
|
|
6038
5956
|
*/
|
|
6039
|
-
Substitutions?:
|
|
6040
|
-
[key: string]: string[];
|
|
6041
|
-
};
|
|
5957
|
+
Substitutions?: Record<string, string[]>;
|
|
6042
5958
|
/**
|
|
6043
5959
|
* <p>The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).</p> <p>Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.</p>
|
|
6044
5960
|
*/
|
|
@@ -6089,9 +6005,7 @@ export interface SMSMessage {
|
|
|
6089
6005
|
/**
|
|
6090
6006
|
* <p>The message variables to use in the SMS message. You can override the default variables with individual address variables.</p>
|
|
6091
6007
|
*/
|
|
6092
|
-
Substitutions?:
|
|
6093
|
-
[key: string]: string[];
|
|
6094
|
-
};
|
|
6008
|
+
Substitutions?: Record<string, string[]>;
|
|
6095
6009
|
/**
|
|
6096
6010
|
* <p>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</p>
|
|
6097
6011
|
*/
|
|
@@ -6126,9 +6040,7 @@ export interface VoiceMessage {
|
|
|
6126
6040
|
/**
|
|
6127
6041
|
* <p>The default message variables to use in the voice message. You can override the default variables with individual address variables.</p>
|
|
6128
6042
|
*/
|
|
6129
|
-
Substitutions?:
|
|
6130
|
-
[key: string]: string[];
|
|
6131
|
-
};
|
|
6043
|
+
Substitutions?: Record<string, string[]>;
|
|
6132
6044
|
/**
|
|
6133
6045
|
* <p>The name of the voice to use when delivering the message. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
|
|
6134
6046
|
*/
|
|
@@ -6260,9 +6172,7 @@ export interface EmailTemplateResponse {
|
|
|
6260
6172
|
/**
|
|
6261
6173
|
* <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
6262
6174
|
*/
|
|
6263
|
-
tags?:
|
|
6264
|
-
[key: string]: string;
|
|
6265
|
-
};
|
|
6175
|
+
tags?: Record<string, string>;
|
|
6266
6176
|
/**
|
|
6267
6177
|
* <p>The custom description of the message template.</p>
|
|
6268
6178
|
*/
|
|
@@ -6301,9 +6211,7 @@ export interface EndpointBatchItem {
|
|
|
6301
6211
|
/**
|
|
6302
6212
|
* <p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>
|
|
6303
6213
|
*/
|
|
6304
|
-
Attributes?:
|
|
6305
|
-
[key: string]: string[];
|
|
6306
|
-
};
|
|
6214
|
+
Attributes?: Record<string, string[]>;
|
|
6307
6215
|
/**
|
|
6308
6216
|
* <p>The channel to use when sending messages or push notifications to the endpoint.</p>
|
|
6309
6217
|
*/
|
|
@@ -6331,9 +6239,7 @@ export interface EndpointBatchItem {
|
|
|
6331
6239
|
/**
|
|
6332
6240
|
* <p>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.</p>
|
|
6333
6241
|
*/
|
|
6334
|
-
Metrics?:
|
|
6335
|
-
[key: string]: number;
|
|
6336
|
-
};
|
|
6242
|
+
Metrics?: Record<string, number>;
|
|
6337
6243
|
/**
|
|
6338
6244
|
* <p>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.</p>
|
|
6339
6245
|
*/
|
|
@@ -6433,9 +6339,7 @@ export interface EndpointRequest {
|
|
|
6433
6339
|
/**
|
|
6434
6340
|
* <p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>
|
|
6435
6341
|
*/
|
|
6436
|
-
Attributes?:
|
|
6437
|
-
[key: string]: string[];
|
|
6438
|
-
};
|
|
6342
|
+
Attributes?: Record<string, string[]>;
|
|
6439
6343
|
/**
|
|
6440
6344
|
* <p>The channel to use when sending messages or push notifications to the endpoint.</p>
|
|
6441
6345
|
*/
|
|
@@ -6459,9 +6363,7 @@ export interface EndpointRequest {
|
|
|
6459
6363
|
/**
|
|
6460
6364
|
* <p>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.</p>
|
|
6461
6365
|
*/
|
|
6462
|
-
Metrics?:
|
|
6463
|
-
[key: string]: number;
|
|
6464
|
-
};
|
|
6366
|
+
Metrics?: Record<string, number>;
|
|
6465
6367
|
/**
|
|
6466
6368
|
* <p>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.</p>
|
|
6467
6369
|
*/
|
|
@@ -6492,9 +6394,7 @@ export interface EndpointSendConfiguration {
|
|
|
6492
6394
|
/**
|
|
6493
6395
|
* <p>A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>
|
|
6494
6396
|
*/
|
|
6495
|
-
Context?:
|
|
6496
|
-
[key: string]: string;
|
|
6497
|
-
};
|
|
6397
|
+
Context?: Record<string, string>;
|
|
6498
6398
|
/**
|
|
6499
6399
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.</p>
|
|
6500
6400
|
*/
|
|
@@ -6502,9 +6402,7 @@ export interface EndpointSendConfiguration {
|
|
|
6502
6402
|
/**
|
|
6503
6403
|
* <p>A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.</p>
|
|
6504
6404
|
*/
|
|
6505
|
-
Substitutions?:
|
|
6506
|
-
[key: string]: string[];
|
|
6507
|
-
};
|
|
6405
|
+
Substitutions?: Record<string, string[]>;
|
|
6508
6406
|
/**
|
|
6509
6407
|
* <p>The title or subject line of the message. If specified, this value overrides the default message title or subject line.</p>
|
|
6510
6408
|
*/
|
|
@@ -6562,9 +6460,7 @@ export interface Event {
|
|
|
6562
6460
|
/**
|
|
6563
6461
|
* <p>One or more custom attributes that are associated with the event.</p>
|
|
6564
6462
|
*/
|
|
6565
|
-
Attributes?:
|
|
6566
|
-
[key: string]: string;
|
|
6567
|
-
};
|
|
6463
|
+
Attributes?: Record<string, string>;
|
|
6568
6464
|
/**
|
|
6569
6465
|
* <p>The version of the SDK that's running on the client device.</p>
|
|
6570
6466
|
*/
|
|
@@ -6576,9 +6472,7 @@ export interface Event {
|
|
|
6576
6472
|
/**
|
|
6577
6473
|
* <p>One or more custom metrics that are associated with the event.</p>
|
|
6578
6474
|
*/
|
|
6579
|
-
Metrics?:
|
|
6580
|
-
[key: string]: number;
|
|
6581
|
-
};
|
|
6475
|
+
Metrics?: Record<string, number>;
|
|
6582
6476
|
/**
|
|
6583
6477
|
* <p>The name of the SDK that's being used to record the event.</p>
|
|
6584
6478
|
*/
|
|
@@ -6628,9 +6522,7 @@ export interface PublicEndpoint {
|
|
|
6628
6522
|
/**
|
|
6629
6523
|
* <p>One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.</p>
|
|
6630
6524
|
*/
|
|
6631
|
-
Attributes?:
|
|
6632
|
-
[key: string]: string[];
|
|
6633
|
-
};
|
|
6525
|
+
Attributes?: Record<string, string[]>;
|
|
6634
6526
|
/**
|
|
6635
6527
|
* <p>The channel that's used when sending messages or push notifications to the endpoint.</p>
|
|
6636
6528
|
*/
|
|
@@ -6654,9 +6546,7 @@ export interface PublicEndpoint {
|
|
|
6654
6546
|
/**
|
|
6655
6547
|
* <p>One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.</p>
|
|
6656
6548
|
*/
|
|
6657
|
-
Metrics?:
|
|
6658
|
-
[key: string]: number;
|
|
6659
|
-
};
|
|
6549
|
+
Metrics?: Record<string, number>;
|
|
6660
6550
|
/**
|
|
6661
6551
|
* <p>Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.</p>
|
|
6662
6552
|
*/
|
|
@@ -6687,9 +6577,7 @@ export interface EventsBatch {
|
|
|
6687
6577
|
/**
|
|
6688
6578
|
* <p>A set of properties that are associated with the event.</p>
|
|
6689
6579
|
*/
|
|
6690
|
-
Events:
|
|
6691
|
-
[key: string]: Event;
|
|
6692
|
-
} | undefined;
|
|
6580
|
+
Events: Record<string, Event> | undefined;
|
|
6693
6581
|
}
|
|
6694
6582
|
export declare namespace EventsBatch {
|
|
6695
6583
|
/**
|
|
@@ -6704,9 +6592,7 @@ export interface EventsRequest {
|
|
|
6704
6592
|
/**
|
|
6705
6593
|
* <p>The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.</p>
|
|
6706
6594
|
*/
|
|
6707
|
-
BatchItem:
|
|
6708
|
-
[key: string]: EventsBatch;
|
|
6709
|
-
} | undefined;
|
|
6595
|
+
BatchItem: Record<string, EventsBatch> | undefined;
|
|
6710
6596
|
}
|
|
6711
6597
|
export declare namespace EventsRequest {
|
|
6712
6598
|
/**
|
|
@@ -6725,9 +6611,7 @@ export interface ItemResponse {
|
|
|
6725
6611
|
/**
|
|
6726
6612
|
* <p>A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.</p>
|
|
6727
6613
|
*/
|
|
6728
|
-
EventsItemResponse?:
|
|
6729
|
-
[key: string]: EventItemResponse;
|
|
6730
|
-
};
|
|
6614
|
+
EventsItemResponse?: Record<string, EventItemResponse>;
|
|
6731
6615
|
}
|
|
6732
6616
|
export declare namespace ItemResponse {
|
|
6733
6617
|
/**
|
|
@@ -6742,9 +6626,7 @@ export interface EventsResponse {
|
|
|
6742
6626
|
/**
|
|
6743
6627
|
* <p>A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.</p>
|
|
6744
6628
|
*/
|
|
6745
|
-
Results?:
|
|
6746
|
-
[key: string]: ItemResponse;
|
|
6747
|
-
};
|
|
6629
|
+
Results?: Record<string, ItemResponse>;
|
|
6748
6630
|
}
|
|
6749
6631
|
export declare namespace EventsResponse {
|
|
6750
6632
|
/**
|