@aws-sdk/client-pinpoint 3.321.1 → 3.326.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/dist-types/commands/CreateAppCommand.d.ts +14 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateExportJobCommand.d.ts +27 -0
- package/dist-types/commands/CreateImportJobCommand.d.ts +31 -0
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/CreateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/CreateSmsTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteAppCommand.d.ts +14 -0
- package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +385 -0
- package/dist-types/commands/DeleteEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteEndpointCommand.d.ts +51 -0
- package/dist-types/commands/DeleteEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteJourneyCommand.d.ts +383 -0
- package/dist-types/commands/DeletePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSegmentCommand.d.ts +158 -0
- package/dist-types/commands/DeleteSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/GetAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetAppCommand.d.ts +14 -0
- package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +32 -0
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/GetAppsCommand.d.ts +19 -0
- package/dist-types/commands/GetBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +28 -0
- package/dist-types/commands/GetCampaignCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +390 -0
- package/dist-types/commands/GetCampaignsCommand.d.ts +390 -0
- package/dist-types/commands/GetChannelsCommand.d.ts +20 -0
- package/dist-types/commands/GetEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +22 -0
- package/dist-types/commands/GetEndpointCommand.d.ts +51 -0
- package/dist-types/commands/GetEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/GetExportJobCommand.d.ts +27 -0
- package/dist-types/commands/GetExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +31 -0
- package/dist-types/commands/GetImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +112 -0
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +78 -0
- package/dist-types/commands/GetJourneyCommand.d.ts +383 -0
- package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +15 -0
- package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +13 -0
- package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +16 -0
- package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +14 -0
- package/dist-types/commands/GetJourneyRunsCommand.d.ts +16 -0
- package/dist-types/commands/GetPushTemplateCommand.d.ts +68 -0
- package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +26 -0
- package/dist-types/commands/GetSegmentCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetSegmentVersionCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentVersionsCommand.d.ts +163 -0
- package/dist-types/commands/GetSegmentsCommand.d.ts +163 -0
- package/dist-types/commands/GetSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/GetSmsTemplateCommand.d.ts +20 -0
- package/dist-types/commands/GetUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/GetVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetVoiceTemplateCommand.d.ts +21 -0
- package/dist-types/commands/ListJourneysCommand.d.ts +388 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -0
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +21 -0
- package/dist-types/commands/ListTemplatesCommand.d.ts +23 -0
- package/dist-types/commands/PhoneNumberValidateCommand.d.ts +21 -0
- package/dist-types/commands/PutEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/PutEventsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveAttributesCommand.d.ts +12 -0
- package/dist-types/commands/SendMessagesCommand.d.ts +28 -0
- package/dist-types/commands/SendOTPMessageCommand.d.ts +28 -0
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +21 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/UpdateEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +9 -0
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +383 -0
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/UpdateSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +9 -0
- package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
- package/package.json +16 -16
|
@@ -34,6 +34,167 @@ export interface GetSegmentVersionsCommandOutput extends GetSegmentVersionsRespo
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new GetSegmentVersionsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // GetSegmentVersionsResponse
|
|
38
|
+
* // SegmentsResponse: { // SegmentsResponse
|
|
39
|
+
* // Item: [ // ListOfSegmentResponse // required
|
|
40
|
+
* // { // SegmentResponse
|
|
41
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
42
|
+
* // Arn: "STRING_VALUE", // required
|
|
43
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
44
|
+
* // Dimensions: { // SegmentDimensions
|
|
45
|
+
* // Attributes: { // MapOfAttributeDimension
|
|
46
|
+
* // "<keys>": { // AttributeDimension
|
|
47
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
48
|
+
* // Values: [ // ListOf__string // required
|
|
49
|
+
* // "STRING_VALUE",
|
|
50
|
+
* // ],
|
|
51
|
+
* // },
|
|
52
|
+
* // },
|
|
53
|
+
* // Behavior: { // SegmentBehaviors
|
|
54
|
+
* // Recency: { // RecencyDimension
|
|
55
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
56
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // Demographic: { // SegmentDemographics
|
|
60
|
+
* // AppVersion: { // SetDimension
|
|
61
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
62
|
+
* // Values: [ // required
|
|
63
|
+
* // "STRING_VALUE",
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // Channel: {
|
|
67
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
68
|
+
* // Values: [ // required
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
72
|
+
* // DeviceType: {
|
|
73
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
74
|
+
* // Values: [ // required
|
|
75
|
+
* // "STRING_VALUE",
|
|
76
|
+
* // ],
|
|
77
|
+
* // },
|
|
78
|
+
* // Make: {
|
|
79
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
80
|
+
* // Values: [ // required
|
|
81
|
+
* // "STRING_VALUE",
|
|
82
|
+
* // ],
|
|
83
|
+
* // },
|
|
84
|
+
* // Model: {
|
|
85
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
86
|
+
* // Values: "<ListOf__string>", // required
|
|
87
|
+
* // },
|
|
88
|
+
* // Platform: "<SetDimension>",
|
|
89
|
+
* // },
|
|
90
|
+
* // Location: { // SegmentLocation
|
|
91
|
+
* // Country: "<SetDimension>",
|
|
92
|
+
* // GPSPoint: { // GPSPointDimension
|
|
93
|
+
* // Coordinates: { // GPSCoordinates
|
|
94
|
+
* // Latitude: Number("double"), // required
|
|
95
|
+
* // Longitude: Number("double"), // required
|
|
96
|
+
* // },
|
|
97
|
+
* // RangeInKilometers: Number("double"),
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // Metrics: { // MapOfMetricDimension
|
|
101
|
+
* // "<keys>": { // MetricDimension
|
|
102
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
103
|
+
* // Value: Number("double"), // required
|
|
104
|
+
* // },
|
|
105
|
+
* // },
|
|
106
|
+
* // UserAttributes: {
|
|
107
|
+
* // "<keys>": {
|
|
108
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
109
|
+
* // Values: "<ListOf__string>", // required
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // },
|
|
113
|
+
* // Id: "STRING_VALUE", // required
|
|
114
|
+
* // ImportDefinition: { // SegmentImportResource
|
|
115
|
+
* // ChannelCounts: { // MapOf__integer
|
|
116
|
+
* // "<keys>": Number("int"),
|
|
117
|
+
* // },
|
|
118
|
+
* // ExternalId: "STRING_VALUE", // required
|
|
119
|
+
* // Format: "CSV" || "JSON", // required
|
|
120
|
+
* // RoleArn: "STRING_VALUE", // required
|
|
121
|
+
* // S3Url: "STRING_VALUE", // required
|
|
122
|
+
* // Size: Number("int"), // required
|
|
123
|
+
* // },
|
|
124
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
125
|
+
* // Name: "STRING_VALUE",
|
|
126
|
+
* // SegmentGroups: { // SegmentGroupList
|
|
127
|
+
* // Groups: [ // ListOfSegmentGroup
|
|
128
|
+
* // { // SegmentGroup
|
|
129
|
+
* // Dimensions: [ // ListOfSegmentDimensions
|
|
130
|
+
* // {
|
|
131
|
+
* // Attributes: {
|
|
132
|
+
* // "<keys>": {
|
|
133
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
134
|
+
* // Values: "<ListOf__string>", // required
|
|
135
|
+
* // },
|
|
136
|
+
* // },
|
|
137
|
+
* // Behavior: {
|
|
138
|
+
* // Recency: {
|
|
139
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
140
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
141
|
+
* // },
|
|
142
|
+
* // },
|
|
143
|
+
* // Demographic: {
|
|
144
|
+
* // AppVersion: "<SetDimension>",
|
|
145
|
+
* // Channel: "<SetDimension>",
|
|
146
|
+
* // DeviceType: "<SetDimension>",
|
|
147
|
+
* // Make: "<SetDimension>",
|
|
148
|
+
* // Model: "<SetDimension>",
|
|
149
|
+
* // Platform: "<SetDimension>",
|
|
150
|
+
* // },
|
|
151
|
+
* // Location: {
|
|
152
|
+
* // Country: "<SetDimension>",
|
|
153
|
+
* // GPSPoint: {
|
|
154
|
+
* // Coordinates: {
|
|
155
|
+
* // Latitude: Number("double"), // required
|
|
156
|
+
* // Longitude: Number("double"), // required
|
|
157
|
+
* // },
|
|
158
|
+
* // RangeInKilometers: Number("double"),
|
|
159
|
+
* // },
|
|
160
|
+
* // },
|
|
161
|
+
* // Metrics: {
|
|
162
|
+
* // "<keys>": {
|
|
163
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
164
|
+
* // Value: Number("double"), // required
|
|
165
|
+
* // },
|
|
166
|
+
* // },
|
|
167
|
+
* // UserAttributes: {
|
|
168
|
+
* // "<keys>": {
|
|
169
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
170
|
+
* // Values: "<ListOf__string>", // required
|
|
171
|
+
* // },
|
|
172
|
+
* // },
|
|
173
|
+
* // },
|
|
174
|
+
* // ],
|
|
175
|
+
* // SourceSegments: [ // ListOfSegmentReference
|
|
176
|
+
* // { // SegmentReference
|
|
177
|
+
* // Id: "STRING_VALUE", // required
|
|
178
|
+
* // Version: Number("int"),
|
|
179
|
+
* // },
|
|
180
|
+
* // ],
|
|
181
|
+
* // SourceType: "ALL" || "ANY" || "NONE",
|
|
182
|
+
* // Type: "ALL" || "ANY" || "NONE",
|
|
183
|
+
* // },
|
|
184
|
+
* // ],
|
|
185
|
+
* // Include: "ALL" || "ANY" || "NONE",
|
|
186
|
+
* // },
|
|
187
|
+
* // SegmentType: "DIMENSIONAL" || "IMPORT", // required
|
|
188
|
+
* // tags: { // MapOf__string
|
|
189
|
+
* // "<keys>": "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // Version: Number("int"),
|
|
192
|
+
* // },
|
|
193
|
+
* // ],
|
|
194
|
+
* // NextToken: "STRING_VALUE",
|
|
195
|
+
* // },
|
|
196
|
+
* // };
|
|
197
|
+
*
|
|
37
198
|
* ```
|
|
38
199
|
*
|
|
39
200
|
* @param GetSegmentVersionsCommandInput - {@link GetSegmentVersionsCommandInput}
|
|
@@ -63,6 +224,8 @@ export interface GetSegmentVersionsCommandOutput extends GetSegmentVersionsRespo
|
|
|
63
224
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
64
225
|
* <p>Provides information about an API request or response.</p>
|
|
65
226
|
*
|
|
227
|
+
* @throws {@link PinpointServiceException}
|
|
228
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
66
229
|
*
|
|
67
230
|
*/
|
|
68
231
|
export declare class GetSegmentVersionsCommand extends $Command<GetSegmentVersionsCommandInput, GetSegmentVersionsCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -33,6 +33,167 @@ export interface GetSegmentsCommandOutput extends GetSegmentsResponse, __Metadat
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new GetSegmentsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // GetSegmentsResponse
|
|
37
|
+
* // SegmentsResponse: { // SegmentsResponse
|
|
38
|
+
* // Item: [ // ListOfSegmentResponse // required
|
|
39
|
+
* // { // SegmentResponse
|
|
40
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
41
|
+
* // Arn: "STRING_VALUE", // required
|
|
42
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
43
|
+
* // Dimensions: { // SegmentDimensions
|
|
44
|
+
* // Attributes: { // MapOfAttributeDimension
|
|
45
|
+
* // "<keys>": { // AttributeDimension
|
|
46
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
47
|
+
* // Values: [ // ListOf__string // required
|
|
48
|
+
* // "STRING_VALUE",
|
|
49
|
+
* // ],
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // Behavior: { // SegmentBehaviors
|
|
53
|
+
* // Recency: { // RecencyDimension
|
|
54
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
55
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // Demographic: { // SegmentDemographics
|
|
59
|
+
* // AppVersion: { // SetDimension
|
|
60
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
61
|
+
* // Values: [ // required
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // },
|
|
65
|
+
* // Channel: {
|
|
66
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
67
|
+
* // Values: [ // required
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // DeviceType: {
|
|
72
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
73
|
+
* // Values: [ // required
|
|
74
|
+
* // "STRING_VALUE",
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // Make: {
|
|
78
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
79
|
+
* // Values: [ // required
|
|
80
|
+
* // "STRING_VALUE",
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // Model: {
|
|
84
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
85
|
+
* // Values: "<ListOf__string>", // required
|
|
86
|
+
* // },
|
|
87
|
+
* // Platform: "<SetDimension>",
|
|
88
|
+
* // },
|
|
89
|
+
* // Location: { // SegmentLocation
|
|
90
|
+
* // Country: "<SetDimension>",
|
|
91
|
+
* // GPSPoint: { // GPSPointDimension
|
|
92
|
+
* // Coordinates: { // GPSCoordinates
|
|
93
|
+
* // Latitude: Number("double"), // required
|
|
94
|
+
* // Longitude: Number("double"), // required
|
|
95
|
+
* // },
|
|
96
|
+
* // RangeInKilometers: Number("double"),
|
|
97
|
+
* // },
|
|
98
|
+
* // },
|
|
99
|
+
* // Metrics: { // MapOfMetricDimension
|
|
100
|
+
* // "<keys>": { // MetricDimension
|
|
101
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
102
|
+
* // Value: Number("double"), // required
|
|
103
|
+
* // },
|
|
104
|
+
* // },
|
|
105
|
+
* // UserAttributes: {
|
|
106
|
+
* // "<keys>": {
|
|
107
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
108
|
+
* // Values: "<ListOf__string>", // required
|
|
109
|
+
* // },
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // Id: "STRING_VALUE", // required
|
|
113
|
+
* // ImportDefinition: { // SegmentImportResource
|
|
114
|
+
* // ChannelCounts: { // MapOf__integer
|
|
115
|
+
* // "<keys>": Number("int"),
|
|
116
|
+
* // },
|
|
117
|
+
* // ExternalId: "STRING_VALUE", // required
|
|
118
|
+
* // Format: "CSV" || "JSON", // required
|
|
119
|
+
* // RoleArn: "STRING_VALUE", // required
|
|
120
|
+
* // S3Url: "STRING_VALUE", // required
|
|
121
|
+
* // Size: Number("int"), // required
|
|
122
|
+
* // },
|
|
123
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
124
|
+
* // Name: "STRING_VALUE",
|
|
125
|
+
* // SegmentGroups: { // SegmentGroupList
|
|
126
|
+
* // Groups: [ // ListOfSegmentGroup
|
|
127
|
+
* // { // SegmentGroup
|
|
128
|
+
* // Dimensions: [ // ListOfSegmentDimensions
|
|
129
|
+
* // {
|
|
130
|
+
* // Attributes: {
|
|
131
|
+
* // "<keys>": {
|
|
132
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
133
|
+
* // Values: "<ListOf__string>", // required
|
|
134
|
+
* // },
|
|
135
|
+
* // },
|
|
136
|
+
* // Behavior: {
|
|
137
|
+
* // Recency: {
|
|
138
|
+
* // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
139
|
+
* // RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
140
|
+
* // },
|
|
141
|
+
* // },
|
|
142
|
+
* // Demographic: {
|
|
143
|
+
* // AppVersion: "<SetDimension>",
|
|
144
|
+
* // Channel: "<SetDimension>",
|
|
145
|
+
* // DeviceType: "<SetDimension>",
|
|
146
|
+
* // Make: "<SetDimension>",
|
|
147
|
+
* // Model: "<SetDimension>",
|
|
148
|
+
* // Platform: "<SetDimension>",
|
|
149
|
+
* // },
|
|
150
|
+
* // Location: {
|
|
151
|
+
* // Country: "<SetDimension>",
|
|
152
|
+
* // GPSPoint: {
|
|
153
|
+
* // Coordinates: {
|
|
154
|
+
* // Latitude: Number("double"), // required
|
|
155
|
+
* // Longitude: Number("double"), // required
|
|
156
|
+
* // },
|
|
157
|
+
* // RangeInKilometers: Number("double"),
|
|
158
|
+
* // },
|
|
159
|
+
* // },
|
|
160
|
+
* // Metrics: {
|
|
161
|
+
* // "<keys>": {
|
|
162
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
163
|
+
* // Value: Number("double"), // required
|
|
164
|
+
* // },
|
|
165
|
+
* // },
|
|
166
|
+
* // UserAttributes: {
|
|
167
|
+
* // "<keys>": {
|
|
168
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
169
|
+
* // Values: "<ListOf__string>", // required
|
|
170
|
+
* // },
|
|
171
|
+
* // },
|
|
172
|
+
* // },
|
|
173
|
+
* // ],
|
|
174
|
+
* // SourceSegments: [ // ListOfSegmentReference
|
|
175
|
+
* // { // SegmentReference
|
|
176
|
+
* // Id: "STRING_VALUE", // required
|
|
177
|
+
* // Version: Number("int"),
|
|
178
|
+
* // },
|
|
179
|
+
* // ],
|
|
180
|
+
* // SourceType: "ALL" || "ANY" || "NONE",
|
|
181
|
+
* // Type: "ALL" || "ANY" || "NONE",
|
|
182
|
+
* // },
|
|
183
|
+
* // ],
|
|
184
|
+
* // Include: "ALL" || "ANY" || "NONE",
|
|
185
|
+
* // },
|
|
186
|
+
* // SegmentType: "DIMENSIONAL" || "IMPORT", // required
|
|
187
|
+
* // tags: { // MapOf__string
|
|
188
|
+
* // "<keys>": "STRING_VALUE",
|
|
189
|
+
* // },
|
|
190
|
+
* // Version: Number("int"),
|
|
191
|
+
* // },
|
|
192
|
+
* // ],
|
|
193
|
+
* // NextToken: "STRING_VALUE",
|
|
194
|
+
* // },
|
|
195
|
+
* // };
|
|
196
|
+
*
|
|
36
197
|
* ```
|
|
37
198
|
*
|
|
38
199
|
* @param GetSegmentsCommandInput - {@link GetSegmentsCommandInput}
|
|
@@ -62,6 +223,8 @@ export interface GetSegmentsCommandOutput extends GetSegmentsResponse, __Metadat
|
|
|
62
223
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
63
224
|
* <p>Provides information about an API request or response.</p>
|
|
64
225
|
*
|
|
226
|
+
* @throws {@link PinpointServiceException}
|
|
227
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
65
228
|
*
|
|
66
229
|
*/
|
|
67
230
|
export declare class GetSegmentsCommand extends $Command<GetSegmentsCommandInput, GetSegmentsCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -31,6 +31,25 @@ export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetSmsChannelCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // GetSmsChannelResponse
|
|
35
|
+
* // SMSChannelResponse: { // SMSChannelResponse
|
|
36
|
+
* // ApplicationId: "STRING_VALUE",
|
|
37
|
+
* // CreationDate: "STRING_VALUE",
|
|
38
|
+
* // Enabled: true || false,
|
|
39
|
+
* // HasCredential: true || false,
|
|
40
|
+
* // Id: "STRING_VALUE",
|
|
41
|
+
* // IsArchived: true || false,
|
|
42
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
43
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
44
|
+
* // Platform: "STRING_VALUE", // required
|
|
45
|
+
* // PromotionalMessagesPerSecond: Number("int"),
|
|
46
|
+
* // SenderId: "STRING_VALUE",
|
|
47
|
+
* // ShortCode: "STRING_VALUE",
|
|
48
|
+
* // TransactionalMessagesPerSecond: Number("int"),
|
|
49
|
+
* // Version: Number("int"),
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
34
53
|
* ```
|
|
35
54
|
*
|
|
36
55
|
* @param GetSmsChannelCommandInput - {@link GetSmsChannelCommandInput}
|
|
@@ -60,6 +79,8 @@ export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met
|
|
|
60
79
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
61
80
|
* <p>Provides information about an API request or response.</p>
|
|
62
81
|
*
|
|
82
|
+
* @throws {@link PinpointServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
63
84
|
*
|
|
64
85
|
*/
|
|
65
86
|
export declare class GetSmsChannelCommand extends $Command<GetSmsChannelCommandInput, GetSmsChannelCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -32,6 +32,24 @@ export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetSmsTemplateCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetSmsTemplateResponse
|
|
36
|
+
* // SMSTemplateResponse: { // SMSTemplateResponse
|
|
37
|
+
* // Arn: "STRING_VALUE",
|
|
38
|
+
* // Body: "STRING_VALUE",
|
|
39
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
40
|
+
* // DefaultSubstitutions: "STRING_VALUE",
|
|
41
|
+
* // LastModifiedDate: "STRING_VALUE", // required
|
|
42
|
+
* // RecommenderId: "STRING_VALUE",
|
|
43
|
+
* // tags: { // MapOf__string
|
|
44
|
+
* // "<keys>": "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // TemplateDescription: "STRING_VALUE",
|
|
47
|
+
* // TemplateName: "STRING_VALUE", // required
|
|
48
|
+
* // TemplateType: "EMAIL" || "SMS" || "VOICE" || "PUSH" || "INAPP", // required
|
|
49
|
+
* // Version: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
35
53
|
* ```
|
|
36
54
|
*
|
|
37
55
|
* @param GetSmsTemplateCommandInput - {@link GetSmsTemplateCommandInput}
|
|
@@ -61,6 +79,8 @@ export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M
|
|
|
61
79
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
62
80
|
* <p>Provides information about an API request or response.</p>
|
|
63
81
|
*
|
|
82
|
+
* @throws {@link PinpointServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
64
84
|
*
|
|
65
85
|
*/
|
|
66
86
|
export declare class GetSmsTemplateCommand extends $Command<GetSmsTemplateCommandInput, GetSmsTemplateCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -32,6 +32,59 @@ export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse,
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetUserEndpointsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetUserEndpointsResponse
|
|
36
|
+
* // EndpointsResponse: { // EndpointsResponse
|
|
37
|
+
* // Item: [ // ListOfEndpointResponse // required
|
|
38
|
+
* // { // EndpointResponse
|
|
39
|
+
* // Address: "STRING_VALUE",
|
|
40
|
+
* // ApplicationId: "STRING_VALUE",
|
|
41
|
+
* // Attributes: { // MapOfListOf__string
|
|
42
|
+
* // "<keys>": [ // ListOf__string
|
|
43
|
+
* // "STRING_VALUE",
|
|
44
|
+
* // ],
|
|
45
|
+
* // },
|
|
46
|
+
* // ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
47
|
+
* // CohortId: "STRING_VALUE",
|
|
48
|
+
* // CreationDate: "STRING_VALUE",
|
|
49
|
+
* // Demographic: { // EndpointDemographic
|
|
50
|
+
* // AppVersion: "STRING_VALUE",
|
|
51
|
+
* // Locale: "STRING_VALUE",
|
|
52
|
+
* // Make: "STRING_VALUE",
|
|
53
|
+
* // Model: "STRING_VALUE",
|
|
54
|
+
* // ModelVersion: "STRING_VALUE",
|
|
55
|
+
* // Platform: "STRING_VALUE",
|
|
56
|
+
* // PlatformVersion: "STRING_VALUE",
|
|
57
|
+
* // Timezone: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // EffectiveDate: "STRING_VALUE",
|
|
60
|
+
* // EndpointStatus: "STRING_VALUE",
|
|
61
|
+
* // Id: "STRING_VALUE",
|
|
62
|
+
* // Location: { // EndpointLocation
|
|
63
|
+
* // City: "STRING_VALUE",
|
|
64
|
+
* // Country: "STRING_VALUE",
|
|
65
|
+
* // Latitude: Number("double"),
|
|
66
|
+
* // Longitude: Number("double"),
|
|
67
|
+
* // PostalCode: "STRING_VALUE",
|
|
68
|
+
* // Region: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // Metrics: { // MapOf__double
|
|
71
|
+
* // "<keys>": Number("double"),
|
|
72
|
+
* // },
|
|
73
|
+
* // OptOut: "STRING_VALUE",
|
|
74
|
+
* // RequestId: "STRING_VALUE",
|
|
75
|
+
* // User: { // EndpointUser
|
|
76
|
+
* // UserAttributes: {
|
|
77
|
+
* // "<keys>": [
|
|
78
|
+
* // "STRING_VALUE",
|
|
79
|
+
* // ],
|
|
80
|
+
* // },
|
|
81
|
+
* // UserId: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
35
88
|
* ```
|
|
36
89
|
*
|
|
37
90
|
* @param GetUserEndpointsCommandInput - {@link GetUserEndpointsCommandInput}
|
|
@@ -61,6 +114,8 @@ export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse,
|
|
|
61
114
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
62
115
|
* <p>Provides information about an API request or response.</p>
|
|
63
116
|
*
|
|
117
|
+
* @throws {@link PinpointServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
64
119
|
*
|
|
65
120
|
*/
|
|
66
121
|
export declare class GetUserEndpointsCommand extends $Command<GetUserEndpointsCommandInput, GetUserEndpointsCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -31,6 +31,21 @@ export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetVoiceChannelCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // GetVoiceChannelResponse
|
|
35
|
+
* // VoiceChannelResponse: { // VoiceChannelResponse
|
|
36
|
+
* // ApplicationId: "STRING_VALUE",
|
|
37
|
+
* // CreationDate: "STRING_VALUE",
|
|
38
|
+
* // Enabled: true || false,
|
|
39
|
+
* // HasCredential: true || false,
|
|
40
|
+
* // Id: "STRING_VALUE",
|
|
41
|
+
* // IsArchived: true || false,
|
|
42
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
43
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
44
|
+
* // Platform: "STRING_VALUE", // required
|
|
45
|
+
* // Version: Number("int"),
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
34
49
|
* ```
|
|
35
50
|
*
|
|
36
51
|
* @param GetVoiceChannelCommandInput - {@link GetVoiceChannelCommandInput}
|
|
@@ -60,6 +75,8 @@ export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _
|
|
|
60
75
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
61
76
|
* <p>Provides information about an API request or response.</p>
|
|
62
77
|
*
|
|
78
|
+
* @throws {@link PinpointServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
63
80
|
*
|
|
64
81
|
*/
|
|
65
82
|
export declare class GetVoiceChannelCommand extends $Command<GetVoiceChannelCommandInput, GetVoiceChannelCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -32,6 +32,25 @@ export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse,
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetVoiceTemplateCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetVoiceTemplateResponse
|
|
36
|
+
* // VoiceTemplateResponse: { // VoiceTemplateResponse
|
|
37
|
+
* // Arn: "STRING_VALUE",
|
|
38
|
+
* // Body: "STRING_VALUE",
|
|
39
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
40
|
+
* // DefaultSubstitutions: "STRING_VALUE",
|
|
41
|
+
* // LanguageCode: "STRING_VALUE",
|
|
42
|
+
* // LastModifiedDate: "STRING_VALUE", // required
|
|
43
|
+
* // tags: { // MapOf__string
|
|
44
|
+
* // "<keys>": "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // TemplateDescription: "STRING_VALUE",
|
|
47
|
+
* // TemplateName: "STRING_VALUE", // required
|
|
48
|
+
* // TemplateType: "EMAIL" || "SMS" || "VOICE" || "PUSH" || "INAPP", // required
|
|
49
|
+
* // Version: "STRING_VALUE",
|
|
50
|
+
* // VoiceId: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
35
54
|
* ```
|
|
36
55
|
*
|
|
37
56
|
* @param GetVoiceTemplateCommandInput - {@link GetVoiceTemplateCommandInput}
|
|
@@ -61,6 +80,8 @@ export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse,
|
|
|
61
80
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
62
81
|
* <p>Provides information about an API request or response.</p>
|
|
63
82
|
*
|
|
83
|
+
* @throws {@link PinpointServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
64
85
|
*
|
|
65
86
|
*/
|
|
66
87
|
export declare class GetVoiceTemplateCommand extends $Command<GetVoiceTemplateCommandInput, GetVoiceTemplateCommandOutput, PinpointClientResolvedConfig> {
|