aws-sdk 2.987.0 → 2.991.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 +25 -1
- package/README.md +1 -1
- package/apis/chime-2018-05-01.min.json +148 -139
- package/apis/comprehend-2017-11-27.min.json +114 -97
- package/apis/dms-2016-01-01.min.json +3 -0
- package/apis/ec2-2016-11-15.min.json +48 -48
- package/apis/es-2015-01-01.min.json +14 -4
- package/apis/iot-2015-05-28.min.json +136 -119
- package/apis/kafkaconnect-2021-09-14.examples.json +5 -0
- package/apis/kafkaconnect-2021-09-14.min.json +960 -0
- package/apis/kafkaconnect-2021-09-14.paginators.json +22 -0
- package/apis/macie2-2020-01-01.min.json +159 -108
- package/apis/metadata.json +3 -0
- package/apis/opensearch-2021-01-01.min.json +14 -4
- package/apis/pinpoint-2016-12-01.min.json +719 -329
- package/apis/robomaker-2018-06-29.min.json +138 -86
- package/apis/s3-2006-03-01.examples.json +145 -145
- package/apis/s3-2006-03-01.min.json +80 -78
- package/apis/sagemaker-2017-07-24.min.json +71 -22
- package/apis/transcribe-2017-10-26.min.json +30 -6
- package/apis/wafv2-2019-07-29.min.json +1 -0
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/chime.d.ts +10 -5
- package/clients/comprehend.d.ts +35 -0
- package/clients/dms.d.ts +14 -10
- package/clients/ec2.d.ts +73 -73
- package/clients/es.d.ts +18 -3
- package/clients/iot.d.ts +28 -2
- package/clients/kafkaconnect.d.ts +1132 -0
- package/clients/kafkaconnect.js +18 -0
- package/clients/macie2.d.ts +75 -23
- package/clients/opensearch.d.ts +22 -1
- package/clients/pinpoint.d.ts +408 -4
- package/clients/robomaker.d.ts +85 -4
- package/clients/s3.d.ts +53 -44
- package/clients/sagemaker.d.ts +90 -17
- package/clients/transcribeservice.d.ts +27 -0
- package/clients/wafv2.d.ts +22 -18
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +55 -18
- package/dist/aws-sdk.js +384 -345
- package/dist/aws-sdk.min.js +72 -72
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/pinpoint.d.ts
CHANGED
|
@@ -51,6 +51,14 @@ declare class Pinpoint extends Service {
|
|
|
51
51
|
* Creates an import job for an application.
|
|
52
52
|
*/
|
|
53
53
|
createImportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
|
|
54
|
+
/**
|
|
55
|
+
* Creates a new message template for messages using the in-app message channel.
|
|
56
|
+
*/
|
|
57
|
+
createInAppTemplate(params: Pinpoint.Types.CreateInAppTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateInAppTemplateResponse) => void): Request<Pinpoint.Types.CreateInAppTemplateResponse, AWSError>;
|
|
58
|
+
/**
|
|
59
|
+
* Creates a new message template for messages using the in-app message channel.
|
|
60
|
+
*/
|
|
61
|
+
createInAppTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateInAppTemplateResponse) => void): Request<Pinpoint.Types.CreateInAppTemplateResponse, AWSError>;
|
|
54
62
|
/**
|
|
55
63
|
* Creates a journey for an application.
|
|
56
64
|
*/
|
|
@@ -203,6 +211,14 @@ declare class Pinpoint extends Service {
|
|
|
203
211
|
* Disables the GCM channel for an application and deletes any existing settings for the channel.
|
|
204
212
|
*/
|
|
205
213
|
deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
|
|
214
|
+
/**
|
|
215
|
+
* Deletes a message template for messages sent using the in-app message channel.
|
|
216
|
+
*/
|
|
217
|
+
deleteInAppTemplate(params: Pinpoint.Types.DeleteInAppTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteInAppTemplateResponse) => void): Request<Pinpoint.Types.DeleteInAppTemplateResponse, AWSError>;
|
|
218
|
+
/**
|
|
219
|
+
* Deletes a message template for messages sent using the in-app message channel.
|
|
220
|
+
*/
|
|
221
|
+
deleteInAppTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteInAppTemplateResponse) => void): Request<Pinpoint.Types.DeleteInAppTemplateResponse, AWSError>;
|
|
206
222
|
/**
|
|
207
223
|
* Deletes a journey from an application.
|
|
208
224
|
*/
|
|
@@ -483,6 +499,22 @@ declare class Pinpoint extends Service {
|
|
|
483
499
|
* Retrieves information about the status and settings of all the import jobs for an application.
|
|
484
500
|
*/
|
|
485
501
|
getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
|
|
502
|
+
/**
|
|
503
|
+
* Retrieves the in-app messages targeted for the provided endpoint ID.
|
|
504
|
+
*/
|
|
505
|
+
getInAppMessages(params: Pinpoint.Types.GetInAppMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetInAppMessagesResponse) => void): Request<Pinpoint.Types.GetInAppMessagesResponse, AWSError>;
|
|
506
|
+
/**
|
|
507
|
+
* Retrieves the in-app messages targeted for the provided endpoint ID.
|
|
508
|
+
*/
|
|
509
|
+
getInAppMessages(callback?: (err: AWSError, data: Pinpoint.Types.GetInAppMessagesResponse) => void): Request<Pinpoint.Types.GetInAppMessagesResponse, AWSError>;
|
|
510
|
+
/**
|
|
511
|
+
* Retrieves the content and settings of a message template for messages sent through the in-app channel.
|
|
512
|
+
*/
|
|
513
|
+
getInAppTemplate(params: Pinpoint.Types.GetInAppTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetInAppTemplateResponse) => void): Request<Pinpoint.Types.GetInAppTemplateResponse, AWSError>;
|
|
514
|
+
/**
|
|
515
|
+
* Retrieves the content and settings of a message template for messages sent through the in-app channel.
|
|
516
|
+
*/
|
|
517
|
+
getInAppTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetInAppTemplateResponse) => void): Request<Pinpoint.Types.GetInAppTemplateResponse, AWSError>;
|
|
486
518
|
/**
|
|
487
519
|
* Retrieves information about the status, configuration, and other settings for a journey.
|
|
488
520
|
*/
|
|
@@ -827,6 +859,14 @@ declare class Pinpoint extends Service {
|
|
|
827
859
|
* Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
|
|
828
860
|
*/
|
|
829
861
|
updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
|
|
862
|
+
/**
|
|
863
|
+
* Updates an existing message template for messages sent through the in-app message channel.
|
|
864
|
+
*/
|
|
865
|
+
updateInAppTemplate(params: Pinpoint.Types.UpdateInAppTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateInAppTemplateResponse) => void): Request<Pinpoint.Types.UpdateInAppTemplateResponse, AWSError>;
|
|
866
|
+
/**
|
|
867
|
+
* Updates an existing message template for messages sent through the in-app message channel.
|
|
868
|
+
*/
|
|
869
|
+
updateInAppTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateInAppTemplateResponse) => void): Request<Pinpoint.Types.UpdateInAppTemplateResponse, AWSError>;
|
|
830
870
|
/**
|
|
831
871
|
* Updates the configuration and other settings for a journey.
|
|
832
872
|
*/
|
|
@@ -1604,6 +1644,7 @@ declare namespace Pinpoint {
|
|
|
1604
1644
|
*/
|
|
1605
1645
|
TitleOverride?: __string;
|
|
1606
1646
|
}
|
|
1647
|
+
export type Alignment = "LEFT"|"CENTER"|"RIGHT"|string;
|
|
1607
1648
|
export interface AndroidPushNotificationTemplate {
|
|
1608
1649
|
/**
|
|
1609
1650
|
* The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
|
|
@@ -1867,6 +1908,7 @@ declare namespace Pinpoint {
|
|
|
1867
1908
|
*/
|
|
1868
1909
|
Rows: ListOfResultRow;
|
|
1869
1910
|
}
|
|
1911
|
+
export type ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE"|string;
|
|
1870
1912
|
export interface CampaignCustomMessage {
|
|
1871
1913
|
/**
|
|
1872
1914
|
* The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
|
|
@@ -1945,6 +1987,24 @@ declare namespace Pinpoint {
|
|
|
1945
1987
|
*/
|
|
1946
1988
|
WebUrl?: __string;
|
|
1947
1989
|
}
|
|
1990
|
+
export interface CampaignInAppMessage {
|
|
1991
|
+
/**
|
|
1992
|
+
* The message body of the notification, the email body or the text message.
|
|
1993
|
+
*/
|
|
1994
|
+
Body?: __string;
|
|
1995
|
+
/**
|
|
1996
|
+
* In-app message content.
|
|
1997
|
+
*/
|
|
1998
|
+
Content?: ListOfInAppMessageContent;
|
|
1999
|
+
/**
|
|
2000
|
+
* Custom config to be sent to client.
|
|
2001
|
+
*/
|
|
2002
|
+
CustomConfig?: MapOf__string;
|
|
2003
|
+
/**
|
|
2004
|
+
* In-app message layout.
|
|
2005
|
+
*/
|
|
2006
|
+
Layout?: Layout;
|
|
2007
|
+
}
|
|
1948
2008
|
export interface CampaignLimits {
|
|
1949
2009
|
/**
|
|
1950
2010
|
* The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
|
|
@@ -1962,6 +2022,10 @@ declare namespace Pinpoint {
|
|
|
1962
2022
|
* The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
|
|
1963
2023
|
*/
|
|
1964
2024
|
Total?: __integer;
|
|
2025
|
+
/**
|
|
2026
|
+
* The maximum total number of messages that the campaign can send per user session.
|
|
2027
|
+
*/
|
|
2028
|
+
Session?: __integer;
|
|
1965
2029
|
}
|
|
1966
2030
|
export interface CampaignResponse {
|
|
1967
2031
|
/**
|
|
@@ -2060,6 +2124,10 @@ declare namespace Pinpoint {
|
|
|
2060
2124
|
* The version number of the campaign.
|
|
2061
2125
|
*/
|
|
2062
2126
|
Version?: __integer;
|
|
2127
|
+
/**
|
|
2128
|
+
* Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
|
|
2129
|
+
*/
|
|
2130
|
+
Priority?: __integer;
|
|
2063
2131
|
}
|
|
2064
2132
|
export interface CampaignSmsMessage {
|
|
2065
2133
|
/**
|
|
@@ -2142,7 +2210,7 @@ declare namespace Pinpoint {
|
|
|
2142
2210
|
*/
|
|
2143
2211
|
Version?: __integer;
|
|
2144
2212
|
}
|
|
2145
|
-
export type ChannelType = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
|
|
2213
|
+
export type ChannelType = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP"|string;
|
|
2146
2214
|
export interface ChannelsResponse {
|
|
2147
2215
|
/**
|
|
2148
2216
|
* 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.
|
|
@@ -2233,6 +2301,16 @@ declare namespace Pinpoint {
|
|
|
2233
2301
|
export interface CreateImportJobResponse {
|
|
2234
2302
|
ImportJobResponse: ImportJobResponse;
|
|
2235
2303
|
}
|
|
2304
|
+
export interface CreateInAppTemplateRequest {
|
|
2305
|
+
InAppTemplateRequest: InAppTemplateRequest;
|
|
2306
|
+
/**
|
|
2307
|
+
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
|
|
2308
|
+
*/
|
|
2309
|
+
TemplateName: __string;
|
|
2310
|
+
}
|
|
2311
|
+
export interface CreateInAppTemplateResponse {
|
|
2312
|
+
TemplateCreateMessageBody: TemplateCreateMessageBody;
|
|
2313
|
+
}
|
|
2236
2314
|
export interface CreateJourneyRequest {
|
|
2237
2315
|
/**
|
|
2238
2316
|
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
@@ -2377,6 +2455,32 @@ declare namespace Pinpoint {
|
|
|
2377
2455
|
*/
|
|
2378
2456
|
TemplateVersion?: __string;
|
|
2379
2457
|
}
|
|
2458
|
+
export interface DefaultButtonConfiguration {
|
|
2459
|
+
/**
|
|
2460
|
+
* The background color of the button.
|
|
2461
|
+
*/
|
|
2462
|
+
BackgroundColor?: __string;
|
|
2463
|
+
/**
|
|
2464
|
+
* The border radius of the button.
|
|
2465
|
+
*/
|
|
2466
|
+
BorderRadius?: __integer;
|
|
2467
|
+
/**
|
|
2468
|
+
* Action triggered by the button.
|
|
2469
|
+
*/
|
|
2470
|
+
ButtonAction: ButtonAction;
|
|
2471
|
+
/**
|
|
2472
|
+
* Button destination.
|
|
2473
|
+
*/
|
|
2474
|
+
Link?: __string;
|
|
2475
|
+
/**
|
|
2476
|
+
* Button text.
|
|
2477
|
+
*/
|
|
2478
|
+
Text: __string;
|
|
2479
|
+
/**
|
|
2480
|
+
* The text color of the button.
|
|
2481
|
+
*/
|
|
2482
|
+
TextColor?: __string;
|
|
2483
|
+
}
|
|
2380
2484
|
export interface DefaultMessage {
|
|
2381
2485
|
/**
|
|
2382
2486
|
* The default body of the message.
|
|
@@ -2568,6 +2672,19 @@ declare namespace Pinpoint {
|
|
|
2568
2672
|
export interface DeleteGcmChannelResponse {
|
|
2569
2673
|
GCMChannelResponse: GCMChannelResponse;
|
|
2570
2674
|
}
|
|
2675
|
+
export interface DeleteInAppTemplateRequest {
|
|
2676
|
+
/**
|
|
2677
|
+
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
|
|
2678
|
+
*/
|
|
2679
|
+
TemplateName: __string;
|
|
2680
|
+
/**
|
|
2681
|
+
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
|
|
2682
|
+
*/
|
|
2683
|
+
Version?: __string;
|
|
2684
|
+
}
|
|
2685
|
+
export interface DeleteInAppTemplateResponse {
|
|
2686
|
+
MessageBody: MessageBody;
|
|
2687
|
+
}
|
|
2571
2688
|
export interface DeleteJourneyRequest {
|
|
2572
2689
|
/**
|
|
2573
2690
|
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
@@ -3470,7 +3587,7 @@ declare namespace Pinpoint {
|
|
|
3470
3587
|
}
|
|
3471
3588
|
export type FilterType = "SYSTEM"|"ENDPOINT"|string;
|
|
3472
3589
|
export type Format = "CSV"|"JSON"|string;
|
|
3473
|
-
export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string;
|
|
3590
|
+
export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|"IN_APP_EVENT"|string;
|
|
3474
3591
|
export interface GCMChannelRequest {
|
|
3475
3592
|
/**
|
|
3476
3593
|
* The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
|
|
@@ -3975,6 +4092,32 @@ declare namespace Pinpoint {
|
|
|
3975
4092
|
export interface GetImportJobsResponse {
|
|
3976
4093
|
ImportJobsResponse: ImportJobsResponse;
|
|
3977
4094
|
}
|
|
4095
|
+
export interface GetInAppMessagesRequest {
|
|
4096
|
+
/**
|
|
4097
|
+
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
4098
|
+
*/
|
|
4099
|
+
ApplicationId: __string;
|
|
4100
|
+
/**
|
|
4101
|
+
* The unique identifier for the endpoint.
|
|
4102
|
+
*/
|
|
4103
|
+
EndpointId: __string;
|
|
4104
|
+
}
|
|
4105
|
+
export interface GetInAppMessagesResponse {
|
|
4106
|
+
InAppMessagesResponse: InAppMessagesResponse;
|
|
4107
|
+
}
|
|
4108
|
+
export interface GetInAppTemplateRequest {
|
|
4109
|
+
/**
|
|
4110
|
+
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
|
|
4111
|
+
*/
|
|
4112
|
+
TemplateName: __string;
|
|
4113
|
+
/**
|
|
4114
|
+
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
|
|
4115
|
+
*/
|
|
4116
|
+
Version?: __string;
|
|
4117
|
+
}
|
|
4118
|
+
export interface GetInAppTemplateResponse {
|
|
4119
|
+
InAppTemplateResponse: InAppTemplateResponse;
|
|
4120
|
+
}
|
|
3978
4121
|
export interface GetJourneyDateRangeKpiRequest {
|
|
3979
4122
|
/**
|
|
3980
4123
|
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
@@ -4411,6 +4554,214 @@ declare namespace Pinpoint {
|
|
|
4411
4554
|
*/
|
|
4412
4555
|
NextToken?: __string;
|
|
4413
4556
|
}
|
|
4557
|
+
export interface InAppCampaignSchedule {
|
|
4558
|
+
/**
|
|
4559
|
+
* The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
|
|
4560
|
+
*/
|
|
4561
|
+
EndDate?: __string;
|
|
4562
|
+
/**
|
|
4563
|
+
* The event filter the SDK has to use to show the in-app message in the application.
|
|
4564
|
+
*/
|
|
4565
|
+
EventFilter?: CampaignEventFilter;
|
|
4566
|
+
/**
|
|
4567
|
+
* Time during which the in-app message should not be shown to the user.
|
|
4568
|
+
*/
|
|
4569
|
+
QuietTime?: QuietTime;
|
|
4570
|
+
}
|
|
4571
|
+
export interface InAppMessage {
|
|
4572
|
+
/**
|
|
4573
|
+
* In-app message content.
|
|
4574
|
+
*/
|
|
4575
|
+
Content?: ListOfInAppMessageContent;
|
|
4576
|
+
/**
|
|
4577
|
+
* Custom config to be sent to SDK.
|
|
4578
|
+
*/
|
|
4579
|
+
CustomConfig?: MapOf__string;
|
|
4580
|
+
/**
|
|
4581
|
+
* The layout of the message.
|
|
4582
|
+
*/
|
|
4583
|
+
Layout?: Layout;
|
|
4584
|
+
}
|
|
4585
|
+
export interface InAppMessageBodyConfig {
|
|
4586
|
+
/**
|
|
4587
|
+
* The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
|
|
4588
|
+
*/
|
|
4589
|
+
Alignment: Alignment;
|
|
4590
|
+
/**
|
|
4591
|
+
* Message Body.
|
|
4592
|
+
*/
|
|
4593
|
+
Body: __string;
|
|
4594
|
+
/**
|
|
4595
|
+
* The text color.
|
|
4596
|
+
*/
|
|
4597
|
+
TextColor: __string;
|
|
4598
|
+
}
|
|
4599
|
+
export interface InAppMessageButton {
|
|
4600
|
+
/**
|
|
4601
|
+
* Default button content.
|
|
4602
|
+
*/
|
|
4603
|
+
Android?: OverrideButtonConfiguration;
|
|
4604
|
+
/**
|
|
4605
|
+
* Default button content.
|
|
4606
|
+
*/
|
|
4607
|
+
DefaultConfig?: DefaultButtonConfiguration;
|
|
4608
|
+
/**
|
|
4609
|
+
* Default button content.
|
|
4610
|
+
*/
|
|
4611
|
+
IOS?: OverrideButtonConfiguration;
|
|
4612
|
+
/**
|
|
4613
|
+
* Default button content.
|
|
4614
|
+
*/
|
|
4615
|
+
Web?: OverrideButtonConfiguration;
|
|
4616
|
+
}
|
|
4617
|
+
export interface InAppMessageCampaign {
|
|
4618
|
+
/**
|
|
4619
|
+
* Campaign id of the corresponding campaign.
|
|
4620
|
+
*/
|
|
4621
|
+
CampaignId?: __string;
|
|
4622
|
+
/**
|
|
4623
|
+
* Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
|
|
4624
|
+
*/
|
|
4625
|
+
DailyCap?: __integer;
|
|
4626
|
+
/**
|
|
4627
|
+
* In-app message content with all fields required for rendering an in-app message.
|
|
4628
|
+
*/
|
|
4629
|
+
InAppMessage?: InAppMessage;
|
|
4630
|
+
/**
|
|
4631
|
+
* Priority of the in-app message.
|
|
4632
|
+
*/
|
|
4633
|
+
Priority?: __integer;
|
|
4634
|
+
/**
|
|
4635
|
+
* Schedule of the campaign.
|
|
4636
|
+
*/
|
|
4637
|
+
Schedule?: InAppCampaignSchedule;
|
|
4638
|
+
/**
|
|
4639
|
+
* Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
|
|
4640
|
+
*/
|
|
4641
|
+
SessionCap?: __integer;
|
|
4642
|
+
/**
|
|
4643
|
+
* Total cap which controls the number of times an in-app message can be shown to the endpoint.
|
|
4644
|
+
*/
|
|
4645
|
+
TotalCap?: __integer;
|
|
4646
|
+
/**
|
|
4647
|
+
* Treatment id of the campaign.
|
|
4648
|
+
*/
|
|
4649
|
+
TreatmentId?: __string;
|
|
4650
|
+
}
|
|
4651
|
+
export interface InAppMessageContent {
|
|
4652
|
+
/**
|
|
4653
|
+
* The background color for the message.
|
|
4654
|
+
*/
|
|
4655
|
+
BackgroundColor?: __string;
|
|
4656
|
+
/**
|
|
4657
|
+
* The configuration for the message body.
|
|
4658
|
+
*/
|
|
4659
|
+
BodyConfig?: InAppMessageBodyConfig;
|
|
4660
|
+
/**
|
|
4661
|
+
* The configuration for the message header.
|
|
4662
|
+
*/
|
|
4663
|
+
HeaderConfig?: InAppMessageHeaderConfig;
|
|
4664
|
+
/**
|
|
4665
|
+
* The image url for the background of message.
|
|
4666
|
+
*/
|
|
4667
|
+
ImageUrl?: __string;
|
|
4668
|
+
/**
|
|
4669
|
+
* The first button inside the message.
|
|
4670
|
+
*/
|
|
4671
|
+
PrimaryBtn?: InAppMessageButton;
|
|
4672
|
+
/**
|
|
4673
|
+
* The second button inside message.
|
|
4674
|
+
*/
|
|
4675
|
+
SecondaryBtn?: InAppMessageButton;
|
|
4676
|
+
}
|
|
4677
|
+
export interface InAppMessageHeaderConfig {
|
|
4678
|
+
/**
|
|
4679
|
+
* The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
|
|
4680
|
+
*/
|
|
4681
|
+
Alignment: Alignment;
|
|
4682
|
+
/**
|
|
4683
|
+
* Message Header.
|
|
4684
|
+
*/
|
|
4685
|
+
Header: __string;
|
|
4686
|
+
/**
|
|
4687
|
+
* The text color.
|
|
4688
|
+
*/
|
|
4689
|
+
TextColor: __string;
|
|
4690
|
+
}
|
|
4691
|
+
export interface InAppMessagesResponse {
|
|
4692
|
+
/**
|
|
4693
|
+
* List of targeted in-app message campaigns.
|
|
4694
|
+
*/
|
|
4695
|
+
InAppMessageCampaigns?: ListOfInAppMessageCampaign;
|
|
4696
|
+
}
|
|
4697
|
+
export interface InAppTemplateRequest {
|
|
4698
|
+
/**
|
|
4699
|
+
* The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
|
|
4700
|
+
*/
|
|
4701
|
+
Content?: ListOfInAppMessageContent;
|
|
4702
|
+
/**
|
|
4703
|
+
* Custom config to be sent to client.
|
|
4704
|
+
*/
|
|
4705
|
+
CustomConfig?: MapOf__string;
|
|
4706
|
+
/**
|
|
4707
|
+
* The layout of the message.
|
|
4708
|
+
*/
|
|
4709
|
+
Layout?: Layout;
|
|
4710
|
+
/**
|
|
4711
|
+
* 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.
|
|
4712
|
+
*/
|
|
4713
|
+
tags?: MapOf__string;
|
|
4714
|
+
/**
|
|
4715
|
+
* The description of the template.
|
|
4716
|
+
*/
|
|
4717
|
+
TemplateDescription?: __string;
|
|
4718
|
+
}
|
|
4719
|
+
export interface InAppTemplateResponse {
|
|
4720
|
+
/**
|
|
4721
|
+
* The resource arn of the template.
|
|
4722
|
+
*/
|
|
4723
|
+
Arn?: __string;
|
|
4724
|
+
/**
|
|
4725
|
+
* The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
|
|
4726
|
+
*/
|
|
4727
|
+
Content?: ListOfInAppMessageContent;
|
|
4728
|
+
/**
|
|
4729
|
+
* The creation date of the template.
|
|
4730
|
+
*/
|
|
4731
|
+
CreationDate: __string;
|
|
4732
|
+
/**
|
|
4733
|
+
* Custom config to be sent to client.
|
|
4734
|
+
*/
|
|
4735
|
+
CustomConfig?: MapOf__string;
|
|
4736
|
+
/**
|
|
4737
|
+
* The last modified date of the template.
|
|
4738
|
+
*/
|
|
4739
|
+
LastModifiedDate: __string;
|
|
4740
|
+
/**
|
|
4741
|
+
* The layout of the message.
|
|
4742
|
+
*/
|
|
4743
|
+
Layout?: Layout;
|
|
4744
|
+
/**
|
|
4745
|
+
* 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.
|
|
4746
|
+
*/
|
|
4747
|
+
tags?: MapOf__string;
|
|
4748
|
+
/**
|
|
4749
|
+
* The description of the template.
|
|
4750
|
+
*/
|
|
4751
|
+
TemplateDescription?: __string;
|
|
4752
|
+
/**
|
|
4753
|
+
* The name of the template.
|
|
4754
|
+
*/
|
|
4755
|
+
TemplateName: __string;
|
|
4756
|
+
/**
|
|
4757
|
+
* The type of the template.
|
|
4758
|
+
*/
|
|
4759
|
+
TemplateType: TemplateType;
|
|
4760
|
+
/**
|
|
4761
|
+
* The version id of the template.
|
|
4762
|
+
*/
|
|
4763
|
+
Version?: __string;
|
|
4764
|
+
}
|
|
4414
4765
|
export type Include = "ALL"|"ANY"|"NONE"|string;
|
|
4415
4766
|
export interface ItemResponse {
|
|
4416
4767
|
/**
|
|
@@ -4660,6 +5011,7 @@ declare namespace Pinpoint {
|
|
|
4660
5011
|
*/
|
|
4661
5012
|
NextToken?: __string;
|
|
4662
5013
|
}
|
|
5014
|
+
export type Layout = "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL"|string;
|
|
4663
5015
|
export interface ListJourneysRequest {
|
|
4664
5016
|
/**
|
|
4665
5017
|
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
@@ -4831,6 +5183,10 @@ declare namespace Pinpoint {
|
|
|
4831
5183
|
* The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
|
|
4832
5184
|
*/
|
|
4833
5185
|
SMSMessage?: CampaignSmsMessage;
|
|
5186
|
+
/**
|
|
5187
|
+
* The in-app message configuration.
|
|
5188
|
+
*/
|
|
5189
|
+
InAppMessage?: CampaignInAppMessage;
|
|
4834
5190
|
}
|
|
4835
5191
|
export interface MessageRequest {
|
|
4836
5192
|
/**
|
|
@@ -5004,6 +5360,16 @@ declare namespace Pinpoint {
|
|
|
5004
5360
|
ZipCode?: __string;
|
|
5005
5361
|
}
|
|
5006
5362
|
export type Operator = "ALL"|"ANY"|string;
|
|
5363
|
+
export interface OverrideButtonConfiguration {
|
|
5364
|
+
/**
|
|
5365
|
+
* Action triggered by the button.
|
|
5366
|
+
*/
|
|
5367
|
+
ButtonAction: ButtonAction;
|
|
5368
|
+
/**
|
|
5369
|
+
* Button destination.
|
|
5370
|
+
*/
|
|
5371
|
+
Link?: __string;
|
|
5372
|
+
}
|
|
5007
5373
|
export interface PhoneNumberValidateRequest {
|
|
5008
5374
|
NumberValidateRequest: NumberValidateRequest;
|
|
5009
5375
|
}
|
|
@@ -5936,6 +6302,20 @@ declare namespace Pinpoint {
|
|
|
5936
6302
|
*/
|
|
5937
6303
|
VoiceTemplate?: Template;
|
|
5938
6304
|
}
|
|
6305
|
+
export interface TemplateCreateMessageBody {
|
|
6306
|
+
/**
|
|
6307
|
+
* The Amazon Resource Name (ARN) of the message template that was created.
|
|
6308
|
+
*/
|
|
6309
|
+
Arn?: __string;
|
|
6310
|
+
/**
|
|
6311
|
+
* The message that's returned from the API for the request to create the message template.
|
|
6312
|
+
*/
|
|
6313
|
+
Message?: __string;
|
|
6314
|
+
/**
|
|
6315
|
+
* The unique identifier for the request to create the message template.
|
|
6316
|
+
*/
|
|
6317
|
+
RequestID?: __string;
|
|
6318
|
+
}
|
|
5939
6319
|
export interface TemplateResponse {
|
|
5940
6320
|
/**
|
|
5941
6321
|
* The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
|
|
@@ -5974,7 +6354,7 @@ declare namespace Pinpoint {
|
|
|
5974
6354
|
*/
|
|
5975
6355
|
Version?: __string;
|
|
5976
6356
|
}
|
|
5977
|
-
export type TemplateType = "EMAIL"|"SMS"|"VOICE"|"PUSH"|string;
|
|
6357
|
+
export type TemplateType = "EMAIL"|"SMS"|"VOICE"|"PUSH"|"INAPP"|string;
|
|
5978
6358
|
export interface TemplateVersionResponse {
|
|
5979
6359
|
/**
|
|
5980
6360
|
* The date, in ISO 8601 format, when the version of the message template was created.
|
|
@@ -6234,6 +6614,24 @@ declare namespace Pinpoint {
|
|
|
6234
6614
|
export interface UpdateGcmChannelResponse {
|
|
6235
6615
|
GCMChannelResponse: GCMChannelResponse;
|
|
6236
6616
|
}
|
|
6617
|
+
export interface UpdateInAppTemplateRequest {
|
|
6618
|
+
/**
|
|
6619
|
+
* Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
|
|
6620
|
+
*/
|
|
6621
|
+
CreateNewVersion?: __boolean;
|
|
6622
|
+
InAppTemplateRequest: InAppTemplateRequest;
|
|
6623
|
+
/**
|
|
6624
|
+
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
|
|
6625
|
+
*/
|
|
6626
|
+
TemplateName: __string;
|
|
6627
|
+
/**
|
|
6628
|
+
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
|
|
6629
|
+
*/
|
|
6630
|
+
Version?: __string;
|
|
6631
|
+
}
|
|
6632
|
+
export interface UpdateInAppTemplateResponse {
|
|
6633
|
+
MessageBody: MessageBody;
|
|
6634
|
+
}
|
|
6237
6635
|
export interface UpdateJourneyRequest {
|
|
6238
6636
|
/**
|
|
6239
6637
|
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
|
|
@@ -6662,6 +7060,10 @@ declare namespace Pinpoint {
|
|
|
6662
7060
|
* A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
|
|
6663
7061
|
*/
|
|
6664
7062
|
TreatmentName?: __string;
|
|
7063
|
+
/**
|
|
7064
|
+
* Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
|
|
7065
|
+
*/
|
|
7066
|
+
Priority?: __integer;
|
|
6665
7067
|
}
|
|
6666
7068
|
export interface WriteEventStream {
|
|
6667
7069
|
/**
|
|
@@ -6781,7 +7183,7 @@ declare namespace Pinpoint {
|
|
|
6781
7183
|
*/
|
|
6782
7184
|
TreatmentName?: __string;
|
|
6783
7185
|
}
|
|
6784
|
-
export type __EndpointTypesElement = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
|
|
7186
|
+
export type __EndpointTypesElement = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP"|string;
|
|
6785
7187
|
export type __boolean = boolean;
|
|
6786
7188
|
export type __double = number;
|
|
6787
7189
|
export type __integer = number;
|
|
@@ -6792,6 +7194,8 @@ declare namespace Pinpoint {
|
|
|
6792
7194
|
export type ListOfEndpointResponse = EndpointResponse[];
|
|
6793
7195
|
export type ListOfExportJobResponse = ExportJobResponse[];
|
|
6794
7196
|
export type ListOfImportJobResponse = ImportJobResponse[];
|
|
7197
|
+
export type ListOfInAppMessageCampaign = InAppMessageCampaign[];
|
|
7198
|
+
export type ListOfInAppMessageContent = InAppMessageContent[];
|
|
6795
7199
|
export type ListOfJourneyResponse = JourneyResponse[];
|
|
6796
7200
|
export type ListOfMultiConditionalBranch = MultiConditionalBranch[];
|
|
6797
7201
|
export type ListOfRandomSplitEntry = RandomSplitEntry[];
|