@aws-sdk/client-pinpoint 3.299.0 → 3.301.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/dist-types/commands/CreateAppCommand.d.ts +8 -0
  2. package/dist-types/commands/CreateCampaignCommand.d.ts +367 -0
  3. package/dist-types/commands/CreateEmailTemplateCommand.d.ts +14 -0
  4. package/dist-types/commands/CreateExportJobCommand.d.ts +9 -0
  5. package/dist-types/commands/CreateImportJobCommand.d.ts +13 -0
  6. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +70 -0
  7. package/dist-types/commands/CreateJourneyCommand.d.ts +376 -0
  8. package/dist-types/commands/CreatePushTemplateCommand.d.ts +60 -0
  9. package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +15 -0
  10. package/dist-types/commands/CreateSegmentCommand.d.ts +139 -0
  11. package/dist-types/commands/CreateSmsTemplateCommand.d.ts +12 -0
  12. package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +13 -0
  13. package/dist-types/commands/DeleteAdmChannelCommand.d.ts +3 -0
  14. package/dist-types/commands/DeleteApnsChannelCommand.d.ts +3 -0
  15. package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +3 -0
  16. package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +3 -0
  17. package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +3 -0
  18. package/dist-types/commands/DeleteAppCommand.d.ts +3 -0
  19. package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +3 -0
  20. package/dist-types/commands/DeleteCampaignCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteEmailChannelCommand.d.ts +3 -0
  22. package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteEndpointCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteEventStreamCommand.d.ts +3 -0
  25. package/dist-types/commands/DeleteGcmChannelCommand.d.ts +3 -0
  26. package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteJourneyCommand.d.ts +4 -0
  28. package/dist-types/commands/DeletePushTemplateCommand.d.ts +4 -0
  29. package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +3 -0
  30. package/dist-types/commands/DeleteSegmentCommand.d.ts +4 -0
  31. package/dist-types/commands/DeleteSmsChannelCommand.d.ts +3 -0
  32. package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +4 -0
  33. package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +3 -0
  35. package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +4 -0
  36. package/dist-types/commands/GetAdmChannelCommand.d.ts +3 -0
  37. package/dist-types/commands/GetApnsChannelCommand.d.ts +3 -0
  38. package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +3 -0
  39. package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +3 -0
  40. package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +3 -0
  41. package/dist-types/commands/GetAppCommand.d.ts +3 -0
  42. package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +8 -0
  43. package/dist-types/commands/GetApplicationSettingsCommand.d.ts +3 -0
  44. package/dist-types/commands/GetAppsCommand.d.ts +4 -0
  45. package/dist-types/commands/GetBaiduChannelCommand.d.ts +3 -0
  46. package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +6 -0
  47. package/dist-types/commands/GetCampaignCommand.d.ts +4 -0
  48. package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +9 -0
  49. package/dist-types/commands/GetCampaignVersionCommand.d.ts +5 -0
  50. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +6 -0
  51. package/dist-types/commands/GetCampaignsCommand.d.ts +5 -0
  52. package/dist-types/commands/GetChannelsCommand.d.ts +3 -0
  53. package/dist-types/commands/GetEmailChannelCommand.d.ts +3 -0
  54. package/dist-types/commands/GetEmailTemplateCommand.d.ts +4 -0
  55. package/dist-types/commands/GetEndpointCommand.d.ts +4 -0
  56. package/dist-types/commands/GetEventStreamCommand.d.ts +3 -0
  57. package/dist-types/commands/GetExportJobCommand.d.ts +4 -0
  58. package/dist-types/commands/GetExportJobsCommand.d.ts +5 -0
  59. package/dist-types/commands/GetGcmChannelCommand.d.ts +3 -0
  60. package/dist-types/commands/GetImportJobCommand.d.ts +4 -0
  61. package/dist-types/commands/GetImportJobsCommand.d.ts +5 -0
  62. package/dist-types/commands/GetInAppMessagesCommand.d.ts +4 -0
  63. package/dist-types/commands/GetInAppTemplateCommand.d.ts +4 -0
  64. package/dist-types/commands/GetJourneyCommand.d.ts +4 -0
  65. package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +9 -0
  66. package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +7 -0
  67. package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +6 -0
  68. package/dist-types/commands/GetPushTemplateCommand.d.ts +4 -0
  69. package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +3 -0
  70. package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +4 -0
  71. package/dist-types/commands/GetSegmentCommand.d.ts +4 -0
  72. package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +6 -0
  73. package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +6 -0
  74. package/dist-types/commands/GetSegmentVersionCommand.d.ts +5 -0
  75. package/dist-types/commands/GetSegmentVersionsCommand.d.ts +6 -0
  76. package/dist-types/commands/GetSegmentsCommand.d.ts +5 -0
  77. package/dist-types/commands/GetSmsChannelCommand.d.ts +3 -0
  78. package/dist-types/commands/GetSmsTemplateCommand.d.ts +4 -0
  79. package/dist-types/commands/GetUserEndpointsCommand.d.ts +4 -0
  80. package/dist-types/commands/GetVoiceChannelCommand.d.ts +3 -0
  81. package/dist-types/commands/GetVoiceTemplateCommand.d.ts +4 -0
  82. package/dist-types/commands/ListJourneysCommand.d.ts +5 -0
  83. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  84. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +6 -0
  85. package/dist-types/commands/ListTemplatesCommand.d.ts +6 -0
  86. package/dist-types/commands/PhoneNumberValidateCommand.d.ts +6 -0
  87. package/dist-types/commands/PutEventStreamCommand.d.ts +7 -0
  88. package/dist-types/commands/PutEventsCommand.d.ts +74 -0
  89. package/dist-types/commands/RemoveAttributesCommand.d.ts +9 -0
  90. package/dist-types/commands/SendMessagesCommand.d.ts +204 -0
  91. package/dist-types/commands/SendOTPMessageCommand.d.ts +16 -0
  92. package/dist-types/commands/SendUsersMessagesCommand.d.ts +194 -0
  93. package/dist-types/commands/TagResourceCommand.d.ts +8 -0
  94. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  95. package/dist-types/commands/UpdateAdmChannelCommand.d.ts +8 -0
  96. package/dist-types/commands/UpdateApnsChannelCommand.d.ts +13 -0
  97. package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +13 -0
  98. package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +13 -0
  99. package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +13 -0
  100. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +23 -0
  101. package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +8 -0
  102. package/dist-types/commands/UpdateCampaignCommand.d.ts +368 -0
  103. package/dist-types/commands/UpdateEmailChannelCommand.d.ts +10 -0
  104. package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateEndpointCommand.d.ts +46 -0
  106. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +50 -0
  107. package/dist-types/commands/UpdateGcmChannelCommand.d.ts +7 -0
  108. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +72 -0
  109. package/dist-types/commands/UpdateJourneyCommand.d.ts +377 -0
  110. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +7 -0
  111. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +62 -0
  112. package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +16 -0
  113. package/dist-types/commands/UpdateSegmentCommand.d.ts +140 -0
  114. package/dist-types/commands/UpdateSmsChannelCommand.d.ts +8 -0
  115. package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +14 -0
  116. package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +7 -0
  117. package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +6 -0
  118. package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +15 -0
  119. package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
  120. package/package.json +8 -8
@@ -26,6 +26,15 @@ export interface GetJourneyDateRangeKpiCommandOutput extends GetJourneyDateRange
26
26
  * import { PinpointClient, GetJourneyDateRangeKpiCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetJourneyDateRangeKpiCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetJourneyDateRangeKpiRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * EndTime: new Date("TIMESTAMP"),
32
+ * JourneyId: "STRING_VALUE", // required
33
+ * KpiName: "STRING_VALUE", // required
34
+ * NextToken: "STRING_VALUE",
35
+ * PageSize: "STRING_VALUE",
36
+ * StartTime: new Date("TIMESTAMP"),
37
+ * };
29
38
  * const command = new GetJourneyDateRangeKpiCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,13 @@ export interface GetJourneyExecutionActivityMetricsCommandOutput extends GetJour
26
26
  * import { PinpointClient, GetJourneyExecutionActivityMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetJourneyExecutionActivityMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetJourneyExecutionActivityMetricsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * JourneyActivityId: "STRING_VALUE", // required
32
+ * JourneyId: "STRING_VALUE", // required
33
+ * NextToken: "STRING_VALUE",
34
+ * PageSize: "STRING_VALUE",
35
+ * };
29
36
  * const command = new GetJourneyExecutionActivityMetricsCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,12 @@ export interface GetJourneyExecutionMetricsCommandOutput extends GetJourneyExecu
26
26
  * import { PinpointClient, GetJourneyExecutionMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetJourneyExecutionMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetJourneyExecutionMetricsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * JourneyId: "STRING_VALUE", // required
32
+ * NextToken: "STRING_VALUE",
33
+ * PageSize: "STRING_VALUE",
34
+ * };
29
35
  * const command = new GetJourneyExecutionMetricsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,10 @@ export interface GetPushTemplateCommandOutput extends GetPushTemplateResponse, _
26
26
  * import { PinpointClient, GetPushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetPushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetPushTemplateRequest
30
+ * TemplateName: "STRING_VALUE", // required
31
+ * Version: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetPushTemplateCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface GetRecommenderConfigurationCommandOutput extends GetRecommender
26
26
  * import { PinpointClient, GetRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetRecommenderConfigurationRequest
30
+ * RecommenderId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetRecommenderConfigurationCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetRecommenderConfigurationsCommandOutput extends GetRecommende
26
26
  * import { PinpointClient, GetRecommenderConfigurationsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetRecommenderConfigurationsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetRecommenderConfigurationsRequest
30
+ * PageSize: "STRING_VALUE",
31
+ * Token: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetRecommenderConfigurationsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface GetSegmentCommandOutput extends GetSegmentResponse, __MetadataB
26
26
  * import { PinpointClient, GetSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * SegmentId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetSegmentCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,12 @@ export interface GetSegmentExportJobsCommandOutput extends GetSegmentExportJobsR
26
26
  * import { PinpointClient, GetSegmentExportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentExportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentExportJobsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * PageSize: "STRING_VALUE",
32
+ * SegmentId: "STRING_VALUE", // required
33
+ * Token: "STRING_VALUE",
34
+ * };
29
35
  * const command = new GetSegmentExportJobsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,12 @@ export interface GetSegmentImportJobsCommandOutput extends GetSegmentImportJobsR
26
26
  * import { PinpointClient, GetSegmentImportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentImportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentImportJobsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * PageSize: "STRING_VALUE",
32
+ * SegmentId: "STRING_VALUE", // required
33
+ * Token: "STRING_VALUE",
34
+ * };
29
35
  * const command = new GetSegmentImportJobsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface GetSegmentVersionCommandOutput extends GetSegmentVersionRespons
26
26
  * import { PinpointClient, GetSegmentVersionCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentVersionCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentVersionRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * SegmentId: "STRING_VALUE", // required
32
+ * Version: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetSegmentVersionCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,12 @@ export interface GetSegmentVersionsCommandOutput extends GetSegmentVersionsRespo
26
26
  * import { PinpointClient, GetSegmentVersionsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentVersionsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentVersionsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * PageSize: "STRING_VALUE",
32
+ * SegmentId: "STRING_VALUE", // required
33
+ * Token: "STRING_VALUE",
34
+ * };
29
35
  * const command = new GetSegmentVersionsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface GetSegmentsCommandOutput extends GetSegmentsResponse, __Metadat
26
26
  * import { PinpointClient, GetSegmentsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSegmentsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSegmentsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * PageSize: "STRING_VALUE",
32
+ * Token: "STRING_VALUE",
33
+ * };
29
34
  * const command = new GetSegmentsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met
26
26
  * import { PinpointClient, GetSmsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSmsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSmsChannelRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetSmsChannelCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M
26
26
  * import { PinpointClient, GetSmsTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetSmsTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetSmsTemplateRequest
30
+ * TemplateName: "STRING_VALUE", // required
31
+ * Version: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetSmsTemplateCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse,
26
26
  * import { PinpointClient, GetUserEndpointsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetUserEndpointsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetUserEndpointsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * UserId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetUserEndpointsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _
26
26
  * import { PinpointClient, GetVoiceChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetVoiceChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetVoiceChannelRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetVoiceChannelCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse,
26
26
  * import { PinpointClient, GetVoiceTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, GetVoiceTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // GetVoiceTemplateRequest
30
+ * TemplateName: "STRING_VALUE", // required
31
+ * Version: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetVoiceTemplateCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface ListJourneysCommandOutput extends ListJourneysResponse, __Metad
26
26
  * import { PinpointClient, ListJourneysCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, ListJourneysCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // ListJourneysRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * PageSize: "STRING_VALUE",
32
+ * Token: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListJourneysCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { PinpointClient, ListTagsForResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // ListTagsForResourceRequest
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new ListTagsForResourceCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,12 @@ export interface ListTemplateVersionsCommandOutput extends ListTemplateVersionsR
26
26
  * import { PinpointClient, ListTemplateVersionsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, ListTemplateVersionsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // ListTemplateVersionsRequest
30
+ * NextToken: "STRING_VALUE",
31
+ * PageSize: "STRING_VALUE",
32
+ * TemplateName: "STRING_VALUE", // required
33
+ * TemplateType: "STRING_VALUE", // required
34
+ * };
29
35
  * const command = new ListTemplateVersionsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,12 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
26
26
  * import { PinpointClient, ListTemplatesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, ListTemplatesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // ListTemplatesRequest
30
+ * NextToken: "STRING_VALUE",
31
+ * PageSize: "STRING_VALUE",
32
+ * Prefix: "STRING_VALUE",
33
+ * TemplateType: "STRING_VALUE",
34
+ * };
29
35
  * const command = new ListTemplatesCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,12 @@ export interface PhoneNumberValidateCommandOutput extends PhoneNumberValidateRes
26
26
  * import { PinpointClient, PhoneNumberValidateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, PhoneNumberValidateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // PhoneNumberValidateRequest
30
+ * NumberValidateRequest: { // NumberValidateRequest
31
+ * IsoCountryCode: "STRING_VALUE",
32
+ * PhoneNumber: "STRING_VALUE",
33
+ * },
34
+ * };
29
35
  * const command = new PhoneNumberValidateCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,13 @@ export interface PutEventStreamCommandOutput extends PutEventStreamResponse, __M
26
26
  * import { PinpointClient, PutEventStreamCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, PutEventStreamCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // PutEventStreamRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * WriteEventStream: { // WriteEventStream
32
+ * DestinationStreamArn: "STRING_VALUE", // required
33
+ * RoleArn: "STRING_VALUE", // required
34
+ * },
35
+ * };
29
36
  * const command = new PutEventStreamCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,80 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
26
26
  * import { PinpointClient, PutEventsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, PutEventsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // PutEventsRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * EventsRequest: { // EventsRequest
32
+ * BatchItem: { // MapOfEventsBatch // required
33
+ * "<keys>": { // EventsBatch
34
+ * Endpoint: { // PublicEndpoint
35
+ * Address: "STRING_VALUE",
36
+ * Attributes: { // MapOfListOf__string
37
+ * "<keys>": [ // ListOf__string
38
+ * "STRING_VALUE",
39
+ * ],
40
+ * },
41
+ * ChannelType: "STRING_VALUE",
42
+ * Demographic: { // EndpointDemographic
43
+ * AppVersion: "STRING_VALUE",
44
+ * Locale: "STRING_VALUE",
45
+ * Make: "STRING_VALUE",
46
+ * Model: "STRING_VALUE",
47
+ * ModelVersion: "STRING_VALUE",
48
+ * Platform: "STRING_VALUE",
49
+ * PlatformVersion: "STRING_VALUE",
50
+ * Timezone: "STRING_VALUE",
51
+ * },
52
+ * EffectiveDate: "STRING_VALUE",
53
+ * EndpointStatus: "STRING_VALUE",
54
+ * Location: { // EndpointLocation
55
+ * City: "STRING_VALUE",
56
+ * Country: "STRING_VALUE",
57
+ * Latitude: Number("double"),
58
+ * Longitude: Number("double"),
59
+ * PostalCode: "STRING_VALUE",
60
+ * Region: "STRING_VALUE",
61
+ * },
62
+ * Metrics: { // MapOf__double
63
+ * "<keys>": Number("double"),
64
+ * },
65
+ * OptOut: "STRING_VALUE",
66
+ * RequestId: "STRING_VALUE",
67
+ * User: { // EndpointUser
68
+ * UserAttributes: {
69
+ * "<keys>": [
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * UserId: "STRING_VALUE",
74
+ * },
75
+ * },
76
+ * Events: { // MapOfEvent // required
77
+ * "<keys>": { // Event
78
+ * AppPackageName: "STRING_VALUE",
79
+ * AppTitle: "STRING_VALUE",
80
+ * AppVersionCode: "STRING_VALUE",
81
+ * Attributes: { // MapOf__string
82
+ * "<keys>": "STRING_VALUE",
83
+ * },
84
+ * ClientSdkVersion: "STRING_VALUE",
85
+ * EventType: "STRING_VALUE", // required
86
+ * Metrics: {
87
+ * "<keys>": Number("double"),
88
+ * },
89
+ * SdkName: "STRING_VALUE",
90
+ * Session: { // Session
91
+ * Duration: Number("int"),
92
+ * Id: "STRING_VALUE", // required
93
+ * StartTimestamp: "STRING_VALUE", // required
94
+ * StopTimestamp: "STRING_VALUE",
95
+ * },
96
+ * Timestamp: "STRING_VALUE", // required
97
+ * },
98
+ * },
99
+ * },
100
+ * },
101
+ * },
102
+ * };
29
103
  * const command = new PutEventsCommand(input);
30
104
  * const response = await client.send(command);
31
105
  * ```
@@ -26,6 +26,15 @@ export interface RemoveAttributesCommandOutput extends RemoveAttributesResponse,
26
26
  * import { PinpointClient, RemoveAttributesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, RemoveAttributesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // RemoveAttributesRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * AttributeType: "STRING_VALUE", // required
32
+ * UpdateAttributesRequest: { // UpdateAttributesRequest
33
+ * Blacklist: [ // ListOf__string
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * },
37
+ * };
29
38
  * const command = new RemoveAttributesCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,210 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
26
26
  * import { PinpointClient, SendMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, SendMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // SendMessagesRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * MessageRequest: { // MessageRequest
32
+ * Addresses: { // MapOfAddressConfiguration
33
+ * "<keys>": { // AddressConfiguration
34
+ * BodyOverride: "STRING_VALUE",
35
+ * ChannelType: "STRING_VALUE",
36
+ * Context: { // MapOf__string
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * RawContent: "STRING_VALUE",
40
+ * Substitutions: { // MapOfListOf__string
41
+ * "<keys>": [ // ListOf__string
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * },
45
+ * TitleOverride: "STRING_VALUE",
46
+ * },
47
+ * },
48
+ * Context: {
49
+ * "<keys>": "STRING_VALUE",
50
+ * },
51
+ * Endpoints: { // MapOfEndpointSendConfiguration
52
+ * "<keys>": { // EndpointSendConfiguration
53
+ * BodyOverride: "STRING_VALUE",
54
+ * Context: {
55
+ * "<keys>": "STRING_VALUE",
56
+ * },
57
+ * RawContent: "STRING_VALUE",
58
+ * Substitutions: {
59
+ * "<keys>": [
60
+ * "STRING_VALUE",
61
+ * ],
62
+ * },
63
+ * TitleOverride: "STRING_VALUE",
64
+ * },
65
+ * },
66
+ * MessageConfiguration: { // DirectMessageConfiguration
67
+ * ADMMessage: { // ADMMessage
68
+ * Action: "STRING_VALUE",
69
+ * Body: "STRING_VALUE",
70
+ * ConsolidationKey: "STRING_VALUE",
71
+ * Data: {
72
+ * "<keys>": "STRING_VALUE",
73
+ * },
74
+ * ExpiresAfter: "STRING_VALUE",
75
+ * IconReference: "STRING_VALUE",
76
+ * ImageIconUrl: "STRING_VALUE",
77
+ * ImageUrl: "STRING_VALUE",
78
+ * MD5: "STRING_VALUE",
79
+ * RawContent: "STRING_VALUE",
80
+ * SilentPush: true || false,
81
+ * SmallImageIconUrl: "STRING_VALUE",
82
+ * Sound: "STRING_VALUE",
83
+ * Substitutions: {
84
+ * "<keys>": [
85
+ * "STRING_VALUE",
86
+ * ],
87
+ * },
88
+ * Title: "STRING_VALUE",
89
+ * Url: "STRING_VALUE",
90
+ * },
91
+ * APNSMessage: { // APNSMessage
92
+ * APNSPushType: "STRING_VALUE",
93
+ * Action: "STRING_VALUE",
94
+ * Badge: Number("int"),
95
+ * Body: "STRING_VALUE",
96
+ * Category: "STRING_VALUE",
97
+ * CollapseId: "STRING_VALUE",
98
+ * Data: {
99
+ * "<keys>": "STRING_VALUE",
100
+ * },
101
+ * MediaUrl: "STRING_VALUE",
102
+ * PreferredAuthenticationMethod: "STRING_VALUE",
103
+ * Priority: "STRING_VALUE",
104
+ * RawContent: "STRING_VALUE",
105
+ * SilentPush: true || false,
106
+ * Sound: "STRING_VALUE",
107
+ * Substitutions: {
108
+ * "<keys>": [
109
+ * "STRING_VALUE",
110
+ * ],
111
+ * },
112
+ * ThreadId: "STRING_VALUE",
113
+ * TimeToLive: Number("int"),
114
+ * Title: "STRING_VALUE",
115
+ * Url: "STRING_VALUE",
116
+ * },
117
+ * BaiduMessage: { // BaiduMessage
118
+ * Action: "STRING_VALUE",
119
+ * Body: "STRING_VALUE",
120
+ * Data: "<MapOf__string>",
121
+ * IconReference: "STRING_VALUE",
122
+ * ImageIconUrl: "STRING_VALUE",
123
+ * ImageUrl: "STRING_VALUE",
124
+ * RawContent: "STRING_VALUE",
125
+ * SilentPush: true || false,
126
+ * SmallImageIconUrl: "STRING_VALUE",
127
+ * Sound: "STRING_VALUE",
128
+ * Substitutions: {
129
+ * "<keys>": [
130
+ * "STRING_VALUE",
131
+ * ],
132
+ * },
133
+ * TimeToLive: Number("int"),
134
+ * Title: "STRING_VALUE",
135
+ * Url: "STRING_VALUE",
136
+ * },
137
+ * DefaultMessage: { // DefaultMessage
138
+ * Body: "STRING_VALUE",
139
+ * Substitutions: "<MapOfListOf__string>",
140
+ * },
141
+ * DefaultPushNotificationMessage: { // DefaultPushNotificationMessage
142
+ * Action: "STRING_VALUE",
143
+ * Body: "STRING_VALUE",
144
+ * Data: "<MapOf__string>",
145
+ * SilentPush: true || false,
146
+ * Substitutions: "<MapOfListOf__string>",
147
+ * Title: "STRING_VALUE",
148
+ * Url: "STRING_VALUE",
149
+ * },
150
+ * EmailMessage: { // EmailMessage
151
+ * Body: "STRING_VALUE",
152
+ * FeedbackForwardingAddress: "STRING_VALUE",
153
+ * FromAddress: "STRING_VALUE",
154
+ * RawEmail: { // RawEmail
155
+ * Data: "BLOB_VALUE",
156
+ * },
157
+ * ReplyToAddresses: "<ListOf__string>",
158
+ * SimpleEmail: { // SimpleEmail
159
+ * HtmlPart: { // SimpleEmailPart
160
+ * Charset: "STRING_VALUE",
161
+ * Data: "STRING_VALUE",
162
+ * },
163
+ * Subject: {
164
+ * Charset: "STRING_VALUE",
165
+ * Data: "STRING_VALUE",
166
+ * },
167
+ * TextPart: {
168
+ * Charset: "STRING_VALUE",
169
+ * Data: "STRING_VALUE",
170
+ * },
171
+ * },
172
+ * Substitutions: "<MapOfListOf__string>",
173
+ * },
174
+ * GCMMessage: { // GCMMessage
175
+ * Action: "STRING_VALUE",
176
+ * Body: "STRING_VALUE",
177
+ * CollapseKey: "STRING_VALUE",
178
+ * Data: "<MapOf__string>",
179
+ * IconReference: "STRING_VALUE",
180
+ * ImageIconUrl: "STRING_VALUE",
181
+ * ImageUrl: "STRING_VALUE",
182
+ * Priority: "STRING_VALUE",
183
+ * RawContent: "STRING_VALUE",
184
+ * RestrictedPackageName: "STRING_VALUE",
185
+ * SilentPush: true || false,
186
+ * SmallImageIconUrl: "STRING_VALUE",
187
+ * Sound: "STRING_VALUE",
188
+ * Substitutions: "<MapOfListOf__string>",
189
+ * TimeToLive: Number("int"),
190
+ * Title: "STRING_VALUE",
191
+ * Url: "STRING_VALUE",
192
+ * },
193
+ * SMSMessage: { // SMSMessage
194
+ * Body: "STRING_VALUE",
195
+ * Keyword: "STRING_VALUE",
196
+ * MediaUrl: "STRING_VALUE",
197
+ * MessageType: "STRING_VALUE",
198
+ * OriginationNumber: "STRING_VALUE",
199
+ * SenderId: "STRING_VALUE",
200
+ * Substitutions: "<MapOfListOf__string>",
201
+ * EntityId: "STRING_VALUE",
202
+ * TemplateId: "STRING_VALUE",
203
+ * },
204
+ * VoiceMessage: { // VoiceMessage
205
+ * Body: "STRING_VALUE",
206
+ * LanguageCode: "STRING_VALUE",
207
+ * OriginationNumber: "STRING_VALUE",
208
+ * Substitutions: "<MapOfListOf__string>",
209
+ * VoiceId: "STRING_VALUE",
210
+ * },
211
+ * },
212
+ * TemplateConfiguration: { // TemplateConfiguration
213
+ * EmailTemplate: { // Template
214
+ * Name: "STRING_VALUE",
215
+ * Version: "STRING_VALUE",
216
+ * },
217
+ * PushTemplate: {
218
+ * Name: "STRING_VALUE",
219
+ * Version: "STRING_VALUE",
220
+ * },
221
+ * SMSTemplate: {
222
+ * Name: "STRING_VALUE",
223
+ * Version: "STRING_VALUE",
224
+ * },
225
+ * VoiceTemplate: {
226
+ * Name: "STRING_VALUE",
227
+ * Version: "STRING_VALUE",
228
+ * },
229
+ * },
230
+ * TraceId: "STRING_VALUE",
231
+ * },
232
+ * };
29
233
  * const command = new SendMessagesCommand(input);
30
234
  * const response = await client.send(command);
31
235
  * ```
@@ -26,6 +26,22 @@ export interface SendOTPMessageCommandOutput extends SendOTPMessageResponse, __M
26
26
  * import { PinpointClient, SendOTPMessageCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
27
  * // const { PinpointClient, SendOTPMessageCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
28
  * const client = new PinpointClient(config);
29
+ * const input = { // SendOTPMessageRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * SendOTPMessageRequestParameters: { // SendOTPMessageRequestParameters
32
+ * AllowedAttempts: Number("int"),
33
+ * BrandName: "STRING_VALUE", // required
34
+ * Channel: "STRING_VALUE", // required
35
+ * CodeLength: Number("int"),
36
+ * DestinationIdentity: "STRING_VALUE", // required
37
+ * EntityId: "STRING_VALUE",
38
+ * Language: "STRING_VALUE",
39
+ * OriginationIdentity: "STRING_VALUE", // required
40
+ * ReferenceId: "STRING_VALUE", // required
41
+ * TemplateId: "STRING_VALUE",
42
+ * ValidityPeriod: Number("int"),
43
+ * },
44
+ * };
29
45
  * const command = new SendOTPMessageCommand(input);
30
46
  * const response = await client.send(command);
31
47
  * ```