@aws-sdk/client-pinpoint 3.319.0 → 3.320.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 (54) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/Pinpoint.js +6 -0
  3. package/dist-cjs/commands/GetJourneyRunExecutionActivityMetricsCommand.js +45 -0
  4. package/dist-cjs/commands/GetJourneyRunExecutionMetricsCommand.js +45 -0
  5. package/dist-cjs/commands/GetJourneyRunsCommand.js +45 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_1.js +7 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +226 -4
  10. package/dist-es/Pinpoint.js +6 -0
  11. package/dist-es/commands/GetJourneyRunExecutionActivityMetricsCommand.js +41 -0
  12. package/dist-es/commands/GetJourneyRunExecutionMetricsCommand.js +41 -0
  13. package/dist-es/commands/GetJourneyRunsCommand.js +41 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_1.js +6 -1
  17. package/dist-es/protocols/Aws_restJson1.js +216 -0
  18. package/dist-types/Pinpoint.d.ts +21 -0
  19. package/dist-types/PinpointClient.d.ts +5 -2
  20. package/dist-types/commands/CreateCampaignCommand.d.ts +33 -33
  21. package/dist-types/commands/CreateImportJobCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -10
  23. package/dist-types/commands/CreateJourneyCommand.d.ts +19 -19
  24. package/dist-types/commands/CreatePushTemplateCommand.d.ts +5 -5
  25. package/dist-types/commands/CreateSegmentCommand.d.ts +16 -16
  26. package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +89 -0
  27. package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +88 -0
  28. package/dist-types/commands/GetJourneyRunsCommand.d.ts +87 -0
  29. package/dist-types/commands/PutEventsCommand.d.ts +1 -1
  30. package/dist-types/commands/SendMessagesCommand.d.ts +7 -7
  31. package/dist-types/commands/SendUsersMessagesCommand.d.ts +6 -6
  32. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateCampaignCommand.d.ts +33 -33
  34. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +10 -10
  37. package/dist-types/commands/UpdateJourneyCommand.d.ts +19 -19
  38. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdatePushTemplateCommand.d.ts +5 -5
  40. package/dist-types/commands/UpdateSegmentCommand.d.ts +16 -16
  41. package/dist-types/commands/index.d.ts +3 -0
  42. package/dist-types/models/models_0.d.ts +30 -26
  43. package/dist-types/models/models_1.d.ts +215 -3
  44. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  45. package/dist-types/ts3.4/Pinpoint.d.ts +57 -0
  46. package/dist-types/ts3.4/PinpointClient.d.ts +18 -0
  47. package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +41 -0
  48. package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +41 -0
  49. package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +37 -0
  50. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  52. package/dist-types/ts3.4/models/models_1.d.ts +68 -0
  53. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  54. package/package.json +1 -1
@@ -518,7 +518,7 @@ export interface GetJourneyExecutionActivityMetricsRequest {
518
518
  */
519
519
  JourneyId: string | undefined;
520
520
  /**
521
- * <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>
521
+ * <p>The <code/> 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>
522
522
  */
523
523
  NextToken?: string;
524
524
  /**
@@ -532,7 +532,7 @@ export interface GetJourneyExecutionActivityMetricsRequest {
532
532
  */
533
533
  export interface JourneyExecutionActivityMetricsResponse {
534
534
  /**
535
- * <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>
535
+ * <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>
536
536
  */
537
537
  ActivityType: string | undefined;
538
538
  /**
@@ -578,7 +578,7 @@ export interface GetJourneyExecutionMetricsRequest {
578
578
  */
579
579
  JourneyId: string | undefined;
580
580
  /**
581
- * <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>
581
+ * <p>The <code/> 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>
582
582
  */
583
583
  NextToken?: string;
584
584
  /**
@@ -617,6 +617,218 @@ export interface GetJourneyExecutionMetricsResponse {
617
617
  */
618
618
  JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse | undefined;
619
619
  }
620
+ /**
621
+ * @public
622
+ */
623
+ export interface GetJourneyRunExecutionActivityMetricsRequest {
624
+ /**
625
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
626
+ */
627
+ ApplicationId: string | undefined;
628
+ /**
629
+ * <p>The unique identifier for the journey activity.</p>
630
+ */
631
+ JourneyActivityId: string | undefined;
632
+ /**
633
+ * <p>The unique identifier for the journey.</p>
634
+ */
635
+ JourneyId: string | undefined;
636
+ /**
637
+ * <p>The <code/> 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>
638
+ */
639
+ NextToken?: string;
640
+ /**
641
+ * <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>
642
+ */
643
+ PageSize?: string;
644
+ /**
645
+ * <p>The unique identifier for the journey run.</p>
646
+ */
647
+ RunId: string | undefined;
648
+ }
649
+ /**
650
+ * @public
651
+ * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
652
+ */
653
+ export interface JourneyRunExecutionActivityMetricsResponse {
654
+ /**
655
+ * <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>
656
+ */
657
+ ActivityType: string | undefined;
658
+ /**
659
+ * <p>The unique identifier for the application that the metric applies to.</p>
660
+ */
661
+ ApplicationId: string | undefined;
662
+ /**
663
+ * <p>The unique identifier for the activity that the metric applies to.</p>
664
+ */
665
+ JourneyActivityId: string | undefined;
666
+ /**
667
+ * <p>The unique identifier for the journey that the metric applies to.</p>
668
+ */
669
+ JourneyId: string | undefined;
670
+ /**
671
+ * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.</p>
672
+ */
673
+ LastEvaluatedTime: string | undefined;
674
+ /**
675
+ * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see see <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
676
+ */
677
+ Metrics: Record<string, string> | undefined;
678
+ /**
679
+ * <p>The unique identifier for the journey run that the metric applies to.</p>
680
+ */
681
+ RunId: string | undefined;
682
+ }
683
+ /**
684
+ * @public
685
+ */
686
+ export interface GetJourneyRunExecutionActivityMetricsResponse {
687
+ /**
688
+ * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
689
+ */
690
+ JourneyRunExecutionActivityMetricsResponse: JourneyRunExecutionActivityMetricsResponse | undefined;
691
+ }
692
+ /**
693
+ * @public
694
+ */
695
+ export interface GetJourneyRunExecutionMetricsRequest {
696
+ /**
697
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
698
+ */
699
+ ApplicationId: string | undefined;
700
+ /**
701
+ * <p>The unique identifier for the journey.</p>
702
+ */
703
+ JourneyId: string | undefined;
704
+ /**
705
+ * <p>The <code/> 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>
706
+ */
707
+ NextToken?: string;
708
+ /**
709
+ * <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>
710
+ */
711
+ PageSize?: string;
712
+ /**
713
+ * <p>The unique identifier for the journey run.</p>
714
+ */
715
+ RunId: string | undefined;
716
+ }
717
+ /**
718
+ * @public
719
+ * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
720
+ */
721
+ export interface JourneyRunExecutionMetricsResponse {
722
+ /**
723
+ * <p>The unique identifier for the application that the metric applies to.</p>
724
+ */
725
+ ApplicationId: string | undefined;
726
+ /**
727
+ * <p>The unique identifier for the journey that the metric applies to.</p>
728
+ */
729
+ JourneyId: string | undefined;
730
+ /**
731
+ * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.</p>
732
+ */
733
+ LastEvaluatedTime: string | undefined;
734
+ /**
735
+ * <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">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
736
+ */
737
+ Metrics: Record<string, string> | undefined;
738
+ /**
739
+ * <p>The unique identifier for the journey run that the metric applies to.</p>
740
+ */
741
+ RunId: string | undefined;
742
+ }
743
+ /**
744
+ * @public
745
+ */
746
+ export interface GetJourneyRunExecutionMetricsResponse {
747
+ /**
748
+ * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
749
+ */
750
+ JourneyRunExecutionMetricsResponse: JourneyRunExecutionMetricsResponse | undefined;
751
+ }
752
+ /**
753
+ * @public
754
+ */
755
+ export interface GetJourneyRunsRequest {
756
+ /**
757
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
758
+ */
759
+ ApplicationId: string | undefined;
760
+ /**
761
+ * <p>The unique identifier for the journey.</p>
762
+ */
763
+ JourneyId: string | undefined;
764
+ /**
765
+ * <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>
766
+ */
767
+ PageSize?: string;
768
+ /**
769
+ * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
770
+ */
771
+ Token?: string;
772
+ }
773
+ /**
774
+ * @public
775
+ * @enum
776
+ */
777
+ export declare const JourneyRunStatus: {
778
+ readonly CANCELLED: "CANCELLED";
779
+ readonly COMPLETED: "COMPLETED";
780
+ readonly RUNNING: "RUNNING";
781
+ readonly SCHEDULED: "SCHEDULED";
782
+ };
783
+ /**
784
+ * @public
785
+ */
786
+ export type JourneyRunStatus = (typeof JourneyRunStatus)[keyof typeof JourneyRunStatus];
787
+ /**
788
+ * @public
789
+ * <p>Provides information from a specified run of a journey.</p>
790
+ */
791
+ export interface JourneyRunResponse {
792
+ /**
793
+ * <p>The time when the journey run was created or scheduled, in ISO 8601 format.</p>
794
+ */
795
+ CreationTime: string | undefined;
796
+ /**
797
+ * <p>The last time the journey run was updated, in ISO 8601 format..</p>
798
+ */
799
+ LastUpdateTime: string | undefined;
800
+ /**
801
+ * <p>The unique identifier for the run.</p>
802
+ */
803
+ RunId: string | undefined;
804
+ /**
805
+ * <p>The current status of the journey run.</p>
806
+ */
807
+ Status: JourneyRunStatus | string | undefined;
808
+ }
809
+ /**
810
+ * @public
811
+ * <p>Provides information from all runs of a journey.</p>
812
+ */
813
+ export interface JourneyRunsResponse {
814
+ /**
815
+ * <p>An array of responses, one for each run of the journey</p>
816
+ */
817
+ Item: JourneyRunResponse[] | undefined;
818
+ /**
819
+ * <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>
820
+ */
821
+ NextToken?: string;
822
+ }
823
+ /**
824
+ * @public
825
+ */
826
+ export interface GetJourneyRunsResponse {
827
+ /**
828
+ * <p>Provides information from all runs of a journey.</p>
829
+ */
830
+ JourneyRunsResponse: JourneyRunsResponse | undefined;
831
+ }
620
832
  /**
621
833
  * @public
622
834
  */
@@ -67,6 +67,9 @@ import { GetJourneyCommandInput, GetJourneyCommandOutput } from "../commands/Get
67
67
  import { GetJourneyDateRangeKpiCommandInput, GetJourneyDateRangeKpiCommandOutput } from "../commands/GetJourneyDateRangeKpiCommand";
68
68
  import { GetJourneyExecutionActivityMetricsCommandInput, GetJourneyExecutionActivityMetricsCommandOutput } from "../commands/GetJourneyExecutionActivityMetricsCommand";
69
69
  import { GetJourneyExecutionMetricsCommandInput, GetJourneyExecutionMetricsCommandOutput } from "../commands/GetJourneyExecutionMetricsCommand";
70
+ import { GetJourneyRunExecutionActivityMetricsCommandInput, GetJourneyRunExecutionActivityMetricsCommandOutput } from "../commands/GetJourneyRunExecutionActivityMetricsCommand";
71
+ import { GetJourneyRunExecutionMetricsCommandInput, GetJourneyRunExecutionMetricsCommandOutput } from "../commands/GetJourneyRunExecutionMetricsCommand";
72
+ import { GetJourneyRunsCommandInput, GetJourneyRunsCommandOutput } from "../commands/GetJourneyRunsCommand";
70
73
  import { GetPushTemplateCommandInput, GetPushTemplateCommandOutput } from "../commands/GetPushTemplateCommand";
71
74
  import { GetRecommenderConfigurationCommandInput, GetRecommenderConfigurationCommandOutput } from "../commands/GetRecommenderConfigurationCommand";
72
75
  import { GetRecommenderConfigurationsCommandInput, GetRecommenderConfigurationsCommandOutput } from "../commands/GetRecommenderConfigurationsCommand";
@@ -387,6 +390,18 @@ export declare const se_GetJourneyExecutionActivityMetricsCommand: (input: GetJo
387
390
  * serializeAws_restJson1GetJourneyExecutionMetricsCommand
388
391
  */
389
392
  export declare const se_GetJourneyExecutionMetricsCommand: (input: GetJourneyExecutionMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
393
+ /**
394
+ * serializeAws_restJson1GetJourneyRunExecutionActivityMetricsCommand
395
+ */
396
+ export declare const se_GetJourneyRunExecutionActivityMetricsCommand: (input: GetJourneyRunExecutionActivityMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
397
+ /**
398
+ * serializeAws_restJson1GetJourneyRunExecutionMetricsCommand
399
+ */
400
+ export declare const se_GetJourneyRunExecutionMetricsCommand: (input: GetJourneyRunExecutionMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
401
+ /**
402
+ * serializeAws_restJson1GetJourneyRunsCommand
403
+ */
404
+ export declare const se_GetJourneyRunsCommand: (input: GetJourneyRunsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
390
405
  /**
391
406
  * serializeAws_restJson1GetPushTemplateCommand
392
407
  */
@@ -863,6 +878,18 @@ export declare const de_GetJourneyExecutionActivityMetricsCommand: (output: __Ht
863
878
  * deserializeAws_restJson1GetJourneyExecutionMetricsCommand
864
879
  */
865
880
  export declare const de_GetJourneyExecutionMetricsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetJourneyExecutionMetricsCommandOutput>;
881
+ /**
882
+ * deserializeAws_restJson1GetJourneyRunExecutionActivityMetricsCommand
883
+ */
884
+ export declare const de_GetJourneyRunExecutionActivityMetricsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetJourneyRunExecutionActivityMetricsCommandOutput>;
885
+ /**
886
+ * deserializeAws_restJson1GetJourneyRunExecutionMetricsCommand
887
+ */
888
+ export declare const de_GetJourneyRunExecutionMetricsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetJourneyRunExecutionMetricsCommandOutput>;
889
+ /**
890
+ * deserializeAws_restJson1GetJourneyRunsCommand
891
+ */
892
+ export declare const de_GetJourneyRunsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetJourneyRunsCommandOutput>;
866
893
  /**
867
894
  * deserializeAws_restJson1GetPushTemplateCommand
868
895
  */
@@ -267,6 +267,18 @@ import {
267
267
  GetJourneyExecutionMetricsCommandInput,
268
268
  GetJourneyExecutionMetricsCommandOutput,
269
269
  } from "./commands/GetJourneyExecutionMetricsCommand";
270
+ import {
271
+ GetJourneyRunExecutionActivityMetricsCommandInput,
272
+ GetJourneyRunExecutionActivityMetricsCommandOutput,
273
+ } from "./commands/GetJourneyRunExecutionActivityMetricsCommand";
274
+ import {
275
+ GetJourneyRunExecutionMetricsCommandInput,
276
+ GetJourneyRunExecutionMetricsCommandOutput,
277
+ } from "./commands/GetJourneyRunExecutionMetricsCommand";
278
+ import {
279
+ GetJourneyRunsCommandInput,
280
+ GetJourneyRunsCommandOutput,
281
+ } from "./commands/GetJourneyRunsCommand";
270
282
  import {
271
283
  GetPushTemplateCommandInput,
272
284
  GetPushTemplateCommandOutput,
@@ -1354,6 +1366,51 @@ export interface Pinpoint {
1354
1366
  options: __HttpHandlerOptions,
1355
1367
  cb: (err: any, data?: GetJourneyExecutionMetricsCommandOutput) => void
1356
1368
  ): void;
1369
+ getJourneyRunExecutionActivityMetrics(
1370
+ args: GetJourneyRunExecutionActivityMetricsCommandInput,
1371
+ options?: __HttpHandlerOptions
1372
+ ): Promise<GetJourneyRunExecutionActivityMetricsCommandOutput>;
1373
+ getJourneyRunExecutionActivityMetrics(
1374
+ args: GetJourneyRunExecutionActivityMetricsCommandInput,
1375
+ cb: (
1376
+ err: any,
1377
+ data?: GetJourneyRunExecutionActivityMetricsCommandOutput
1378
+ ) => void
1379
+ ): void;
1380
+ getJourneyRunExecutionActivityMetrics(
1381
+ args: GetJourneyRunExecutionActivityMetricsCommandInput,
1382
+ options: __HttpHandlerOptions,
1383
+ cb: (
1384
+ err: any,
1385
+ data?: GetJourneyRunExecutionActivityMetricsCommandOutput
1386
+ ) => void
1387
+ ): void;
1388
+ getJourneyRunExecutionMetrics(
1389
+ args: GetJourneyRunExecutionMetricsCommandInput,
1390
+ options?: __HttpHandlerOptions
1391
+ ): Promise<GetJourneyRunExecutionMetricsCommandOutput>;
1392
+ getJourneyRunExecutionMetrics(
1393
+ args: GetJourneyRunExecutionMetricsCommandInput,
1394
+ cb: (err: any, data?: GetJourneyRunExecutionMetricsCommandOutput) => void
1395
+ ): void;
1396
+ getJourneyRunExecutionMetrics(
1397
+ args: GetJourneyRunExecutionMetricsCommandInput,
1398
+ options: __HttpHandlerOptions,
1399
+ cb: (err: any, data?: GetJourneyRunExecutionMetricsCommandOutput) => void
1400
+ ): void;
1401
+ getJourneyRuns(
1402
+ args: GetJourneyRunsCommandInput,
1403
+ options?: __HttpHandlerOptions
1404
+ ): Promise<GetJourneyRunsCommandOutput>;
1405
+ getJourneyRuns(
1406
+ args: GetJourneyRunsCommandInput,
1407
+ cb: (err: any, data?: GetJourneyRunsCommandOutput) => void
1408
+ ): void;
1409
+ getJourneyRuns(
1410
+ args: GetJourneyRunsCommandInput,
1411
+ options: __HttpHandlerOptions,
1412
+ cb: (err: any, data?: GetJourneyRunsCommandOutput) => void
1413
+ ): void;
1357
1414
  getPushTemplate(
1358
1415
  args: GetPushTemplateCommandInput,
1359
1416
  options?: __HttpHandlerOptions
@@ -312,6 +312,18 @@ import {
312
312
  GetJourneyExecutionMetricsCommandInput,
313
313
  GetJourneyExecutionMetricsCommandOutput,
314
314
  } from "./commands/GetJourneyExecutionMetricsCommand";
315
+ import {
316
+ GetJourneyRunExecutionActivityMetricsCommandInput,
317
+ GetJourneyRunExecutionActivityMetricsCommandOutput,
318
+ } from "./commands/GetJourneyRunExecutionActivityMetricsCommand";
319
+ import {
320
+ GetJourneyRunExecutionMetricsCommandInput,
321
+ GetJourneyRunExecutionMetricsCommandOutput,
322
+ } from "./commands/GetJourneyRunExecutionMetricsCommand";
323
+ import {
324
+ GetJourneyRunsCommandInput,
325
+ GetJourneyRunsCommandOutput,
326
+ } from "./commands/GetJourneyRunsCommand";
315
327
  import {
316
328
  GetPushTemplateCommandInput,
317
329
  GetPushTemplateCommandOutput,
@@ -593,6 +605,9 @@ export type ServiceInputTypes =
593
605
  | GetJourneyDateRangeKpiCommandInput
594
606
  | GetJourneyExecutionActivityMetricsCommandInput
595
607
  | GetJourneyExecutionMetricsCommandInput
608
+ | GetJourneyRunExecutionActivityMetricsCommandInput
609
+ | GetJourneyRunExecutionMetricsCommandInput
610
+ | GetJourneyRunsCommandInput
596
611
  | GetPushTemplateCommandInput
597
612
  | GetRecommenderConfigurationCommandInput
598
613
  | GetRecommenderConfigurationsCommandInput
@@ -713,6 +728,9 @@ export type ServiceOutputTypes =
713
728
  | GetJourneyDateRangeKpiCommandOutput
714
729
  | GetJourneyExecutionActivityMetricsCommandOutput
715
730
  | GetJourneyExecutionMetricsCommandOutput
731
+ | GetJourneyRunExecutionActivityMetricsCommandOutput
732
+ | GetJourneyRunExecutionMetricsCommandOutput
733
+ | GetJourneyRunsCommandOutput
716
734
  | GetPushTemplateCommandOutput
717
735
  | GetRecommenderConfigurationCommandOutput
718
736
  | GetRecommenderConfigurationsCommandOutput
@@ -0,0 +1,41 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@aws-sdk/types";
9
+ import {
10
+ GetJourneyRunExecutionActivityMetricsRequest,
11
+ GetJourneyRunExecutionActivityMetricsResponse,
12
+ } from "../models/models_1";
13
+ import {
14
+ PinpointClientResolvedConfig,
15
+ ServiceInputTypes,
16
+ ServiceOutputTypes,
17
+ } from "../PinpointClient";
18
+ export interface GetJourneyRunExecutionActivityMetricsCommandInput
19
+ extends GetJourneyRunExecutionActivityMetricsRequest {}
20
+ export interface GetJourneyRunExecutionActivityMetricsCommandOutput
21
+ extends GetJourneyRunExecutionActivityMetricsResponse,
22
+ __MetadataBearer {}
23
+ export declare class GetJourneyRunExecutionActivityMetricsCommand extends $Command<
24
+ GetJourneyRunExecutionActivityMetricsCommandInput,
25
+ GetJourneyRunExecutionActivityMetricsCommandOutput,
26
+ PinpointClientResolvedConfig
27
+ > {
28
+ readonly input: GetJourneyRunExecutionActivityMetricsCommandInput;
29
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
+ constructor(input: GetJourneyRunExecutionActivityMetricsCommandInput);
31
+ resolveMiddleware(
32
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
+ configuration: PinpointClientResolvedConfig,
34
+ options?: __HttpHandlerOptions
35
+ ): Handler<
36
+ GetJourneyRunExecutionActivityMetricsCommandInput,
37
+ GetJourneyRunExecutionActivityMetricsCommandOutput
38
+ >;
39
+ private serialize;
40
+ private deserialize;
41
+ }
@@ -0,0 +1,41 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@aws-sdk/types";
9
+ import {
10
+ GetJourneyRunExecutionMetricsRequest,
11
+ GetJourneyRunExecutionMetricsResponse,
12
+ } from "../models/models_1";
13
+ import {
14
+ PinpointClientResolvedConfig,
15
+ ServiceInputTypes,
16
+ ServiceOutputTypes,
17
+ } from "../PinpointClient";
18
+ export interface GetJourneyRunExecutionMetricsCommandInput
19
+ extends GetJourneyRunExecutionMetricsRequest {}
20
+ export interface GetJourneyRunExecutionMetricsCommandOutput
21
+ extends GetJourneyRunExecutionMetricsResponse,
22
+ __MetadataBearer {}
23
+ export declare class GetJourneyRunExecutionMetricsCommand extends $Command<
24
+ GetJourneyRunExecutionMetricsCommandInput,
25
+ GetJourneyRunExecutionMetricsCommandOutput,
26
+ PinpointClientResolvedConfig
27
+ > {
28
+ readonly input: GetJourneyRunExecutionMetricsCommandInput;
29
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
+ constructor(input: GetJourneyRunExecutionMetricsCommandInput);
31
+ resolveMiddleware(
32
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
+ configuration: PinpointClientResolvedConfig,
34
+ options?: __HttpHandlerOptions
35
+ ): Handler<
36
+ GetJourneyRunExecutionMetricsCommandInput,
37
+ GetJourneyRunExecutionMetricsCommandOutput
38
+ >;
39
+ private serialize;
40
+ private deserialize;
41
+ }
@@ -0,0 +1,37 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@aws-sdk/types";
9
+ import {
10
+ GetJourneyRunsRequest,
11
+ GetJourneyRunsResponse,
12
+ } from "../models/models_1";
13
+ import {
14
+ PinpointClientResolvedConfig,
15
+ ServiceInputTypes,
16
+ ServiceOutputTypes,
17
+ } from "../PinpointClient";
18
+ export interface GetJourneyRunsCommandInput extends GetJourneyRunsRequest {}
19
+ export interface GetJourneyRunsCommandOutput
20
+ extends GetJourneyRunsResponse,
21
+ __MetadataBearer {}
22
+ export declare class GetJourneyRunsCommand extends $Command<
23
+ GetJourneyRunsCommandInput,
24
+ GetJourneyRunsCommandOutput,
25
+ PinpointClientResolvedConfig
26
+ > {
27
+ readonly input: GetJourneyRunsCommandInput;
28
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
29
+ constructor(input: GetJourneyRunsCommandInput);
30
+ resolveMiddleware(
31
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
32
+ configuration: PinpointClientResolvedConfig,
33
+ options?: __HttpHandlerOptions
34
+ ): Handler<GetJourneyRunsCommandInput, GetJourneyRunsCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -65,6 +65,9 @@ export * from "./GetJourneyCommand";
65
65
  export * from "./GetJourneyDateRangeKpiCommand";
66
66
  export * from "./GetJourneyExecutionActivityMetricsCommand";
67
67
  export * from "./GetJourneyExecutionMetricsCommand";
68
+ export * from "./GetJourneyRunExecutionActivityMetricsCommand";
69
+ export * from "./GetJourneyRunExecutionMetricsCommand";
70
+ export * from "./GetJourneyRunsCommand";
68
71
  export * from "./GetPushTemplateCommand";
69
72
  export * from "./GetRecommenderConfigurationCommand";
70
73
  export * from "./GetRecommenderConfigurationsCommand";
@@ -37,6 +37,7 @@ export interface ActivityResponse {
37
37
  TimezonesTotalCount?: number;
38
38
  TotalEndpointCount?: number;
39
39
  TreatmentId?: string;
40
+ ExecutionMetrics?: Record<string, string>;
40
41
  }
41
42
  export interface ActivitiesResponse {
42
43
  Item: ActivityResponse[] | undefined;
@@ -248,6 +248,74 @@ export interface JourneyExecutionMetricsResponse {
248
248
  export interface GetJourneyExecutionMetricsResponse {
249
249
  JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse | undefined;
250
250
  }
251
+ export interface GetJourneyRunExecutionActivityMetricsRequest {
252
+ ApplicationId: string | undefined;
253
+ JourneyActivityId: string | undefined;
254
+ JourneyId: string | undefined;
255
+ NextToken?: string;
256
+ PageSize?: string;
257
+ RunId: string | undefined;
258
+ }
259
+ export interface JourneyRunExecutionActivityMetricsResponse {
260
+ ActivityType: string | undefined;
261
+ ApplicationId: string | undefined;
262
+ JourneyActivityId: string | undefined;
263
+ JourneyId: string | undefined;
264
+ LastEvaluatedTime: string | undefined;
265
+ Metrics: Record<string, string> | undefined;
266
+ RunId: string | undefined;
267
+ }
268
+ export interface GetJourneyRunExecutionActivityMetricsResponse {
269
+ JourneyRunExecutionActivityMetricsResponse:
270
+ | JourneyRunExecutionActivityMetricsResponse
271
+ | undefined;
272
+ }
273
+ export interface GetJourneyRunExecutionMetricsRequest {
274
+ ApplicationId: string | undefined;
275
+ JourneyId: string | undefined;
276
+ NextToken?: string;
277
+ PageSize?: string;
278
+ RunId: string | undefined;
279
+ }
280
+ export interface JourneyRunExecutionMetricsResponse {
281
+ ApplicationId: string | undefined;
282
+ JourneyId: string | undefined;
283
+ LastEvaluatedTime: string | undefined;
284
+ Metrics: Record<string, string> | undefined;
285
+ RunId: string | undefined;
286
+ }
287
+ export interface GetJourneyRunExecutionMetricsResponse {
288
+ JourneyRunExecutionMetricsResponse:
289
+ | JourneyRunExecutionMetricsResponse
290
+ | undefined;
291
+ }
292
+ export interface GetJourneyRunsRequest {
293
+ ApplicationId: string | undefined;
294
+ JourneyId: string | undefined;
295
+ PageSize?: string;
296
+ Token?: string;
297
+ }
298
+ export declare const JourneyRunStatus: {
299
+ readonly CANCELLED: "CANCELLED";
300
+ readonly COMPLETED: "COMPLETED";
301
+ readonly RUNNING: "RUNNING";
302
+ readonly SCHEDULED: "SCHEDULED";
303
+ };
304
+ export type JourneyRunStatus =
305
+ (typeof JourneyRunStatus)[keyof typeof JourneyRunStatus];
306
+ export interface JourneyRunResponse {
307
+ CreationTime: string | undefined;
308
+ LastUpdateTime: string | undefined;
309
+ RunId: string | undefined;
310
+ Status: JourneyRunStatus | string | undefined;
311
+ }
312
+ export interface JourneyRunsResponse {
313
+ Item: JourneyRunResponse[] | undefined;
314
+ NextToken?: string;
315
+ }
316
+ export interface GetJourneyRunsResponse {
317
+ JourneyRunsResponse: JourneyRunsResponse | undefined;
318
+ }
251
319
  export interface GetPushTemplateRequest {
252
320
  TemplateName: string | undefined;
253
321
  Version?: string;