@aws-sdk/client-pinpoint 3.320.0 → 3.321.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 (4) hide show
  1. package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +29 -0
  2. package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +28 -0
  3. package/dist-types/commands/GetJourneyRunsCommand.d.ts +32 -0
  4. package/package.json +1 -1
package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts CHANGED
@@ -66,6 +66,35 @@ export interface GetJourneyRunExecutionActivityMetricsCommandOutput extends GetJ
66
66
  * <p>Provides information about an API request or response.</p>
67
67
  *
68
68
  *
69
+ * @example To get the activity execution metrics for a journey run
70
+ * ```javascript
71
+ * // The following example gets activity execution metrics for a single run of a journey.
72
+ * const input = {
73
+ * "ApplicationId": "11111111112222222222333333333344",
74
+ * "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
75
+ * "RunId": "99999999998888888888777777777766",
76
+ * "JourneyActivityId": "AAAAAAAAAA"
77
+ * };
78
+ * const command = new GetJourneyRunExecutionActivityMetricsCommand(input);
79
+ * const response = await client.send(command);
80
+ * /* response ==
81
+ * {
82
+ * "JourneyRunExecutionActivityMetricsResponse": {
83
+ * "ApplicationId": "11111111112222222222333333333344",
84
+ * "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
85
+ * "RunId": "99999999998888888888777777777766",
86
+ * "JourneyActivityId": "AAAAAAAAAA",
87
+ * "ActivityType": "EMAIL",
88
+ * "LastEvaluatedTime": "2000-01-01T00:00:05.000Z",
89
+ * "Metrics": {
90
+ * "SUCCESS": "1"
91
+ * }
92
+ * }
93
+ * }
94
+ * *\/
95
+ * // example id: to-get-the-activity-execution-metrics-for-a-journey-run
96
+ * ```
97
+ *
69
98
  */
70
99
  export declare class GetJourneyRunExecutionActivityMetricsCommand extends $Command<GetJourneyRunExecutionActivityMetricsCommandInput, GetJourneyRunExecutionActivityMetricsCommandOutput, PinpointClientResolvedConfig> {
71
100
  readonly input: GetJourneyRunExecutionActivityMetricsCommandInput;
package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts CHANGED
@@ -65,6 +65,34 @@ export interface GetJourneyRunExecutionMetricsCommandOutput extends GetJourneyRu
65
65
  * <p>Provides information about an API request or response.</p>
66
66
  *
67
67
  *
68
+ * @example To get the execution metrics for a journey run
69
+ * ```javascript
70
+ * // The following example gets execution metrics for a single run of a journey.
71
+ * const input = {
72
+ * "ApplicationId": "11111111112222222222333333333344",
73
+ * "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
74
+ * "RunId": "99999999998888888888777777777766"
75
+ * };
76
+ * const command = new GetJourneyRunExecutionMetricsCommand(input);
77
+ * const response = await client.send(command);
78
+ * /* response ==
79
+ * {
80
+ * "JourneyRunExecutionMetricsResponse": {
81
+ * "ApplicationId": "11111111112222222222333333333344",
82
+ * "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd",
83
+ * "RunId": "99999999998888888888777777777766",
84
+ * "LastEvaluatedTime": "2000-01-01T00:00:05.000Z",
85
+ * "Metrics": {
86
+ * "ENDPOINT_PRODUCED": "1",
87
+ * "ENDPOINT_ENTERED": "1",
88
+ * "ENDPOINT_LEFT": "1"
89
+ * }
90
+ * }
91
+ * }
92
+ * *\/
93
+ * // example id: to-get-the-execution-metrics-for-a-journey-run
94
+ * ```
95
+ *
68
96
  */
69
97
  export declare class GetJourneyRunExecutionMetricsCommand extends $Command<GetJourneyRunExecutionMetricsCommandInput, GetJourneyRunExecutionMetricsCommandOutput, PinpointClientResolvedConfig> {
70
98
  readonly input: GetJourneyRunExecutionMetricsCommandInput;
package/dist-types/commands/GetJourneyRunsCommand.d.ts CHANGED
@@ -64,6 +64,38 @@ export interface GetJourneyRunsCommandOutput extends GetJourneyRunsResponse, __M
64
64
  * <p>Provides information about an API request or response.</p>
65
65
  *
66
66
  *
67
+ * @example To get the runs of a journey
68
+ * ```javascript
69
+ * // The following example gets the runs of a journey.
70
+ * const input = {
71
+ * "ApplicationId": "11111111112222222222333333333344",
72
+ * "JourneyId": "aaaaaaaaaabbbbbbbbbbccccccccccdd"
73
+ * };
74
+ * const command = new GetJourneyRunsCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "JourneyRunsResponse": {
79
+ * "Item": [
80
+ * {
81
+ * "RunId": "99999999998888888888777777777766",
82
+ * "CreationTime": "2000-01-01T00:00:00.000Z",
83
+ * "LastUpdateTime": "2000-01-01T00:00:05.000Z",
84
+ * "Status": "COMPLETED"
85
+ * },
86
+ * {
87
+ * "RunId": "ffffffffffeeeeeeeeeeddddddddddcc",
88
+ * "CreationTime": "2000-01-01T00:00:10.000Z",
89
+ * "LastUpdateTime": "2000-01-01T00:00:10.000Z",
90
+ * "Status": "SCHEDULED"
91
+ * }
92
+ * ]
93
+ * }
94
+ * }
95
+ * *\/
96
+ * // example id: to-get-the-runs-of-a-journey
97
+ * ```
98
+ *
67
99
  */
68
100
  export declare class GetJourneyRunsCommand extends $Command<GetJourneyRunsCommandInput, GetJourneyRunsCommandOutput, PinpointClientResolvedConfig> {
69
101
  readonly input: GetJourneyRunsCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pinpoint",
3
3
  "description": "AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native",
4
- "version": "3.320.0",
4
+ "version": "3.321.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",