@aws-sdk/client-pinpoint 3.36.0 → 3.39.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 +42 -0
- package/dist-cjs/Pinpoint.js +0 -3
- package/dist-cjs/PinpointClient.js +0 -8
- package/dist-cjs/commands/CreateAppCommand.js +0 -24
- package/dist-cjs/commands/CreateCampaignCommand.js +0 -24
- package/dist-cjs/commands/CreateEmailTemplateCommand.js +0 -24
- package/dist-cjs/commands/CreateExportJobCommand.js +0 -24
- package/dist-cjs/commands/CreateImportJobCommand.js +0 -24
- package/dist-cjs/commands/CreateInAppTemplateCommand.js +0 -24
- package/dist-cjs/commands/CreateJourneyCommand.js +0 -24
- package/dist-cjs/commands/CreatePushTemplateCommand.js +0 -24
- package/dist-cjs/commands/CreateRecommenderConfigurationCommand.js +0 -24
- package/dist-cjs/commands/CreateSegmentCommand.js +0 -24
- package/dist-cjs/commands/CreateSmsTemplateCommand.js +0 -24
- package/dist-cjs/commands/CreateVoiceTemplateCommand.js +0 -24
- package/dist-cjs/commands/DeleteAdmChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteApnsChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteApnsSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteApnsVoipChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteApnsVoipSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteAppCommand.js +0 -24
- package/dist-cjs/commands/DeleteBaiduChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteCampaignCommand.js +0 -24
- package/dist-cjs/commands/DeleteEmailChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteEmailTemplateCommand.js +0 -24
- package/dist-cjs/commands/DeleteEndpointCommand.js +0 -24
- package/dist-cjs/commands/DeleteEventStreamCommand.js +0 -24
- package/dist-cjs/commands/DeleteGcmChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteInAppTemplateCommand.js +0 -24
- package/dist-cjs/commands/DeleteJourneyCommand.js +0 -24
- package/dist-cjs/commands/DeletePushTemplateCommand.js +0 -24
- package/dist-cjs/commands/DeleteRecommenderConfigurationCommand.js +0 -24
- package/dist-cjs/commands/DeleteSegmentCommand.js +0 -24
- package/dist-cjs/commands/DeleteSmsChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteSmsTemplateCommand.js +0 -24
- package/dist-cjs/commands/DeleteUserEndpointsCommand.js +0 -24
- package/dist-cjs/commands/DeleteVoiceChannelCommand.js +0 -24
- package/dist-cjs/commands/DeleteVoiceTemplateCommand.js +0 -24
- package/dist-cjs/commands/GetAdmChannelCommand.js +0 -24
- package/dist-cjs/commands/GetApnsChannelCommand.js +0 -24
- package/dist-cjs/commands/GetApnsSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/GetApnsVoipChannelCommand.js +0 -24
- package/dist-cjs/commands/GetApnsVoipSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/GetAppCommand.js +0 -24
- package/dist-cjs/commands/GetApplicationDateRangeKpiCommand.js +0 -24
- package/dist-cjs/commands/GetApplicationSettingsCommand.js +0 -24
- package/dist-cjs/commands/GetAppsCommand.js +0 -24
- package/dist-cjs/commands/GetBaiduChannelCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignActivitiesCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignDateRangeKpiCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignVersionCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignVersionsCommand.js +0 -24
- package/dist-cjs/commands/GetCampaignsCommand.js +0 -24
- package/dist-cjs/commands/GetChannelsCommand.js +0 -24
- package/dist-cjs/commands/GetEmailChannelCommand.js +0 -24
- package/dist-cjs/commands/GetEmailTemplateCommand.js +0 -24
- package/dist-cjs/commands/GetEndpointCommand.js +0 -24
- package/dist-cjs/commands/GetEventStreamCommand.js +0 -24
- package/dist-cjs/commands/GetExportJobCommand.js +0 -24
- package/dist-cjs/commands/GetExportJobsCommand.js +0 -24
- package/dist-cjs/commands/GetGcmChannelCommand.js +0 -24
- package/dist-cjs/commands/GetImportJobCommand.js +0 -24
- package/dist-cjs/commands/GetImportJobsCommand.js +0 -24
- package/dist-cjs/commands/GetInAppMessagesCommand.js +0 -24
- package/dist-cjs/commands/GetInAppTemplateCommand.js +0 -24
- package/dist-cjs/commands/GetJourneyCommand.js +0 -24
- package/dist-cjs/commands/GetJourneyDateRangeKpiCommand.js +0 -24
- package/dist-cjs/commands/GetJourneyExecutionActivityMetricsCommand.js +0 -24
- package/dist-cjs/commands/GetJourneyExecutionMetricsCommand.js +0 -24
- package/dist-cjs/commands/GetPushTemplateCommand.js +0 -24
- package/dist-cjs/commands/GetRecommenderConfigurationCommand.js +0 -24
- package/dist-cjs/commands/GetRecommenderConfigurationsCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentExportJobsCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentImportJobsCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentVersionCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentVersionsCommand.js +0 -24
- package/dist-cjs/commands/GetSegmentsCommand.js +0 -24
- package/dist-cjs/commands/GetSmsChannelCommand.js +0 -24
- package/dist-cjs/commands/GetSmsTemplateCommand.js +0 -24
- package/dist-cjs/commands/GetUserEndpointsCommand.js +0 -24
- package/dist-cjs/commands/GetVoiceChannelCommand.js +0 -24
- package/dist-cjs/commands/GetVoiceTemplateCommand.js +0 -24
- package/dist-cjs/commands/ListJourneysCommand.js +0 -24
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
- package/dist-cjs/commands/ListTemplateVersionsCommand.js +0 -24
- package/dist-cjs/commands/ListTemplatesCommand.js +0 -24
- package/dist-cjs/commands/PhoneNumberValidateCommand.js +0 -24
- package/dist-cjs/commands/PutEventStreamCommand.js +0 -24
- package/dist-cjs/commands/PutEventsCommand.js +0 -24
- package/dist-cjs/commands/RemoveAttributesCommand.js +0 -24
- package/dist-cjs/commands/SendMessagesCommand.js +0 -24
- package/dist-cjs/commands/SendUsersMessagesCommand.js +0 -24
- package/dist-cjs/commands/TagResourceCommand.js +0 -24
- package/dist-cjs/commands/UntagResourceCommand.js +0 -24
- package/dist-cjs/commands/UpdateAdmChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateApnsChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateApnsSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateApnsVoipChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateApnsVoipSandboxChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateApplicationSettingsCommand.js +0 -24
- package/dist-cjs/commands/UpdateBaiduChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateCampaignCommand.js +0 -24
- package/dist-cjs/commands/UpdateEmailChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateEmailTemplateCommand.js +0 -24
- package/dist-cjs/commands/UpdateEndpointCommand.js +0 -24
- package/dist-cjs/commands/UpdateEndpointsBatchCommand.js +0 -24
- package/dist-cjs/commands/UpdateGcmChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateInAppTemplateCommand.js +0 -24
- package/dist-cjs/commands/UpdateJourneyCommand.js +0 -24
- package/dist-cjs/commands/UpdateJourneyStateCommand.js +0 -24
- package/dist-cjs/commands/UpdatePushTemplateCommand.js +0 -24
- package/dist-cjs/commands/UpdateRecommenderConfigurationCommand.js +0 -24
- package/dist-cjs/commands/UpdateSegmentCommand.js +0 -24
- package/dist-cjs/commands/UpdateSmsChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateSmsTemplateCommand.js +0 -24
- package/dist-cjs/commands/UpdateTemplateActiveVersionCommand.js +0 -24
- package/dist-cjs/commands/UpdateVoiceChannelCommand.js +0 -24
- package/dist-cjs/commands/UpdateVoiceTemplateCommand.js +0 -24
- package/dist-cjs/commands/index.js +120 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +3 -119
- package/dist-cjs/models/models_0.js +0 -825
- package/dist-cjs/models/models_1.js +0 -480
- package/dist-cjs/protocols/Aws_restJson1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-es/commands/index.js +117 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +3 -119
- package/dist-types/commands/index.d.ts +117 -0
- package/dist-types/index.d.ts +3 -119
- package/dist-types/ts3.4/Pinpoint.d.ts +118 -354
- package/dist-types/ts3.4/PinpointClient.d.ts +24 -89
- package/dist-types/ts3.4/commands/CreateAppCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateEmailTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateExportJobCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateImportJobCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateInAppTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateJourneyCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreatePushTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateRecommenderConfigurationCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateSegmentCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateSmsTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreateVoiceTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteAdmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteApnsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteApnsSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteApnsVoipChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteBaiduChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteEmailChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteEmailTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteEndpointCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteEventStreamCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteGcmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteInAppTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteJourneyCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeletePushTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteRecommenderConfigurationCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteSegmentCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteSmsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteSmsTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteUserEndpointsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteVoiceChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteVoiceTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetAdmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApnsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApnsSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApnsVoipChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApnsVoipSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetAppCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApplicationDateRangeKpiCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetApplicationSettingsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetAppsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetBaiduChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignActivitiesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignDateRangeKpiCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetCampaignsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetJourneyDateRangeKpiCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetJourneyExecutionMetricsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetPushTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetRecommenderConfigurationCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetRecommenderConfigurationsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentExportJobsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentImportJobsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentVersionCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentVersionsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSegmentsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSmsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetSmsTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetUserEndpointsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetVoiceChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetVoiceTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListJourneysCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/PhoneNumberValidateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/PutEventStreamCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/RemoveAttributesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/SendMessagesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/SendUsersMessagesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateAdmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateApnsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateApnsSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateApnsVoipChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateApplicationSettingsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateBaiduChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateEmailChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateEmailTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateEndpointCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateEndpointsBatchCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateGcmChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateInAppTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateJourneyCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateJourneyStateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdatePushTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateRecommenderConfigurationCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateSegmentCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateSmsChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateSmsTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateTemplateActiveVersionCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateVoiceChannelCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/UpdateVoiceTemplateCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/index.d.ts +117 -0
- package/dist-types/ts3.4/index.d.ts +3 -119
- package/dist-types/ts3.4/models/models_0.d.ts +1523 -4579
- package/dist-types/ts3.4/models/models_1.d.ts +591 -1776
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +32 -32
|
@@ -1,2095 +1,1256 @@
|
|
|
1
1
|
import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignEventFilter, CampaignHook, CampaignLimits, CampaignResponse, DefaultPushNotificationTemplate, DeliveryStatus, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EmailTemplateResponse, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointResponse, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobResponse, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobResponse, InAppMessageContent, InAppTemplateRequest, JourneyResponse, Layout, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, State, TemplateConfiguration, TemplateType, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
|
|
2
2
|
export interface GetEmailTemplateResponse {
|
|
3
|
-
|
|
4
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
|
|
5
|
-
*/
|
|
3
|
+
|
|
6
4
|
EmailTemplateResponse: EmailTemplateResponse | undefined;
|
|
7
5
|
}
|
|
8
6
|
export declare namespace GetEmailTemplateResponse {
|
|
9
|
-
|
|
10
|
-
* @internal
|
|
11
|
-
*/
|
|
7
|
+
|
|
12
8
|
const filterSensitiveLog: (obj: GetEmailTemplateResponse) => any;
|
|
13
9
|
}
|
|
14
10
|
export interface GetEndpointRequest {
|
|
15
|
-
|
|
16
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
17
|
-
*/
|
|
11
|
+
|
|
18
12
|
ApplicationId: string | undefined;
|
|
19
|
-
|
|
20
|
-
* <p>The unique identifier for the endpoint.</p>
|
|
21
|
-
*/
|
|
13
|
+
|
|
22
14
|
EndpointId: string | undefined;
|
|
23
15
|
}
|
|
24
16
|
export declare namespace GetEndpointRequest {
|
|
25
|
-
|
|
26
|
-
* @internal
|
|
27
|
-
*/
|
|
17
|
+
|
|
28
18
|
const filterSensitiveLog: (obj: GetEndpointRequest) => any;
|
|
29
19
|
}
|
|
30
20
|
export interface GetEndpointResponse {
|
|
31
|
-
|
|
32
|
-
* <p>Provides information about the channel type and other settings for an endpoint.</p>
|
|
33
|
-
*/
|
|
21
|
+
|
|
34
22
|
EndpointResponse: EndpointResponse | undefined;
|
|
35
23
|
}
|
|
36
24
|
export declare namespace GetEndpointResponse {
|
|
37
|
-
|
|
38
|
-
* @internal
|
|
39
|
-
*/
|
|
25
|
+
|
|
40
26
|
const filterSensitiveLog: (obj: GetEndpointResponse) => any;
|
|
41
27
|
}
|
|
42
28
|
export interface GetEventStreamRequest {
|
|
43
|
-
|
|
44
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
45
|
-
*/
|
|
29
|
+
|
|
46
30
|
ApplicationId: string | undefined;
|
|
47
31
|
}
|
|
48
32
|
export declare namespace GetEventStreamRequest {
|
|
49
|
-
|
|
50
|
-
* @internal
|
|
51
|
-
*/
|
|
33
|
+
|
|
52
34
|
const filterSensitiveLog: (obj: GetEventStreamRequest) => any;
|
|
53
35
|
}
|
|
54
36
|
export interface GetEventStreamResponse {
|
|
55
|
-
|
|
56
|
-
* <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
57
|
-
*/
|
|
37
|
+
|
|
58
38
|
EventStream: EventStream | undefined;
|
|
59
39
|
}
|
|
60
40
|
export declare namespace GetEventStreamResponse {
|
|
61
|
-
|
|
62
|
-
* @internal
|
|
63
|
-
*/
|
|
41
|
+
|
|
64
42
|
const filterSensitiveLog: (obj: GetEventStreamResponse) => any;
|
|
65
43
|
}
|
|
66
44
|
export interface GetExportJobRequest {
|
|
67
|
-
|
|
68
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
69
|
-
*/
|
|
45
|
+
|
|
70
46
|
ApplicationId: string | undefined;
|
|
71
|
-
|
|
72
|
-
* <p>The unique identifier for the job.</p>
|
|
73
|
-
*/
|
|
47
|
+
|
|
74
48
|
JobId: string | undefined;
|
|
75
49
|
}
|
|
76
50
|
export declare namespace GetExportJobRequest {
|
|
77
|
-
|
|
78
|
-
* @internal
|
|
79
|
-
*/
|
|
51
|
+
|
|
80
52
|
const filterSensitiveLog: (obj: GetExportJobRequest) => any;
|
|
81
53
|
}
|
|
82
54
|
export interface GetExportJobResponse {
|
|
83
|
-
|
|
84
|
-
* <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
|
|
85
|
-
*/
|
|
55
|
+
|
|
86
56
|
ExportJobResponse: ExportJobResponse | undefined;
|
|
87
57
|
}
|
|
88
58
|
export declare namespace GetExportJobResponse {
|
|
89
|
-
|
|
90
|
-
* @internal
|
|
91
|
-
*/
|
|
59
|
+
|
|
92
60
|
const filterSensitiveLog: (obj: GetExportJobResponse) => any;
|
|
93
61
|
}
|
|
94
62
|
export interface GetExportJobsRequest {
|
|
95
|
-
|
|
96
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
97
|
-
*/
|
|
63
|
+
|
|
98
64
|
ApplicationId: string | undefined;
|
|
99
|
-
|
|
100
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
101
|
-
*/
|
|
65
|
+
|
|
102
66
|
PageSize?: string;
|
|
103
|
-
|
|
104
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
105
|
-
*/
|
|
67
|
+
|
|
106
68
|
Token?: string;
|
|
107
69
|
}
|
|
108
70
|
export declare namespace GetExportJobsRequest {
|
|
109
|
-
|
|
110
|
-
* @internal
|
|
111
|
-
*/
|
|
71
|
+
|
|
112
72
|
const filterSensitiveLog: (obj: GetExportJobsRequest) => any;
|
|
113
73
|
}
|
|
114
74
|
export interface GetExportJobsResponse {
|
|
115
|
-
|
|
116
|
-
* <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
|
|
117
|
-
*/
|
|
75
|
+
|
|
118
76
|
ExportJobsResponse: ExportJobsResponse | undefined;
|
|
119
77
|
}
|
|
120
78
|
export declare namespace GetExportJobsResponse {
|
|
121
|
-
|
|
122
|
-
* @internal
|
|
123
|
-
*/
|
|
79
|
+
|
|
124
80
|
const filterSensitiveLog: (obj: GetExportJobsResponse) => any;
|
|
125
81
|
}
|
|
126
82
|
export interface GetGcmChannelRequest {
|
|
127
|
-
|
|
128
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
129
|
-
*/
|
|
83
|
+
|
|
130
84
|
ApplicationId: string | undefined;
|
|
131
85
|
}
|
|
132
86
|
export declare namespace GetGcmChannelRequest {
|
|
133
|
-
|
|
134
|
-
* @internal
|
|
135
|
-
*/
|
|
87
|
+
|
|
136
88
|
const filterSensitiveLog: (obj: GetGcmChannelRequest) => any;
|
|
137
89
|
}
|
|
138
90
|
export interface GetGcmChannelResponse {
|
|
139
|
-
|
|
140
|
-
* <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
|
|
141
|
-
*/
|
|
91
|
+
|
|
142
92
|
GCMChannelResponse: GCMChannelResponse | undefined;
|
|
143
93
|
}
|
|
144
94
|
export declare namespace GetGcmChannelResponse {
|
|
145
|
-
|
|
146
|
-
* @internal
|
|
147
|
-
*/
|
|
95
|
+
|
|
148
96
|
const filterSensitiveLog: (obj: GetGcmChannelResponse) => any;
|
|
149
97
|
}
|
|
150
98
|
export interface GetImportJobRequest {
|
|
151
|
-
|
|
152
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
153
|
-
*/
|
|
99
|
+
|
|
154
100
|
ApplicationId: string | undefined;
|
|
155
|
-
|
|
156
|
-
* <p>The unique identifier for the job.</p>
|
|
157
|
-
*/
|
|
101
|
+
|
|
158
102
|
JobId: string | undefined;
|
|
159
103
|
}
|
|
160
104
|
export declare namespace GetImportJobRequest {
|
|
161
|
-
|
|
162
|
-
* @internal
|
|
163
|
-
*/
|
|
105
|
+
|
|
164
106
|
const filterSensitiveLog: (obj: GetImportJobRequest) => any;
|
|
165
107
|
}
|
|
166
108
|
export interface GetImportJobResponse {
|
|
167
|
-
|
|
168
|
-
* <p>Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.</p>
|
|
169
|
-
*/
|
|
109
|
+
|
|
170
110
|
ImportJobResponse: ImportJobResponse | undefined;
|
|
171
111
|
}
|
|
172
112
|
export declare namespace GetImportJobResponse {
|
|
173
|
-
|
|
174
|
-
* @internal
|
|
175
|
-
*/
|
|
113
|
+
|
|
176
114
|
const filterSensitiveLog: (obj: GetImportJobResponse) => any;
|
|
177
115
|
}
|
|
178
116
|
export interface GetImportJobsRequest {
|
|
179
|
-
|
|
180
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
181
|
-
*/
|
|
117
|
+
|
|
182
118
|
ApplicationId: string | undefined;
|
|
183
|
-
|
|
184
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
185
|
-
*/
|
|
119
|
+
|
|
186
120
|
PageSize?: string;
|
|
187
|
-
|
|
188
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
189
|
-
*/
|
|
121
|
+
|
|
190
122
|
Token?: string;
|
|
191
123
|
}
|
|
192
124
|
export declare namespace GetImportJobsRequest {
|
|
193
|
-
|
|
194
|
-
* @internal
|
|
195
|
-
*/
|
|
125
|
+
|
|
196
126
|
const filterSensitiveLog: (obj: GetImportJobsRequest) => any;
|
|
197
127
|
}
|
|
198
|
-
|
|
199
|
-
* <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
|
|
200
|
-
*/
|
|
128
|
+
|
|
201
129
|
export interface ImportJobsResponse {
|
|
202
|
-
|
|
203
|
-
* <p>An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).</p>
|
|
204
|
-
*/
|
|
130
|
+
|
|
205
131
|
Item: ImportJobResponse[] | undefined;
|
|
206
|
-
|
|
207
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
208
|
-
*/
|
|
132
|
+
|
|
209
133
|
NextToken?: string;
|
|
210
134
|
}
|
|
211
135
|
export declare namespace ImportJobsResponse {
|
|
212
|
-
|
|
213
|
-
* @internal
|
|
214
|
-
*/
|
|
136
|
+
|
|
215
137
|
const filterSensitiveLog: (obj: ImportJobsResponse) => any;
|
|
216
138
|
}
|
|
217
139
|
export interface GetImportJobsResponse {
|
|
218
|
-
|
|
219
|
-
* <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
|
|
220
|
-
*/
|
|
140
|
+
|
|
221
141
|
ImportJobsResponse: ImportJobsResponse | undefined;
|
|
222
142
|
}
|
|
223
143
|
export declare namespace GetImportJobsResponse {
|
|
224
|
-
|
|
225
|
-
* @internal
|
|
226
|
-
*/
|
|
144
|
+
|
|
227
145
|
const filterSensitiveLog: (obj: GetImportJobsResponse) => any;
|
|
228
146
|
}
|
|
229
147
|
export interface GetInAppMessagesRequest {
|
|
230
|
-
|
|
231
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
232
|
-
*/
|
|
148
|
+
|
|
233
149
|
ApplicationId: string | undefined;
|
|
234
|
-
|
|
235
|
-
* <p>The unique identifier for the endpoint.</p>
|
|
236
|
-
*/
|
|
150
|
+
|
|
237
151
|
EndpointId: string | undefined;
|
|
238
152
|
}
|
|
239
153
|
export declare namespace GetInAppMessagesRequest {
|
|
240
|
-
|
|
241
|
-
* @internal
|
|
242
|
-
*/
|
|
154
|
+
|
|
243
155
|
const filterSensitiveLog: (obj: GetInAppMessagesRequest) => any;
|
|
244
156
|
}
|
|
245
|
-
|
|
246
|
-
* <p>Provides all fields required for building an in-app message.</p>
|
|
247
|
-
*/
|
|
157
|
+
|
|
248
158
|
export interface InAppMessage {
|
|
249
|
-
|
|
250
|
-
* <p>In-app message content.</p>
|
|
251
|
-
*/
|
|
159
|
+
|
|
252
160
|
Content?: InAppMessageContent[];
|
|
253
|
-
|
|
254
|
-
* <p>Custom config to be sent to SDK.</p>
|
|
255
|
-
*/
|
|
161
|
+
|
|
256
162
|
CustomConfig?: {
|
|
257
163
|
[key: string]: string;
|
|
258
164
|
};
|
|
259
|
-
|
|
260
|
-
* <p>The layout of the message.</p>
|
|
261
|
-
*/
|
|
165
|
+
|
|
262
166
|
Layout?: Layout | string;
|
|
263
167
|
}
|
|
264
168
|
export declare namespace InAppMessage {
|
|
265
|
-
|
|
266
|
-
* @internal
|
|
267
|
-
*/
|
|
169
|
+
|
|
268
170
|
const filterSensitiveLog: (obj: InAppMessage) => any;
|
|
269
171
|
}
|
|
270
|
-
|
|
271
|
-
* <p>Schedule of the campaign.</p>
|
|
272
|
-
*/
|
|
172
|
+
|
|
273
173
|
export interface InAppCampaignSchedule {
|
|
274
|
-
|
|
275
|
-
* <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
|
|
276
|
-
*/
|
|
174
|
+
|
|
277
175
|
EndDate?: string;
|
|
278
|
-
|
|
279
|
-
* <p>The event filter the SDK has to use to show the in-app message in the application.</p>
|
|
280
|
-
*/
|
|
176
|
+
|
|
281
177
|
EventFilter?: CampaignEventFilter;
|
|
282
|
-
|
|
283
|
-
* <p>Time during which the in-app message should not be shown to the user.</p>
|
|
284
|
-
*/
|
|
178
|
+
|
|
285
179
|
QuietTime?: QuietTime;
|
|
286
180
|
}
|
|
287
181
|
export declare namespace InAppCampaignSchedule {
|
|
288
|
-
|
|
289
|
-
* @internal
|
|
290
|
-
*/
|
|
182
|
+
|
|
291
183
|
const filterSensitiveLog: (obj: InAppCampaignSchedule) => any;
|
|
292
184
|
}
|
|
293
|
-
|
|
294
|
-
* <p>Targeted in-app message campaign.</p>
|
|
295
|
-
*/
|
|
185
|
+
|
|
296
186
|
export interface InAppMessageCampaign {
|
|
297
|
-
|
|
298
|
-
* <p>Campaign id of the corresponding campaign.</p>
|
|
299
|
-
*/
|
|
187
|
+
|
|
300
188
|
CampaignId?: string;
|
|
301
|
-
|
|
302
|
-
* <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
|
|
303
|
-
*/
|
|
189
|
+
|
|
304
190
|
DailyCap?: number;
|
|
305
|
-
|
|
306
|
-
* <p>In-app message content with all fields required for rendering an in-app message.</p>
|
|
307
|
-
*/
|
|
191
|
+
|
|
308
192
|
InAppMessage?: InAppMessage;
|
|
309
|
-
|
|
310
|
-
* <p>Priority of the in-app message.</p>
|
|
311
|
-
*/
|
|
193
|
+
|
|
312
194
|
Priority?: number;
|
|
313
|
-
|
|
314
|
-
* <p>Schedule of the campaign.</p>
|
|
315
|
-
*/
|
|
195
|
+
|
|
316
196
|
Schedule?: InAppCampaignSchedule;
|
|
317
|
-
|
|
318
|
-
* <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
|
|
319
|
-
*/
|
|
197
|
+
|
|
320
198
|
SessionCap?: number;
|
|
321
|
-
|
|
322
|
-
* <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
|
|
323
|
-
*/
|
|
199
|
+
|
|
324
200
|
TotalCap?: number;
|
|
325
|
-
|
|
326
|
-
* <p>Treatment id of the campaign.</p>
|
|
327
|
-
*/
|
|
201
|
+
|
|
328
202
|
TreatmentId?: string;
|
|
329
203
|
}
|
|
330
204
|
export declare namespace InAppMessageCampaign {
|
|
331
|
-
|
|
332
|
-
* @internal
|
|
333
|
-
*/
|
|
205
|
+
|
|
334
206
|
const filterSensitiveLog: (obj: InAppMessageCampaign) => any;
|
|
335
207
|
}
|
|
336
|
-
|
|
337
|
-
* <p>Get in-app messages response object.</p>
|
|
338
|
-
*/
|
|
208
|
+
|
|
339
209
|
export interface InAppMessagesResponse {
|
|
340
|
-
|
|
341
|
-
* <p>List of targeted in-app message campaigns.</p>
|
|
342
|
-
*/
|
|
210
|
+
|
|
343
211
|
InAppMessageCampaigns?: InAppMessageCampaign[];
|
|
344
212
|
}
|
|
345
213
|
export declare namespace InAppMessagesResponse {
|
|
346
|
-
|
|
347
|
-
* @internal
|
|
348
|
-
*/
|
|
214
|
+
|
|
349
215
|
const filterSensitiveLog: (obj: InAppMessagesResponse) => any;
|
|
350
216
|
}
|
|
351
217
|
export interface GetInAppMessagesResponse {
|
|
352
|
-
|
|
353
|
-
* <p>Get in-app messages response object.</p>
|
|
354
|
-
*/
|
|
218
|
+
|
|
355
219
|
InAppMessagesResponse: InAppMessagesResponse | undefined;
|
|
356
220
|
}
|
|
357
221
|
export declare namespace GetInAppMessagesResponse {
|
|
358
|
-
|
|
359
|
-
* @internal
|
|
360
|
-
*/
|
|
222
|
+
|
|
361
223
|
const filterSensitiveLog: (obj: GetInAppMessagesResponse) => any;
|
|
362
224
|
}
|
|
363
225
|
export interface GetInAppTemplateRequest {
|
|
364
|
-
|
|
365
|
-
* <p>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.</p>
|
|
366
|
-
*/
|
|
226
|
+
|
|
367
227
|
TemplateName: string | undefined;
|
|
368
|
-
|
|
369
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
370
|
-
*/
|
|
228
|
+
|
|
371
229
|
Version?: string;
|
|
372
230
|
}
|
|
373
231
|
export declare namespace GetInAppTemplateRequest {
|
|
374
|
-
|
|
375
|
-
* @internal
|
|
376
|
-
*/
|
|
232
|
+
|
|
377
233
|
const filterSensitiveLog: (obj: GetInAppTemplateRequest) => any;
|
|
378
234
|
}
|
|
379
|
-
|
|
380
|
-
* <p>In-App Template Response.</p>
|
|
381
|
-
*/
|
|
235
|
+
|
|
382
236
|
export interface InAppTemplateResponse {
|
|
383
|
-
|
|
384
|
-
* <p>The resource arn of the template.</p>
|
|
385
|
-
*/
|
|
237
|
+
|
|
386
238
|
Arn?: string;
|
|
387
|
-
|
|
388
|
-
* <p>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.</p>
|
|
389
|
-
*/
|
|
239
|
+
|
|
390
240
|
Content?: InAppMessageContent[];
|
|
391
|
-
|
|
392
|
-
* <p>The creation date of the template.</p>
|
|
393
|
-
*/
|
|
241
|
+
|
|
394
242
|
CreationDate: string | undefined;
|
|
395
|
-
|
|
396
|
-
* <p>Custom config to be sent to client.</p>
|
|
397
|
-
*/
|
|
243
|
+
|
|
398
244
|
CustomConfig?: {
|
|
399
245
|
[key: string]: string;
|
|
400
246
|
};
|
|
401
|
-
|
|
402
|
-
* <p>The last modified date of the template.</p>
|
|
403
|
-
*/
|
|
247
|
+
|
|
404
248
|
LastModifiedDate: string | undefined;
|
|
405
|
-
|
|
406
|
-
* <p>The layout of the message.</p>
|
|
407
|
-
*/
|
|
249
|
+
|
|
408
250
|
Layout?: Layout | string;
|
|
409
|
-
|
|
410
|
-
* <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>
|
|
411
|
-
*/
|
|
251
|
+
|
|
412
252
|
tags?: {
|
|
413
253
|
[key: string]: string;
|
|
414
254
|
};
|
|
415
|
-
|
|
416
|
-
* <p>The description of the template.</p>
|
|
417
|
-
*/
|
|
255
|
+
|
|
418
256
|
TemplateDescription?: string;
|
|
419
|
-
|
|
420
|
-
* <p>The name of the template.</p>
|
|
421
|
-
*/
|
|
257
|
+
|
|
422
258
|
TemplateName: string | undefined;
|
|
423
|
-
|
|
424
|
-
* <p>The type of the template.</p>
|
|
425
|
-
*/
|
|
259
|
+
|
|
426
260
|
TemplateType: TemplateType | string | undefined;
|
|
427
|
-
|
|
428
|
-
* <p>The version id of the template.</p>
|
|
429
|
-
*/
|
|
261
|
+
|
|
430
262
|
Version?: string;
|
|
431
263
|
}
|
|
432
264
|
export declare namespace InAppTemplateResponse {
|
|
433
|
-
|
|
434
|
-
* @internal
|
|
435
|
-
*/
|
|
265
|
+
|
|
436
266
|
const filterSensitiveLog: (obj: InAppTemplateResponse) => any;
|
|
437
267
|
}
|
|
438
268
|
export interface GetInAppTemplateResponse {
|
|
439
|
-
|
|
440
|
-
* <p>In-App Template Response.</p>
|
|
441
|
-
*/
|
|
269
|
+
|
|
442
270
|
InAppTemplateResponse: InAppTemplateResponse | undefined;
|
|
443
271
|
}
|
|
444
272
|
export declare namespace GetInAppTemplateResponse {
|
|
445
|
-
|
|
446
|
-
* @internal
|
|
447
|
-
*/
|
|
273
|
+
|
|
448
274
|
const filterSensitiveLog: (obj: GetInAppTemplateResponse) => any;
|
|
449
275
|
}
|
|
450
276
|
export interface GetJourneyRequest {
|
|
451
|
-
|
|
452
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
453
|
-
*/
|
|
277
|
+
|
|
454
278
|
ApplicationId: string | undefined;
|
|
455
|
-
|
|
456
|
-
* <p>The unique identifier for the journey.</p>
|
|
457
|
-
*/
|
|
279
|
+
|
|
458
280
|
JourneyId: string | undefined;
|
|
459
281
|
}
|
|
460
282
|
export declare namespace GetJourneyRequest {
|
|
461
|
-
|
|
462
|
-
* @internal
|
|
463
|
-
*/
|
|
283
|
+
|
|
464
284
|
const filterSensitiveLog: (obj: GetJourneyRequest) => any;
|
|
465
285
|
}
|
|
466
286
|
export interface GetJourneyResponse {
|
|
467
|
-
|
|
468
|
-
* <p>Provides information about the status, configuration, and other settings for a journey.</p>
|
|
469
|
-
*/
|
|
287
|
+
|
|
470
288
|
JourneyResponse: JourneyResponse | undefined;
|
|
471
289
|
}
|
|
472
290
|
export declare namespace GetJourneyResponse {
|
|
473
|
-
|
|
474
|
-
* @internal
|
|
475
|
-
*/
|
|
291
|
+
|
|
476
292
|
const filterSensitiveLog: (obj: GetJourneyResponse) => any;
|
|
477
293
|
}
|
|
478
294
|
export interface GetJourneyDateRangeKpiRequest {
|
|
479
|
-
|
|
480
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
481
|
-
*/
|
|
295
|
+
|
|
482
296
|
ApplicationId: string | undefined;
|
|
483
|
-
|
|
484
|
-
* <p>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</p>
|
|
485
|
-
*/
|
|
297
|
+
|
|
486
298
|
EndTime?: Date;
|
|
487
|
-
|
|
488
|
-
* <p>The unique identifier for the journey.</p>
|
|
489
|
-
*/
|
|
299
|
+
|
|
490
300
|
JourneyId: string | undefined;
|
|
491
|
-
|
|
492
|
-
* <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
493
|
-
*/
|
|
301
|
+
|
|
494
302
|
KpiName: string | undefined;
|
|
495
|
-
|
|
496
|
-
* <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
497
|
-
*/
|
|
303
|
+
|
|
498
304
|
NextToken?: string;
|
|
499
|
-
|
|
500
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
501
|
-
*/
|
|
305
|
+
|
|
502
306
|
PageSize?: string;
|
|
503
|
-
|
|
504
|
-
* <p>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</p>
|
|
505
|
-
*/
|
|
307
|
+
|
|
506
308
|
StartTime?: Date;
|
|
507
309
|
}
|
|
508
310
|
export declare namespace GetJourneyDateRangeKpiRequest {
|
|
509
|
-
|
|
510
|
-
* @internal
|
|
511
|
-
*/
|
|
311
|
+
|
|
512
312
|
const filterSensitiveLog: (obj: GetJourneyDateRangeKpiRequest) => any;
|
|
513
313
|
}
|
|
514
|
-
|
|
515
|
-
* <p>Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.</p>
|
|
516
|
-
*/
|
|
314
|
+
|
|
517
315
|
export interface JourneyDateRangeKpiResponse {
|
|
518
|
-
|
|
519
|
-
* <p>The unique identifier for the application that the metric applies to.</p>
|
|
520
|
-
*/
|
|
316
|
+
|
|
521
317
|
ApplicationId: string | undefined;
|
|
522
|
-
|
|
523
|
-
* <p>The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>
|
|
524
|
-
*/
|
|
318
|
+
|
|
525
319
|
EndTime: Date | undefined;
|
|
526
|
-
|
|
527
|
-
* <p>The unique identifier for the journey that the metric applies to.</p>
|
|
528
|
-
*/
|
|
320
|
+
|
|
529
321
|
JourneyId: string | undefined;
|
|
530
|
-
|
|
531
|
-
* <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
532
|
-
*/
|
|
322
|
+
|
|
533
323
|
KpiName: string | undefined;
|
|
534
|
-
|
|
535
|
-
* <p>An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.</p>
|
|
536
|
-
*/
|
|
324
|
+
|
|
537
325
|
KpiResult: BaseKpiResult | undefined;
|
|
538
|
-
|
|
539
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.</p>
|
|
540
|
-
*/
|
|
326
|
+
|
|
541
327
|
NextToken?: string;
|
|
542
|
-
|
|
543
|
-
* <p>The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>
|
|
544
|
-
*/
|
|
328
|
+
|
|
545
329
|
StartTime: Date | undefined;
|
|
546
330
|
}
|
|
547
331
|
export declare namespace JourneyDateRangeKpiResponse {
|
|
548
|
-
|
|
549
|
-
* @internal
|
|
550
|
-
*/
|
|
332
|
+
|
|
551
333
|
const filterSensitiveLog: (obj: JourneyDateRangeKpiResponse) => any;
|
|
552
334
|
}
|
|
553
335
|
export interface GetJourneyDateRangeKpiResponse {
|
|
554
|
-
|
|
555
|
-
* <p>Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.</p>
|
|
556
|
-
*/
|
|
336
|
+
|
|
557
337
|
JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponse | undefined;
|
|
558
338
|
}
|
|
559
339
|
export declare namespace GetJourneyDateRangeKpiResponse {
|
|
560
|
-
|
|
561
|
-
* @internal
|
|
562
|
-
*/
|
|
340
|
+
|
|
563
341
|
const filterSensitiveLog: (obj: GetJourneyDateRangeKpiResponse) => any;
|
|
564
342
|
}
|
|
565
343
|
export interface GetJourneyExecutionActivityMetricsRequest {
|
|
566
|
-
|
|
567
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
568
|
-
*/
|
|
344
|
+
|
|
569
345
|
ApplicationId: string | undefined;
|
|
570
|
-
|
|
571
|
-
* <p>The unique identifier for the journey activity.</p>
|
|
572
|
-
*/
|
|
346
|
+
|
|
573
347
|
JourneyActivityId: string | undefined;
|
|
574
|
-
|
|
575
|
-
* <p>The unique identifier for the journey.</p>
|
|
576
|
-
*/
|
|
348
|
+
|
|
577
349
|
JourneyId: string | undefined;
|
|
578
|
-
|
|
579
|
-
* <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
580
|
-
*/
|
|
350
|
+
|
|
581
351
|
NextToken?: string;
|
|
582
|
-
|
|
583
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
584
|
-
*/
|
|
352
|
+
|
|
585
353
|
PageSize?: string;
|
|
586
354
|
}
|
|
587
355
|
export declare namespace GetJourneyExecutionActivityMetricsRequest {
|
|
588
|
-
|
|
589
|
-
* @internal
|
|
590
|
-
*/
|
|
356
|
+
|
|
591
357
|
const filterSensitiveLog: (obj: GetJourneyExecutionActivityMetricsRequest) => any;
|
|
592
358
|
}
|
|
593
|
-
|
|
594
|
-
* <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.</p>
|
|
595
|
-
*/
|
|
359
|
+
|
|
596
360
|
export interface JourneyExecutionActivityMetricsResponse {
|
|
597
|
-
|
|
598
|
-
* <p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE - For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>
|
|
599
|
-
*/
|
|
361
|
+
|
|
600
362
|
ActivityType: string | undefined;
|
|
601
|
-
|
|
602
|
-
* <p>The unique identifier for the application that the metric applies to.</p>
|
|
603
|
-
*/
|
|
363
|
+
|
|
604
364
|
ApplicationId: string | undefined;
|
|
605
|
-
|
|
606
|
-
* <p>The unique identifier for the activity that the metric applies to.</p>
|
|
607
|
-
*/
|
|
365
|
+
|
|
608
366
|
JourneyActivityId: string | undefined;
|
|
609
|
-
|
|
610
|
-
* <p>The unique identifier for the journey that the metric applies to.</p>
|
|
611
|
-
*/
|
|
367
|
+
|
|
612
368
|
JourneyId: string | undefined;
|
|
613
|
-
|
|
614
|
-
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.</p>
|
|
615
|
-
*/
|
|
369
|
+
|
|
616
370
|
LastEvaluatedTime: string | undefined;
|
|
617
|
-
|
|
618
|
-
* <p>A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
619
|
-
*/
|
|
371
|
+
|
|
620
372
|
Metrics: {
|
|
621
373
|
[key: string]: string;
|
|
622
374
|
} | undefined;
|
|
623
375
|
}
|
|
624
376
|
export declare namespace JourneyExecutionActivityMetricsResponse {
|
|
625
|
-
|
|
626
|
-
* @internal
|
|
627
|
-
*/
|
|
377
|
+
|
|
628
378
|
const filterSensitiveLog: (obj: JourneyExecutionActivityMetricsResponse) => any;
|
|
629
379
|
}
|
|
630
380
|
export interface GetJourneyExecutionActivityMetricsResponse {
|
|
631
|
-
|
|
632
|
-
* <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.</p>
|
|
633
|
-
*/
|
|
381
|
+
|
|
634
382
|
JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponse | undefined;
|
|
635
383
|
}
|
|
636
384
|
export declare namespace GetJourneyExecutionActivityMetricsResponse {
|
|
637
|
-
|
|
638
|
-
* @internal
|
|
639
|
-
*/
|
|
385
|
+
|
|
640
386
|
const filterSensitiveLog: (obj: GetJourneyExecutionActivityMetricsResponse) => any;
|
|
641
387
|
}
|
|
642
388
|
export interface GetJourneyExecutionMetricsRequest {
|
|
643
|
-
|
|
644
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
645
|
-
*/
|
|
389
|
+
|
|
646
390
|
ApplicationId: string | undefined;
|
|
647
|
-
|
|
648
|
-
* <p>The unique identifier for the journey.</p>
|
|
649
|
-
*/
|
|
391
|
+
|
|
650
392
|
JourneyId: string | undefined;
|
|
651
|
-
|
|
652
|
-
* <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
653
|
-
*/
|
|
393
|
+
|
|
654
394
|
NextToken?: string;
|
|
655
|
-
|
|
656
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
657
|
-
*/
|
|
395
|
+
|
|
658
396
|
PageSize?: string;
|
|
659
397
|
}
|
|
660
398
|
export declare namespace GetJourneyExecutionMetricsRequest {
|
|
661
|
-
|
|
662
|
-
* @internal
|
|
663
|
-
*/
|
|
399
|
+
|
|
664
400
|
const filterSensitiveLog: (obj: GetJourneyExecutionMetricsRequest) => any;
|
|
665
401
|
}
|
|
666
|
-
|
|
667
|
-
* <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.</p>
|
|
668
|
-
*/
|
|
402
|
+
|
|
669
403
|
export interface JourneyExecutionMetricsResponse {
|
|
670
|
-
|
|
671
|
-
* <p>The unique identifier for the application that the metric applies to.</p>
|
|
672
|
-
*/
|
|
404
|
+
|
|
673
405
|
ApplicationId: string | undefined;
|
|
674
|
-
|
|
675
|
-
* <p>The unique identifier for the journey that the metric applies to.</p>
|
|
676
|
-
*/
|
|
406
|
+
|
|
677
407
|
JourneyId: string | undefined;
|
|
678
|
-
|
|
679
|
-
* <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.</p>
|
|
680
|
-
*/
|
|
408
|
+
|
|
681
409
|
LastEvaluatedTime: string | undefined;
|
|
682
|
-
|
|
683
|
-
* <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
|
|
684
|
-
*/
|
|
410
|
+
|
|
685
411
|
Metrics: {
|
|
686
412
|
[key: string]: string;
|
|
687
413
|
} | undefined;
|
|
688
414
|
}
|
|
689
415
|
export declare namespace JourneyExecutionMetricsResponse {
|
|
690
|
-
|
|
691
|
-
* @internal
|
|
692
|
-
*/
|
|
416
|
+
|
|
693
417
|
const filterSensitiveLog: (obj: JourneyExecutionMetricsResponse) => any;
|
|
694
418
|
}
|
|
695
419
|
export interface GetJourneyExecutionMetricsResponse {
|
|
696
|
-
|
|
697
|
-
* <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.</p>
|
|
698
|
-
*/
|
|
420
|
+
|
|
699
421
|
JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse | undefined;
|
|
700
422
|
}
|
|
701
423
|
export declare namespace GetJourneyExecutionMetricsResponse {
|
|
702
|
-
|
|
703
|
-
* @internal
|
|
704
|
-
*/
|
|
424
|
+
|
|
705
425
|
const filterSensitiveLog: (obj: GetJourneyExecutionMetricsResponse) => any;
|
|
706
426
|
}
|
|
707
427
|
export interface GetPushTemplateRequest {
|
|
708
|
-
|
|
709
|
-
* <p>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.</p>
|
|
710
|
-
*/
|
|
428
|
+
|
|
711
429
|
TemplateName: string | undefined;
|
|
712
|
-
|
|
713
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
714
|
-
*/
|
|
430
|
+
|
|
715
431
|
Version?: string;
|
|
716
432
|
}
|
|
717
433
|
export declare namespace GetPushTemplateRequest {
|
|
718
|
-
|
|
719
|
-
* @internal
|
|
720
|
-
*/
|
|
434
|
+
|
|
721
435
|
const filterSensitiveLog: (obj: GetPushTemplateRequest) => any;
|
|
722
436
|
}
|
|
723
|
-
|
|
724
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
|
|
725
|
-
*/
|
|
437
|
+
|
|
726
438
|
export interface PushNotificationTemplateResponse {
|
|
727
|
-
|
|
728
|
-
* <p>The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
|
|
729
|
-
*/
|
|
439
|
+
|
|
730
440
|
ADM?: AndroidPushNotificationTemplate;
|
|
731
|
-
|
|
732
|
-
* <p>The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
|
|
733
|
-
*/
|
|
441
|
+
|
|
734
442
|
APNS?: APNSPushNotificationTemplate;
|
|
735
|
-
|
|
736
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
737
|
-
*/
|
|
443
|
+
|
|
738
444
|
Arn?: string;
|
|
739
|
-
|
|
740
|
-
* <p>The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
|
|
741
|
-
*/
|
|
445
|
+
|
|
742
446
|
Baidu?: AndroidPushNotificationTemplate;
|
|
743
|
-
|
|
744
|
-
* <p>The date, in ISO 8601 format, when the message template was created.</p>
|
|
745
|
-
*/
|
|
447
|
+
|
|
746
448
|
CreationDate: string | undefined;
|
|
747
|
-
|
|
748
|
-
* <p>The default message template that's used for push notification channels.</p>
|
|
749
|
-
*/
|
|
449
|
+
|
|
750
450
|
Default?: DefaultPushNotificationTemplate;
|
|
751
|
-
|
|
752
|
-
* <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
|
|
753
|
-
*/
|
|
451
|
+
|
|
754
452
|
DefaultSubstitutions?: string;
|
|
755
|
-
|
|
756
|
-
* <p>The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
|
|
757
|
-
*/
|
|
453
|
+
|
|
758
454
|
GCM?: AndroidPushNotificationTemplate;
|
|
759
|
-
|
|
760
|
-
* <p>The date, in ISO 8601 format, when the message template was last modified.</p>
|
|
761
|
-
*/
|
|
455
|
+
|
|
762
456
|
LastModifiedDate: string | undefined;
|
|
763
|
-
|
|
764
|
-
* <p>The unique identifier for the recommender model that's used by the message template.</p>
|
|
765
|
-
*/
|
|
457
|
+
|
|
766
458
|
RecommenderId?: string;
|
|
767
|
-
|
|
768
|
-
* <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>
|
|
769
|
-
*/
|
|
459
|
+
|
|
770
460
|
tags?: {
|
|
771
461
|
[key: string]: string;
|
|
772
462
|
};
|
|
773
|
-
|
|
774
|
-
* <p>The custom description of the message template.</p>
|
|
775
|
-
*/
|
|
463
|
+
|
|
776
464
|
TemplateDescription?: string;
|
|
777
|
-
|
|
778
|
-
* <p>The name of the message template.</p>
|
|
779
|
-
*/
|
|
465
|
+
|
|
780
466
|
TemplateName: string | undefined;
|
|
781
|
-
|
|
782
|
-
* <p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>
|
|
783
|
-
*/
|
|
467
|
+
|
|
784
468
|
TemplateType: TemplateType | string | undefined;
|
|
785
|
-
|
|
786
|
-
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
787
|
-
*/
|
|
469
|
+
|
|
788
470
|
Version?: string;
|
|
789
471
|
}
|
|
790
472
|
export declare namespace PushNotificationTemplateResponse {
|
|
791
|
-
|
|
792
|
-
* @internal
|
|
793
|
-
*/
|
|
473
|
+
|
|
794
474
|
const filterSensitiveLog: (obj: PushNotificationTemplateResponse) => any;
|
|
795
475
|
}
|
|
796
476
|
export interface GetPushTemplateResponse {
|
|
797
|
-
|
|
798
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
|
|
799
|
-
*/
|
|
477
|
+
|
|
800
478
|
PushNotificationTemplateResponse: PushNotificationTemplateResponse | undefined;
|
|
801
479
|
}
|
|
802
480
|
export declare namespace GetPushTemplateResponse {
|
|
803
|
-
|
|
804
|
-
* @internal
|
|
805
|
-
*/
|
|
481
|
+
|
|
806
482
|
const filterSensitiveLog: (obj: GetPushTemplateResponse) => any;
|
|
807
483
|
}
|
|
808
484
|
export interface GetRecommenderConfigurationRequest {
|
|
809
|
-
|
|
810
|
-
* <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
|
|
811
|
-
*/
|
|
485
|
+
|
|
812
486
|
RecommenderId: string | undefined;
|
|
813
487
|
}
|
|
814
488
|
export declare namespace GetRecommenderConfigurationRequest {
|
|
815
|
-
|
|
816
|
-
* @internal
|
|
817
|
-
*/
|
|
489
|
+
|
|
818
490
|
const filterSensitiveLog: (obj: GetRecommenderConfigurationRequest) => any;
|
|
819
491
|
}
|
|
820
492
|
export interface GetRecommenderConfigurationResponse {
|
|
821
|
-
|
|
822
|
-
* <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
|
|
823
|
-
*/
|
|
493
|
+
|
|
824
494
|
RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
|
|
825
495
|
}
|
|
826
496
|
export declare namespace GetRecommenderConfigurationResponse {
|
|
827
|
-
|
|
828
|
-
* @internal
|
|
829
|
-
*/
|
|
497
|
+
|
|
830
498
|
const filterSensitiveLog: (obj: GetRecommenderConfigurationResponse) => any;
|
|
831
499
|
}
|
|
832
500
|
export interface GetRecommenderConfigurationsRequest {
|
|
833
|
-
|
|
834
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
835
|
-
*/
|
|
501
|
+
|
|
836
502
|
PageSize?: string;
|
|
837
|
-
|
|
838
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
839
|
-
*/
|
|
503
|
+
|
|
840
504
|
Token?: string;
|
|
841
505
|
}
|
|
842
506
|
export declare namespace GetRecommenderConfigurationsRequest {
|
|
843
|
-
|
|
844
|
-
* @internal
|
|
845
|
-
*/
|
|
507
|
+
|
|
846
508
|
const filterSensitiveLog: (obj: GetRecommenderConfigurationsRequest) => any;
|
|
847
509
|
}
|
|
848
|
-
|
|
849
|
-
* <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
|
|
850
|
-
*/
|
|
510
|
+
|
|
851
511
|
export interface ListRecommenderConfigurationsResponse {
|
|
852
|
-
|
|
853
|
-
* <p>An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.</p>
|
|
854
|
-
*/
|
|
512
|
+
|
|
855
513
|
Item: RecommenderConfigurationResponse[] | undefined;
|
|
856
|
-
|
|
857
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
858
|
-
*/
|
|
514
|
+
|
|
859
515
|
NextToken?: string;
|
|
860
516
|
}
|
|
861
517
|
export declare namespace ListRecommenderConfigurationsResponse {
|
|
862
|
-
|
|
863
|
-
* @internal
|
|
864
|
-
*/
|
|
518
|
+
|
|
865
519
|
const filterSensitiveLog: (obj: ListRecommenderConfigurationsResponse) => any;
|
|
866
520
|
}
|
|
867
521
|
export interface GetRecommenderConfigurationsResponse {
|
|
868
|
-
|
|
869
|
-
* <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
|
|
870
|
-
*/
|
|
522
|
+
|
|
871
523
|
ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponse | undefined;
|
|
872
524
|
}
|
|
873
525
|
export declare namespace GetRecommenderConfigurationsResponse {
|
|
874
|
-
|
|
875
|
-
* @internal
|
|
876
|
-
*/
|
|
526
|
+
|
|
877
527
|
const filterSensitiveLog: (obj: GetRecommenderConfigurationsResponse) => any;
|
|
878
528
|
}
|
|
879
529
|
export interface GetSegmentRequest {
|
|
880
|
-
|
|
881
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
882
|
-
*/
|
|
530
|
+
|
|
883
531
|
ApplicationId: string | undefined;
|
|
884
|
-
|
|
885
|
-
* <p>The unique identifier for the segment.</p>
|
|
886
|
-
*/
|
|
532
|
+
|
|
887
533
|
SegmentId: string | undefined;
|
|
888
534
|
}
|
|
889
535
|
export declare namespace GetSegmentRequest {
|
|
890
|
-
|
|
891
|
-
* @internal
|
|
892
|
-
*/
|
|
536
|
+
|
|
893
537
|
const filterSensitiveLog: (obj: GetSegmentRequest) => any;
|
|
894
538
|
}
|
|
895
539
|
export interface GetSegmentResponse {
|
|
896
|
-
|
|
897
|
-
* <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
|
|
898
|
-
*/
|
|
540
|
+
|
|
899
541
|
SegmentResponse: SegmentResponse | undefined;
|
|
900
542
|
}
|
|
901
543
|
export declare namespace GetSegmentResponse {
|
|
902
|
-
|
|
903
|
-
* @internal
|
|
904
|
-
*/
|
|
544
|
+
|
|
905
545
|
const filterSensitiveLog: (obj: GetSegmentResponse) => any;
|
|
906
546
|
}
|
|
907
547
|
export interface GetSegmentExportJobsRequest {
|
|
908
|
-
|
|
909
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
910
|
-
*/
|
|
548
|
+
|
|
911
549
|
ApplicationId: string | undefined;
|
|
912
|
-
|
|
913
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
914
|
-
*/
|
|
550
|
+
|
|
915
551
|
PageSize?: string;
|
|
916
|
-
|
|
917
|
-
* <p>The unique identifier for the segment.</p>
|
|
918
|
-
*/
|
|
552
|
+
|
|
919
553
|
SegmentId: string | undefined;
|
|
920
|
-
|
|
921
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
922
|
-
*/
|
|
554
|
+
|
|
923
555
|
Token?: string;
|
|
924
556
|
}
|
|
925
557
|
export declare namespace GetSegmentExportJobsRequest {
|
|
926
|
-
|
|
927
|
-
* @internal
|
|
928
|
-
*/
|
|
558
|
+
|
|
929
559
|
const filterSensitiveLog: (obj: GetSegmentExportJobsRequest) => any;
|
|
930
560
|
}
|
|
931
561
|
export interface GetSegmentExportJobsResponse {
|
|
932
|
-
|
|
933
|
-
* <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
|
|
934
|
-
*/
|
|
562
|
+
|
|
935
563
|
ExportJobsResponse: ExportJobsResponse | undefined;
|
|
936
564
|
}
|
|
937
565
|
export declare namespace GetSegmentExportJobsResponse {
|
|
938
|
-
|
|
939
|
-
* @internal
|
|
940
|
-
*/
|
|
566
|
+
|
|
941
567
|
const filterSensitiveLog: (obj: GetSegmentExportJobsResponse) => any;
|
|
942
568
|
}
|
|
943
569
|
export interface GetSegmentImportJobsRequest {
|
|
944
|
-
|
|
945
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
946
|
-
*/
|
|
570
|
+
|
|
947
571
|
ApplicationId: string | undefined;
|
|
948
|
-
|
|
949
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
950
|
-
*/
|
|
572
|
+
|
|
951
573
|
PageSize?: string;
|
|
952
|
-
|
|
953
|
-
* <p>The unique identifier for the segment.</p>
|
|
954
|
-
*/
|
|
574
|
+
|
|
955
575
|
SegmentId: string | undefined;
|
|
956
|
-
|
|
957
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
958
|
-
*/
|
|
576
|
+
|
|
959
577
|
Token?: string;
|
|
960
578
|
}
|
|
961
579
|
export declare namespace GetSegmentImportJobsRequest {
|
|
962
|
-
|
|
963
|
-
* @internal
|
|
964
|
-
*/
|
|
580
|
+
|
|
965
581
|
const filterSensitiveLog: (obj: GetSegmentImportJobsRequest) => any;
|
|
966
582
|
}
|
|
967
583
|
export interface GetSegmentImportJobsResponse {
|
|
968
|
-
|
|
969
|
-
* <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
|
|
970
|
-
*/
|
|
584
|
+
|
|
971
585
|
ImportJobsResponse: ImportJobsResponse | undefined;
|
|
972
586
|
}
|
|
973
587
|
export declare namespace GetSegmentImportJobsResponse {
|
|
974
|
-
|
|
975
|
-
* @internal
|
|
976
|
-
*/
|
|
588
|
+
|
|
977
589
|
const filterSensitiveLog: (obj: GetSegmentImportJobsResponse) => any;
|
|
978
590
|
}
|
|
979
591
|
export interface GetSegmentsRequest {
|
|
980
|
-
|
|
981
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
982
|
-
*/
|
|
592
|
+
|
|
983
593
|
ApplicationId: string | undefined;
|
|
984
|
-
|
|
985
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
986
|
-
*/
|
|
594
|
+
|
|
987
595
|
PageSize?: string;
|
|
988
|
-
|
|
989
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
990
|
-
*/
|
|
596
|
+
|
|
991
597
|
Token?: string;
|
|
992
598
|
}
|
|
993
599
|
export declare namespace GetSegmentsRequest {
|
|
994
|
-
|
|
995
|
-
* @internal
|
|
996
|
-
*/
|
|
600
|
+
|
|
997
601
|
const filterSensitiveLog: (obj: GetSegmentsRequest) => any;
|
|
998
602
|
}
|
|
999
|
-
|
|
1000
|
-
* <p>Provides information about all the segments that are associated with an application.</p>
|
|
1001
|
-
*/
|
|
603
|
+
|
|
1002
604
|
export interface SegmentsResponse {
|
|
1003
|
-
|
|
1004
|
-
* <p>An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).</p>
|
|
1005
|
-
*/
|
|
605
|
+
|
|
1006
606
|
Item: SegmentResponse[] | undefined;
|
|
1007
|
-
|
|
1008
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
1009
|
-
*/
|
|
607
|
+
|
|
1010
608
|
NextToken?: string;
|
|
1011
609
|
}
|
|
1012
610
|
export declare namespace SegmentsResponse {
|
|
1013
|
-
|
|
1014
|
-
* @internal
|
|
1015
|
-
*/
|
|
611
|
+
|
|
1016
612
|
const filterSensitiveLog: (obj: SegmentsResponse) => any;
|
|
1017
613
|
}
|
|
1018
614
|
export interface GetSegmentsResponse {
|
|
1019
|
-
|
|
1020
|
-
* <p>Provides information about all the segments that are associated with an application.</p>
|
|
1021
|
-
*/
|
|
615
|
+
|
|
1022
616
|
SegmentsResponse: SegmentsResponse | undefined;
|
|
1023
617
|
}
|
|
1024
618
|
export declare namespace GetSegmentsResponse {
|
|
1025
|
-
|
|
1026
|
-
* @internal
|
|
1027
|
-
*/
|
|
619
|
+
|
|
1028
620
|
const filterSensitiveLog: (obj: GetSegmentsResponse) => any;
|
|
1029
621
|
}
|
|
1030
622
|
export interface GetSegmentVersionRequest {
|
|
1031
|
-
|
|
1032
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1033
|
-
*/
|
|
623
|
+
|
|
1034
624
|
ApplicationId: string | undefined;
|
|
1035
|
-
|
|
1036
|
-
* <p>The unique identifier for the segment.</p>
|
|
1037
|
-
*/
|
|
625
|
+
|
|
1038
626
|
SegmentId: string | undefined;
|
|
1039
|
-
|
|
1040
|
-
* <p>The unique version number (Version property) for the campaign version.</p>
|
|
1041
|
-
*/
|
|
627
|
+
|
|
1042
628
|
Version: string | undefined;
|
|
1043
629
|
}
|
|
1044
630
|
export declare namespace GetSegmentVersionRequest {
|
|
1045
|
-
|
|
1046
|
-
* @internal
|
|
1047
|
-
*/
|
|
631
|
+
|
|
1048
632
|
const filterSensitiveLog: (obj: GetSegmentVersionRequest) => any;
|
|
1049
633
|
}
|
|
1050
634
|
export interface GetSegmentVersionResponse {
|
|
1051
|
-
|
|
1052
|
-
* <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
|
|
1053
|
-
*/
|
|
635
|
+
|
|
1054
636
|
SegmentResponse: SegmentResponse | undefined;
|
|
1055
637
|
}
|
|
1056
638
|
export declare namespace GetSegmentVersionResponse {
|
|
1057
|
-
|
|
1058
|
-
* @internal
|
|
1059
|
-
*/
|
|
639
|
+
|
|
1060
640
|
const filterSensitiveLog: (obj: GetSegmentVersionResponse) => any;
|
|
1061
641
|
}
|
|
1062
642
|
export interface GetSegmentVersionsRequest {
|
|
1063
|
-
|
|
1064
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1065
|
-
*/
|
|
643
|
+
|
|
1066
644
|
ApplicationId: string | undefined;
|
|
1067
|
-
|
|
1068
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1069
|
-
*/
|
|
645
|
+
|
|
1070
646
|
PageSize?: string;
|
|
1071
|
-
|
|
1072
|
-
* <p>The unique identifier for the segment.</p>
|
|
1073
|
-
*/
|
|
647
|
+
|
|
1074
648
|
SegmentId: string | undefined;
|
|
1075
|
-
|
|
1076
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
1077
|
-
*/
|
|
649
|
+
|
|
1078
650
|
Token?: string;
|
|
1079
651
|
}
|
|
1080
652
|
export declare namespace GetSegmentVersionsRequest {
|
|
1081
|
-
|
|
1082
|
-
* @internal
|
|
1083
|
-
*/
|
|
653
|
+
|
|
1084
654
|
const filterSensitiveLog: (obj: GetSegmentVersionsRequest) => any;
|
|
1085
655
|
}
|
|
1086
656
|
export interface GetSegmentVersionsResponse {
|
|
1087
|
-
|
|
1088
|
-
* <p>Provides information about all the segments that are associated with an application.</p>
|
|
1089
|
-
*/
|
|
657
|
+
|
|
1090
658
|
SegmentsResponse: SegmentsResponse | undefined;
|
|
1091
659
|
}
|
|
1092
660
|
export declare namespace GetSegmentVersionsResponse {
|
|
1093
|
-
|
|
1094
|
-
* @internal
|
|
1095
|
-
*/
|
|
661
|
+
|
|
1096
662
|
const filterSensitiveLog: (obj: GetSegmentVersionsResponse) => any;
|
|
1097
663
|
}
|
|
1098
664
|
export interface GetSmsChannelRequest {
|
|
1099
|
-
|
|
1100
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1101
|
-
*/
|
|
665
|
+
|
|
1102
666
|
ApplicationId: string | undefined;
|
|
1103
667
|
}
|
|
1104
668
|
export declare namespace GetSmsChannelRequest {
|
|
1105
|
-
|
|
1106
|
-
* @internal
|
|
1107
|
-
*/
|
|
669
|
+
|
|
1108
670
|
const filterSensitiveLog: (obj: GetSmsChannelRequest) => any;
|
|
1109
671
|
}
|
|
1110
672
|
export interface GetSmsChannelResponse {
|
|
1111
|
-
|
|
1112
|
-
* <p>Provides information about the status and settings of the SMS channel for an application.</p>
|
|
1113
|
-
*/
|
|
673
|
+
|
|
1114
674
|
SMSChannelResponse: SMSChannelResponse | undefined;
|
|
1115
675
|
}
|
|
1116
676
|
export declare namespace GetSmsChannelResponse {
|
|
1117
|
-
|
|
1118
|
-
* @internal
|
|
1119
|
-
*/
|
|
677
|
+
|
|
1120
678
|
const filterSensitiveLog: (obj: GetSmsChannelResponse) => any;
|
|
1121
679
|
}
|
|
1122
680
|
export interface GetSmsTemplateRequest {
|
|
1123
|
-
|
|
1124
|
-
* <p>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.</p>
|
|
1125
|
-
*/
|
|
681
|
+
|
|
1126
682
|
TemplateName: string | undefined;
|
|
1127
|
-
|
|
1128
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
1129
|
-
*/
|
|
683
|
+
|
|
1130
684
|
Version?: string;
|
|
1131
685
|
}
|
|
1132
686
|
export declare namespace GetSmsTemplateRequest {
|
|
1133
|
-
|
|
1134
|
-
* @internal
|
|
1135
|
-
*/
|
|
687
|
+
|
|
1136
688
|
const filterSensitiveLog: (obj: GetSmsTemplateRequest) => any;
|
|
1137
689
|
}
|
|
1138
|
-
|
|
1139
|
-
* <p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
|
|
1140
|
-
*/
|
|
690
|
+
|
|
1141
691
|
export interface SMSTemplateResponse {
|
|
1142
|
-
|
|
1143
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
1144
|
-
*/
|
|
692
|
+
|
|
1145
693
|
Arn?: string;
|
|
1146
|
-
|
|
1147
|
-
* <p>The message body that's used in text messages that are based on the message template.</p>
|
|
1148
|
-
*/
|
|
694
|
+
|
|
1149
695
|
Body?: string;
|
|
1150
|
-
|
|
1151
|
-
* <p>The date, in ISO 8601 format, when the message template was created.</p>
|
|
1152
|
-
*/
|
|
696
|
+
|
|
1153
697
|
CreationDate: string | undefined;
|
|
1154
|
-
|
|
1155
|
-
* <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
|
|
1156
|
-
*/
|
|
698
|
+
|
|
1157
699
|
DefaultSubstitutions?: string;
|
|
1158
|
-
|
|
1159
|
-
* <p>The date, in ISO 8601 format, when the message template was last modified.</p>
|
|
1160
|
-
*/
|
|
700
|
+
|
|
1161
701
|
LastModifiedDate: string | undefined;
|
|
1162
|
-
|
|
1163
|
-
* <p>The unique identifier for the recommender model that's used by the message template.</p>
|
|
1164
|
-
*/
|
|
702
|
+
|
|
1165
703
|
RecommenderId?: string;
|
|
1166
|
-
|
|
1167
|
-
* <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>
|
|
1168
|
-
*/
|
|
704
|
+
|
|
1169
705
|
tags?: {
|
|
1170
706
|
[key: string]: string;
|
|
1171
707
|
};
|
|
1172
|
-
|
|
1173
|
-
* <p>The custom description of the message template.</p>
|
|
1174
|
-
*/
|
|
708
|
+
|
|
1175
709
|
TemplateDescription?: string;
|
|
1176
|
-
|
|
1177
|
-
* <p>The name of the message template.</p>
|
|
1178
|
-
*/
|
|
710
|
+
|
|
1179
711
|
TemplateName: string | undefined;
|
|
1180
|
-
|
|
1181
|
-
* <p>The type of channel that the message template is designed for. For an SMS template, this value is SMS.</p>
|
|
1182
|
-
*/
|
|
712
|
+
|
|
1183
713
|
TemplateType: TemplateType | string | undefined;
|
|
1184
|
-
|
|
1185
|
-
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
1186
|
-
*/
|
|
714
|
+
|
|
1187
715
|
Version?: string;
|
|
1188
716
|
}
|
|
1189
717
|
export declare namespace SMSTemplateResponse {
|
|
1190
|
-
|
|
1191
|
-
* @internal
|
|
1192
|
-
*/
|
|
718
|
+
|
|
1193
719
|
const filterSensitiveLog: (obj: SMSTemplateResponse) => any;
|
|
1194
720
|
}
|
|
1195
721
|
export interface GetSmsTemplateResponse {
|
|
1196
|
-
|
|
1197
|
-
* <p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
|
|
1198
|
-
*/
|
|
722
|
+
|
|
1199
723
|
SMSTemplateResponse: SMSTemplateResponse | undefined;
|
|
1200
724
|
}
|
|
1201
725
|
export declare namespace GetSmsTemplateResponse {
|
|
1202
|
-
|
|
1203
|
-
* @internal
|
|
1204
|
-
*/
|
|
726
|
+
|
|
1205
727
|
const filterSensitiveLog: (obj: GetSmsTemplateResponse) => any;
|
|
1206
728
|
}
|
|
1207
729
|
export interface GetUserEndpointsRequest {
|
|
1208
|
-
|
|
1209
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1210
|
-
*/
|
|
730
|
+
|
|
1211
731
|
ApplicationId: string | undefined;
|
|
1212
|
-
|
|
1213
|
-
* <p>The unique identifier for the user.</p>
|
|
1214
|
-
*/
|
|
732
|
+
|
|
1215
733
|
UserId: string | undefined;
|
|
1216
734
|
}
|
|
1217
735
|
export declare namespace GetUserEndpointsRequest {
|
|
1218
|
-
|
|
1219
|
-
* @internal
|
|
1220
|
-
*/
|
|
736
|
+
|
|
1221
737
|
const filterSensitiveLog: (obj: GetUserEndpointsRequest) => any;
|
|
1222
738
|
}
|
|
1223
739
|
export interface GetUserEndpointsResponse {
|
|
1224
|
-
|
|
1225
|
-
* <p>Provides information about all the endpoints that are associated with a user ID.</p>
|
|
1226
|
-
*/
|
|
740
|
+
|
|
1227
741
|
EndpointsResponse: EndpointsResponse | undefined;
|
|
1228
742
|
}
|
|
1229
743
|
export declare namespace GetUserEndpointsResponse {
|
|
1230
|
-
|
|
1231
|
-
* @internal
|
|
1232
|
-
*/
|
|
744
|
+
|
|
1233
745
|
const filterSensitiveLog: (obj: GetUserEndpointsResponse) => any;
|
|
1234
746
|
}
|
|
1235
747
|
export interface GetVoiceChannelRequest {
|
|
1236
|
-
|
|
1237
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1238
|
-
*/
|
|
748
|
+
|
|
1239
749
|
ApplicationId: string | undefined;
|
|
1240
750
|
}
|
|
1241
751
|
export declare namespace GetVoiceChannelRequest {
|
|
1242
|
-
|
|
1243
|
-
* @internal
|
|
1244
|
-
*/
|
|
752
|
+
|
|
1245
753
|
const filterSensitiveLog: (obj: GetVoiceChannelRequest) => any;
|
|
1246
754
|
}
|
|
1247
755
|
export interface GetVoiceChannelResponse {
|
|
1248
|
-
|
|
1249
|
-
* <p>Provides information about the status and settings of the voice channel for an application.</p>
|
|
1250
|
-
*/
|
|
756
|
+
|
|
1251
757
|
VoiceChannelResponse: VoiceChannelResponse | undefined;
|
|
1252
758
|
}
|
|
1253
759
|
export declare namespace GetVoiceChannelResponse {
|
|
1254
|
-
|
|
1255
|
-
* @internal
|
|
1256
|
-
*/
|
|
760
|
+
|
|
1257
761
|
const filterSensitiveLog: (obj: GetVoiceChannelResponse) => any;
|
|
1258
762
|
}
|
|
1259
763
|
export interface GetVoiceTemplateRequest {
|
|
1260
|
-
|
|
1261
|
-
* <p>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.</p>
|
|
1262
|
-
*/
|
|
764
|
+
|
|
1263
765
|
TemplateName: string | undefined;
|
|
1264
|
-
|
|
1265
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
1266
|
-
*/
|
|
766
|
+
|
|
1267
767
|
Version?: string;
|
|
1268
768
|
}
|
|
1269
769
|
export declare namespace GetVoiceTemplateRequest {
|
|
1270
|
-
|
|
1271
|
-
* @internal
|
|
1272
|
-
*/
|
|
770
|
+
|
|
1273
771
|
const filterSensitiveLog: (obj: GetVoiceTemplateRequest) => any;
|
|
1274
772
|
}
|
|
1275
|
-
|
|
1276
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
|
|
1277
|
-
*/
|
|
773
|
+
|
|
1278
774
|
export interface VoiceTemplateResponse {
|
|
1279
|
-
|
|
1280
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
1281
|
-
*/
|
|
775
|
+
|
|
1282
776
|
Arn?: string;
|
|
1283
|
-
|
|
1284
|
-
* <p>The text of the script that's used in messages that are based on the message template, in plain text format.</p>
|
|
1285
|
-
*/
|
|
777
|
+
|
|
1286
778
|
Body?: string;
|
|
1287
|
-
|
|
1288
|
-
* <p>The date, in ISO 8601 format, when the message template was created.</p>
|
|
1289
|
-
*/
|
|
779
|
+
|
|
1290
780
|
CreationDate: string | undefined;
|
|
1291
|
-
|
|
1292
|
-
* <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
|
|
1293
|
-
*/
|
|
781
|
+
|
|
1294
782
|
DefaultSubstitutions?: string;
|
|
1295
|
-
|
|
1296
|
-
* <p>The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
|
|
1297
|
-
*/
|
|
783
|
+
|
|
1298
784
|
LanguageCode?: string;
|
|
1299
|
-
|
|
1300
|
-
* <p>The date, in ISO 8601 format, when the message template was last modified.</p>
|
|
1301
|
-
*/
|
|
785
|
+
|
|
1302
786
|
LastModifiedDate: string | undefined;
|
|
1303
|
-
|
|
1304
|
-
* <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>
|
|
1305
|
-
*/
|
|
787
|
+
|
|
1306
788
|
tags?: {
|
|
1307
789
|
[key: string]: string;
|
|
1308
790
|
};
|
|
1309
|
-
|
|
1310
|
-
* <p>The custom description of the message template.</p>
|
|
1311
|
-
*/
|
|
791
|
+
|
|
1312
792
|
TemplateDescription?: string;
|
|
1313
|
-
|
|
1314
|
-
* <p>The name of the message template.</p>
|
|
1315
|
-
*/
|
|
793
|
+
|
|
1316
794
|
TemplateName: string | undefined;
|
|
1317
|
-
|
|
1318
|
-
* <p>The type of channel that the message template is designed for. For a voice template, this value is VOICE.</p>
|
|
1319
|
-
*/
|
|
795
|
+
|
|
1320
796
|
TemplateType: TemplateType | string | undefined;
|
|
1321
|
-
|
|
1322
|
-
* <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
|
|
1323
|
-
*/
|
|
797
|
+
|
|
1324
798
|
Version?: string;
|
|
1325
|
-
|
|
1326
|
-
* <p>The name of the voice that's used when delivering messages that are based on the message template. 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>
|
|
1327
|
-
*/
|
|
799
|
+
|
|
1328
800
|
VoiceId?: string;
|
|
1329
801
|
}
|
|
1330
802
|
export declare namespace VoiceTemplateResponse {
|
|
1331
|
-
|
|
1332
|
-
* @internal
|
|
1333
|
-
*/
|
|
803
|
+
|
|
1334
804
|
const filterSensitiveLog: (obj: VoiceTemplateResponse) => any;
|
|
1335
805
|
}
|
|
1336
806
|
export interface GetVoiceTemplateResponse {
|
|
1337
|
-
|
|
1338
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
|
|
1339
|
-
*/
|
|
807
|
+
|
|
1340
808
|
VoiceTemplateResponse: VoiceTemplateResponse | undefined;
|
|
1341
809
|
}
|
|
1342
810
|
export declare namespace GetVoiceTemplateResponse {
|
|
1343
|
-
|
|
1344
|
-
* @internal
|
|
1345
|
-
*/
|
|
811
|
+
|
|
1346
812
|
const filterSensitiveLog: (obj: GetVoiceTemplateResponse) => any;
|
|
1347
813
|
}
|
|
1348
|
-
|
|
1349
|
-
* <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
|
|
1350
|
-
*/
|
|
814
|
+
|
|
1351
815
|
export interface JourneysResponse {
|
|
1352
|
-
|
|
1353
|
-
* <p>An array of responses, one for each journey that's associated with the application.</p>
|
|
1354
|
-
*/
|
|
816
|
+
|
|
1355
817
|
Item: JourneyResponse[] | undefined;
|
|
1356
|
-
|
|
1357
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
1358
|
-
*/
|
|
818
|
+
|
|
1359
819
|
NextToken?: string;
|
|
1360
820
|
}
|
|
1361
821
|
export declare namespace JourneysResponse {
|
|
1362
|
-
|
|
1363
|
-
* @internal
|
|
1364
|
-
*/
|
|
822
|
+
|
|
1365
823
|
const filterSensitiveLog: (obj: JourneysResponse) => any;
|
|
1366
824
|
}
|
|
1367
|
-
|
|
1368
|
-
* <p>Changes the status of a journey.</p>
|
|
1369
|
-
*/
|
|
825
|
+
|
|
1370
826
|
export interface JourneyStateRequest {
|
|
1371
|
-
|
|
1372
|
-
* <p>The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED</p> <p>If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.</p> <p>After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.</p> <p>When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.</p>
|
|
1373
|
-
*/
|
|
827
|
+
|
|
1374
828
|
State?: State | string;
|
|
1375
829
|
}
|
|
1376
830
|
export declare namespace JourneyStateRequest {
|
|
1377
|
-
|
|
1378
|
-
* @internal
|
|
1379
|
-
*/
|
|
831
|
+
|
|
1380
832
|
const filterSensitiveLog: (obj: JourneyStateRequest) => any;
|
|
1381
833
|
}
|
|
1382
834
|
export interface ListJourneysRequest {
|
|
1383
|
-
|
|
1384
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1385
|
-
*/
|
|
835
|
+
|
|
1386
836
|
ApplicationId: string | undefined;
|
|
1387
|
-
|
|
1388
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1389
|
-
*/
|
|
837
|
+
|
|
1390
838
|
PageSize?: string;
|
|
1391
|
-
|
|
1392
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
1393
|
-
*/
|
|
839
|
+
|
|
1394
840
|
Token?: string;
|
|
1395
841
|
}
|
|
1396
842
|
export declare namespace ListJourneysRequest {
|
|
1397
|
-
|
|
1398
|
-
* @internal
|
|
1399
|
-
*/
|
|
843
|
+
|
|
1400
844
|
const filterSensitiveLog: (obj: ListJourneysRequest) => any;
|
|
1401
845
|
}
|
|
1402
846
|
export interface ListJourneysResponse {
|
|
1403
|
-
|
|
1404
|
-
* <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
|
|
1405
|
-
*/
|
|
847
|
+
|
|
1406
848
|
JourneysResponse: JourneysResponse | undefined;
|
|
1407
849
|
}
|
|
1408
850
|
export declare namespace ListJourneysResponse {
|
|
1409
|
-
|
|
1410
|
-
* @internal
|
|
1411
|
-
*/
|
|
851
|
+
|
|
1412
852
|
const filterSensitiveLog: (obj: ListJourneysResponse) => any;
|
|
1413
853
|
}
|
|
1414
|
-
|
|
1415
|
-
* <p>Provides information about a message template that's associated with your Amazon Pinpoint account.</p>
|
|
1416
|
-
*/
|
|
854
|
+
|
|
1417
855
|
export interface TemplateResponse {
|
|
1418
|
-
|
|
1419
|
-
* <p>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.</p>
|
|
1420
|
-
*/
|
|
856
|
+
|
|
1421
857
|
Arn?: string;
|
|
1422
|
-
|
|
1423
|
-
* <p>The date, in ISO 8601 format, when the message template was created.</p>
|
|
1424
|
-
*/
|
|
858
|
+
|
|
1425
859
|
CreationDate: string | undefined;
|
|
1426
|
-
|
|
1427
|
-
* <p>The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
|
|
1428
|
-
*/
|
|
860
|
+
|
|
1429
861
|
DefaultSubstitutions?: string;
|
|
1430
|
-
|
|
1431
|
-
* <p>The date, in ISO 8601 format, when the message template was last modified.</p>
|
|
1432
|
-
*/
|
|
862
|
+
|
|
1433
863
|
LastModifiedDate: string | undefined;
|
|
1434
|
-
|
|
1435
|
-
* <p>A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
|
|
1436
|
-
*/
|
|
864
|
+
|
|
1437
865
|
tags?: {
|
|
1438
866
|
[key: string]: string;
|
|
1439
867
|
};
|
|
1440
|
-
|
|
1441
|
-
* <p>The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.</p>
|
|
1442
|
-
*/
|
|
868
|
+
|
|
1443
869
|
TemplateDescription?: string;
|
|
1444
|
-
|
|
1445
|
-
* <p>The name of the message template.</p>
|
|
1446
|
-
*/
|
|
870
|
+
|
|
1447
871
|
TemplateName: string | undefined;
|
|
1448
|
-
|
|
1449
|
-
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
1450
|
-
*/
|
|
872
|
+
|
|
1451
873
|
TemplateType: TemplateType | string | undefined;
|
|
1452
|
-
|
|
1453
|
-
* <p>The unique identifier, as an integer, for the active version of the message template.</p>
|
|
1454
|
-
*/
|
|
874
|
+
|
|
1455
875
|
Version?: string;
|
|
1456
876
|
}
|
|
1457
877
|
export declare namespace TemplateResponse {
|
|
1458
|
-
|
|
1459
|
-
* @internal
|
|
1460
|
-
*/
|
|
878
|
+
|
|
1461
879
|
const filterSensitiveLog: (obj: TemplateResponse) => any;
|
|
1462
880
|
}
|
|
1463
|
-
|
|
1464
|
-
* <p>Provides information about a specific version of a message template.</p>
|
|
1465
|
-
*/
|
|
881
|
+
|
|
1466
882
|
export interface TemplateVersionResponse {
|
|
1467
|
-
|
|
1468
|
-
* <p>The date, in ISO 8601 format, when the version of the message template was created.</p>
|
|
1469
|
-
*/
|
|
883
|
+
|
|
1470
884
|
CreationDate: string | undefined;
|
|
1471
|
-
|
|
1472
|
-
* <p>A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
|
|
1473
|
-
*/
|
|
885
|
+
|
|
1474
886
|
DefaultSubstitutions?: string;
|
|
1475
|
-
|
|
1476
|
-
* <p>The date, in ISO 8601 format, when the version of the message template was last modified.</p>
|
|
1477
|
-
*/
|
|
887
|
+
|
|
1478
888
|
LastModifiedDate: string | undefined;
|
|
1479
|
-
|
|
1480
|
-
* <p>The custom description of the version of the message template.</p>
|
|
1481
|
-
*/
|
|
889
|
+
|
|
1482
890
|
TemplateDescription?: string;
|
|
1483
|
-
|
|
1484
|
-
* <p>The name of the message template.</p>
|
|
1485
|
-
*/
|
|
891
|
+
|
|
1486
892
|
TemplateName: string | undefined;
|
|
1487
|
-
|
|
1488
|
-
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
1489
|
-
*/
|
|
893
|
+
|
|
1490
894
|
TemplateType: string | undefined;
|
|
1491
|
-
|
|
1492
|
-
* <p>The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.</p>
|
|
1493
|
-
*/
|
|
895
|
+
|
|
1494
896
|
Version?: string;
|
|
1495
897
|
}
|
|
1496
898
|
export declare namespace TemplateVersionResponse {
|
|
1497
|
-
|
|
1498
|
-
* @internal
|
|
1499
|
-
*/
|
|
899
|
+
|
|
1500
900
|
const filterSensitiveLog: (obj: TemplateVersionResponse) => any;
|
|
1501
901
|
}
|
|
1502
902
|
export interface ListTagsForResourceRequest {
|
|
1503
|
-
|
|
1504
|
-
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1505
|
-
*/
|
|
903
|
+
|
|
1506
904
|
ResourceArn: string | undefined;
|
|
1507
905
|
}
|
|
1508
906
|
export declare namespace ListTagsForResourceRequest {
|
|
1509
|
-
|
|
1510
|
-
* @internal
|
|
1511
|
-
*/
|
|
907
|
+
|
|
1512
908
|
const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
1513
909
|
}
|
|
1514
|
-
|
|
1515
|
-
* <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
|
|
1516
|
-
*/
|
|
910
|
+
|
|
1517
911
|
export interface TagsModel {
|
|
1518
|
-
|
|
1519
|
-
* <p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
|
|
1520
|
-
*/
|
|
912
|
+
|
|
1521
913
|
tags: {
|
|
1522
914
|
[key: string]: string;
|
|
1523
915
|
} | undefined;
|
|
1524
916
|
}
|
|
1525
917
|
export declare namespace TagsModel {
|
|
1526
|
-
|
|
1527
|
-
* @internal
|
|
1528
|
-
*/
|
|
918
|
+
|
|
1529
919
|
const filterSensitiveLog: (obj: TagsModel) => any;
|
|
1530
920
|
}
|
|
1531
921
|
export interface ListTagsForResourceResponse {
|
|
1532
|
-
|
|
1533
|
-
* <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
|
|
1534
|
-
*/
|
|
922
|
+
|
|
1535
923
|
TagsModel: TagsModel | undefined;
|
|
1536
924
|
}
|
|
1537
925
|
export declare namespace ListTagsForResourceResponse {
|
|
1538
|
-
|
|
1539
|
-
* @internal
|
|
1540
|
-
*/
|
|
926
|
+
|
|
1541
927
|
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
1542
928
|
}
|
|
1543
929
|
export interface ListTemplatesRequest {
|
|
1544
|
-
|
|
1545
|
-
* <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1546
|
-
*/
|
|
930
|
+
|
|
1547
931
|
NextToken?: string;
|
|
1548
|
-
|
|
1549
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1550
|
-
*/
|
|
932
|
+
|
|
1551
933
|
PageSize?: string;
|
|
1552
|
-
|
|
1553
|
-
* <p>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.</p>
|
|
1554
|
-
*/
|
|
934
|
+
|
|
1555
935
|
Prefix?: string;
|
|
1556
|
-
|
|
1557
|
-
* <p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>
|
|
1558
|
-
*/
|
|
936
|
+
|
|
1559
937
|
TemplateType?: string;
|
|
1560
938
|
}
|
|
1561
939
|
export declare namespace ListTemplatesRequest {
|
|
1562
|
-
|
|
1563
|
-
* @internal
|
|
1564
|
-
*/
|
|
940
|
+
|
|
1565
941
|
const filterSensitiveLog: (obj: ListTemplatesRequest) => any;
|
|
1566
942
|
}
|
|
1567
|
-
|
|
1568
|
-
* <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
|
|
1569
|
-
*/
|
|
943
|
+
|
|
1570
944
|
export interface TemplatesResponse {
|
|
1571
|
-
|
|
1572
|
-
* <p>An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.</p>
|
|
1573
|
-
*/
|
|
945
|
+
|
|
1574
946
|
Item: TemplateResponse[] | undefined;
|
|
1575
|
-
|
|
1576
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
1577
|
-
*/
|
|
947
|
+
|
|
1578
948
|
NextToken?: string;
|
|
1579
949
|
}
|
|
1580
950
|
export declare namespace TemplatesResponse {
|
|
1581
|
-
|
|
1582
|
-
* @internal
|
|
1583
|
-
*/
|
|
951
|
+
|
|
1584
952
|
const filterSensitiveLog: (obj: TemplatesResponse) => any;
|
|
1585
953
|
}
|
|
1586
954
|
export interface ListTemplatesResponse {
|
|
1587
|
-
|
|
1588
|
-
* <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
|
|
1589
|
-
*/
|
|
955
|
+
|
|
1590
956
|
TemplatesResponse: TemplatesResponse | undefined;
|
|
1591
957
|
}
|
|
1592
958
|
export declare namespace ListTemplatesResponse {
|
|
1593
|
-
|
|
1594
|
-
* @internal
|
|
1595
|
-
*/
|
|
959
|
+
|
|
1596
960
|
const filterSensitiveLog: (obj: ListTemplatesResponse) => any;
|
|
1597
961
|
}
|
|
1598
962
|
export interface ListTemplateVersionsRequest {
|
|
1599
|
-
|
|
1600
|
-
* <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1601
|
-
*/
|
|
963
|
+
|
|
1602
964
|
NextToken?: string;
|
|
1603
|
-
|
|
1604
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
1605
|
-
*/
|
|
965
|
+
|
|
1606
966
|
PageSize?: string;
|
|
1607
|
-
|
|
1608
|
-
* <p>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.</p>
|
|
1609
|
-
*/
|
|
967
|
+
|
|
1610
968
|
TemplateName: string | undefined;
|
|
1611
|
-
|
|
1612
|
-
* <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
1613
|
-
*/
|
|
969
|
+
|
|
1614
970
|
TemplateType: string | undefined;
|
|
1615
971
|
}
|
|
1616
972
|
export declare namespace ListTemplateVersionsRequest {
|
|
1617
|
-
|
|
1618
|
-
* @internal
|
|
1619
|
-
*/
|
|
973
|
+
|
|
1620
974
|
const filterSensitiveLog: (obj: ListTemplateVersionsRequest) => any;
|
|
1621
975
|
}
|
|
1622
|
-
|
|
1623
|
-
* <p>Provides information about all the versions of a specific message template.</p>
|
|
1624
|
-
*/
|
|
976
|
+
|
|
1625
977
|
export interface TemplateVersionsResponse {
|
|
1626
|
-
|
|
1627
|
-
* <p>An array of responses, one for each version of the message template.</p>
|
|
1628
|
-
*/
|
|
978
|
+
|
|
1629
979
|
Item: TemplateVersionResponse[] | undefined;
|
|
1630
|
-
|
|
1631
|
-
* <p>The message that's returned from the API for the request to retrieve information about all the versions of the message template.</p>
|
|
1632
|
-
*/
|
|
980
|
+
|
|
1633
981
|
Message?: string;
|
|
1634
|
-
|
|
1635
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
1636
|
-
*/
|
|
982
|
+
|
|
1637
983
|
NextToken?: string;
|
|
1638
|
-
|
|
1639
|
-
* <p>The unique identifier for the request to retrieve information about all the versions of the message template.</p>
|
|
1640
|
-
*/
|
|
984
|
+
|
|
1641
985
|
RequestID?: string;
|
|
1642
986
|
}
|
|
1643
987
|
export declare namespace TemplateVersionsResponse {
|
|
1644
|
-
|
|
1645
|
-
* @internal
|
|
1646
|
-
*/
|
|
988
|
+
|
|
1647
989
|
const filterSensitiveLog: (obj: TemplateVersionsResponse) => any;
|
|
1648
990
|
}
|
|
1649
991
|
export interface ListTemplateVersionsResponse {
|
|
1650
|
-
|
|
1651
|
-
* <p>Provides information about all the versions of a specific message template.</p>
|
|
1652
|
-
*/
|
|
992
|
+
|
|
1653
993
|
TemplateVersionsResponse: TemplateVersionsResponse | undefined;
|
|
1654
994
|
}
|
|
1655
995
|
export declare namespace ListTemplateVersionsResponse {
|
|
1656
|
-
|
|
1657
|
-
* @internal
|
|
1658
|
-
*/
|
|
996
|
+
|
|
1659
997
|
const filterSensitiveLog: (obj: ListTemplateVersionsResponse) => any;
|
|
1660
998
|
}
|
|
1661
|
-
|
|
1662
|
-
* <p>Provides information about the results of sending a message directly to an endpoint address.</p>
|
|
1663
|
-
*/
|
|
999
|
+
|
|
1664
1000
|
export interface MessageResult {
|
|
1665
|
-
|
|
1666
|
-
* <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
|
|
1667
|
-
*/
|
|
1001
|
+
|
|
1668
1002
|
DeliveryStatus: DeliveryStatus | string | undefined;
|
|
1669
|
-
|
|
1670
|
-
* <p>The unique identifier for the message that was sent.</p>
|
|
1671
|
-
*/
|
|
1003
|
+
|
|
1672
1004
|
MessageId?: string;
|
|
1673
|
-
|
|
1674
|
-
* <p>The downstream service status code for delivering the message.</p>
|
|
1675
|
-
*/
|
|
1005
|
+
|
|
1676
1006
|
StatusCode: number | undefined;
|
|
1677
|
-
|
|
1678
|
-
* <p>The status message for delivering the message.</p>
|
|
1679
|
-
*/
|
|
1007
|
+
|
|
1680
1008
|
StatusMessage?: string;
|
|
1681
|
-
|
|
1682
|
-
* <p>For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.</p>
|
|
1683
|
-
*/
|
|
1009
|
+
|
|
1684
1010
|
UpdatedToken?: string;
|
|
1685
1011
|
}
|
|
1686
1012
|
export declare namespace MessageResult {
|
|
1687
|
-
|
|
1688
|
-
* @internal
|
|
1689
|
-
*/
|
|
1013
|
+
|
|
1690
1014
|
const filterSensitiveLog: (obj: MessageResult) => any;
|
|
1691
1015
|
}
|
|
1692
|
-
|
|
1693
|
-
* <p>Specifies the configuration and other settings for a message.</p>
|
|
1694
|
-
*/
|
|
1016
|
+
|
|
1695
1017
|
export interface MessageRequest {
|
|
1696
|
-
|
|
1697
|
-
* <p>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</p>
|
|
1698
|
-
*/
|
|
1018
|
+
|
|
1699
1019
|
Addresses?: {
|
|
1700
1020
|
[key: string]: AddressConfiguration;
|
|
1701
1021
|
};
|
|
1702
|
-
|
|
1703
|
-
* <p>A map of custom attributes to attach to the message. 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>
|
|
1704
|
-
*/
|
|
1022
|
+
|
|
1705
1023
|
Context?: {
|
|
1706
1024
|
[key: string]: string;
|
|
1707
1025
|
};
|
|
1708
|
-
|
|
1709
|
-
* <p>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</p>
|
|
1710
|
-
*/
|
|
1026
|
+
|
|
1711
1027
|
Endpoints?: {
|
|
1712
1028
|
[key: string]: EndpointSendConfiguration;
|
|
1713
1029
|
};
|
|
1714
|
-
|
|
1715
|
-
* <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
|
|
1716
|
-
*/
|
|
1030
|
+
|
|
1717
1031
|
MessageConfiguration: DirectMessageConfiguration | undefined;
|
|
1718
|
-
|
|
1719
|
-
* <p>The message template to use for the message.</p>
|
|
1720
|
-
*/
|
|
1032
|
+
|
|
1721
1033
|
TemplateConfiguration?: TemplateConfiguration;
|
|
1722
|
-
|
|
1723
|
-
* <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
|
|
1724
|
-
*/
|
|
1034
|
+
|
|
1725
1035
|
TraceId?: string;
|
|
1726
1036
|
}
|
|
1727
1037
|
export declare namespace MessageRequest {
|
|
1728
|
-
|
|
1729
|
-
* @internal
|
|
1730
|
-
*/
|
|
1038
|
+
|
|
1731
1039
|
const filterSensitiveLog: (obj: MessageRequest) => any;
|
|
1732
1040
|
}
|
|
1733
|
-
|
|
1734
|
-
* <p>Provides information about the results of a request to send a message to an endpoint address.</p>
|
|
1735
|
-
*/
|
|
1041
|
+
|
|
1736
1042
|
export interface MessageResponse {
|
|
1737
|
-
|
|
1738
|
-
* <p>The unique identifier for the application that was used to send the message.</p>
|
|
1739
|
-
*/
|
|
1043
|
+
|
|
1740
1044
|
ApplicationId: string | undefined;
|
|
1741
|
-
|
|
1742
|
-
* <p>A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.</p>
|
|
1743
|
-
*/
|
|
1045
|
+
|
|
1744
1046
|
EndpointResult?: {
|
|
1745
1047
|
[key: string]: EndpointMessageResult;
|
|
1746
1048
|
};
|
|
1747
|
-
|
|
1748
|
-
* <p>The identifier for the original request that the message was delivered for.</p>
|
|
1749
|
-
*/
|
|
1049
|
+
|
|
1750
1050
|
RequestId?: string;
|
|
1751
|
-
|
|
1752
|
-
* <p>A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.</p>
|
|
1753
|
-
*/
|
|
1051
|
+
|
|
1754
1052
|
Result?: {
|
|
1755
1053
|
[key: string]: MessageResult;
|
|
1756
1054
|
};
|
|
1757
1055
|
}
|
|
1758
1056
|
export declare namespace MessageResponse {
|
|
1759
|
-
|
|
1760
|
-
* @internal
|
|
1761
|
-
*/
|
|
1057
|
+
|
|
1762
1058
|
const filterSensitiveLog: (obj: MessageResponse) => any;
|
|
1763
1059
|
}
|
|
1764
|
-
|
|
1765
|
-
* <p>Specifies a phone number to validate and retrieve information about.</p>
|
|
1766
|
-
*/
|
|
1060
|
+
|
|
1767
1061
|
export interface NumberValidateRequest {
|
|
1768
|
-
|
|
1769
|
-
* <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
|
|
1770
|
-
*/
|
|
1062
|
+
|
|
1771
1063
|
IsoCountryCode?: string;
|
|
1772
|
-
|
|
1773
|
-
* <p>The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.</p>
|
|
1774
|
-
*/
|
|
1064
|
+
|
|
1775
1065
|
PhoneNumber?: string;
|
|
1776
1066
|
}
|
|
1777
1067
|
export declare namespace NumberValidateRequest {
|
|
1778
|
-
|
|
1779
|
-
* @internal
|
|
1780
|
-
*/
|
|
1068
|
+
|
|
1781
1069
|
const filterSensitiveLog: (obj: NumberValidateRequest) => any;
|
|
1782
1070
|
}
|
|
1783
|
-
|
|
1784
|
-
* <p>Provides information about a phone number.</p>
|
|
1785
|
-
*/
|
|
1071
|
+
|
|
1786
1072
|
export interface NumberValidateResponse {
|
|
1787
|
-
|
|
1788
|
-
* <p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>
|
|
1789
|
-
*/
|
|
1073
|
+
|
|
1790
1074
|
Carrier?: string;
|
|
1791
|
-
|
|
1792
|
-
* <p>The name of the city where the phone number was originally registered.</p>
|
|
1793
|
-
*/
|
|
1075
|
+
|
|
1794
1076
|
City?: string;
|
|
1795
|
-
|
|
1796
|
-
* <p>The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.</p>
|
|
1797
|
-
*/
|
|
1077
|
+
|
|
1798
1078
|
CleansedPhoneNumberE164?: string;
|
|
1799
|
-
|
|
1800
|
-
* <p>The cleansed phone number, in the format for the location where the phone number was originally registered.</p>
|
|
1801
|
-
*/
|
|
1079
|
+
|
|
1802
1080
|
CleansedPhoneNumberNational?: string;
|
|
1803
|
-
|
|
1804
|
-
* <p>The name of the country or region where the phone number was originally registered.</p>
|
|
1805
|
-
*/
|
|
1081
|
+
|
|
1806
1082
|
Country?: string;
|
|
1807
|
-
|
|
1808
|
-
* <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
|
|
1809
|
-
*/
|
|
1083
|
+
|
|
1810
1084
|
CountryCodeIso2?: string;
|
|
1811
|
-
|
|
1812
|
-
* <p>The numeric code for the country or region where the phone number was originally registered.</p>
|
|
1813
|
-
*/
|
|
1085
|
+
|
|
1814
1086
|
CountryCodeNumeric?: string;
|
|
1815
|
-
|
|
1816
|
-
* <p>The name of the county where the phone number was originally registered.</p>
|
|
1817
|
-
*/
|
|
1087
|
+
|
|
1818
1088
|
County?: string;
|
|
1819
|
-
|
|
1820
|
-
* <p>The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.</p>
|
|
1821
|
-
*/
|
|
1089
|
+
|
|
1822
1090
|
OriginalCountryCodeIso2?: string;
|
|
1823
|
-
|
|
1824
|
-
* <p>The phone number that was sent in the request body.</p>
|
|
1825
|
-
*/
|
|
1091
|
+
|
|
1826
1092
|
OriginalPhoneNumber?: string;
|
|
1827
|
-
|
|
1828
|
-
* <p>The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
|
|
1829
|
-
* INVALID, PREPAID, and OTHER.</p>
|
|
1830
|
-
*/
|
|
1093
|
+
|
|
1831
1094
|
PhoneType?: string;
|
|
1832
|
-
|
|
1833
|
-
* <p>The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).</p>
|
|
1834
|
-
*/
|
|
1095
|
+
|
|
1835
1096
|
PhoneTypeCode?: number;
|
|
1836
|
-
|
|
1837
|
-
* <p>The time zone for the location where the phone number was originally registered.</p>
|
|
1838
|
-
*/
|
|
1097
|
+
|
|
1839
1098
|
Timezone?: string;
|
|
1840
|
-
|
|
1841
|
-
* <p>The postal or ZIP code for the location where the phone number was originally registered.</p>
|
|
1842
|
-
*/
|
|
1099
|
+
|
|
1843
1100
|
ZipCode?: string;
|
|
1844
1101
|
}
|
|
1845
1102
|
export declare namespace NumberValidateResponse {
|
|
1846
|
-
|
|
1847
|
-
* @internal
|
|
1848
|
-
*/
|
|
1103
|
+
|
|
1849
1104
|
const filterSensitiveLog: (obj: NumberValidateResponse) => any;
|
|
1850
1105
|
}
|
|
1851
1106
|
export interface PhoneNumberValidateRequest {
|
|
1852
|
-
|
|
1853
|
-
* <p>Specifies a phone number to validate and retrieve information about.</p>
|
|
1854
|
-
*/
|
|
1107
|
+
|
|
1855
1108
|
NumberValidateRequest: NumberValidateRequest | undefined;
|
|
1856
1109
|
}
|
|
1857
1110
|
export declare namespace PhoneNumberValidateRequest {
|
|
1858
|
-
|
|
1859
|
-
* @internal
|
|
1860
|
-
*/
|
|
1111
|
+
|
|
1861
1112
|
const filterSensitiveLog: (obj: PhoneNumberValidateRequest) => any;
|
|
1862
1113
|
}
|
|
1863
1114
|
export interface PhoneNumberValidateResponse {
|
|
1864
|
-
|
|
1865
|
-
* <p>Provides information about a phone number.</p>
|
|
1866
|
-
*/
|
|
1115
|
+
|
|
1867
1116
|
NumberValidateResponse: NumberValidateResponse | undefined;
|
|
1868
1117
|
}
|
|
1869
1118
|
export declare namespace PhoneNumberValidateResponse {
|
|
1870
|
-
|
|
1871
|
-
* @internal
|
|
1872
|
-
*/
|
|
1119
|
+
|
|
1873
1120
|
const filterSensitiveLog: (obj: PhoneNumberValidateResponse) => any;
|
|
1874
1121
|
}
|
|
1875
1122
|
export interface PutEventsRequest {
|
|
1876
|
-
|
|
1877
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1878
|
-
*/
|
|
1123
|
+
|
|
1879
1124
|
ApplicationId: string | undefined;
|
|
1880
|
-
|
|
1881
|
-
* <p>Specifies a batch of events to process.</p>
|
|
1882
|
-
*/
|
|
1125
|
+
|
|
1883
1126
|
EventsRequest: EventsRequest | undefined;
|
|
1884
1127
|
}
|
|
1885
1128
|
export declare namespace PutEventsRequest {
|
|
1886
|
-
|
|
1887
|
-
* @internal
|
|
1888
|
-
*/
|
|
1129
|
+
|
|
1889
1130
|
const filterSensitiveLog: (obj: PutEventsRequest) => any;
|
|
1890
1131
|
}
|
|
1891
1132
|
export interface PutEventsResponse {
|
|
1892
|
-
|
|
1893
|
-
* <p>Provides information about endpoints and the events that they're associated with.</p>
|
|
1894
|
-
*/
|
|
1133
|
+
|
|
1895
1134
|
EventsResponse: EventsResponse | undefined;
|
|
1896
1135
|
}
|
|
1897
1136
|
export declare namespace PutEventsResponse {
|
|
1898
|
-
|
|
1899
|
-
* @internal
|
|
1900
|
-
*/
|
|
1137
|
+
|
|
1901
1138
|
const filterSensitiveLog: (obj: PutEventsResponse) => any;
|
|
1902
1139
|
}
|
|
1903
|
-
|
|
1904
|
-
* <p>Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.</p>
|
|
1905
|
-
*/
|
|
1140
|
+
|
|
1906
1141
|
export interface WriteEventStream {
|
|
1907
|
-
|
|
1908
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.</p> <p>For a Kinesis data stream, the ARN format is: arn:aws:kinesis:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:stream/<replaceable>stream_name</replaceable>
|
|
1909
|
-
* </p> <p>For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:deliverystream/<replaceable>stream_name</replaceable>
|
|
1910
|
-
* </p>
|
|
1911
|
-
*/
|
|
1142
|
+
|
|
1912
1143
|
DestinationStreamArn: string | undefined;
|
|
1913
|
-
|
|
1914
|
-
* <p>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.</p>
|
|
1915
|
-
*/
|
|
1144
|
+
|
|
1916
1145
|
RoleArn: string | undefined;
|
|
1917
1146
|
}
|
|
1918
1147
|
export declare namespace WriteEventStream {
|
|
1919
|
-
|
|
1920
|
-
* @internal
|
|
1921
|
-
*/
|
|
1148
|
+
|
|
1922
1149
|
const filterSensitiveLog: (obj: WriteEventStream) => any;
|
|
1923
1150
|
}
|
|
1924
1151
|
export interface PutEventStreamRequest {
|
|
1925
|
-
|
|
1926
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1927
|
-
*/
|
|
1152
|
+
|
|
1928
1153
|
ApplicationId: string | undefined;
|
|
1929
|
-
|
|
1930
|
-
* <p>Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.</p>
|
|
1931
|
-
*/
|
|
1154
|
+
|
|
1932
1155
|
WriteEventStream: WriteEventStream | undefined;
|
|
1933
1156
|
}
|
|
1934
1157
|
export declare namespace PutEventStreamRequest {
|
|
1935
|
-
|
|
1936
|
-
* @internal
|
|
1937
|
-
*/
|
|
1158
|
+
|
|
1938
1159
|
const filterSensitiveLog: (obj: PutEventStreamRequest) => any;
|
|
1939
1160
|
}
|
|
1940
1161
|
export interface PutEventStreamResponse {
|
|
1941
|
-
|
|
1942
|
-
* <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
1943
|
-
*/
|
|
1162
|
+
|
|
1944
1163
|
EventStream: EventStream | undefined;
|
|
1945
1164
|
}
|
|
1946
1165
|
export declare namespace PutEventStreamResponse {
|
|
1947
|
-
|
|
1948
|
-
* @internal
|
|
1949
|
-
*/
|
|
1166
|
+
|
|
1950
1167
|
const filterSensitiveLog: (obj: PutEventStreamResponse) => any;
|
|
1951
1168
|
}
|
|
1952
|
-
|
|
1953
|
-
* <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
|
|
1954
|
-
*/
|
|
1169
|
+
|
|
1955
1170
|
export interface UpdateAttributesRequest {
|
|
1956
|
-
|
|
1957
|
-
* <p>An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.</p>
|
|
1958
|
-
*/
|
|
1171
|
+
|
|
1959
1172
|
Blacklist?: string[];
|
|
1960
1173
|
}
|
|
1961
1174
|
export declare namespace UpdateAttributesRequest {
|
|
1962
|
-
|
|
1963
|
-
* @internal
|
|
1964
|
-
*/
|
|
1175
|
+
|
|
1965
1176
|
const filterSensitiveLog: (obj: UpdateAttributesRequest) => any;
|
|
1966
1177
|
}
|
|
1967
1178
|
export interface RemoveAttributesRequest {
|
|
1968
|
-
|
|
1969
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
1970
|
-
*/
|
|
1179
|
+
|
|
1971
1180
|
ApplicationId: string | undefined;
|
|
1972
|
-
|
|
1973
|
-
* <p>The type of attribute or attributes to remove. Valid values are:</p> <ul><li><p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li> <li><p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li> <li><p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li></ul>
|
|
1974
|
-
*/
|
|
1181
|
+
|
|
1975
1182
|
AttributeType: string | undefined;
|
|
1976
|
-
|
|
1977
|
-
* <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
|
|
1978
|
-
*/
|
|
1183
|
+
|
|
1979
1184
|
UpdateAttributesRequest: UpdateAttributesRequest | undefined;
|
|
1980
1185
|
}
|
|
1981
1186
|
export declare namespace RemoveAttributesRequest {
|
|
1982
|
-
|
|
1983
|
-
* @internal
|
|
1984
|
-
*/
|
|
1187
|
+
|
|
1985
1188
|
const filterSensitiveLog: (obj: RemoveAttributesRequest) => any;
|
|
1986
1189
|
}
|
|
1987
1190
|
export interface RemoveAttributesResponse {
|
|
1988
|
-
|
|
1989
|
-
* <p>Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.</p>
|
|
1990
|
-
*/
|
|
1191
|
+
|
|
1991
1192
|
AttributesResource: AttributesResource | undefined;
|
|
1992
1193
|
}
|
|
1993
1194
|
export declare namespace RemoveAttributesResponse {
|
|
1994
|
-
|
|
1995
|
-
* @internal
|
|
1996
|
-
*/
|
|
1195
|
+
|
|
1997
1196
|
const filterSensitiveLog: (obj: RemoveAttributesResponse) => any;
|
|
1998
1197
|
}
|
|
1999
1198
|
export interface SendMessagesRequest {
|
|
2000
|
-
|
|
2001
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2002
|
-
*/
|
|
1199
|
+
|
|
2003
1200
|
ApplicationId: string | undefined;
|
|
2004
|
-
|
|
2005
|
-
* <p>Specifies the configuration and other settings for a message.</p>
|
|
2006
|
-
*/
|
|
1201
|
+
|
|
2007
1202
|
MessageRequest: MessageRequest | undefined;
|
|
2008
1203
|
}
|
|
2009
1204
|
export declare namespace SendMessagesRequest {
|
|
2010
|
-
|
|
2011
|
-
* @internal
|
|
2012
|
-
*/
|
|
1205
|
+
|
|
2013
1206
|
const filterSensitiveLog: (obj: SendMessagesRequest) => any;
|
|
2014
1207
|
}
|
|
2015
1208
|
export interface SendMessagesResponse {
|
|
2016
|
-
|
|
2017
|
-
* <p>Provides information about the results of a request to send a message to an endpoint address.</p>
|
|
2018
|
-
*/
|
|
1209
|
+
|
|
2019
1210
|
MessageResponse: MessageResponse | undefined;
|
|
2020
1211
|
}
|
|
2021
1212
|
export declare namespace SendMessagesResponse {
|
|
2022
|
-
|
|
2023
|
-
* @internal
|
|
2024
|
-
*/
|
|
1213
|
+
|
|
2025
1214
|
const filterSensitiveLog: (obj: SendMessagesResponse) => any;
|
|
2026
1215
|
}
|
|
2027
|
-
|
|
2028
|
-
* <p>Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.</p>
|
|
2029
|
-
*/
|
|
1216
|
+
|
|
2030
1217
|
export interface SendUsersMessageRequest {
|
|
2031
|
-
|
|
2032
|
-
* <p>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.</p>
|
|
2033
|
-
*/
|
|
1218
|
+
|
|
2034
1219
|
Context?: {
|
|
2035
1220
|
[key: string]: string;
|
|
2036
1221
|
};
|
|
2037
|
-
|
|
2038
|
-
* <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
|
|
2039
|
-
*/
|
|
1222
|
+
|
|
2040
1223
|
MessageConfiguration: DirectMessageConfiguration | undefined;
|
|
2041
|
-
|
|
2042
|
-
* <p>The message template to use for the message.</p>
|
|
2043
|
-
*/
|
|
1224
|
+
|
|
2044
1225
|
TemplateConfiguration?: TemplateConfiguration;
|
|
2045
|
-
|
|
2046
|
-
* <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
|
|
2047
|
-
*/
|
|
1226
|
+
|
|
2048
1227
|
TraceId?: string;
|
|
2049
|
-
|
|
2050
|
-
* <p>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables.</p>
|
|
2051
|
-
*/
|
|
1228
|
+
|
|
2052
1229
|
Users: {
|
|
2053
1230
|
[key: string]: EndpointSendConfiguration;
|
|
2054
1231
|
} | undefined;
|
|
2055
1232
|
}
|
|
2056
1233
|
export declare namespace SendUsersMessageRequest {
|
|
2057
|
-
|
|
2058
|
-
* @internal
|
|
2059
|
-
*/
|
|
1234
|
+
|
|
2060
1235
|
const filterSensitiveLog: (obj: SendUsersMessageRequest) => any;
|
|
2061
1236
|
}
|
|
2062
1237
|
export interface SendUsersMessagesRequest {
|
|
2063
|
-
|
|
2064
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2065
|
-
*/
|
|
1238
|
+
|
|
2066
1239
|
ApplicationId: string | undefined;
|
|
2067
|
-
|
|
2068
|
-
* <p>Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.</p>
|
|
2069
|
-
*/
|
|
1240
|
+
|
|
2070
1241
|
SendUsersMessageRequest: SendUsersMessageRequest | undefined;
|
|
2071
1242
|
}
|
|
2072
1243
|
export declare namespace SendUsersMessagesRequest {
|
|
2073
|
-
|
|
2074
|
-
* @internal
|
|
2075
|
-
*/
|
|
1244
|
+
|
|
2076
1245
|
const filterSensitiveLog: (obj: SendUsersMessagesRequest) => any;
|
|
2077
1246
|
}
|
|
2078
|
-
|
|
2079
|
-
* <p>Provides information about which users and endpoints a message was sent to.</p>
|
|
2080
|
-
*/
|
|
1247
|
+
|
|
2081
1248
|
export interface SendUsersMessageResponse {
|
|
2082
|
-
|
|
2083
|
-
* <p>The unique identifier for the application that was used to send the message.</p>
|
|
2084
|
-
*/
|
|
1249
|
+
|
|
2085
1250
|
ApplicationId: string | undefined;
|
|
2086
|
-
|
|
2087
|
-
* <p>The unique identifier that was assigned to the message request.</p>
|
|
2088
|
-
*/
|
|
1251
|
+
|
|
2089
1252
|
RequestId?: string;
|
|
2090
|
-
|
|
2091
|
-
* <p>An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.</p>
|
|
2092
|
-
*/
|
|
1253
|
+
|
|
2093
1254
|
Result?: {
|
|
2094
1255
|
[key: string]: {
|
|
2095
1256
|
[key: string]: EndpointMessageResult;
|
|
@@ -2097,918 +1258,572 @@ export interface SendUsersMessageResponse {
|
|
|
2097
1258
|
};
|
|
2098
1259
|
}
|
|
2099
1260
|
export declare namespace SendUsersMessageResponse {
|
|
2100
|
-
|
|
2101
|
-
* @internal
|
|
2102
|
-
*/
|
|
1261
|
+
|
|
2103
1262
|
const filterSensitiveLog: (obj: SendUsersMessageResponse) => any;
|
|
2104
1263
|
}
|
|
2105
1264
|
export interface SendUsersMessagesResponse {
|
|
2106
|
-
|
|
2107
|
-
* <p>Provides information about which users and endpoints a message was sent to.</p>
|
|
2108
|
-
*/
|
|
1265
|
+
|
|
2109
1266
|
SendUsersMessageResponse: SendUsersMessageResponse | undefined;
|
|
2110
1267
|
}
|
|
2111
1268
|
export declare namespace SendUsersMessagesResponse {
|
|
2112
|
-
|
|
2113
|
-
* @internal
|
|
2114
|
-
*/
|
|
1269
|
+
|
|
2115
1270
|
const filterSensitiveLog: (obj: SendUsersMessagesResponse) => any;
|
|
2116
1271
|
}
|
|
2117
1272
|
export interface TagResourceRequest {
|
|
2118
|
-
|
|
2119
|
-
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2120
|
-
*/
|
|
1273
|
+
|
|
2121
1274
|
ResourceArn: string | undefined;
|
|
2122
|
-
|
|
2123
|
-
* <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
|
|
2124
|
-
*/
|
|
1275
|
+
|
|
2125
1276
|
TagsModel: TagsModel | undefined;
|
|
2126
1277
|
}
|
|
2127
1278
|
export declare namespace TagResourceRequest {
|
|
2128
|
-
|
|
2129
|
-
* @internal
|
|
2130
|
-
*/
|
|
1279
|
+
|
|
2131
1280
|
const filterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
2132
1281
|
}
|
|
2133
1282
|
export interface UntagResourceRequest {
|
|
2134
|
-
|
|
2135
|
-
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2136
|
-
*/
|
|
1283
|
+
|
|
2137
1284
|
ResourceArn: string | undefined;
|
|
2138
|
-
|
|
2139
|
-
* <p>The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).</p>
|
|
2140
|
-
*/
|
|
1285
|
+
|
|
2141
1286
|
TagKeys: string[] | undefined;
|
|
2142
1287
|
}
|
|
2143
1288
|
export declare namespace UntagResourceRequest {
|
|
2144
|
-
|
|
2145
|
-
* @internal
|
|
2146
|
-
*/
|
|
1289
|
+
|
|
2147
1290
|
const filterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
2148
1291
|
}
|
|
2149
1292
|
export interface UpdateAdmChannelRequest {
|
|
2150
|
-
|
|
2151
|
-
* <p>Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
|
|
2152
|
-
*/
|
|
1293
|
+
|
|
2153
1294
|
ADMChannelRequest: ADMChannelRequest | undefined;
|
|
2154
|
-
|
|
2155
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2156
|
-
*/
|
|
1295
|
+
|
|
2157
1296
|
ApplicationId: string | undefined;
|
|
2158
1297
|
}
|
|
2159
1298
|
export declare namespace UpdateAdmChannelRequest {
|
|
2160
|
-
|
|
2161
|
-
* @internal
|
|
2162
|
-
*/
|
|
1299
|
+
|
|
2163
1300
|
const filterSensitiveLog: (obj: UpdateAdmChannelRequest) => any;
|
|
2164
1301
|
}
|
|
2165
1302
|
export interface UpdateAdmChannelResponse {
|
|
2166
|
-
|
|
2167
|
-
* <p>Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
|
|
2168
|
-
*/
|
|
1303
|
+
|
|
2169
1304
|
ADMChannelResponse: ADMChannelResponse | undefined;
|
|
2170
1305
|
}
|
|
2171
1306
|
export declare namespace UpdateAdmChannelResponse {
|
|
2172
|
-
|
|
2173
|
-
* @internal
|
|
2174
|
-
*/
|
|
1307
|
+
|
|
2175
1308
|
const filterSensitiveLog: (obj: UpdateAdmChannelResponse) => any;
|
|
2176
1309
|
}
|
|
2177
1310
|
export interface UpdateApnsChannelRequest {
|
|
2178
|
-
|
|
2179
|
-
* <p>Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
|
|
2180
|
-
*/
|
|
1311
|
+
|
|
2181
1312
|
APNSChannelRequest: APNSChannelRequest | undefined;
|
|
2182
|
-
|
|
2183
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2184
|
-
*/
|
|
1313
|
+
|
|
2185
1314
|
ApplicationId: string | undefined;
|
|
2186
1315
|
}
|
|
2187
1316
|
export declare namespace UpdateApnsChannelRequest {
|
|
2188
|
-
|
|
2189
|
-
* @internal
|
|
2190
|
-
*/
|
|
1317
|
+
|
|
2191
1318
|
const filterSensitiveLog: (obj: UpdateApnsChannelRequest) => any;
|
|
2192
1319
|
}
|
|
2193
1320
|
export interface UpdateApnsChannelResponse {
|
|
2194
|
-
|
|
2195
|
-
* <p>Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
|
|
2196
|
-
*/
|
|
1321
|
+
|
|
2197
1322
|
APNSChannelResponse: APNSChannelResponse | undefined;
|
|
2198
1323
|
}
|
|
2199
1324
|
export declare namespace UpdateApnsChannelResponse {
|
|
2200
|
-
|
|
2201
|
-
* @internal
|
|
2202
|
-
*/
|
|
1325
|
+
|
|
2203
1326
|
const filterSensitiveLog: (obj: UpdateApnsChannelResponse) => any;
|
|
2204
1327
|
}
|
|
2205
1328
|
export interface UpdateApnsSandboxChannelRequest {
|
|
2206
|
-
|
|
2207
|
-
* <p>Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
|
|
2208
|
-
*/
|
|
1329
|
+
|
|
2209
1330
|
APNSSandboxChannelRequest: APNSSandboxChannelRequest | undefined;
|
|
2210
|
-
|
|
2211
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2212
|
-
*/
|
|
1331
|
+
|
|
2213
1332
|
ApplicationId: string | undefined;
|
|
2214
1333
|
}
|
|
2215
1334
|
export declare namespace UpdateApnsSandboxChannelRequest {
|
|
2216
|
-
|
|
2217
|
-
* @internal
|
|
2218
|
-
*/
|
|
1335
|
+
|
|
2219
1336
|
const filterSensitiveLog: (obj: UpdateApnsSandboxChannelRequest) => any;
|
|
2220
1337
|
}
|
|
2221
1338
|
export interface UpdateApnsSandboxChannelResponse {
|
|
2222
|
-
|
|
2223
|
-
* <p>Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
|
|
2224
|
-
*/
|
|
1339
|
+
|
|
2225
1340
|
APNSSandboxChannelResponse: APNSSandboxChannelResponse | undefined;
|
|
2226
1341
|
}
|
|
2227
1342
|
export declare namespace UpdateApnsSandboxChannelResponse {
|
|
2228
|
-
|
|
2229
|
-
* @internal
|
|
2230
|
-
*/
|
|
1343
|
+
|
|
2231
1344
|
const filterSensitiveLog: (obj: UpdateApnsSandboxChannelResponse) => any;
|
|
2232
1345
|
}
|
|
2233
1346
|
export interface UpdateApnsVoipChannelRequest {
|
|
2234
|
-
|
|
2235
|
-
* <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
|
|
2236
|
-
*/
|
|
1347
|
+
|
|
2237
1348
|
APNSVoipChannelRequest: APNSVoipChannelRequest | undefined;
|
|
2238
|
-
|
|
2239
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2240
|
-
*/
|
|
1349
|
+
|
|
2241
1350
|
ApplicationId: string | undefined;
|
|
2242
1351
|
}
|
|
2243
1352
|
export declare namespace UpdateApnsVoipChannelRequest {
|
|
2244
|
-
|
|
2245
|
-
* @internal
|
|
2246
|
-
*/
|
|
1353
|
+
|
|
2247
1354
|
const filterSensitiveLog: (obj: UpdateApnsVoipChannelRequest) => any;
|
|
2248
1355
|
}
|
|
2249
1356
|
export interface UpdateApnsVoipChannelResponse {
|
|
2250
|
-
|
|
2251
|
-
* <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
|
|
2252
|
-
*/
|
|
1357
|
+
|
|
2253
1358
|
APNSVoipChannelResponse: APNSVoipChannelResponse | undefined;
|
|
2254
1359
|
}
|
|
2255
1360
|
export declare namespace UpdateApnsVoipChannelResponse {
|
|
2256
|
-
|
|
2257
|
-
* @internal
|
|
2258
|
-
*/
|
|
1361
|
+
|
|
2259
1362
|
const filterSensitiveLog: (obj: UpdateApnsVoipChannelResponse) => any;
|
|
2260
1363
|
}
|
|
2261
1364
|
export interface UpdateApnsVoipSandboxChannelRequest {
|
|
2262
|
-
|
|
2263
|
-
* <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
|
|
2264
|
-
*/
|
|
1365
|
+
|
|
2265
1366
|
APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest | undefined;
|
|
2266
|
-
|
|
2267
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2268
|
-
*/
|
|
1367
|
+
|
|
2269
1368
|
ApplicationId: string | undefined;
|
|
2270
1369
|
}
|
|
2271
1370
|
export declare namespace UpdateApnsVoipSandboxChannelRequest {
|
|
2272
|
-
|
|
2273
|
-
* @internal
|
|
2274
|
-
*/
|
|
1371
|
+
|
|
2275
1372
|
const filterSensitiveLog: (obj: UpdateApnsVoipSandboxChannelRequest) => any;
|
|
2276
1373
|
}
|
|
2277
1374
|
export interface UpdateApnsVoipSandboxChannelResponse {
|
|
2278
|
-
|
|
2279
|
-
* <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
|
|
2280
|
-
*/
|
|
1375
|
+
|
|
2281
1376
|
APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse | undefined;
|
|
2282
1377
|
}
|
|
2283
1378
|
export declare namespace UpdateApnsVoipSandboxChannelResponse {
|
|
2284
|
-
|
|
2285
|
-
* @internal
|
|
2286
|
-
*/
|
|
1379
|
+
|
|
2287
1380
|
const filterSensitiveLog: (obj: UpdateApnsVoipSandboxChannelResponse) => any;
|
|
2288
1381
|
}
|
|
2289
|
-
|
|
2290
|
-
* <p>Specifies the default settings for an application.</p>
|
|
2291
|
-
*/
|
|
1382
|
+
|
|
2292
1383
|
export interface WriteApplicationSettingsRequest {
|
|
2293
|
-
|
|
2294
|
-
* <p>The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.</p> <p>To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource.</p>
|
|
2295
|
-
*/
|
|
1384
|
+
|
|
2296
1385
|
CampaignHook?: CampaignHook;
|
|
2297
|
-
|
|
2298
|
-
* <p>Specifies whether to enable application-related alarms in Amazon CloudWatch.</p>
|
|
2299
|
-
*/
|
|
1386
|
+
|
|
2300
1387
|
CloudWatchMetricsEnabled?: boolean;
|
|
2301
1388
|
EventTaggingEnabled?: boolean;
|
|
2302
|
-
|
|
2303
|
-
* <p>The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource, respectively.</p>
|
|
2304
|
-
*/
|
|
1389
|
+
|
|
2305
1390
|
Limits?: CampaignLimits;
|
|
2306
|
-
|
|
2307
|
-
* <p>The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).</p></li> <li><p>The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).</p></li></ul> <p>If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.</p> <p>To override the default quiet time settings for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource to define a custom quiet time for the campaign or journey.</p>
|
|
2308
|
-
*/
|
|
1391
|
+
|
|
2309
1392
|
QuietTime?: QuietTime;
|
|
2310
1393
|
}
|
|
2311
1394
|
export declare namespace WriteApplicationSettingsRequest {
|
|
2312
|
-
|
|
2313
|
-
* @internal
|
|
2314
|
-
*/
|
|
1395
|
+
|
|
2315
1396
|
const filterSensitiveLog: (obj: WriteApplicationSettingsRequest) => any;
|
|
2316
1397
|
}
|
|
2317
1398
|
export interface UpdateApplicationSettingsRequest {
|
|
2318
|
-
|
|
2319
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2320
|
-
*/
|
|
1399
|
+
|
|
2321
1400
|
ApplicationId: string | undefined;
|
|
2322
|
-
|
|
2323
|
-
* <p>Specifies the default settings for an application.</p>
|
|
2324
|
-
*/
|
|
1401
|
+
|
|
2325
1402
|
WriteApplicationSettingsRequest: WriteApplicationSettingsRequest | undefined;
|
|
2326
1403
|
}
|
|
2327
1404
|
export declare namespace UpdateApplicationSettingsRequest {
|
|
2328
|
-
|
|
2329
|
-
* @internal
|
|
2330
|
-
*/
|
|
1405
|
+
|
|
2331
1406
|
const filterSensitiveLog: (obj: UpdateApplicationSettingsRequest) => any;
|
|
2332
1407
|
}
|
|
2333
1408
|
export interface UpdateApplicationSettingsResponse {
|
|
2334
|
-
|
|
2335
|
-
* <p>Provides information about an application, including the default settings for an application.</p>
|
|
2336
|
-
*/
|
|
1409
|
+
|
|
2337
1410
|
ApplicationSettingsResource: ApplicationSettingsResource | undefined;
|
|
2338
1411
|
}
|
|
2339
1412
|
export declare namespace UpdateApplicationSettingsResponse {
|
|
2340
|
-
|
|
2341
|
-
* @internal
|
|
2342
|
-
*/
|
|
1413
|
+
|
|
2343
1414
|
const filterSensitiveLog: (obj: UpdateApplicationSettingsResponse) => any;
|
|
2344
1415
|
}
|
|
2345
1416
|
export interface UpdateBaiduChannelRequest {
|
|
2346
|
-
|
|
2347
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2348
|
-
*/
|
|
1417
|
+
|
|
2349
1418
|
ApplicationId: string | undefined;
|
|
2350
|
-
|
|
2351
|
-
* <p>Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
|
|
2352
|
-
*/
|
|
1419
|
+
|
|
2353
1420
|
BaiduChannelRequest: BaiduChannelRequest | undefined;
|
|
2354
1421
|
}
|
|
2355
1422
|
export declare namespace UpdateBaiduChannelRequest {
|
|
2356
|
-
|
|
2357
|
-
* @internal
|
|
2358
|
-
*/
|
|
1423
|
+
|
|
2359
1424
|
const filterSensitiveLog: (obj: UpdateBaiduChannelRequest) => any;
|
|
2360
1425
|
}
|
|
2361
1426
|
export interface UpdateBaiduChannelResponse {
|
|
2362
|
-
|
|
2363
|
-
* <p>Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
|
|
2364
|
-
*/
|
|
1427
|
+
|
|
2365
1428
|
BaiduChannelResponse: BaiduChannelResponse | undefined;
|
|
2366
1429
|
}
|
|
2367
1430
|
export declare namespace UpdateBaiduChannelResponse {
|
|
2368
|
-
|
|
2369
|
-
* @internal
|
|
2370
|
-
*/
|
|
1431
|
+
|
|
2371
1432
|
const filterSensitiveLog: (obj: UpdateBaiduChannelResponse) => any;
|
|
2372
1433
|
}
|
|
2373
1434
|
export interface UpdateCampaignRequest {
|
|
2374
|
-
|
|
2375
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2376
|
-
*/
|
|
1435
|
+
|
|
2377
1436
|
ApplicationId: string | undefined;
|
|
2378
|
-
|
|
2379
|
-
* <p>The unique identifier for the campaign.</p>
|
|
2380
|
-
*/
|
|
1437
|
+
|
|
2381
1438
|
CampaignId: string | undefined;
|
|
2382
|
-
|
|
2383
|
-
* <p>Specifies the configuration and other settings for a campaign.</p>
|
|
2384
|
-
*/
|
|
1439
|
+
|
|
2385
1440
|
WriteCampaignRequest: WriteCampaignRequest | undefined;
|
|
2386
1441
|
}
|
|
2387
1442
|
export declare namespace UpdateCampaignRequest {
|
|
2388
|
-
|
|
2389
|
-
* @internal
|
|
2390
|
-
*/
|
|
1443
|
+
|
|
2391
1444
|
const filterSensitiveLog: (obj: UpdateCampaignRequest) => any;
|
|
2392
1445
|
}
|
|
2393
1446
|
export interface UpdateCampaignResponse {
|
|
2394
|
-
|
|
2395
|
-
* <p>Provides information about the status, configuration, and other settings for a campaign.</p>
|
|
2396
|
-
*/
|
|
1447
|
+
|
|
2397
1448
|
CampaignResponse: CampaignResponse | undefined;
|
|
2398
1449
|
}
|
|
2399
1450
|
export declare namespace UpdateCampaignResponse {
|
|
2400
|
-
|
|
2401
|
-
* @internal
|
|
2402
|
-
*/
|
|
1451
|
+
|
|
2403
1452
|
const filterSensitiveLog: (obj: UpdateCampaignResponse) => any;
|
|
2404
1453
|
}
|
|
2405
1454
|
export interface UpdateEmailChannelRequest {
|
|
2406
|
-
|
|
2407
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2408
|
-
*/
|
|
1455
|
+
|
|
2409
1456
|
ApplicationId: string | undefined;
|
|
2410
|
-
|
|
2411
|
-
* <p>Specifies the status and settings of the email channel for an application.</p>
|
|
2412
|
-
*/
|
|
1457
|
+
|
|
2413
1458
|
EmailChannelRequest: EmailChannelRequest | undefined;
|
|
2414
1459
|
}
|
|
2415
1460
|
export declare namespace UpdateEmailChannelRequest {
|
|
2416
|
-
|
|
2417
|
-
* @internal
|
|
2418
|
-
*/
|
|
1461
|
+
|
|
2419
1462
|
const filterSensitiveLog: (obj: UpdateEmailChannelRequest) => any;
|
|
2420
1463
|
}
|
|
2421
1464
|
export interface UpdateEmailChannelResponse {
|
|
2422
|
-
|
|
2423
|
-
* <p>Provides information about the status and settings of the email channel for an application.</p>
|
|
2424
|
-
*/
|
|
1465
|
+
|
|
2425
1466
|
EmailChannelResponse: EmailChannelResponse | undefined;
|
|
2426
1467
|
}
|
|
2427
1468
|
export declare namespace UpdateEmailChannelResponse {
|
|
2428
|
-
|
|
2429
|
-
* @internal
|
|
2430
|
-
*/
|
|
1469
|
+
|
|
2431
1470
|
const filterSensitiveLog: (obj: UpdateEmailChannelResponse) => any;
|
|
2432
1471
|
}
|
|
2433
1472
|
export interface UpdateEmailTemplateRequest {
|
|
2434
|
-
|
|
2435
|
-
* <p>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.</p> <p>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.</p>
|
|
2436
|
-
*/
|
|
1473
|
+
|
|
2437
1474
|
CreateNewVersion?: boolean;
|
|
2438
|
-
|
|
2439
|
-
* <p>Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
|
|
2440
|
-
*/
|
|
1475
|
+
|
|
2441
1476
|
EmailTemplateRequest: EmailTemplateRequest | undefined;
|
|
2442
|
-
|
|
2443
|
-
* <p>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.</p>
|
|
2444
|
-
*/
|
|
1477
|
+
|
|
2445
1478
|
TemplateName: string | undefined;
|
|
2446
|
-
|
|
2447
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
2448
|
-
*/
|
|
1479
|
+
|
|
2449
1480
|
Version?: string;
|
|
2450
1481
|
}
|
|
2451
1482
|
export declare namespace UpdateEmailTemplateRequest {
|
|
2452
|
-
|
|
2453
|
-
* @internal
|
|
2454
|
-
*/
|
|
1483
|
+
|
|
2455
1484
|
const filterSensitiveLog: (obj: UpdateEmailTemplateRequest) => any;
|
|
2456
1485
|
}
|
|
2457
1486
|
export interface UpdateEmailTemplateResponse {
|
|
2458
|
-
|
|
2459
|
-
* <p>Provides information about an API request or response.</p>
|
|
2460
|
-
*/
|
|
1487
|
+
|
|
2461
1488
|
MessageBody: MessageBody | undefined;
|
|
2462
1489
|
}
|
|
2463
1490
|
export declare namespace UpdateEmailTemplateResponse {
|
|
2464
|
-
|
|
2465
|
-
* @internal
|
|
2466
|
-
*/
|
|
1491
|
+
|
|
2467
1492
|
const filterSensitiveLog: (obj: UpdateEmailTemplateResponse) => any;
|
|
2468
1493
|
}
|
|
2469
1494
|
export interface UpdateEndpointRequest {
|
|
2470
|
-
|
|
2471
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2472
|
-
*/
|
|
1495
|
+
|
|
2473
1496
|
ApplicationId: string | undefined;
|
|
2474
|
-
|
|
2475
|
-
* <p>The unique identifier for the endpoint.</p>
|
|
2476
|
-
*/
|
|
1497
|
+
|
|
2477
1498
|
EndpointId: string | undefined;
|
|
2478
|
-
|
|
2479
|
-
* <p>Specifies the channel type and other settings for an endpoint.</p>
|
|
2480
|
-
*/
|
|
1499
|
+
|
|
2481
1500
|
EndpointRequest: EndpointRequest | undefined;
|
|
2482
1501
|
}
|
|
2483
1502
|
export declare namespace UpdateEndpointRequest {
|
|
2484
|
-
|
|
2485
|
-
* @internal
|
|
2486
|
-
*/
|
|
1503
|
+
|
|
2487
1504
|
const filterSensitiveLog: (obj: UpdateEndpointRequest) => any;
|
|
2488
1505
|
}
|
|
2489
1506
|
export interface UpdateEndpointResponse {
|
|
2490
|
-
|
|
2491
|
-
* <p>Provides information about an API request or response.</p>
|
|
2492
|
-
*/
|
|
1507
|
+
|
|
2493
1508
|
MessageBody: MessageBody | undefined;
|
|
2494
1509
|
}
|
|
2495
1510
|
export declare namespace UpdateEndpointResponse {
|
|
2496
|
-
|
|
2497
|
-
* @internal
|
|
2498
|
-
*/
|
|
1511
|
+
|
|
2499
1512
|
const filterSensitiveLog: (obj: UpdateEndpointResponse) => any;
|
|
2500
1513
|
}
|
|
2501
1514
|
export interface UpdateEndpointsBatchRequest {
|
|
2502
|
-
|
|
2503
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2504
|
-
*/
|
|
1515
|
+
|
|
2505
1516
|
ApplicationId: string | undefined;
|
|
2506
|
-
|
|
2507
|
-
* <p>Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.</p>
|
|
2508
|
-
*/
|
|
1517
|
+
|
|
2509
1518
|
EndpointBatchRequest: EndpointBatchRequest | undefined;
|
|
2510
1519
|
}
|
|
2511
1520
|
export declare namespace UpdateEndpointsBatchRequest {
|
|
2512
|
-
|
|
2513
|
-
* @internal
|
|
2514
|
-
*/
|
|
1521
|
+
|
|
2515
1522
|
const filterSensitiveLog: (obj: UpdateEndpointsBatchRequest) => any;
|
|
2516
1523
|
}
|
|
2517
1524
|
export interface UpdateEndpointsBatchResponse {
|
|
2518
|
-
|
|
2519
|
-
* <p>Provides information about an API request or response.</p>
|
|
2520
|
-
*/
|
|
1525
|
+
|
|
2521
1526
|
MessageBody: MessageBody | undefined;
|
|
2522
1527
|
}
|
|
2523
1528
|
export declare namespace UpdateEndpointsBatchResponse {
|
|
2524
|
-
|
|
2525
|
-
* @internal
|
|
2526
|
-
*/
|
|
1529
|
+
|
|
2527
1530
|
const filterSensitiveLog: (obj: UpdateEndpointsBatchResponse) => any;
|
|
2528
1531
|
}
|
|
2529
1532
|
export interface UpdateGcmChannelRequest {
|
|
2530
|
-
|
|
2531
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2532
|
-
*/
|
|
1533
|
+
|
|
2533
1534
|
ApplicationId: string | undefined;
|
|
2534
|
-
|
|
2535
|
-
* <p>Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
|
|
2536
|
-
*/
|
|
1535
|
+
|
|
2537
1536
|
GCMChannelRequest: GCMChannelRequest | undefined;
|
|
2538
1537
|
}
|
|
2539
1538
|
export declare namespace UpdateGcmChannelRequest {
|
|
2540
|
-
|
|
2541
|
-
* @internal
|
|
2542
|
-
*/
|
|
1539
|
+
|
|
2543
1540
|
const filterSensitiveLog: (obj: UpdateGcmChannelRequest) => any;
|
|
2544
1541
|
}
|
|
2545
1542
|
export interface UpdateGcmChannelResponse {
|
|
2546
|
-
|
|
2547
|
-
* <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
|
|
2548
|
-
*/
|
|
1543
|
+
|
|
2549
1544
|
GCMChannelResponse: GCMChannelResponse | undefined;
|
|
2550
1545
|
}
|
|
2551
1546
|
export declare namespace UpdateGcmChannelResponse {
|
|
2552
|
-
|
|
2553
|
-
* @internal
|
|
2554
|
-
*/
|
|
1547
|
+
|
|
2555
1548
|
const filterSensitiveLog: (obj: UpdateGcmChannelResponse) => any;
|
|
2556
1549
|
}
|
|
2557
1550
|
export interface UpdateInAppTemplateRequest {
|
|
2558
|
-
|
|
2559
|
-
* <p>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.</p> <p>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.</p>
|
|
2560
|
-
*/
|
|
1551
|
+
|
|
2561
1552
|
CreateNewVersion?: boolean;
|
|
2562
|
-
|
|
2563
|
-
* <p>InApp Template Request.</p>
|
|
2564
|
-
*/
|
|
1553
|
+
|
|
2565
1554
|
InAppTemplateRequest: InAppTemplateRequest | undefined;
|
|
2566
|
-
|
|
2567
|
-
* <p>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.</p>
|
|
2568
|
-
*/
|
|
1555
|
+
|
|
2569
1556
|
TemplateName: string | undefined;
|
|
2570
|
-
|
|
2571
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
2572
|
-
*/
|
|
1557
|
+
|
|
2573
1558
|
Version?: string;
|
|
2574
1559
|
}
|
|
2575
1560
|
export declare namespace UpdateInAppTemplateRequest {
|
|
2576
|
-
|
|
2577
|
-
* @internal
|
|
2578
|
-
*/
|
|
1561
|
+
|
|
2579
1562
|
const filterSensitiveLog: (obj: UpdateInAppTemplateRequest) => any;
|
|
2580
1563
|
}
|
|
2581
1564
|
export interface UpdateInAppTemplateResponse {
|
|
2582
|
-
|
|
2583
|
-
* <p>Provides information about an API request or response.</p>
|
|
2584
|
-
*/
|
|
1565
|
+
|
|
2585
1566
|
MessageBody: MessageBody | undefined;
|
|
2586
1567
|
}
|
|
2587
1568
|
export declare namespace UpdateInAppTemplateResponse {
|
|
2588
|
-
|
|
2589
|
-
* @internal
|
|
2590
|
-
*/
|
|
1569
|
+
|
|
2591
1570
|
const filterSensitiveLog: (obj: UpdateInAppTemplateResponse) => any;
|
|
2592
1571
|
}
|
|
2593
1572
|
export interface UpdateJourneyRequest {
|
|
2594
|
-
|
|
2595
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2596
|
-
*/
|
|
1573
|
+
|
|
2597
1574
|
ApplicationId: string | undefined;
|
|
2598
|
-
|
|
2599
|
-
* <p>The unique identifier for the journey.</p>
|
|
2600
|
-
*/
|
|
1575
|
+
|
|
2601
1576
|
JourneyId: string | undefined;
|
|
2602
|
-
|
|
2603
|
-
* <p>Specifies the configuration and other settings for a journey.</p>
|
|
2604
|
-
*/
|
|
1577
|
+
|
|
2605
1578
|
WriteJourneyRequest: WriteJourneyRequest | undefined;
|
|
2606
1579
|
}
|
|
2607
1580
|
export declare namespace UpdateJourneyRequest {
|
|
2608
|
-
|
|
2609
|
-
* @internal
|
|
2610
|
-
*/
|
|
1581
|
+
|
|
2611
1582
|
const filterSensitiveLog: (obj: UpdateJourneyRequest) => any;
|
|
2612
1583
|
}
|
|
2613
1584
|
export interface UpdateJourneyResponse {
|
|
2614
|
-
|
|
2615
|
-
* <p>Provides information about the status, configuration, and other settings for a journey.</p>
|
|
2616
|
-
*/
|
|
1585
|
+
|
|
2617
1586
|
JourneyResponse: JourneyResponse | undefined;
|
|
2618
1587
|
}
|
|
2619
1588
|
export declare namespace UpdateJourneyResponse {
|
|
2620
|
-
|
|
2621
|
-
* @internal
|
|
2622
|
-
*/
|
|
1589
|
+
|
|
2623
1590
|
const filterSensitiveLog: (obj: UpdateJourneyResponse) => any;
|
|
2624
1591
|
}
|
|
2625
1592
|
export interface UpdateJourneyStateRequest {
|
|
2626
|
-
|
|
2627
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2628
|
-
*/
|
|
1593
|
+
|
|
2629
1594
|
ApplicationId: string | undefined;
|
|
2630
|
-
|
|
2631
|
-
* <p>The unique identifier for the journey.</p>
|
|
2632
|
-
*/
|
|
1595
|
+
|
|
2633
1596
|
JourneyId: string | undefined;
|
|
2634
|
-
|
|
2635
|
-
* <p>Changes the status of a journey.</p>
|
|
2636
|
-
*/
|
|
1597
|
+
|
|
2637
1598
|
JourneyStateRequest: JourneyStateRequest | undefined;
|
|
2638
1599
|
}
|
|
2639
1600
|
export declare namespace UpdateJourneyStateRequest {
|
|
2640
|
-
|
|
2641
|
-
* @internal
|
|
2642
|
-
*/
|
|
1601
|
+
|
|
2643
1602
|
const filterSensitiveLog: (obj: UpdateJourneyStateRequest) => any;
|
|
2644
1603
|
}
|
|
2645
1604
|
export interface UpdateJourneyStateResponse {
|
|
2646
|
-
|
|
2647
|
-
* <p>Provides information about the status, configuration, and other settings for a journey.</p>
|
|
2648
|
-
*/
|
|
1605
|
+
|
|
2649
1606
|
JourneyResponse: JourneyResponse | undefined;
|
|
2650
1607
|
}
|
|
2651
1608
|
export declare namespace UpdateJourneyStateResponse {
|
|
2652
|
-
|
|
2653
|
-
* @internal
|
|
2654
|
-
*/
|
|
1609
|
+
|
|
2655
1610
|
const filterSensitiveLog: (obj: UpdateJourneyStateResponse) => any;
|
|
2656
1611
|
}
|
|
2657
1612
|
export interface UpdatePushTemplateRequest {
|
|
2658
|
-
|
|
2659
|
-
* <p>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.</p> <p>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.</p>
|
|
2660
|
-
*/
|
|
1613
|
+
|
|
2661
1614
|
CreateNewVersion?: boolean;
|
|
2662
|
-
|
|
2663
|
-
* <p>Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
|
|
2664
|
-
*/
|
|
1615
|
+
|
|
2665
1616
|
PushNotificationTemplateRequest: PushNotificationTemplateRequest | undefined;
|
|
2666
|
-
|
|
2667
|
-
* <p>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.</p>
|
|
2668
|
-
*/
|
|
1617
|
+
|
|
2669
1618
|
TemplateName: string | undefined;
|
|
2670
|
-
|
|
2671
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
2672
|
-
*/
|
|
1619
|
+
|
|
2673
1620
|
Version?: string;
|
|
2674
1621
|
}
|
|
2675
1622
|
export declare namespace UpdatePushTemplateRequest {
|
|
2676
|
-
|
|
2677
|
-
* @internal
|
|
2678
|
-
*/
|
|
1623
|
+
|
|
2679
1624
|
const filterSensitiveLog: (obj: UpdatePushTemplateRequest) => any;
|
|
2680
1625
|
}
|
|
2681
1626
|
export interface UpdatePushTemplateResponse {
|
|
2682
|
-
|
|
2683
|
-
* <p>Provides information about an API request or response.</p>
|
|
2684
|
-
*/
|
|
1627
|
+
|
|
2685
1628
|
MessageBody: MessageBody | undefined;
|
|
2686
1629
|
}
|
|
2687
1630
|
export declare namespace UpdatePushTemplateResponse {
|
|
2688
|
-
|
|
2689
|
-
* @internal
|
|
2690
|
-
*/
|
|
1631
|
+
|
|
2691
1632
|
const filterSensitiveLog: (obj: UpdatePushTemplateResponse) => any;
|
|
2692
1633
|
}
|
|
2693
|
-
|
|
2694
|
-
* <p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>
|
|
2695
|
-
*/
|
|
1634
|
+
|
|
2696
1635
|
export interface UpdateRecommenderConfigurationShape {
|
|
2697
|
-
|
|
2698
|
-
* <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>
|
|
2699
|
-
*/
|
|
1636
|
+
|
|
2700
1637
|
Attributes?: {
|
|
2701
1638
|
[key: string]: string;
|
|
2702
1639
|
};
|
|
2703
|
-
|
|
2704
|
-
* <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>
|
|
2705
|
-
*/
|
|
1640
|
+
|
|
2706
1641
|
Description?: string;
|
|
2707
|
-
|
|
2708
|
-
* <p>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p>
|
|
2709
|
-
*/
|
|
1642
|
+
|
|
2710
1643
|
Name?: string;
|
|
2711
|
-
|
|
2712
|
-
* <p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>
|
|
2713
|
-
*/
|
|
1644
|
+
|
|
2714
1645
|
RecommendationProviderIdType?: string;
|
|
2715
|
-
|
|
2716
|
-
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>
|
|
2717
|
-
*/
|
|
1646
|
+
|
|
2718
1647
|
RecommendationProviderRoleArn: string | undefined;
|
|
2719
|
-
|
|
2720
|
-
* <p>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</p>
|
|
2721
|
-
*/
|
|
1648
|
+
|
|
2722
1649
|
RecommendationProviderUri: string | undefined;
|
|
2723
|
-
|
|
2724
|
-
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</p>
|
|
2725
|
-
*/
|
|
1650
|
+
|
|
2726
1651
|
RecommendationTransformerUri?: string;
|
|
2727
|
-
|
|
2728
|
-
* <p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>
|
|
2729
|
-
*/
|
|
1652
|
+
|
|
2730
1653
|
RecommendationsDisplayName?: string;
|
|
2731
|
-
|
|
2732
|
-
* <p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
|
|
2733
|
-
*/
|
|
1654
|
+
|
|
2734
1655
|
RecommendationsPerMessage?: number;
|
|
2735
1656
|
}
|
|
2736
1657
|
export declare namespace UpdateRecommenderConfigurationShape {
|
|
2737
|
-
|
|
2738
|
-
* @internal
|
|
2739
|
-
*/
|
|
1658
|
+
|
|
2740
1659
|
const filterSensitiveLog: (obj: UpdateRecommenderConfigurationShape) => any;
|
|
2741
1660
|
}
|
|
2742
1661
|
export interface UpdateRecommenderConfigurationRequest {
|
|
2743
|
-
|
|
2744
|
-
* <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
|
|
2745
|
-
*/
|
|
1662
|
+
|
|
2746
1663
|
RecommenderId: string | undefined;
|
|
2747
|
-
|
|
2748
|
-
* <p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>
|
|
2749
|
-
*/
|
|
1664
|
+
|
|
2750
1665
|
UpdateRecommenderConfiguration: UpdateRecommenderConfigurationShape | undefined;
|
|
2751
1666
|
}
|
|
2752
1667
|
export declare namespace UpdateRecommenderConfigurationRequest {
|
|
2753
|
-
|
|
2754
|
-
* @internal
|
|
2755
|
-
*/
|
|
1668
|
+
|
|
2756
1669
|
const filterSensitiveLog: (obj: UpdateRecommenderConfigurationRequest) => any;
|
|
2757
1670
|
}
|
|
2758
1671
|
export interface UpdateRecommenderConfigurationResponse {
|
|
2759
|
-
|
|
2760
|
-
* <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
|
|
2761
|
-
*/
|
|
1672
|
+
|
|
2762
1673
|
RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
|
|
2763
1674
|
}
|
|
2764
1675
|
export declare namespace UpdateRecommenderConfigurationResponse {
|
|
2765
|
-
|
|
2766
|
-
* @internal
|
|
2767
|
-
*/
|
|
1676
|
+
|
|
2768
1677
|
const filterSensitiveLog: (obj: UpdateRecommenderConfigurationResponse) => any;
|
|
2769
1678
|
}
|
|
2770
1679
|
export interface UpdateSegmentRequest {
|
|
2771
|
-
|
|
2772
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2773
|
-
*/
|
|
1680
|
+
|
|
2774
1681
|
ApplicationId: string | undefined;
|
|
2775
|
-
|
|
2776
|
-
* <p>The unique identifier for the segment.</p>
|
|
2777
|
-
*/
|
|
1682
|
+
|
|
2778
1683
|
SegmentId: string | undefined;
|
|
2779
|
-
|
|
2780
|
-
* <p>Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.</p>
|
|
2781
|
-
*/
|
|
1684
|
+
|
|
2782
1685
|
WriteSegmentRequest: WriteSegmentRequest | undefined;
|
|
2783
1686
|
}
|
|
2784
1687
|
export declare namespace UpdateSegmentRequest {
|
|
2785
|
-
|
|
2786
|
-
* @internal
|
|
2787
|
-
*/
|
|
1688
|
+
|
|
2788
1689
|
const filterSensitiveLog: (obj: UpdateSegmentRequest) => any;
|
|
2789
1690
|
}
|
|
2790
1691
|
export interface UpdateSegmentResponse {
|
|
2791
|
-
|
|
2792
|
-
* <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
|
|
2793
|
-
*/
|
|
1692
|
+
|
|
2794
1693
|
SegmentResponse: SegmentResponse | undefined;
|
|
2795
1694
|
}
|
|
2796
1695
|
export declare namespace UpdateSegmentResponse {
|
|
2797
|
-
|
|
2798
|
-
* @internal
|
|
2799
|
-
*/
|
|
1696
|
+
|
|
2800
1697
|
const filterSensitiveLog: (obj: UpdateSegmentResponse) => any;
|
|
2801
1698
|
}
|
|
2802
|
-
|
|
2803
|
-
* <p>Specifies the status and settings of the SMS channel for an application.</p>
|
|
2804
|
-
*/
|
|
1699
|
+
|
|
2805
1700
|
export interface SMSChannelRequest {
|
|
2806
|
-
|
|
2807
|
-
* <p>Specifies whether to enable the SMS channel for the application.</p>
|
|
2808
|
-
*/
|
|
1701
|
+
|
|
2809
1702
|
Enabled?: boolean;
|
|
2810
|
-
|
|
2811
|
-
* <p>The identity that you want to display on recipients' devices when they receive messages from the SMS channel.</p>
|
|
2812
|
-
*/
|
|
1703
|
+
|
|
2813
1704
|
SenderId?: string;
|
|
2814
|
-
|
|
2815
|
-
* <p>The registered short code that you want to use when you send messages through the SMS channel.</p>
|
|
2816
|
-
*/
|
|
1705
|
+
|
|
2817
1706
|
ShortCode?: string;
|
|
2818
1707
|
}
|
|
2819
1708
|
export declare namespace SMSChannelRequest {
|
|
2820
|
-
|
|
2821
|
-
* @internal
|
|
2822
|
-
*/
|
|
1709
|
+
|
|
2823
1710
|
const filterSensitiveLog: (obj: SMSChannelRequest) => any;
|
|
2824
1711
|
}
|
|
2825
1712
|
export interface UpdateSmsChannelRequest {
|
|
2826
|
-
|
|
2827
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2828
|
-
*/
|
|
1713
|
+
|
|
2829
1714
|
ApplicationId: string | undefined;
|
|
2830
|
-
|
|
2831
|
-
* <p>Specifies the status and settings of the SMS channel for an application.</p>
|
|
2832
|
-
*/
|
|
1715
|
+
|
|
2833
1716
|
SMSChannelRequest: SMSChannelRequest | undefined;
|
|
2834
1717
|
}
|
|
2835
1718
|
export declare namespace UpdateSmsChannelRequest {
|
|
2836
|
-
|
|
2837
|
-
* @internal
|
|
2838
|
-
*/
|
|
1719
|
+
|
|
2839
1720
|
const filterSensitiveLog: (obj: UpdateSmsChannelRequest) => any;
|
|
2840
1721
|
}
|
|
2841
1722
|
export interface UpdateSmsChannelResponse {
|
|
2842
|
-
|
|
2843
|
-
* <p>Provides information about the status and settings of the SMS channel for an application.</p>
|
|
2844
|
-
*/
|
|
1723
|
+
|
|
2845
1724
|
SMSChannelResponse: SMSChannelResponse | undefined;
|
|
2846
1725
|
}
|
|
2847
1726
|
export declare namespace UpdateSmsChannelResponse {
|
|
2848
|
-
|
|
2849
|
-
* @internal
|
|
2850
|
-
*/
|
|
1727
|
+
|
|
2851
1728
|
const filterSensitiveLog: (obj: UpdateSmsChannelResponse) => any;
|
|
2852
1729
|
}
|
|
2853
1730
|
export interface UpdateSmsTemplateRequest {
|
|
2854
|
-
|
|
2855
|
-
* <p>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.</p> <p>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.</p>
|
|
2856
|
-
*/
|
|
1731
|
+
|
|
2857
1732
|
CreateNewVersion?: boolean;
|
|
2858
|
-
|
|
2859
|
-
* <p>Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
|
|
2860
|
-
*/
|
|
1733
|
+
|
|
2861
1734
|
SMSTemplateRequest: SMSTemplateRequest | undefined;
|
|
2862
|
-
|
|
2863
|
-
* <p>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.</p>
|
|
2864
|
-
*/
|
|
1735
|
+
|
|
2865
1736
|
TemplateName: string | undefined;
|
|
2866
|
-
|
|
2867
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
2868
|
-
*/
|
|
1737
|
+
|
|
2869
1738
|
Version?: string;
|
|
2870
1739
|
}
|
|
2871
1740
|
export declare namespace UpdateSmsTemplateRequest {
|
|
2872
|
-
|
|
2873
|
-
* @internal
|
|
2874
|
-
*/
|
|
1741
|
+
|
|
2875
1742
|
const filterSensitiveLog: (obj: UpdateSmsTemplateRequest) => any;
|
|
2876
1743
|
}
|
|
2877
1744
|
export interface UpdateSmsTemplateResponse {
|
|
2878
|
-
|
|
2879
|
-
* <p>Provides information about an API request or response.</p>
|
|
2880
|
-
*/
|
|
1745
|
+
|
|
2881
1746
|
MessageBody: MessageBody | undefined;
|
|
2882
1747
|
}
|
|
2883
1748
|
export declare namespace UpdateSmsTemplateResponse {
|
|
2884
|
-
|
|
2885
|
-
* @internal
|
|
2886
|
-
*/
|
|
1749
|
+
|
|
2887
1750
|
const filterSensitiveLog: (obj: UpdateSmsTemplateResponse) => any;
|
|
2888
1751
|
}
|
|
2889
|
-
|
|
2890
|
-
* <p>Specifies which version of a message template to use as the active version of the template.</p>
|
|
2891
|
-
*/
|
|
1752
|
+
|
|
2892
1753
|
export interface TemplateActiveVersionRequest {
|
|
2893
|
-
|
|
2894
|
-
* <p>The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p>
|
|
2895
|
-
*/
|
|
1754
|
+
|
|
2896
1755
|
Version?: string;
|
|
2897
1756
|
}
|
|
2898
1757
|
export declare namespace TemplateActiveVersionRequest {
|
|
2899
|
-
|
|
2900
|
-
* @internal
|
|
2901
|
-
*/
|
|
1758
|
+
|
|
2902
1759
|
const filterSensitiveLog: (obj: TemplateActiveVersionRequest) => any;
|
|
2903
1760
|
}
|
|
2904
1761
|
export interface UpdateTemplateActiveVersionRequest {
|
|
2905
|
-
|
|
2906
|
-
* <p>Specifies which version of a message template to use as the active version of the template.</p>
|
|
2907
|
-
*/
|
|
1762
|
+
|
|
2908
1763
|
TemplateActiveVersionRequest: TemplateActiveVersionRequest | undefined;
|
|
2909
|
-
|
|
2910
|
-
* <p>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.</p>
|
|
2911
|
-
*/
|
|
1764
|
+
|
|
2912
1765
|
TemplateName: string | undefined;
|
|
2913
|
-
|
|
2914
|
-
* <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
2915
|
-
*/
|
|
1766
|
+
|
|
2916
1767
|
TemplateType: string | undefined;
|
|
2917
1768
|
}
|
|
2918
1769
|
export declare namespace UpdateTemplateActiveVersionRequest {
|
|
2919
|
-
|
|
2920
|
-
* @internal
|
|
2921
|
-
*/
|
|
1770
|
+
|
|
2922
1771
|
const filterSensitiveLog: (obj: UpdateTemplateActiveVersionRequest) => any;
|
|
2923
1772
|
}
|
|
2924
1773
|
export interface UpdateTemplateActiveVersionResponse {
|
|
2925
|
-
|
|
2926
|
-
* <p>Provides information about an API request or response.</p>
|
|
2927
|
-
*/
|
|
1774
|
+
|
|
2928
1775
|
MessageBody: MessageBody | undefined;
|
|
2929
1776
|
}
|
|
2930
1777
|
export declare namespace UpdateTemplateActiveVersionResponse {
|
|
2931
|
-
|
|
2932
|
-
* @internal
|
|
2933
|
-
*/
|
|
1778
|
+
|
|
2934
1779
|
const filterSensitiveLog: (obj: UpdateTemplateActiveVersionResponse) => any;
|
|
2935
1780
|
}
|
|
2936
|
-
|
|
2937
|
-
* <p>Specifies the status and settings of the voice channel for an application.</p>
|
|
2938
|
-
*/
|
|
1781
|
+
|
|
2939
1782
|
export interface VoiceChannelRequest {
|
|
2940
|
-
|
|
2941
|
-
* <p>Specifies whether to enable the voice channel for the application.</p>
|
|
2942
|
-
*/
|
|
1783
|
+
|
|
2943
1784
|
Enabled?: boolean;
|
|
2944
1785
|
}
|
|
2945
1786
|
export declare namespace VoiceChannelRequest {
|
|
2946
|
-
|
|
2947
|
-
* @internal
|
|
2948
|
-
*/
|
|
1787
|
+
|
|
2949
1788
|
const filterSensitiveLog: (obj: VoiceChannelRequest) => any;
|
|
2950
1789
|
}
|
|
2951
1790
|
export interface UpdateVoiceChannelRequest {
|
|
2952
|
-
|
|
2953
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
2954
|
-
*/
|
|
1791
|
+
|
|
2955
1792
|
ApplicationId: string | undefined;
|
|
2956
|
-
|
|
2957
|
-
* <p>Specifies the status and settings of the voice channel for an application.</p>
|
|
2958
|
-
*/
|
|
1793
|
+
|
|
2959
1794
|
VoiceChannelRequest: VoiceChannelRequest | undefined;
|
|
2960
1795
|
}
|
|
2961
1796
|
export declare namespace UpdateVoiceChannelRequest {
|
|
2962
|
-
|
|
2963
|
-
* @internal
|
|
2964
|
-
*/
|
|
1797
|
+
|
|
2965
1798
|
const filterSensitiveLog: (obj: UpdateVoiceChannelRequest) => any;
|
|
2966
1799
|
}
|
|
2967
1800
|
export interface UpdateVoiceChannelResponse {
|
|
2968
|
-
|
|
2969
|
-
* <p>Provides information about the status and settings of the voice channel for an application.</p>
|
|
2970
|
-
*/
|
|
1801
|
+
|
|
2971
1802
|
VoiceChannelResponse: VoiceChannelResponse | undefined;
|
|
2972
1803
|
}
|
|
2973
1804
|
export declare namespace UpdateVoiceChannelResponse {
|
|
2974
|
-
|
|
2975
|
-
* @internal
|
|
2976
|
-
*/
|
|
1805
|
+
|
|
2977
1806
|
const filterSensitiveLog: (obj: UpdateVoiceChannelResponse) => any;
|
|
2978
1807
|
}
|
|
2979
1808
|
export interface UpdateVoiceTemplateRequest {
|
|
2980
|
-
|
|
2981
|
-
* <p>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.</p> <p>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.</p>
|
|
2982
|
-
*/
|
|
1809
|
+
|
|
2983
1810
|
CreateNewVersion?: boolean;
|
|
2984
|
-
|
|
2985
|
-
* <p>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.</p>
|
|
2986
|
-
*/
|
|
1811
|
+
|
|
2987
1812
|
TemplateName: string | undefined;
|
|
2988
|
-
|
|
2989
|
-
* <p>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 <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>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.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>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.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
2990
|
-
*/
|
|
1813
|
+
|
|
2991
1814
|
Version?: string;
|
|
2992
|
-
|
|
2993
|
-
* <p>Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
|
|
2994
|
-
*/
|
|
1815
|
+
|
|
2995
1816
|
VoiceTemplateRequest: VoiceTemplateRequest | undefined;
|
|
2996
1817
|
}
|
|
2997
1818
|
export declare namespace UpdateVoiceTemplateRequest {
|
|
2998
|
-
|
|
2999
|
-
* @internal
|
|
3000
|
-
*/
|
|
1819
|
+
|
|
3001
1820
|
const filterSensitiveLog: (obj: UpdateVoiceTemplateRequest) => any;
|
|
3002
1821
|
}
|
|
3003
1822
|
export interface UpdateVoiceTemplateResponse {
|
|
3004
|
-
|
|
3005
|
-
* <p>Provides information about an API request or response.</p>
|
|
3006
|
-
*/
|
|
1823
|
+
|
|
3007
1824
|
MessageBody: MessageBody | undefined;
|
|
3008
1825
|
}
|
|
3009
1826
|
export declare namespace UpdateVoiceTemplateResponse {
|
|
3010
|
-
|
|
3011
|
-
* @internal
|
|
3012
|
-
*/
|
|
1827
|
+
|
|
3013
1828
|
const filterSensitiveLog: (obj: UpdateVoiceTemplateResponse) => any;
|
|
3014
1829
|
}
|