@aws-sdk/client-pinpoint 3.319.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.
- package/README.md +24 -0
- package/dist-cjs/Pinpoint.js +6 -0
- package/dist-cjs/commands/GetJourneyRunExecutionActivityMetricsCommand.js +45 -0
- package/dist-cjs/commands/GetJourneyRunExecutionMetricsCommand.js +45 -0
- package/dist-cjs/commands/GetJourneyRunsCommand.js +45 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_1.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +226 -4
- package/dist-es/Pinpoint.js +6 -0
- package/dist-es/commands/GetJourneyRunExecutionActivityMetricsCommand.js +41 -0
- package/dist-es/commands/GetJourneyRunExecutionMetricsCommand.js +41 -0
- package/dist-es/commands/GetJourneyRunsCommand.js +41 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_1.js +6 -1
- package/dist-es/protocols/Aws_restJson1.js +216 -0
- package/dist-types/Pinpoint.d.ts +21 -0
- package/dist-types/PinpointClient.d.ts +5 -2
- package/dist-types/commands/CreateCampaignCommand.d.ts +33 -33
- package/dist-types/commands/CreateImportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -10
- package/dist-types/commands/CreateJourneyCommand.d.ts +19 -19
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateSegmentCommand.d.ts +16 -16
- package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +118 -0
- package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +116 -0
- package/dist-types/commands/GetJourneyRunsCommand.d.ts +119 -0
- package/dist-types/commands/PutEventsCommand.d.ts +1 -1
- package/dist-types/commands/SendMessagesCommand.d.ts +7 -7
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +6 -6
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCampaignCommand.d.ts +33 -33
- package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +10 -10
- package/dist-types/commands/UpdateJourneyCommand.d.ts +19 -19
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +5 -5
- package/dist-types/commands/UpdateSegmentCommand.d.ts +16 -16
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +30 -26
- package/dist-types/models/models_1.d.ts +215 -3
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/Pinpoint.d.ts +57 -0
- package/dist-types/ts3.4/PinpointClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +68 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +1 -1
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetJourneyRunExecutionActivityMetricsRequest, GetJourneyRunExecutionActivityMetricsResponse } from "../models/models_1";
|
|
5
|
+
import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetJourneyRunExecutionActivityMetricsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetJourneyRunExecutionActivityMetricsCommandInput extends GetJourneyRunExecutionActivityMetricsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetJourneyRunExecutionActivityMetricsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetJourneyRunExecutionActivityMetricsCommandOutput extends GetJourneyRunExecutionActivityMetricsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { PinpointClient, GetJourneyRunExecutionActivityMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
|
+
* // const { PinpointClient, GetJourneyRunExecutionActivityMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
|
+
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = { // GetJourneyRunExecutionActivityMetricsRequest
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* JourneyActivityId: "STRING_VALUE", // required
|
|
32
|
+
* JourneyId: "STRING_VALUE", // required
|
|
33
|
+
* NextToken: "STRING_VALUE",
|
|
34
|
+
* PageSize: "STRING_VALUE",
|
|
35
|
+
* RunId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetJourneyRunExecutionActivityMetricsCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @param GetJourneyRunExecutionActivityMetricsCommandInput - {@link GetJourneyRunExecutionActivityMetricsCommandInput}
|
|
42
|
+
* @returns {@link GetJourneyRunExecutionActivityMetricsCommandOutput}
|
|
43
|
+
* @see {@link GetJourneyRunExecutionActivityMetricsCommandInput} for command's `input` shape.
|
|
44
|
+
* @see {@link GetJourneyRunExecutionActivityMetricsCommandOutput} for command's `response` shape.
|
|
45
|
+
* @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link BadRequestException} (client fault)
|
|
48
|
+
* <p>Provides information about an API request or response.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
51
|
+
* <p>Provides information about an API request or response.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
54
|
+
* <p>Provides information about an API request or response.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
57
|
+
* <p>Provides information about an API request or response.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link NotFoundException} (client fault)
|
|
60
|
+
* <p>Provides information about an API request or response.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link PayloadTooLargeException} (client fault)
|
|
63
|
+
* <p>Provides information about an API request or response.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
|
+
* <p>Provides information about an API request or response.</p>
|
|
67
|
+
*
|
|
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
|
+
*
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetJourneyRunExecutionActivityMetricsCommand extends $Command<GetJourneyRunExecutionActivityMetricsCommandInput, GetJourneyRunExecutionActivityMetricsCommandOutput, PinpointClientResolvedConfig> {
|
|
100
|
+
readonly input: GetJourneyRunExecutionActivityMetricsCommandInput;
|
|
101
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
constructor(input: GetJourneyRunExecutionActivityMetricsCommandInput);
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetJourneyRunExecutionActivityMetricsCommandInput, GetJourneyRunExecutionActivityMetricsCommandOutput>;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
private serialize;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
private deserialize;
|
|
118
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetJourneyRunExecutionMetricsRequest, GetJourneyRunExecutionMetricsResponse } from "../models/models_1";
|
|
5
|
+
import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetJourneyRunExecutionMetricsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetJourneyRunExecutionMetricsCommandInput extends GetJourneyRunExecutionMetricsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetJourneyRunExecutionMetricsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetJourneyRunExecutionMetricsCommandOutput extends GetJourneyRunExecutionMetricsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { PinpointClient, GetJourneyRunExecutionMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
|
+
* // const { PinpointClient, GetJourneyRunExecutionMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
|
+
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = { // GetJourneyRunExecutionMetricsRequest
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* JourneyId: "STRING_VALUE", // required
|
|
32
|
+
* NextToken: "STRING_VALUE",
|
|
33
|
+
* PageSize: "STRING_VALUE",
|
|
34
|
+
* RunId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetJourneyRunExecutionMetricsCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @param GetJourneyRunExecutionMetricsCommandInput - {@link GetJourneyRunExecutionMetricsCommandInput}
|
|
41
|
+
* @returns {@link GetJourneyRunExecutionMetricsCommandOutput}
|
|
42
|
+
* @see {@link GetJourneyRunExecutionMetricsCommandInput} for command's `input` shape.
|
|
43
|
+
* @see {@link GetJourneyRunExecutionMetricsCommandOutput} for command's `response` shape.
|
|
44
|
+
* @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link BadRequestException} (client fault)
|
|
47
|
+
* <p>Provides information about an API request or response.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
50
|
+
* <p>Provides information about an API request or response.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
53
|
+
* <p>Provides information about an API request or response.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
56
|
+
* <p>Provides information about an API request or response.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link NotFoundException} (client fault)
|
|
59
|
+
* <p>Provides information about an API request or response.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link PayloadTooLargeException} (client fault)
|
|
62
|
+
* <p>Provides information about an API request or response.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
65
|
+
* <p>Provides information about an API request or response.</p>
|
|
66
|
+
*
|
|
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
|
+
*
|
|
96
|
+
*/
|
|
97
|
+
export declare class GetJourneyRunExecutionMetricsCommand extends $Command<GetJourneyRunExecutionMetricsCommandInput, GetJourneyRunExecutionMetricsCommandOutput, PinpointClientResolvedConfig> {
|
|
98
|
+
readonly input: GetJourneyRunExecutionMetricsCommandInput;
|
|
99
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
constructor(input: GetJourneyRunExecutionMetricsCommandInput);
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetJourneyRunExecutionMetricsCommandInput, GetJourneyRunExecutionMetricsCommandOutput>;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private serialize;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
private deserialize;
|
|
116
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetJourneyRunsRequest, GetJourneyRunsResponse } from "../models/models_1";
|
|
5
|
+
import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetJourneyRunsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetJourneyRunsCommandInput extends GetJourneyRunsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetJourneyRunsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetJourneyRunsCommandOutput extends GetJourneyRunsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Provides information about the runs of a journey.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { PinpointClient, GetJourneyRunsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
|
|
27
|
+
* // const { PinpointClient, GetJourneyRunsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
|
|
28
|
+
* const client = new PinpointClient(config);
|
|
29
|
+
* const input = { // GetJourneyRunsRequest
|
|
30
|
+
* ApplicationId: "STRING_VALUE", // required
|
|
31
|
+
* JourneyId: "STRING_VALUE", // required
|
|
32
|
+
* PageSize: "STRING_VALUE",
|
|
33
|
+
* Token: "STRING_VALUE",
|
|
34
|
+
* };
|
|
35
|
+
* const command = new GetJourneyRunsCommand(input);
|
|
36
|
+
* const response = await client.send(command);
|
|
37
|
+
* ```
|
|
38
|
+
*
|
|
39
|
+
* @param GetJourneyRunsCommandInput - {@link GetJourneyRunsCommandInput}
|
|
40
|
+
* @returns {@link GetJourneyRunsCommandOutput}
|
|
41
|
+
* @see {@link GetJourneyRunsCommandInput} for command's `input` shape.
|
|
42
|
+
* @see {@link GetJourneyRunsCommandOutput} for command's `response` shape.
|
|
43
|
+
* @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link BadRequestException} (client fault)
|
|
46
|
+
* <p>Provides information about an API request or response.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
49
|
+
* <p>Provides information about an API request or response.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
52
|
+
* <p>Provides information about an API request or response.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link MethodNotAllowedException} (client fault)
|
|
55
|
+
* <p>Provides information about an API request or response.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link NotFoundException} (client fault)
|
|
58
|
+
* <p>Provides information about an API request or response.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link PayloadTooLargeException} (client fault)
|
|
61
|
+
* <p>Provides information about an API request or response.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
64
|
+
* <p>Provides information about an API request or response.</p>
|
|
65
|
+
*
|
|
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
|
+
*
|
|
99
|
+
*/
|
|
100
|
+
export declare class GetJourneyRunsCommand extends $Command<GetJourneyRunsCommandInput, GetJourneyRunsCommandOutput, PinpointClientResolvedConfig> {
|
|
101
|
+
readonly input: GetJourneyRunsCommandInput;
|
|
102
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
constructor(input: GetJourneyRunsCommandInput);
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetJourneyRunsCommandInput, GetJourneyRunsCommandOutput>;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private serialize;
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
private deserialize;
|
|
119
|
+
}
|
|
@@ -38,7 +38,7 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
|
|
|
38
38
|
* "STRING_VALUE",
|
|
39
39
|
* ],
|
|
40
40
|
* },
|
|
41
|
-
* ChannelType: "
|
|
41
|
+
* ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
42
42
|
* Demographic: { // EndpointDemographic
|
|
43
43
|
* AppVersion: "STRING_VALUE",
|
|
44
44
|
* Locale: "STRING_VALUE",
|
|
@@ -32,7 +32,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
32
32
|
* Addresses: { // MapOfAddressConfiguration
|
|
33
33
|
* "<keys>": { // AddressConfiguration
|
|
34
34
|
* BodyOverride: "STRING_VALUE",
|
|
35
|
-
* ChannelType: "
|
|
35
|
+
* ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
36
36
|
* Context: { // MapOf__string
|
|
37
37
|
* "<keys>": "STRING_VALUE",
|
|
38
38
|
* },
|
|
@@ -65,7 +65,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
65
65
|
* },
|
|
66
66
|
* MessageConfiguration: { // DirectMessageConfiguration
|
|
67
67
|
* ADMMessage: { // ADMMessage
|
|
68
|
-
* Action: "
|
|
68
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
69
69
|
* Body: "STRING_VALUE",
|
|
70
70
|
* ConsolidationKey: "STRING_VALUE",
|
|
71
71
|
* Data: {
|
|
@@ -90,7 +90,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
90
90
|
* },
|
|
91
91
|
* APNSMessage: { // APNSMessage
|
|
92
92
|
* APNSPushType: "STRING_VALUE",
|
|
93
|
-
* Action: "
|
|
93
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
94
94
|
* Badge: Number("int"),
|
|
95
95
|
* Body: "STRING_VALUE",
|
|
96
96
|
* Category: "STRING_VALUE",
|
|
@@ -115,7 +115,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
115
115
|
* Url: "STRING_VALUE",
|
|
116
116
|
* },
|
|
117
117
|
* BaiduMessage: { // BaiduMessage
|
|
118
|
-
* Action: "
|
|
118
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
119
119
|
* Body: "STRING_VALUE",
|
|
120
120
|
* Data: "<MapOf__string>",
|
|
121
121
|
* IconReference: "STRING_VALUE",
|
|
@@ -139,7 +139,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
139
139
|
* Substitutions: "<MapOfListOf__string>",
|
|
140
140
|
* },
|
|
141
141
|
* DefaultPushNotificationMessage: { // DefaultPushNotificationMessage
|
|
142
|
-
* Action: "
|
|
142
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
143
143
|
* Body: "STRING_VALUE",
|
|
144
144
|
* Data: "<MapOf__string>",
|
|
145
145
|
* SilentPush: true || false,
|
|
@@ -172,7 +172,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
172
172
|
* Substitutions: "<MapOfListOf__string>",
|
|
173
173
|
* },
|
|
174
174
|
* GCMMessage: { // GCMMessage
|
|
175
|
-
* Action: "
|
|
175
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
176
176
|
* Body: "STRING_VALUE",
|
|
177
177
|
* CollapseKey: "STRING_VALUE",
|
|
178
178
|
* Data: "<MapOf__string>",
|
|
@@ -194,7 +194,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
194
194
|
* Body: "STRING_VALUE",
|
|
195
195
|
* Keyword: "STRING_VALUE",
|
|
196
196
|
* MediaUrl: "STRING_VALUE",
|
|
197
|
-
* MessageType: "
|
|
197
|
+
* MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
198
198
|
* OriginationNumber: "STRING_VALUE",
|
|
199
199
|
* SenderId: "STRING_VALUE",
|
|
200
200
|
* Substitutions: "<MapOfListOf__string>",
|
|
@@ -34,7 +34,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
34
34
|
* },
|
|
35
35
|
* MessageConfiguration: { // DirectMessageConfiguration
|
|
36
36
|
* ADMMessage: { // ADMMessage
|
|
37
|
-
* Action: "
|
|
37
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
38
38
|
* Body: "STRING_VALUE",
|
|
39
39
|
* ConsolidationKey: "STRING_VALUE",
|
|
40
40
|
* Data: {
|
|
@@ -59,7 +59,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
59
59
|
* },
|
|
60
60
|
* APNSMessage: { // APNSMessage
|
|
61
61
|
* APNSPushType: "STRING_VALUE",
|
|
62
|
-
* Action: "
|
|
62
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
63
63
|
* Badge: Number("int"),
|
|
64
64
|
* Body: "STRING_VALUE",
|
|
65
65
|
* Category: "STRING_VALUE",
|
|
@@ -84,7 +84,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
84
84
|
* Url: "STRING_VALUE",
|
|
85
85
|
* },
|
|
86
86
|
* BaiduMessage: { // BaiduMessage
|
|
87
|
-
* Action: "
|
|
87
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
88
88
|
* Body: "STRING_VALUE",
|
|
89
89
|
* Data: {
|
|
90
90
|
* "<keys>": "STRING_VALUE",
|
|
@@ -114,7 +114,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
114
114
|
* },
|
|
115
115
|
* },
|
|
116
116
|
* DefaultPushNotificationMessage: { // DefaultPushNotificationMessage
|
|
117
|
-
* Action: "
|
|
117
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
118
118
|
* Body: "STRING_VALUE",
|
|
119
119
|
* Data: {
|
|
120
120
|
* "<keys>": "STRING_VALUE",
|
|
@@ -153,7 +153,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
153
153
|
* Substitutions: "<MapOfListOf__string>",
|
|
154
154
|
* },
|
|
155
155
|
* GCMMessage: { // GCMMessage
|
|
156
|
-
* Action: "
|
|
156
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
157
157
|
* Body: "STRING_VALUE",
|
|
158
158
|
* CollapseKey: "STRING_VALUE",
|
|
159
159
|
* Data: "<MapOf__string>",
|
|
@@ -175,7 +175,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
175
175
|
* Body: "STRING_VALUE",
|
|
176
176
|
* Keyword: "STRING_VALUE",
|
|
177
177
|
* MediaUrl: "STRING_VALUE",
|
|
178
|
-
* MessageType: "
|
|
178
|
+
* MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
179
179
|
* OriginationNumber: "STRING_VALUE",
|
|
180
180
|
* SenderId: "STRING_VALUE",
|
|
181
181
|
* Substitutions: "<MapOfListOf__string>",
|
|
@@ -31,7 +31,7 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
|
|
|
31
31
|
* WriteApplicationSettingsRequest: { // WriteApplicationSettingsRequest
|
|
32
32
|
* CampaignHook: { // CampaignHook
|
|
33
33
|
* LambdaFunctionName: "STRING_VALUE",
|
|
34
|
-
* Mode: "
|
|
34
|
+
* Mode: "DELIVERY" || "FILTER",
|
|
35
35
|
* WebUrl: "STRING_VALUE",
|
|
36
36
|
* },
|
|
37
37
|
* CloudWatchMetricsEnabled: true || false,
|