@aws-sdk/client-pinpoint-sms-voice-v2 3.296.0 → 3.297.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/PinpointSMSVoiceV2.d.ts +44 -0
- package/dist-types/PinpointSMSVoiceV2Client.d.ts +24 -4
- package/dist-types/commands/AssociateOriginationIdentityCommand.d.ts +16 -0
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +16 -0
- package/dist-types/commands/CreateEventDestinationCommand.d.ts +16 -0
- package/dist-types/commands/CreateOptOutListCommand.d.ts +16 -0
- package/dist-types/commands/CreatePoolCommand.d.ts +16 -0
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDefaultMessageTypeCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDefaultSenderIdCommand.d.ts +16 -0
- package/dist-types/commands/DeleteEventDestinationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteKeywordCommand.d.ts +16 -0
- package/dist-types/commands/DeleteOptOutListCommand.d.ts +16 -0
- package/dist-types/commands/DeleteOptedOutNumberCommand.d.ts +16 -0
- package/dist-types/commands/DeletePoolCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +16 -0
- package/dist-types/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeConfigurationSetsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeKeywordsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeOptOutListsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeOptedOutNumbersCommand.d.ts +16 -0
- package/dist-types/commands/DescribePhoneNumbersCommand.d.ts +16 -0
- package/dist-types/commands/DescribePoolsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSenderIdsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSpendLimitsCommand.d.ts +16 -0
- package/dist-types/commands/DisassociateOriginationIdentityCommand.d.ts +16 -0
- package/dist-types/commands/ListPoolOriginationIdentitiesCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutKeywordCommand.d.ts +16 -0
- package/dist-types/commands/PutOptedOutNumberCommand.d.ts +16 -0
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +16 -0
- package/dist-types/commands/RequestPhoneNumberCommand.d.ts +16 -0
- package/dist-types/commands/SendTextMessageCommand.d.ts +16 -0
- package/dist-types/commands/SendVoiceMessageCommand.d.ts +16 -0
- package/dist-types/commands/SetDefaultMessageTypeCommand.d.ts +16 -0
- package/dist-types/commands/SetDefaultSenderIdCommand.d.ts +16 -0
- package/dist-types/commands/SetTextMessageSpendLimitOverrideCommand.d.ts +16 -0
- package/dist-types/commands/SetVoiceMessageSpendLimitOverrideCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateEventDestinationCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePoolCommand.d.ts +16 -0
- package/dist-types/models/PinpointSMSVoiceV2ServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +368 -0
- package/dist-types/pagination/DescribeAccountAttributesPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeAccountLimitsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeConfigurationSetsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeKeywordsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeOptOutListsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeOptedOutNumbersPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribePhoneNumbersPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribePoolsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeSenderIdsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeSpendLimitsPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListPoolOriginationIdentitiesPaginator.d.ts +3 -0
- package/package.json +3 -3
|
@@ -44,6 +44,7 @@ import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from ".
|
|
|
44
44
|
import { UpdatePoolCommandInput, UpdatePoolCommandOutput } from "./commands/UpdatePoolCommand";
|
|
45
45
|
import { PinpointSMSVoiceV2Client } from "./PinpointSMSVoiceV2Client";
|
|
46
46
|
/**
|
|
47
|
+
* @public
|
|
47
48
|
* <p>Welcome to the <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i>.
|
|
48
49
|
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
|
|
49
50
|
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
@@ -63,6 +64,7 @@ import { PinpointSMSVoiceV2Client } from "./PinpointSMSVoiceV2Client";
|
|
|
63
64
|
*/
|
|
64
65
|
export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
65
66
|
/**
|
|
67
|
+
* @public
|
|
66
68
|
* <p>Associates the specified origination identity with a pool.</p>
|
|
67
69
|
* <p>If the origination identity is a phone number and is already associated with another
|
|
68
70
|
* pool, an Error is returned. A sender ID can be associated with multiple pools.</p>
|
|
@@ -73,6 +75,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
73
75
|
associateOriginationIdentity(args: AssociateOriginationIdentityCommandInput, cb: (err: any, data?: AssociateOriginationIdentityCommandOutput) => void): void;
|
|
74
76
|
associateOriginationIdentity(args: AssociateOriginationIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateOriginationIdentityCommandOutput) => void): void;
|
|
75
77
|
/**
|
|
78
|
+
* @public
|
|
76
79
|
* <p>Creates a new configuration set. After you create the configuration set, you can add
|
|
77
80
|
* one or more event destinations to it.</p>
|
|
78
81
|
* <p>A configuration set is a set of rules that you apply to the SMS and voice messages
|
|
@@ -83,6 +86,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
83
86
|
createConfigurationSet(args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
|
|
84
87
|
createConfigurationSet(args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
|
|
85
88
|
/**
|
|
89
|
+
* @public
|
|
86
90
|
* <p>Creates a new event destination in a configuration set.</p>
|
|
87
91
|
* <p>An event destination is a location where you send message events. The event options
|
|
88
92
|
* are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,
|
|
@@ -97,6 +101,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
97
101
|
createEventDestination(args: CreateEventDestinationCommandInput, cb: (err: any, data?: CreateEventDestinationCommandOutput) => void): void;
|
|
98
102
|
createEventDestination(args: CreateEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventDestinationCommandOutput) => void): void;
|
|
99
103
|
/**
|
|
104
|
+
* @public
|
|
100
105
|
* <p>Creates a new opt-out list.</p>
|
|
101
106
|
* <p>If the opt-out list name already exists, an Error is returned.</p>
|
|
102
107
|
* <p>An opt-out list is a list of phone numbers that are opted out, meaning you can't send
|
|
@@ -111,6 +116,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
111
116
|
createOptOutList(args: CreateOptOutListCommandInput, cb: (err: any, data?: CreateOptOutListCommandOutput) => void): void;
|
|
112
117
|
createOptOutList(args: CreateOptOutListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOptOutListCommandOutput) => void): void;
|
|
113
118
|
/**
|
|
119
|
+
* @public
|
|
114
120
|
* <p>Creates a new pool and associates the specified origination identity to the pool. A
|
|
115
121
|
* pool can include one or more phone numbers and SenderIds that are associated with your
|
|
116
122
|
* Amazon Web Services account.</p>
|
|
@@ -125,6 +131,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
125
131
|
createPool(args: CreatePoolCommandInput, cb: (err: any, data?: CreatePoolCommandOutput) => void): void;
|
|
126
132
|
createPool(args: CreatePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePoolCommandOutput) => void): void;
|
|
127
133
|
/**
|
|
134
|
+
* @public
|
|
128
135
|
* <p>Deletes an existing configuration set.</p>
|
|
129
136
|
* <p>A configuration set is a set of rules that you apply to voice and SMS messages that
|
|
130
137
|
* you send. In a configuration set, you can specify a destination for specific types of
|
|
@@ -134,6 +141,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
134
141
|
deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
|
|
135
142
|
deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
|
|
136
143
|
/**
|
|
144
|
+
* @public
|
|
137
145
|
* <p>Deletes an existing default message type on a configuration set.</p>
|
|
138
146
|
* <p> A message type is a type of messages that you plan to send. If you send
|
|
139
147
|
* account-related messages or time-sensitive messages such as one-time passcodes, choose
|
|
@@ -145,6 +153,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
145
153
|
deleteDefaultMessageType(args: DeleteDefaultMessageTypeCommandInput, cb: (err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void): void;
|
|
146
154
|
deleteDefaultMessageType(args: DeleteDefaultMessageTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void): void;
|
|
147
155
|
/**
|
|
156
|
+
* @public
|
|
148
157
|
* <p>Deletes an existing default sender ID on a configuration set.</p>
|
|
149
158
|
* <p>A default sender ID is the identity that appears on recipients' devices when they
|
|
150
159
|
* receive SMS messages. Support for sender ID capabilities varies by country or
|
|
@@ -154,6 +163,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
154
163
|
deleteDefaultSenderId(args: DeleteDefaultSenderIdCommandInput, cb: (err: any, data?: DeleteDefaultSenderIdCommandOutput) => void): void;
|
|
155
164
|
deleteDefaultSenderId(args: DeleteDefaultSenderIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDefaultSenderIdCommandOutput) => void): void;
|
|
156
165
|
/**
|
|
166
|
+
* @public
|
|
157
167
|
* <p>Deletes an existing event destination.</p>
|
|
158
168
|
* <p>An event destination is a location where you send response information about the
|
|
159
169
|
* messages that you send. For example, when a message is delivered successfully, you can
|
|
@@ -164,6 +174,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
164
174
|
deleteEventDestination(args: DeleteEventDestinationCommandInput, cb: (err: any, data?: DeleteEventDestinationCommandOutput) => void): void;
|
|
165
175
|
deleteEventDestination(args: DeleteEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventDestinationCommandOutput) => void): void;
|
|
166
176
|
/**
|
|
177
|
+
* @public
|
|
167
178
|
* <p>Deletes an existing keyword from an origination phone number or pool.</p>
|
|
168
179
|
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
|
|
169
180
|
* is also a specific word or phrase that an end user can send to your number to elicit a
|
|
@@ -176,6 +187,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
176
187
|
deleteKeyword(args: DeleteKeywordCommandInput, cb: (err: any, data?: DeleteKeywordCommandOutput) => void): void;
|
|
177
188
|
deleteKeyword(args: DeleteKeywordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeywordCommandOutput) => void): void;
|
|
178
189
|
/**
|
|
190
|
+
* @public
|
|
179
191
|
* <p>Deletes an existing opted out destination phone number from the specified opt-out
|
|
180
192
|
* list.</p>
|
|
181
193
|
* <p>Each destination phone number can only be deleted once every 30 days.</p>
|
|
@@ -186,6 +198,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
186
198
|
deleteOptedOutNumber(args: DeleteOptedOutNumberCommandInput, cb: (err: any, data?: DeleteOptedOutNumberCommandOutput) => void): void;
|
|
187
199
|
deleteOptedOutNumber(args: DeleteOptedOutNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOptedOutNumberCommandOutput) => void): void;
|
|
188
200
|
/**
|
|
201
|
+
* @public
|
|
189
202
|
* <p>Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are
|
|
190
203
|
* deleted.</p>
|
|
191
204
|
* <p>If the specified opt-out list name doesn't exist or is in-use by an origination phone
|
|
@@ -195,6 +208,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
195
208
|
deleteOptOutList(args: DeleteOptOutListCommandInput, cb: (err: any, data?: DeleteOptOutListCommandOutput) => void): void;
|
|
196
209
|
deleteOptOutList(args: DeleteOptOutListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOptOutListCommandOutput) => void): void;
|
|
197
210
|
/**
|
|
211
|
+
* @public
|
|
198
212
|
* <p>Deletes an existing pool. Deleting a pool disassociates all origination identities
|
|
199
213
|
* from that pool.</p>
|
|
200
214
|
* <p>If the pool status isn't active or if deletion protection is enabled, an Error is
|
|
@@ -207,6 +221,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
207
221
|
deletePool(args: DeletePoolCommandInput, cb: (err: any, data?: DeletePoolCommandOutput) => void): void;
|
|
208
222
|
deletePool(args: DeletePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePoolCommandOutput) => void): void;
|
|
209
223
|
/**
|
|
224
|
+
* @public
|
|
210
225
|
* <p>Deletes an account-level monthly spending limit override for sending text messages.
|
|
211
226
|
* Deleting a spend limit override will set the <code>EnforcedLimit</code> to equal the
|
|
212
227
|
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
|
|
@@ -217,6 +232,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
217
232
|
deleteTextMessageSpendLimitOverride(args: DeleteTextMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
218
233
|
deleteTextMessageSpendLimitOverride(args: DeleteTextMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
219
234
|
/**
|
|
235
|
+
* @public
|
|
220
236
|
* <p>Deletes an account level monthly spend limit override for sending voice messages.
|
|
221
237
|
* Deleting a spend limit override sets the <code>EnforcedLimit</code> equal to the
|
|
222
238
|
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
|
|
@@ -227,6 +243,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
227
243
|
deleteVoiceMessageSpendLimitOverride(args: DeleteVoiceMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
228
244
|
deleteVoiceMessageSpendLimitOverride(args: DeleteVoiceMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
229
245
|
/**
|
|
246
|
+
* @public
|
|
230
247
|
* <p>Describes attributes of your Amazon Web Services account. The supported account
|
|
231
248
|
* attributes include account tier, which indicates whether your account is in the sandbox
|
|
232
249
|
* or production environment. When you're ready to move your account out of the sandbox,
|
|
@@ -239,6 +256,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
239
256
|
describeAccountAttributes(args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void): void;
|
|
240
257
|
describeAccountAttributes(args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void): void;
|
|
241
258
|
/**
|
|
259
|
+
* @public
|
|
242
260
|
* <p>Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your
|
|
243
261
|
* account. The description for a quota includes the quota name, current usage toward that
|
|
244
262
|
* quota, and the quota's maximum value.</p>
|
|
@@ -252,6 +270,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
252
270
|
describeAccountLimits(args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void): void;
|
|
253
271
|
describeAccountLimits(args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void): void;
|
|
254
272
|
/**
|
|
273
|
+
* @public
|
|
255
274
|
* <p>Describes the specified configuration sets or all in your account.</p>
|
|
256
275
|
* <p>If you specify configuration set names, the output includes information for only the
|
|
257
276
|
* specified configuration sets. If you specify filters, the output includes information
|
|
@@ -264,6 +283,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
264
283
|
describeConfigurationSets(args: DescribeConfigurationSetsCommandInput, cb: (err: any, data?: DescribeConfigurationSetsCommandOutput) => void): void;
|
|
265
284
|
describeConfigurationSets(args: DescribeConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationSetsCommandOutput) => void): void;
|
|
266
285
|
/**
|
|
286
|
+
* @public
|
|
267
287
|
* <p>Describes the specified keywords or all keywords on your origination phone number or
|
|
268
288
|
* pool.</p>
|
|
269
289
|
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
|
|
@@ -277,6 +297,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
277
297
|
describeKeywords(args: DescribeKeywordsCommandInput, cb: (err: any, data?: DescribeKeywordsCommandOutput) => void): void;
|
|
278
298
|
describeKeywords(args: DescribeKeywordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeywordsCommandOutput) => void): void;
|
|
279
299
|
/**
|
|
300
|
+
* @public
|
|
280
301
|
* <p>Describes the specified opted out destination numbers or all opted out destination
|
|
281
302
|
* numbers in an opt-out list.</p>
|
|
282
303
|
* <p>If you specify opted out numbers, the output includes information for only the
|
|
@@ -290,6 +311,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
290
311
|
describeOptedOutNumbers(args: DescribeOptedOutNumbersCommandInput, cb: (err: any, data?: DescribeOptedOutNumbersCommandOutput) => void): void;
|
|
291
312
|
describeOptedOutNumbers(args: DescribeOptedOutNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptedOutNumbersCommandOutput) => void): void;
|
|
292
313
|
/**
|
|
314
|
+
* @public
|
|
293
315
|
* <p>Describes the specified opt-out list or all opt-out lists in your account.</p>
|
|
294
316
|
* <p>If you specify opt-out list names, the output includes information for only the
|
|
295
317
|
* specified opt-out lists. Opt-out lists include only those that meet the filter criteria.
|
|
@@ -301,6 +323,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
301
323
|
describeOptOutLists(args: DescribeOptOutListsCommandInput, cb: (err: any, data?: DescribeOptOutListsCommandOutput) => void): void;
|
|
302
324
|
describeOptOutLists(args: DescribeOptOutListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptOutListsCommandOutput) => void): void;
|
|
303
325
|
/**
|
|
326
|
+
* @public
|
|
304
327
|
* <p>Describes the specified origination phone number, or all the phone numbers in your
|
|
305
328
|
* account.</p>
|
|
306
329
|
* <p>If you specify phone number IDs, the output includes information for only the
|
|
@@ -313,6 +336,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
313
336
|
describePhoneNumbers(args: DescribePhoneNumbersCommandInput, cb: (err: any, data?: DescribePhoneNumbersCommandOutput) => void): void;
|
|
314
337
|
describePhoneNumbers(args: DescribePhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePhoneNumbersCommandOutput) => void): void;
|
|
315
338
|
/**
|
|
339
|
+
* @public
|
|
316
340
|
* <p>Retrieves the specified pools or all pools associated with your Amazon Web Services
|
|
317
341
|
* account.</p>
|
|
318
342
|
* <p>If you specify pool IDs, the output includes information for only the specified pools.
|
|
@@ -328,6 +352,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
328
352
|
describePools(args: DescribePoolsCommandInput, cb: (err: any, data?: DescribePoolsCommandOutput) => void): void;
|
|
329
353
|
describePools(args: DescribePoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePoolsCommandOutput) => void): void;
|
|
330
354
|
/**
|
|
355
|
+
* @public
|
|
331
356
|
* <p>Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.</p>
|
|
332
357
|
* <p>If you specify SenderIds, the output includes information for only the specified
|
|
333
358
|
* SenderIds. If you specify filters, the output includes information for only those
|
|
@@ -339,6 +364,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
339
364
|
describeSenderIds(args: DescribeSenderIdsCommandInput, cb: (err: any, data?: DescribeSenderIdsCommandOutput) => void): void;
|
|
340
365
|
describeSenderIds(args: DescribeSenderIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSenderIdsCommandOutput) => void): void;
|
|
341
366
|
/**
|
|
367
|
+
* @public
|
|
342
368
|
* <p>Describes the current Amazon Pinpoint monthly spend limits for sending voice and
|
|
343
369
|
* text messages.</p>
|
|
344
370
|
* <p>When you establish an Amazon Web Services account, the account has initial monthly
|
|
@@ -351,6 +377,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
351
377
|
describeSpendLimits(args: DescribeSpendLimitsCommandInput, cb: (err: any, data?: DescribeSpendLimitsCommandOutput) => void): void;
|
|
352
378
|
describeSpendLimits(args: DescribeSpendLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpendLimitsCommandOutput) => void): void;
|
|
353
379
|
/**
|
|
380
|
+
* @public
|
|
354
381
|
* <p>Removes the specified origination identity from an existing pool.</p>
|
|
355
382
|
* <p>If the origination identity isn't associated with the specified pool, an Error is
|
|
356
383
|
* returned.</p>
|
|
@@ -359,6 +386,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
359
386
|
disassociateOriginationIdentity(args: DisassociateOriginationIdentityCommandInput, cb: (err: any, data?: DisassociateOriginationIdentityCommandOutput) => void): void;
|
|
360
387
|
disassociateOriginationIdentity(args: DisassociateOriginationIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateOriginationIdentityCommandOutput) => void): void;
|
|
361
388
|
/**
|
|
389
|
+
* @public
|
|
362
390
|
* <p>Lists all associated origination identities in your pool.</p>
|
|
363
391
|
* <p>If you specify filters, the output includes information for only those origination
|
|
364
392
|
* identities that meet the filter criteria.</p>
|
|
@@ -367,12 +395,14 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
367
395
|
listPoolOriginationIdentities(args: ListPoolOriginationIdentitiesCommandInput, cb: (err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void): void;
|
|
368
396
|
listPoolOriginationIdentities(args: ListPoolOriginationIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void): void;
|
|
369
397
|
/**
|
|
398
|
+
* @public
|
|
370
399
|
* <p>List all tags associated with a resource.</p>
|
|
371
400
|
*/
|
|
372
401
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
373
402
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
374
403
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
375
404
|
/**
|
|
405
|
+
* @public
|
|
376
406
|
* <p>Creates or updates a keyword configuration on an origination phone number or
|
|
377
407
|
* pool.</p>
|
|
378
408
|
* <p> A keyword is a word that you can search for on a particular phone number or pool. It
|
|
@@ -386,6 +416,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
386
416
|
putKeyword(args: PutKeywordCommandInput, cb: (err: any, data?: PutKeywordCommandOutput) => void): void;
|
|
387
417
|
putKeyword(args: PutKeywordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeywordCommandOutput) => void): void;
|
|
388
418
|
/**
|
|
419
|
+
* @public
|
|
389
420
|
* <p>Creates an opted out destination phone number in the opt-out list.</p>
|
|
390
421
|
* <p>If the destination phone number isn't valid or if the specified opt-out list doesn't
|
|
391
422
|
* exist, an Error is returned.</p>
|
|
@@ -394,6 +425,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
394
425
|
putOptedOutNumber(args: PutOptedOutNumberCommandInput, cb: (err: any, data?: PutOptedOutNumberCommandOutput) => void): void;
|
|
395
426
|
putOptedOutNumber(args: PutOptedOutNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOptedOutNumberCommandOutput) => void): void;
|
|
396
427
|
/**
|
|
428
|
+
* @public
|
|
397
429
|
* <p>Releases an existing origination phone number in your account. Once released, a phone
|
|
398
430
|
* number is no longer available for sending messages.</p>
|
|
399
431
|
* <p>If the origination phone number has deletion protection enabled or is associated with
|
|
@@ -403,6 +435,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
403
435
|
releasePhoneNumber(args: ReleasePhoneNumberCommandInput, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void): void;
|
|
404
436
|
releasePhoneNumber(args: ReleasePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void): void;
|
|
405
437
|
/**
|
|
438
|
+
* @public
|
|
406
439
|
* <p>Request an origination phone number for use in your account. For more information on
|
|
407
440
|
* phone number request see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html"> Requesting a
|
|
408
441
|
* number </a> in the <i>Amazon Pinpoint User Guide</i>.</p>
|
|
@@ -411,6 +444,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
411
444
|
requestPhoneNumber(args: RequestPhoneNumberCommandInput, cb: (err: any, data?: RequestPhoneNumberCommandOutput) => void): void;
|
|
412
445
|
requestPhoneNumber(args: RequestPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestPhoneNumberCommandOutput) => void): void;
|
|
413
446
|
/**
|
|
447
|
+
* @public
|
|
414
448
|
* <p>Creates a new text message and sends it to a recipient's phone number.</p>
|
|
415
449
|
* <p>SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit
|
|
416
450
|
* depends on the destination country of your messages, as well as the type of phone number
|
|
@@ -422,6 +456,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
422
456
|
sendTextMessage(args: SendTextMessageCommandInput, cb: (err: any, data?: SendTextMessageCommandOutput) => void): void;
|
|
423
457
|
sendTextMessage(args: SendTextMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTextMessageCommandOutput) => void): void;
|
|
424
458
|
/**
|
|
459
|
+
* @public
|
|
425
460
|
* <p>Allows you to send a request that sends a text message through Amazon Pinpoint.
|
|
426
461
|
* This operation uses <a href="http://aws.amazon.com/polly/">Amazon Polly</a> to
|
|
427
462
|
* convert a text script into a voice message.</p>
|
|
@@ -430,6 +465,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
430
465
|
sendVoiceMessage(args: SendVoiceMessageCommandInput, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void): void;
|
|
431
466
|
sendVoiceMessage(args: SendVoiceMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void): void;
|
|
432
467
|
/**
|
|
468
|
+
* @public
|
|
433
469
|
* <p>Sets the default message type on a configuration set.</p>
|
|
434
470
|
* <p>Choose the category of SMS messages that you plan to send from this account. If you
|
|
435
471
|
* send account-related messages or time-sensitive messages such as one-time passcodes,
|
|
@@ -441,6 +477,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
441
477
|
setDefaultMessageType(args: SetDefaultMessageTypeCommandInput, cb: (err: any, data?: SetDefaultMessageTypeCommandOutput) => void): void;
|
|
442
478
|
setDefaultMessageType(args: SetDefaultMessageTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultMessageTypeCommandOutput) => void): void;
|
|
443
479
|
/**
|
|
480
|
+
* @public
|
|
444
481
|
* <p>Sets default sender ID on a configuration set.</p>
|
|
445
482
|
* <p>When sending a text message to a destination country that supports sender IDs, the
|
|
446
483
|
* default sender ID on the configuration set specified will be used if no dedicated
|
|
@@ -450,6 +487,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
450
487
|
setDefaultSenderId(args: SetDefaultSenderIdCommandInput, cb: (err: any, data?: SetDefaultSenderIdCommandOutput) => void): void;
|
|
451
488
|
setDefaultSenderId(args: SetDefaultSenderIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultSenderIdCommandOutput) => void): void;
|
|
452
489
|
/**
|
|
490
|
+
* @public
|
|
453
491
|
* <p>Sets an account level monthly spend limit override for sending text messages. The
|
|
454
492
|
* requested spend limit must be less than or equal to the <code>MaxLimit</code>, which is
|
|
455
493
|
* set by Amazon Web Services. </p>
|
|
@@ -458,6 +496,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
458
496
|
setTextMessageSpendLimitOverride(args: SetTextMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
459
497
|
setTextMessageSpendLimitOverride(args: SetTextMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
460
498
|
/**
|
|
499
|
+
* @public
|
|
461
500
|
* <p>Sets an account level monthly spend limit override for sending voice messages. The
|
|
462
501
|
* requested spend limit must be less than or equal to the <code>MaxLimit</code>, which is
|
|
463
502
|
* set by Amazon Web Services. </p>
|
|
@@ -466,6 +505,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
466
505
|
setVoiceMessageSpendLimitOverride(args: SetVoiceMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
467
506
|
setVoiceMessageSpendLimitOverride(args: SetVoiceMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void): void;
|
|
468
507
|
/**
|
|
508
|
+
* @public
|
|
469
509
|
* <p>Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS
|
|
470
510
|
* Voice, version 2 resource. When you specify an existing tag key, the value is
|
|
471
511
|
* overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag
|
|
@@ -477,6 +517,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
477
517
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
478
518
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
479
519
|
/**
|
|
520
|
+
* @public
|
|
480
521
|
* <p>Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2
|
|
481
522
|
* resource. For more information on tags see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html"> Tagging Amazon Pinpoint resources</a> in the <i>Amazon Pinpoint Developer
|
|
482
523
|
* Guide</i>. </p>
|
|
@@ -485,6 +526,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
485
526
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
486
527
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
487
528
|
/**
|
|
529
|
+
* @public
|
|
488
530
|
* <p>Updates an existing event destination in a configuration set. You can update the
|
|
489
531
|
* IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can
|
|
490
532
|
* also enable or disable the event destination.</p>
|
|
@@ -496,6 +538,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
496
538
|
updateEventDestination(args: UpdateEventDestinationCommandInput, cb: (err: any, data?: UpdateEventDestinationCommandOutput) => void): void;
|
|
497
539
|
updateEventDestination(args: UpdateEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventDestinationCommandOutput) => void): void;
|
|
498
540
|
/**
|
|
541
|
+
* @public
|
|
499
542
|
* <p>Updates the configuration of an existing origination phone number. You can update the
|
|
500
543
|
* opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable
|
|
501
544
|
* or disable self-managed opt-outs, and enable or disable deletion protection.</p>
|
|
@@ -506,6 +549,7 @@ export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client {
|
|
|
506
549
|
updatePhoneNumber(args: UpdatePhoneNumberCommandInput, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void): void;
|
|
507
550
|
updatePhoneNumber(args: UpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void): void;
|
|
508
551
|
/**
|
|
552
|
+
* @public
|
|
509
553
|
* <p>Updates the configuration of an existing pool. You can update the opt-out list, enable
|
|
510
554
|
* or disable two-way messaging, change the <code>TwoWayChannelArn</code>, enable or
|
|
511
555
|
* disable self-managed opt-outs, enable or disable deletion protection, and enable or
|
|
@@ -51,15 +51,24 @@ import { UpdateEventDestinationCommandInput, UpdateEventDestinationCommandOutput
|
|
|
51
51
|
import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from "./commands/UpdatePhoneNumberCommand";
|
|
52
52
|
import { UpdatePoolCommandInput, UpdatePoolCommandOutput } from "./commands/UpdatePoolCommand";
|
|
53
53
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
54
57
|
export type ServiceInputTypes = AssociateOriginationIdentityCommandInput | CreateConfigurationSetCommandInput | CreateEventDestinationCommandInput | CreateOptOutListCommandInput | CreatePoolCommandInput | DeleteConfigurationSetCommandInput | DeleteDefaultMessageTypeCommandInput | DeleteDefaultSenderIdCommandInput | DeleteEventDestinationCommandInput | DeleteKeywordCommandInput | DeleteOptOutListCommandInput | DeleteOptedOutNumberCommandInput | DeletePoolCommandInput | DeleteTextMessageSpendLimitOverrideCommandInput | DeleteVoiceMessageSpendLimitOverrideCommandInput | DescribeAccountAttributesCommandInput | DescribeAccountLimitsCommandInput | DescribeConfigurationSetsCommandInput | DescribeKeywordsCommandInput | DescribeOptOutListsCommandInput | DescribeOptedOutNumbersCommandInput | DescribePhoneNumbersCommandInput | DescribePoolsCommandInput | DescribeSenderIdsCommandInput | DescribeSpendLimitsCommandInput | DisassociateOriginationIdentityCommandInput | ListPoolOriginationIdentitiesCommandInput | ListTagsForResourceCommandInput | PutKeywordCommandInput | PutOptedOutNumberCommandInput | ReleasePhoneNumberCommandInput | RequestPhoneNumberCommandInput | SendTextMessageCommandInput | SendVoiceMessageCommandInput | SetDefaultMessageTypeCommandInput | SetDefaultSenderIdCommandInput | SetTextMessageSpendLimitOverrideCommandInput | SetVoiceMessageSpendLimitOverrideCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEventDestinationCommandInput | UpdatePhoneNumberCommandInput | UpdatePoolCommandInput;
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
55
61
|
export type ServiceOutputTypes = AssociateOriginationIdentityCommandOutput | CreateConfigurationSetCommandOutput | CreateEventDestinationCommandOutput | CreateOptOutListCommandOutput | CreatePoolCommandOutput | DeleteConfigurationSetCommandOutput | DeleteDefaultMessageTypeCommandOutput | DeleteDefaultSenderIdCommandOutput | DeleteEventDestinationCommandOutput | DeleteKeywordCommandOutput | DeleteOptOutListCommandOutput | DeleteOptedOutNumberCommandOutput | DeletePoolCommandOutput | DeleteTextMessageSpendLimitOverrideCommandOutput | DeleteVoiceMessageSpendLimitOverrideCommandOutput | DescribeAccountAttributesCommandOutput | DescribeAccountLimitsCommandOutput | DescribeConfigurationSetsCommandOutput | DescribeKeywordsCommandOutput | DescribeOptOutListsCommandOutput | DescribeOptedOutNumbersCommandOutput | DescribePhoneNumbersCommandOutput | DescribePoolsCommandOutput | DescribeSenderIdsCommandOutput | DescribeSpendLimitsCommandOutput | DisassociateOriginationIdentityCommandOutput | ListPoolOriginationIdentitiesCommandOutput | ListTagsForResourceCommandOutput | PutKeywordCommandOutput | PutOptedOutNumberCommandOutput | ReleasePhoneNumberCommandOutput | RequestPhoneNumberCommandOutput | SendTextMessageCommandOutput | SendVoiceMessageCommandOutput | SetDefaultMessageTypeCommandOutput | SetDefaultSenderIdCommandOutput | SetTextMessageSpendLimitOverrideCommandOutput | SetVoiceMessageSpendLimitOverrideCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEventDestinationCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePoolCommandOutput;
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
56
65
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
57
66
|
/**
|
|
58
67
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
59
68
|
*/
|
|
60
69
|
requestHandler?: __HttpHandler;
|
|
61
70
|
/**
|
|
62
|
-
* A constructor for a class implementing the {@link
|
|
71
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
63
72
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
64
73
|
* @internal
|
|
65
74
|
*/
|
|
@@ -149,23 +158,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
149
158
|
*/
|
|
150
159
|
logger?: __Logger;
|
|
151
160
|
/**
|
|
152
|
-
* The {@link
|
|
161
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
153
162
|
*/
|
|
154
163
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
155
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
156
168
|
type PinpointSMSVoiceV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
157
169
|
/**
|
|
158
|
-
*
|
|
170
|
+
* @public
|
|
171
|
+
*
|
|
172
|
+
* The configuration interface of PinpointSMSVoiceV2Client class constructor that set the region, credentials and other options.
|
|
159
173
|
*/
|
|
160
174
|
export interface PinpointSMSVoiceV2ClientConfig extends PinpointSMSVoiceV2ClientConfigType {
|
|
161
175
|
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
162
179
|
type PinpointSMSVoiceV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
163
180
|
/**
|
|
164
|
-
*
|
|
181
|
+
* @public
|
|
182
|
+
*
|
|
183
|
+
* The resolved configuration interface of PinpointSMSVoiceV2Client class. This is resolved and normalized from the {@link PinpointSMSVoiceV2ClientConfig | constructor configuration interface}.
|
|
165
184
|
*/
|
|
166
185
|
export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoiceV2ClientResolvedConfigType {
|
|
167
186
|
}
|
|
168
187
|
/**
|
|
188
|
+
* @public
|
|
169
189
|
* <p>Welcome to the <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i>.
|
|
170
190
|
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
|
|
171
191
|
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { AssociateOriginationIdentityRequest, AssociateOriginationIdentityResult } from "../models/models_0";
|
|
5
5
|
import { PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceV2Client";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssociateOriginationIdentityCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssociateOriginationIdentityCommandInput extends AssociateOriginationIdentityRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssociateOriginationIdentityCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssociateOriginationIdentityCommandOutput extends AssociateOriginationIdentityResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Associates the specified origination identity with a pool.</p>
|
|
18
23
|
* <p>If the origination identity is a phone number and is already associated with another
|
|
19
24
|
* pool, an Error is returned. A sender ID can be associated with multiple pools.</p>
|
|
@@ -29,6 +34,8 @@ export interface AssociateOriginationIdentityCommandOutput extends AssociateOrig
|
|
|
29
34
|
* const response = await client.send(command);
|
|
30
35
|
* ```
|
|
31
36
|
*
|
|
37
|
+
* @param AssociateOriginationIdentityCommandInput - {@link AssociateOriginationIdentityCommandInput}
|
|
38
|
+
* @returns {@link AssociateOriginationIdentityCommandOutput}
|
|
32
39
|
* @see {@link AssociateOriginationIdentityCommandInput} for command's `input` shape.
|
|
33
40
|
* @see {@link AssociateOriginationIdentityCommandOutput} for command's `response` shape.
|
|
34
41
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
@@ -65,11 +72,20 @@ export interface AssociateOriginationIdentityCommandOutput extends AssociateOrig
|
|
|
65
72
|
export declare class AssociateOriginationIdentityCommand extends $Command<AssociateOriginationIdentityCommandInput, AssociateOriginationIdentityCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
66
73
|
readonly input: AssociateOriginationIdentityCommandInput;
|
|
67
74
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
68
78
|
constructor(input: AssociateOriginationIdentityCommandInput);
|
|
69
79
|
/**
|
|
70
80
|
* @internal
|
|
71
81
|
*/
|
|
72
82
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateOriginationIdentityCommandInput, AssociateOriginationIdentityCommandOutput>;
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
73
86
|
private serialize;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
74
90
|
private deserialize;
|
|
75
91
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { CreateConfigurationSetRequest, CreateConfigurationSetResult } from "../models/models_0";
|
|
5
5
|
import { PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceV2Client";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateConfigurationSetCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateConfigurationSetCommandInput extends CreateConfigurationSetRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateConfigurationSetCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateConfigurationSetCommandOutput extends CreateConfigurationSetResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a new configuration set. After you create the configuration set, you can add
|
|
18
23
|
* one or more event destinations to it.</p>
|
|
19
24
|
* <p>A configuration set is a set of rules that you apply to the SMS and voice messages
|
|
@@ -29,6 +34,8 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
|
|
|
29
34
|
* const response = await client.send(command);
|
|
30
35
|
* ```
|
|
31
36
|
*
|
|
37
|
+
* @param CreateConfigurationSetCommandInput - {@link CreateConfigurationSetCommandInput}
|
|
38
|
+
* @returns {@link CreateConfigurationSetCommandOutput}
|
|
32
39
|
* @see {@link CreateConfigurationSetCommandInput} for command's `input` shape.
|
|
33
40
|
* @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape.
|
|
34
41
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
@@ -62,11 +69,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
|
|
|
62
69
|
export declare class CreateConfigurationSetCommand extends $Command<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
63
70
|
readonly input: CreateConfigurationSetCommandInput;
|
|
64
71
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
65
75
|
constructor(input: CreateConfigurationSetCommandInput);
|
|
66
76
|
/**
|
|
67
77
|
* @internal
|
|
68
78
|
*/
|
|
69
79
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput>;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
70
83
|
private serialize;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
71
87
|
private deserialize;
|
|
72
88
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { CreateEventDestinationRequest, CreateEventDestinationResult } from "../models/models_0";
|
|
5
5
|
import { PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceV2Client";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateEventDestinationCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateEventDestinationCommandInput extends CreateEventDestinationRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateEventDestinationCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateEventDestinationCommandOutput extends CreateEventDestinationResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a new event destination in a configuration set.</p>
|
|
18
23
|
* <p>An event destination is a location where you send message events. The event options
|
|
19
24
|
* are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,
|
|
@@ -33,6 +38,8 @@ export interface CreateEventDestinationCommandOutput extends CreateEventDestinat
|
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
35
40
|
*
|
|
41
|
+
* @param CreateEventDestinationCommandInput - {@link CreateEventDestinationCommandInput}
|
|
42
|
+
* @returns {@link CreateEventDestinationCommandOutput}
|
|
36
43
|
* @see {@link CreateEventDestinationCommandInput} for command's `input` shape.
|
|
37
44
|
* @see {@link CreateEventDestinationCommandOutput} for command's `response` shape.
|
|
38
45
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
@@ -69,11 +76,20 @@ export interface CreateEventDestinationCommandOutput extends CreateEventDestinat
|
|
|
69
76
|
export declare class CreateEventDestinationCommand extends $Command<CreateEventDestinationCommandInput, CreateEventDestinationCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
70
77
|
readonly input: CreateEventDestinationCommandInput;
|
|
71
78
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
72
82
|
constructor(input: CreateEventDestinationCommandInput);
|
|
73
83
|
/**
|
|
74
84
|
* @internal
|
|
75
85
|
*/
|
|
76
86
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEventDestinationCommandInput, CreateEventDestinationCommandOutput>;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
77
90
|
private serialize;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
78
94
|
private deserialize;
|
|
79
95
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { CreateOptOutListRequest, CreateOptOutListResult } from "../models/models_0";
|
|
5
5
|
import { PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceV2Client";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateOptOutListCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateOptOutListCommandInput extends CreateOptOutListRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateOptOutListCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateOptOutListCommandOutput extends CreateOptOutListResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a new opt-out list.</p>
|
|
18
23
|
* <p>If the opt-out list name already exists, an Error is returned.</p>
|
|
19
24
|
* <p>An opt-out list is a list of phone numbers that are opted out, meaning you can't send
|
|
@@ -33,6 +38,8 @@ export interface CreateOptOutListCommandOutput extends CreateOptOutListResult, _
|
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
35
40
|
*
|
|
41
|
+
* @param CreateOptOutListCommandInput - {@link CreateOptOutListCommandInput}
|
|
42
|
+
* @returns {@link CreateOptOutListCommandOutput}
|
|
36
43
|
* @see {@link CreateOptOutListCommandInput} for command's `input` shape.
|
|
37
44
|
* @see {@link CreateOptOutListCommandOutput} for command's `response` shape.
|
|
38
45
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
@@ -66,11 +73,20 @@ export interface CreateOptOutListCommandOutput extends CreateOptOutListResult, _
|
|
|
66
73
|
export declare class CreateOptOutListCommand extends $Command<CreateOptOutListCommandInput, CreateOptOutListCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
67
74
|
readonly input: CreateOptOutListCommandInput;
|
|
68
75
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
69
79
|
constructor(input: CreateOptOutListCommandInput);
|
|
70
80
|
/**
|
|
71
81
|
* @internal
|
|
72
82
|
*/
|
|
73
83
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateOptOutListCommandInput, CreateOptOutListCommandOutput>;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
74
87
|
private serialize;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
75
91
|
private deserialize;
|
|
76
92
|
}
|