@aws-sdk/client-pinpoint-sms-voice-v2 3.922.0 → 3.925.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 +9 -1
- package/dist-cjs/index.js +45 -0
- package/dist-es/PinpointSMSVoiceV2.js +2 -0
- package/dist-es/commands/CarrierLookupCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/protocols/Aws_json1_0.js +19 -0
- package/dist-types/PinpointSMSVoiceV2.d.ts +8 -1
- package/dist-types/PinpointSMSVoiceV2Client.d.ts +4 -3
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +1 -1
- package/dist-types/commands/CarrierLookupCommand.d.ts +118 -0
- package/dist-types/commands/CreateOptOutListCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKeywordCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeywordsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSpendLimitsCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/PutKeywordCommand.d.ts +1 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/RequestPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/SendTextMessageCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +122 -53
- package/dist-types/protocols/Aws_json1_0.d.ts +9 -0
- package/dist-types/ts3.4/PinpointSMSVoiceV2.d.ts +17 -0
- package/dist-types/ts3.4/PinpointSMSVoiceV2Client.d.ts +6 -0
- package/dist-types/ts3.4/commands/CarrierLookupCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +21 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +12 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript PinpointSMSVoiceV2 Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>Welcome to the <i>
|
|
9
|
+
<p>Welcome to the <i>End User MessagingSMS, version 2 API Reference</i>. This guide provides information about End User MessagingSMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.</p> <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User MessagingSMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User MessagingSMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p> <p>If you're new to End User MessagingSMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> End User MessagingSMS User Guide</a>, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User MessagingSMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User MessagingSMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.</p> <p> <b>Regional availability</b> </p> <p>The <i>End User MessagingSMS version 2 API Reference</i> is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see <a href="https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region">Amazon Web Services Service Endpoints</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/pinpoint.html">Amazon Pinpoint endpoints and quotas</a> in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing Amazon Web Services Regions</a> in the Amazon Web Services General Reference.</p> <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see <a href="http://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
10
10
|
|
|
11
11
|
## Installing
|
|
12
12
|
|
|
@@ -218,6 +218,14 @@ AssociateProtectConfiguration
|
|
|
218
218
|
|
|
219
219
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/pinpoint-sms-voice-v2/command/AssociateProtectConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pinpoint-sms-voice-v2/Interface/AssociateProtectConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pinpoint-sms-voice-v2/Interface/AssociateProtectConfigurationCommandOutput/)
|
|
220
220
|
|
|
221
|
+
</details>
|
|
222
|
+
<details>
|
|
223
|
+
<summary>
|
|
224
|
+
CarrierLookup
|
|
225
|
+
</summary>
|
|
226
|
+
|
|
227
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/pinpoint-sms-voice-v2/command/CarrierLookupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pinpoint-sms-voice-v2/Interface/CarrierLookupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pinpoint-sms-voice-v2/Interface/CarrierLookupCommandOutput/)
|
|
228
|
+
|
|
221
229
|
</details>
|
|
222
230
|
<details>
|
|
223
231
|
<summary>
|
package/dist-cjs/index.js
CHANGED
|
@@ -391,6 +391,12 @@ const AttachmentStatus = {
|
|
|
391
391
|
const AttachmentUploadErrorReason = {
|
|
392
392
|
INTERNAL_ERROR: "INTERNAL_ERROR",
|
|
393
393
|
};
|
|
394
|
+
const PhoneNumberType = {
|
|
395
|
+
INVALID: "INVALID",
|
|
396
|
+
LANDLINE: "LANDLINE",
|
|
397
|
+
MOBILE: "MOBILE",
|
|
398
|
+
OTHER: "OTHER",
|
|
399
|
+
};
|
|
394
400
|
const ConfigurationSetFilterName = {
|
|
395
401
|
DEFAULT_MESSAGE_FEEDBACK_ENABLED: "default-message-feedback-enabled",
|
|
396
402
|
DEFAULT_MESSAGE_TYPE: "default-message-type",
|
|
@@ -726,6 +732,12 @@ const se_AssociateProtectConfigurationCommand = async (input, context) => {
|
|
|
726
732
|
body = JSON.stringify(smithyClient._json(input));
|
|
727
733
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
728
734
|
};
|
|
735
|
+
const se_CarrierLookupCommand = async (input, context) => {
|
|
736
|
+
const headers = sharedHeaders("CarrierLookup");
|
|
737
|
+
let body;
|
|
738
|
+
body = JSON.stringify(smithyClient._json(input));
|
|
739
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
740
|
+
};
|
|
729
741
|
const se_CreateConfigurationSetCommand = async (input, context) => {
|
|
730
742
|
const headers = sharedHeaders("CreateConfigurationSet");
|
|
731
743
|
let body;
|
|
@@ -1280,6 +1292,19 @@ const de_AssociateProtectConfigurationCommand = async (output, context) => {
|
|
|
1280
1292
|
};
|
|
1281
1293
|
return response;
|
|
1282
1294
|
};
|
|
1295
|
+
const de_CarrierLookupCommand = async (output, context) => {
|
|
1296
|
+
if (output.statusCode >= 300) {
|
|
1297
|
+
return de_CommandError(output, context);
|
|
1298
|
+
}
|
|
1299
|
+
const data = await core$1.parseJsonBody(output.body, context);
|
|
1300
|
+
let contents = {};
|
|
1301
|
+
contents = smithyClient._json(data);
|
|
1302
|
+
const response = {
|
|
1303
|
+
$metadata: deserializeMetadata(output),
|
|
1304
|
+
...contents,
|
|
1305
|
+
};
|
|
1306
|
+
return response;
|
|
1307
|
+
};
|
|
1283
1308
|
const de_CreateConfigurationSetCommand = async (output, context) => {
|
|
1284
1309
|
if (output.statusCode >= 300) {
|
|
1285
1310
|
return de_CommandError(output, context);
|
|
@@ -3330,6 +3355,23 @@ class AssociateProtectConfigurationCommand extends smithyClient.Command
|
|
|
3330
3355
|
.build() {
|
|
3331
3356
|
}
|
|
3332
3357
|
|
|
3358
|
+
class CarrierLookupCommand extends smithyClient.Command
|
|
3359
|
+
.classBuilder()
|
|
3360
|
+
.ep(commonParams)
|
|
3361
|
+
.m(function (Command, cs, config, o) {
|
|
3362
|
+
return [
|
|
3363
|
+
middlewareSerde.getSerdePlugin(config, this.serialize, this.deserialize),
|
|
3364
|
+
middlewareEndpoint.getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
3365
|
+
];
|
|
3366
|
+
})
|
|
3367
|
+
.s("PinpointSMSVoiceV2", "CarrierLookup", {})
|
|
3368
|
+
.n("PinpointSMSVoiceV2Client", "CarrierLookupCommand")
|
|
3369
|
+
.f(void 0, void 0)
|
|
3370
|
+
.ser(se_CarrierLookupCommand)
|
|
3371
|
+
.de(de_CarrierLookupCommand)
|
|
3372
|
+
.build() {
|
|
3373
|
+
}
|
|
3374
|
+
|
|
3333
3375
|
class CreateConfigurationSetCommand extends smithyClient.Command
|
|
3334
3376
|
.classBuilder()
|
|
3335
3377
|
.ep(commonParams)
|
|
@@ -4829,6 +4871,7 @@ class VerifyDestinationNumberCommand extends smithyClient.Command
|
|
|
4829
4871
|
const commands = {
|
|
4830
4872
|
AssociateOriginationIdentityCommand,
|
|
4831
4873
|
AssociateProtectConfigurationCommand,
|
|
4874
|
+
CarrierLookupCommand,
|
|
4832
4875
|
CreateConfigurationSetCommand,
|
|
4833
4876
|
CreateEventDestinationCommand,
|
|
4834
4877
|
CreateOptOutListCommand,
|
|
@@ -4982,6 +5025,7 @@ exports.AssociateOriginationIdentityCommand = AssociateOriginationIdentityComman
|
|
|
4982
5025
|
exports.AssociateProtectConfigurationCommand = AssociateProtectConfigurationCommand;
|
|
4983
5026
|
exports.AttachmentStatus = AttachmentStatus;
|
|
4984
5027
|
exports.AttachmentUploadErrorReason = AttachmentUploadErrorReason;
|
|
5028
|
+
exports.CarrierLookupCommand = CarrierLookupCommand;
|
|
4985
5029
|
exports.ConfigurationSetFilterName = ConfigurationSetFilterName;
|
|
4986
5030
|
exports.ConflictException = ConflictException;
|
|
4987
5031
|
exports.ConflictExceptionReason = ConflictExceptionReason;
|
|
@@ -5058,6 +5102,7 @@ exports.NumberType = NumberType;
|
|
|
5058
5102
|
exports.OptedOutFilterName = OptedOutFilterName;
|
|
5059
5103
|
exports.Owner = Owner;
|
|
5060
5104
|
exports.PhoneNumberFilterName = PhoneNumberFilterName;
|
|
5105
|
+
exports.PhoneNumberType = PhoneNumberType;
|
|
5061
5106
|
exports.PinpointSMSVoiceV2 = PinpointSMSVoiceV2;
|
|
5062
5107
|
exports.PinpointSMSVoiceV2Client = PinpointSMSVoiceV2Client;
|
|
5063
5108
|
exports.PinpointSMSVoiceV2ServiceException = PinpointSMSVoiceV2ServiceException;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { createAggregatedClient } from "@smithy/smithy-client";
|
|
2
2
|
import { AssociateOriginationIdentityCommand, } from "./commands/AssociateOriginationIdentityCommand";
|
|
3
3
|
import { AssociateProtectConfigurationCommand, } from "./commands/AssociateProtectConfigurationCommand";
|
|
4
|
+
import { CarrierLookupCommand, } from "./commands/CarrierLookupCommand";
|
|
4
5
|
import { CreateConfigurationSetCommand, } from "./commands/CreateConfigurationSetCommand";
|
|
5
6
|
import { CreateEventDestinationCommand, } from "./commands/CreateEventDestinationCommand";
|
|
6
7
|
import { CreateOptOutListCommand, } from "./commands/CreateOptOutListCommand";
|
|
@@ -93,6 +94,7 @@ import { PinpointSMSVoiceV2Client } from "./PinpointSMSVoiceV2Client";
|
|
|
93
94
|
const commands = {
|
|
94
95
|
AssociateOriginationIdentityCommand,
|
|
95
96
|
AssociateProtectConfigurationCommand,
|
|
97
|
+
CarrierLookupCommand,
|
|
96
98
|
CreateConfigurationSetCommand,
|
|
97
99
|
CreateEventDestinationCommand,
|
|
98
100
|
CreateOptOutListCommand,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { de_CarrierLookupCommand, se_CarrierLookupCommand } from "../protocols/Aws_json1_0";
|
|
6
|
+
export { $Command };
|
|
7
|
+
export class CarrierLookupCommand extends $Command
|
|
8
|
+
.classBuilder()
|
|
9
|
+
.ep(commonParams)
|
|
10
|
+
.m(function (Command, cs, config, o) {
|
|
11
|
+
return [
|
|
12
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
13
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
14
|
+
];
|
|
15
|
+
})
|
|
16
|
+
.s("PinpointSMSVoiceV2", "CarrierLookup", {})
|
|
17
|
+
.n("PinpointSMSVoiceV2Client", "CarrierLookupCommand")
|
|
18
|
+
.f(void 0, void 0)
|
|
19
|
+
.ser(se_CarrierLookupCommand)
|
|
20
|
+
.de(de_CarrierLookupCommand)
|
|
21
|
+
.build() {
|
|
22
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./AssociateOriginationIdentityCommand";
|
|
2
2
|
export * from "./AssociateProtectConfigurationCommand";
|
|
3
|
+
export * from "./CarrierLookupCommand";
|
|
3
4
|
export * from "./CreateConfigurationSetCommand";
|
|
4
5
|
export * from "./CreateEventDestinationCommand";
|
|
5
6
|
export * from "./CreateOptOutListCommand";
|
|
@@ -272,6 +272,12 @@ export const AttachmentStatus = {
|
|
|
272
272
|
export const AttachmentUploadErrorReason = {
|
|
273
273
|
INTERNAL_ERROR: "INTERNAL_ERROR",
|
|
274
274
|
};
|
|
275
|
+
export const PhoneNumberType = {
|
|
276
|
+
INVALID: "INVALID",
|
|
277
|
+
LANDLINE: "LANDLINE",
|
|
278
|
+
MOBILE: "MOBILE",
|
|
279
|
+
OTHER: "OTHER",
|
|
280
|
+
};
|
|
275
281
|
export const ConfigurationSetFilterName = {
|
|
276
282
|
DEFAULT_MESSAGE_FEEDBACK_ENABLED: "default-message-feedback-enabled",
|
|
277
283
|
DEFAULT_MESSAGE_TYPE: "default-message-type",
|
|
@@ -16,6 +16,12 @@ export const se_AssociateProtectConfigurationCommand = async (input, context) =>
|
|
|
16
16
|
body = JSON.stringify(_json(input));
|
|
17
17
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
18
18
|
};
|
|
19
|
+
export const se_CarrierLookupCommand = async (input, context) => {
|
|
20
|
+
const headers = sharedHeaders("CarrierLookup");
|
|
21
|
+
let body;
|
|
22
|
+
body = JSON.stringify(_json(input));
|
|
23
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
24
|
+
};
|
|
19
25
|
export const se_CreateConfigurationSetCommand = async (input, context) => {
|
|
20
26
|
const headers = sharedHeaders("CreateConfigurationSet");
|
|
21
27
|
let body;
|
|
@@ -570,6 +576,19 @@ export const de_AssociateProtectConfigurationCommand = async (output, context) =
|
|
|
570
576
|
};
|
|
571
577
|
return response;
|
|
572
578
|
};
|
|
579
|
+
export const de_CarrierLookupCommand = async (output, context) => {
|
|
580
|
+
if (output.statusCode >= 300) {
|
|
581
|
+
return de_CommandError(output, context);
|
|
582
|
+
}
|
|
583
|
+
const data = await parseBody(output.body, context);
|
|
584
|
+
let contents = {};
|
|
585
|
+
contents = _json(data);
|
|
586
|
+
const response = {
|
|
587
|
+
$metadata: deserializeMetadata(output),
|
|
588
|
+
...contents,
|
|
589
|
+
};
|
|
590
|
+
return response;
|
|
591
|
+
};
|
|
573
592
|
export const de_CreateConfigurationSetCommand = async (output, context) => {
|
|
574
593
|
if (output.statusCode >= 300) {
|
|
575
594
|
return de_CommandError(output, context);
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
2
|
import { AssociateOriginationIdentityCommandInput, AssociateOriginationIdentityCommandOutput } from "./commands/AssociateOriginationIdentityCommand";
|
|
3
3
|
import { AssociateProtectConfigurationCommandInput, AssociateProtectConfigurationCommandOutput } from "./commands/AssociateProtectConfigurationCommand";
|
|
4
|
+
import { CarrierLookupCommandInput, CarrierLookupCommandOutput } from "./commands/CarrierLookupCommand";
|
|
4
5
|
import { CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput } from "./commands/CreateConfigurationSetCommand";
|
|
5
6
|
import { CreateEventDestinationCommandInput, CreateEventDestinationCommandOutput } from "./commands/CreateEventDestinationCommand";
|
|
6
7
|
import { CreateOptOutListCommandInput, CreateOptOutListCommandOutput } from "./commands/CreateOptOutListCommand";
|
|
@@ -103,6 +104,12 @@ export interface PinpointSMSVoiceV2 {
|
|
|
103
104
|
associateProtectConfiguration(args: AssociateProtectConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<AssociateProtectConfigurationCommandOutput>;
|
|
104
105
|
associateProtectConfiguration(args: AssociateProtectConfigurationCommandInput, cb: (err: any, data?: AssociateProtectConfigurationCommandOutput) => void): void;
|
|
105
106
|
associateProtectConfiguration(args: AssociateProtectConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateProtectConfigurationCommandOutput) => void): void;
|
|
107
|
+
/**
|
|
108
|
+
* @see {@link CarrierLookupCommand}
|
|
109
|
+
*/
|
|
110
|
+
carrierLookup(args: CarrierLookupCommandInput, options?: __HttpHandlerOptions): Promise<CarrierLookupCommandOutput>;
|
|
111
|
+
carrierLookup(args: CarrierLookupCommandInput, cb: (err: any, data?: CarrierLookupCommandOutput) => void): void;
|
|
112
|
+
carrierLookup(args: CarrierLookupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CarrierLookupCommandOutput) => void): void;
|
|
106
113
|
/**
|
|
107
114
|
* @see {@link CreateConfigurationSetCommand}
|
|
108
115
|
*/
|
|
@@ -652,7 +659,7 @@ export interface PinpointSMSVoiceV2 {
|
|
|
652
659
|
verifyDestinationNumber(args: VerifyDestinationNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyDestinationNumberCommandOutput) => void): void;
|
|
653
660
|
}
|
|
654
661
|
/**
|
|
655
|
-
* <p>Welcome to the <i>
|
|
662
|
+
* <p>Welcome to the <i>End User MessagingSMS, version 2 API Reference</i>. This guide provides information about End User MessagingSMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.</p> <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User MessagingSMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User MessagingSMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p> <p>If you're new to End User MessagingSMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> End User MessagingSMS User Guide</a>, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User MessagingSMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User MessagingSMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.</p> <p> <b>Regional availability</b> </p> <p>The <i>End User MessagingSMS version 2 API Reference</i> is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see <a href="https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region">Amazon Web Services Service Endpoints</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/pinpoint.html">Amazon Pinpoint endpoints and quotas</a> in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing Amazon Web Services Regions</a> in the Amazon Web Services General Reference.</p> <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see <a href="http://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
656
663
|
* @public
|
|
657
664
|
*/
|
|
658
665
|
export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client implements PinpointSMSVoiceV2 {
|
|
@@ -9,6 +9,7 @@ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalc
|
|
|
9
9
|
import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
10
|
import { AssociateOriginationIdentityCommandInput, AssociateOriginationIdentityCommandOutput } from "./commands/AssociateOriginationIdentityCommand";
|
|
11
11
|
import { AssociateProtectConfigurationCommandInput, AssociateProtectConfigurationCommandOutput } from "./commands/AssociateProtectConfigurationCommand";
|
|
12
|
+
import { CarrierLookupCommandInput, CarrierLookupCommandOutput } from "./commands/CarrierLookupCommand";
|
|
12
13
|
import { CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput } from "./commands/CreateConfigurationSetCommand";
|
|
13
14
|
import { CreateEventDestinationCommandInput, CreateEventDestinationCommandOutput } from "./commands/CreateEventDestinationCommand";
|
|
14
15
|
import { CreateOptOutListCommandInput, CreateOptOutListCommandOutput } from "./commands/CreateOptOutListCommand";
|
|
@@ -103,11 +104,11 @@ export { __Client };
|
|
|
103
104
|
/**
|
|
104
105
|
* @public
|
|
105
106
|
*/
|
|
106
|
-
export type ServiceInputTypes = AssociateOriginationIdentityCommandInput | AssociateProtectConfigurationCommandInput | CreateConfigurationSetCommandInput | CreateEventDestinationCommandInput | CreateOptOutListCommandInput | CreatePoolCommandInput | CreateProtectConfigurationCommandInput | CreateRegistrationAssociationCommandInput | CreateRegistrationAttachmentCommandInput | CreateRegistrationCommandInput | CreateRegistrationVersionCommandInput | CreateVerifiedDestinationNumberCommandInput | DeleteAccountDefaultProtectConfigurationCommandInput | DeleteConfigurationSetCommandInput | DeleteDefaultMessageTypeCommandInput | DeleteDefaultSenderIdCommandInput | DeleteEventDestinationCommandInput | DeleteKeywordCommandInput | DeleteMediaMessageSpendLimitOverrideCommandInput | DeleteOptOutListCommandInput | DeleteOptedOutNumberCommandInput | DeletePoolCommandInput | DeleteProtectConfigurationCommandInput | DeleteProtectConfigurationRuleSetNumberOverrideCommandInput | DeleteRegistrationAttachmentCommandInput | DeleteRegistrationCommandInput | DeleteRegistrationFieldValueCommandInput | DeleteResourcePolicyCommandInput | DeleteTextMessageSpendLimitOverrideCommandInput | DeleteVerifiedDestinationNumberCommandInput | DeleteVoiceMessageSpendLimitOverrideCommandInput | DescribeAccountAttributesCommandInput | DescribeAccountLimitsCommandInput | DescribeConfigurationSetsCommandInput | DescribeKeywordsCommandInput | DescribeOptOutListsCommandInput | DescribeOptedOutNumbersCommandInput | DescribePhoneNumbersCommandInput | DescribePoolsCommandInput | DescribeProtectConfigurationsCommandInput | DescribeRegistrationAttachmentsCommandInput | DescribeRegistrationFieldDefinitionsCommandInput | DescribeRegistrationFieldValuesCommandInput | DescribeRegistrationSectionDefinitionsCommandInput | DescribeRegistrationTypeDefinitionsCommandInput | DescribeRegistrationVersionsCommandInput | DescribeRegistrationsCommandInput | DescribeSenderIdsCommandInput | DescribeSpendLimitsCommandInput | DescribeVerifiedDestinationNumbersCommandInput | DisassociateOriginationIdentityCommandInput | DisassociateProtectConfigurationCommandInput | DiscardRegistrationVersionCommandInput | GetProtectConfigurationCountryRuleSetCommandInput | GetResourcePolicyCommandInput | ListPoolOriginationIdentitiesCommandInput | ListProtectConfigurationRuleSetNumberOverridesCommandInput | ListRegistrationAssociationsCommandInput | ListTagsForResourceCommandInput | PutKeywordCommandInput | PutMessageFeedbackCommandInput | PutOptedOutNumberCommandInput | PutProtectConfigurationRuleSetNumberOverrideCommandInput | PutRegistrationFieldValueCommandInput | PutResourcePolicyCommandInput | ReleasePhoneNumberCommandInput | ReleaseSenderIdCommandInput | RequestPhoneNumberCommandInput | RequestSenderIdCommandInput | SendDestinationNumberVerificationCodeCommandInput | SendMediaMessageCommandInput | SendTextMessageCommandInput | SendVoiceMessageCommandInput | SetAccountDefaultProtectConfigurationCommandInput | SetDefaultMessageFeedbackEnabledCommandInput | SetDefaultMessageTypeCommandInput | SetDefaultSenderIdCommandInput | SetMediaMessageSpendLimitOverrideCommandInput | SetTextMessageSpendLimitOverrideCommandInput | SetVoiceMessageSpendLimitOverrideCommandInput | SubmitRegistrationVersionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEventDestinationCommandInput | UpdatePhoneNumberCommandInput | UpdatePoolCommandInput | UpdateProtectConfigurationCommandInput | UpdateProtectConfigurationCountryRuleSetCommandInput | UpdateSenderIdCommandInput | VerifyDestinationNumberCommandInput;
|
|
107
|
+
export type ServiceInputTypes = AssociateOriginationIdentityCommandInput | AssociateProtectConfigurationCommandInput | CarrierLookupCommandInput | CreateConfigurationSetCommandInput | CreateEventDestinationCommandInput | CreateOptOutListCommandInput | CreatePoolCommandInput | CreateProtectConfigurationCommandInput | CreateRegistrationAssociationCommandInput | CreateRegistrationAttachmentCommandInput | CreateRegistrationCommandInput | CreateRegistrationVersionCommandInput | CreateVerifiedDestinationNumberCommandInput | DeleteAccountDefaultProtectConfigurationCommandInput | DeleteConfigurationSetCommandInput | DeleteDefaultMessageTypeCommandInput | DeleteDefaultSenderIdCommandInput | DeleteEventDestinationCommandInput | DeleteKeywordCommandInput | DeleteMediaMessageSpendLimitOverrideCommandInput | DeleteOptOutListCommandInput | DeleteOptedOutNumberCommandInput | DeletePoolCommandInput | DeleteProtectConfigurationCommandInput | DeleteProtectConfigurationRuleSetNumberOverrideCommandInput | DeleteRegistrationAttachmentCommandInput | DeleteRegistrationCommandInput | DeleteRegistrationFieldValueCommandInput | DeleteResourcePolicyCommandInput | DeleteTextMessageSpendLimitOverrideCommandInput | DeleteVerifiedDestinationNumberCommandInput | DeleteVoiceMessageSpendLimitOverrideCommandInput | DescribeAccountAttributesCommandInput | DescribeAccountLimitsCommandInput | DescribeConfigurationSetsCommandInput | DescribeKeywordsCommandInput | DescribeOptOutListsCommandInput | DescribeOptedOutNumbersCommandInput | DescribePhoneNumbersCommandInput | DescribePoolsCommandInput | DescribeProtectConfigurationsCommandInput | DescribeRegistrationAttachmentsCommandInput | DescribeRegistrationFieldDefinitionsCommandInput | DescribeRegistrationFieldValuesCommandInput | DescribeRegistrationSectionDefinitionsCommandInput | DescribeRegistrationTypeDefinitionsCommandInput | DescribeRegistrationVersionsCommandInput | DescribeRegistrationsCommandInput | DescribeSenderIdsCommandInput | DescribeSpendLimitsCommandInput | DescribeVerifiedDestinationNumbersCommandInput | DisassociateOriginationIdentityCommandInput | DisassociateProtectConfigurationCommandInput | DiscardRegistrationVersionCommandInput | GetProtectConfigurationCountryRuleSetCommandInput | GetResourcePolicyCommandInput | ListPoolOriginationIdentitiesCommandInput | ListProtectConfigurationRuleSetNumberOverridesCommandInput | ListRegistrationAssociationsCommandInput | ListTagsForResourceCommandInput | PutKeywordCommandInput | PutMessageFeedbackCommandInput | PutOptedOutNumberCommandInput | PutProtectConfigurationRuleSetNumberOverrideCommandInput | PutRegistrationFieldValueCommandInput | PutResourcePolicyCommandInput | ReleasePhoneNumberCommandInput | ReleaseSenderIdCommandInput | RequestPhoneNumberCommandInput | RequestSenderIdCommandInput | SendDestinationNumberVerificationCodeCommandInput | SendMediaMessageCommandInput | SendTextMessageCommandInput | SendVoiceMessageCommandInput | SetAccountDefaultProtectConfigurationCommandInput | SetDefaultMessageFeedbackEnabledCommandInput | SetDefaultMessageTypeCommandInput | SetDefaultSenderIdCommandInput | SetMediaMessageSpendLimitOverrideCommandInput | SetTextMessageSpendLimitOverrideCommandInput | SetVoiceMessageSpendLimitOverrideCommandInput | SubmitRegistrationVersionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEventDestinationCommandInput | UpdatePhoneNumberCommandInput | UpdatePoolCommandInput | UpdateProtectConfigurationCommandInput | UpdateProtectConfigurationCountryRuleSetCommandInput | UpdateSenderIdCommandInput | VerifyDestinationNumberCommandInput;
|
|
107
108
|
/**
|
|
108
109
|
* @public
|
|
109
110
|
*/
|
|
110
|
-
export type ServiceOutputTypes = AssociateOriginationIdentityCommandOutput | AssociateProtectConfigurationCommandOutput | CreateConfigurationSetCommandOutput | CreateEventDestinationCommandOutput | CreateOptOutListCommandOutput | CreatePoolCommandOutput | CreateProtectConfigurationCommandOutput | CreateRegistrationAssociationCommandOutput | CreateRegistrationAttachmentCommandOutput | CreateRegistrationCommandOutput | CreateRegistrationVersionCommandOutput | CreateVerifiedDestinationNumberCommandOutput | DeleteAccountDefaultProtectConfigurationCommandOutput | DeleteConfigurationSetCommandOutput | DeleteDefaultMessageTypeCommandOutput | DeleteDefaultSenderIdCommandOutput | DeleteEventDestinationCommandOutput | DeleteKeywordCommandOutput | DeleteMediaMessageSpendLimitOverrideCommandOutput | DeleteOptOutListCommandOutput | DeleteOptedOutNumberCommandOutput | DeletePoolCommandOutput | DeleteProtectConfigurationCommandOutput | DeleteProtectConfigurationRuleSetNumberOverrideCommandOutput | DeleteRegistrationAttachmentCommandOutput | DeleteRegistrationCommandOutput | DeleteRegistrationFieldValueCommandOutput | DeleteResourcePolicyCommandOutput | DeleteTextMessageSpendLimitOverrideCommandOutput | DeleteVerifiedDestinationNumberCommandOutput | DeleteVoiceMessageSpendLimitOverrideCommandOutput | DescribeAccountAttributesCommandOutput | DescribeAccountLimitsCommandOutput | DescribeConfigurationSetsCommandOutput | DescribeKeywordsCommandOutput | DescribeOptOutListsCommandOutput | DescribeOptedOutNumbersCommandOutput | DescribePhoneNumbersCommandOutput | DescribePoolsCommandOutput | DescribeProtectConfigurationsCommandOutput | DescribeRegistrationAttachmentsCommandOutput | DescribeRegistrationFieldDefinitionsCommandOutput | DescribeRegistrationFieldValuesCommandOutput | DescribeRegistrationSectionDefinitionsCommandOutput | DescribeRegistrationTypeDefinitionsCommandOutput | DescribeRegistrationVersionsCommandOutput | DescribeRegistrationsCommandOutput | DescribeSenderIdsCommandOutput | DescribeSpendLimitsCommandOutput | DescribeVerifiedDestinationNumbersCommandOutput | DisassociateOriginationIdentityCommandOutput | DisassociateProtectConfigurationCommandOutput | DiscardRegistrationVersionCommandOutput | GetProtectConfigurationCountryRuleSetCommandOutput | GetResourcePolicyCommandOutput | ListPoolOriginationIdentitiesCommandOutput | ListProtectConfigurationRuleSetNumberOverridesCommandOutput | ListRegistrationAssociationsCommandOutput | ListTagsForResourceCommandOutput | PutKeywordCommandOutput | PutMessageFeedbackCommandOutput | PutOptedOutNumberCommandOutput | PutProtectConfigurationRuleSetNumberOverrideCommandOutput | PutRegistrationFieldValueCommandOutput | PutResourcePolicyCommandOutput | ReleasePhoneNumberCommandOutput | ReleaseSenderIdCommandOutput | RequestPhoneNumberCommandOutput | RequestSenderIdCommandOutput | SendDestinationNumberVerificationCodeCommandOutput | SendMediaMessageCommandOutput | SendTextMessageCommandOutput | SendVoiceMessageCommandOutput | SetAccountDefaultProtectConfigurationCommandOutput | SetDefaultMessageFeedbackEnabledCommandOutput | SetDefaultMessageTypeCommandOutput | SetDefaultSenderIdCommandOutput | SetMediaMessageSpendLimitOverrideCommandOutput | SetTextMessageSpendLimitOverrideCommandOutput | SetVoiceMessageSpendLimitOverrideCommandOutput | SubmitRegistrationVersionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEventDestinationCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePoolCommandOutput | UpdateProtectConfigurationCommandOutput | UpdateProtectConfigurationCountryRuleSetCommandOutput | UpdateSenderIdCommandOutput | VerifyDestinationNumberCommandOutput;
|
|
111
|
+
export type ServiceOutputTypes = AssociateOriginationIdentityCommandOutput | AssociateProtectConfigurationCommandOutput | CarrierLookupCommandOutput | CreateConfigurationSetCommandOutput | CreateEventDestinationCommandOutput | CreateOptOutListCommandOutput | CreatePoolCommandOutput | CreateProtectConfigurationCommandOutput | CreateRegistrationAssociationCommandOutput | CreateRegistrationAttachmentCommandOutput | CreateRegistrationCommandOutput | CreateRegistrationVersionCommandOutput | CreateVerifiedDestinationNumberCommandOutput | DeleteAccountDefaultProtectConfigurationCommandOutput | DeleteConfigurationSetCommandOutput | DeleteDefaultMessageTypeCommandOutput | DeleteDefaultSenderIdCommandOutput | DeleteEventDestinationCommandOutput | DeleteKeywordCommandOutput | DeleteMediaMessageSpendLimitOverrideCommandOutput | DeleteOptOutListCommandOutput | DeleteOptedOutNumberCommandOutput | DeletePoolCommandOutput | DeleteProtectConfigurationCommandOutput | DeleteProtectConfigurationRuleSetNumberOverrideCommandOutput | DeleteRegistrationAttachmentCommandOutput | DeleteRegistrationCommandOutput | DeleteRegistrationFieldValueCommandOutput | DeleteResourcePolicyCommandOutput | DeleteTextMessageSpendLimitOverrideCommandOutput | DeleteVerifiedDestinationNumberCommandOutput | DeleteVoiceMessageSpendLimitOverrideCommandOutput | DescribeAccountAttributesCommandOutput | DescribeAccountLimitsCommandOutput | DescribeConfigurationSetsCommandOutput | DescribeKeywordsCommandOutput | DescribeOptOutListsCommandOutput | DescribeOptedOutNumbersCommandOutput | DescribePhoneNumbersCommandOutput | DescribePoolsCommandOutput | DescribeProtectConfigurationsCommandOutput | DescribeRegistrationAttachmentsCommandOutput | DescribeRegistrationFieldDefinitionsCommandOutput | DescribeRegistrationFieldValuesCommandOutput | DescribeRegistrationSectionDefinitionsCommandOutput | DescribeRegistrationTypeDefinitionsCommandOutput | DescribeRegistrationVersionsCommandOutput | DescribeRegistrationsCommandOutput | DescribeSenderIdsCommandOutput | DescribeSpendLimitsCommandOutput | DescribeVerifiedDestinationNumbersCommandOutput | DisassociateOriginationIdentityCommandOutput | DisassociateProtectConfigurationCommandOutput | DiscardRegistrationVersionCommandOutput | GetProtectConfigurationCountryRuleSetCommandOutput | GetResourcePolicyCommandOutput | ListPoolOriginationIdentitiesCommandOutput | ListProtectConfigurationRuleSetNumberOverridesCommandOutput | ListRegistrationAssociationsCommandOutput | ListTagsForResourceCommandOutput | PutKeywordCommandOutput | PutMessageFeedbackCommandOutput | PutOptedOutNumberCommandOutput | PutProtectConfigurationRuleSetNumberOverrideCommandOutput | PutRegistrationFieldValueCommandOutput | PutResourcePolicyCommandOutput | ReleasePhoneNumberCommandOutput | ReleaseSenderIdCommandOutput | RequestPhoneNumberCommandOutput | RequestSenderIdCommandOutput | SendDestinationNumberVerificationCodeCommandOutput | SendMediaMessageCommandOutput | SendTextMessageCommandOutput | SendVoiceMessageCommandOutput | SetAccountDefaultProtectConfigurationCommandOutput | SetDefaultMessageFeedbackEnabledCommandOutput | SetDefaultMessageTypeCommandOutput | SetDefaultSenderIdCommandOutput | SetMediaMessageSpendLimitOverrideCommandOutput | SetTextMessageSpendLimitOverrideCommandOutput | SetVoiceMessageSpendLimitOverrideCommandOutput | SubmitRegistrationVersionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEventDestinationCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePoolCommandOutput | UpdateProtectConfigurationCommandOutput | UpdateProtectConfigurationCountryRuleSetCommandOutput | UpdateSenderIdCommandOutput | VerifyDestinationNumberCommandOutput;
|
|
111
112
|
/**
|
|
112
113
|
* @public
|
|
113
114
|
*/
|
|
@@ -259,7 +260,7 @@ export type PinpointSMSVoiceV2ClientResolvedConfigType = __SmithyResolvedConfigu
|
|
|
259
260
|
export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoiceV2ClientResolvedConfigType {
|
|
260
261
|
}
|
|
261
262
|
/**
|
|
262
|
-
* <p>Welcome to the <i>
|
|
263
|
+
* <p>Welcome to the <i>End User MessagingSMS, version 2 API Reference</i>. This guide provides information about End User MessagingSMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.</p> <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User MessagingSMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User MessagingSMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p> <p>If you're new to End User MessagingSMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> End User MessagingSMS User Guide</a>, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User MessagingSMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User MessagingSMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.</p> <p> <b>Regional availability</b> </p> <p>The <i>End User MessagingSMS version 2 API Reference</i> is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see <a href="https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region">Amazon Web Services Service Endpoints</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/pinpoint.html">Amazon Pinpoint endpoints and quotas</a> in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing Amazon Web Services Regions</a> in the Amazon Web Services General Reference.</p> <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see <a href="http://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
263
264
|
* @public
|
|
264
265
|
*/
|
|
265
266
|
export declare class PinpointSMSVoiceV2Client extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
@@ -26,7 +26,7 @@ export interface PinpointSMSVoiceV2HttpAuthSchemeProvider extends HttpAuthScheme
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const defaultPinpointSMSVoiceV2HttpAuthSchemeProvider: PinpointSMSVoiceV2HttpAuthSchemeProvider;
|
|
28
28
|
/**
|
|
29
|
-
* @
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
|
|
32
32
|
/**
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CarrierLookupRequest, CarrierLookupResult } from "../models/models_0";
|
|
4
|
+
import { PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceV2Client";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CarrierLookupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CarrierLookupCommandInput extends CarrierLookupRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CarrierLookupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CarrierLookupCommandOutput extends CarrierLookupResult, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CarrierLookupCommand_base: {
|
|
25
|
+
new (input: CarrierLookupCommandInput): import("@smithy/smithy-client").CommandImpl<CarrierLookupCommandInput, CarrierLookupCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CarrierLookupCommandInput): import("@smithy/smithy-client").CommandImpl<CarrierLookupCommandInput, CarrierLookupCommandOutput, PinpointSMSVoiceV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns information about a destination phone number, including whether the number type and whether it is valid, the carrier, and more.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { PinpointSMSVoiceV2Client, CarrierLookupCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2"; // ES Modules import
|
|
35
|
+
* // const { PinpointSMSVoiceV2Client, CarrierLookupCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2"); // CommonJS import
|
|
36
|
+
* // import type { PinpointSMSVoiceV2ClientConfig } from "@aws-sdk/client-pinpoint-sms-voice-v2";
|
|
37
|
+
* const config = {}; // type is PinpointSMSVoiceV2ClientConfig
|
|
38
|
+
* const client = new PinpointSMSVoiceV2Client(config);
|
|
39
|
+
* const input = { // CarrierLookupRequest
|
|
40
|
+
* PhoneNumber: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new CarrierLookupCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // CarrierLookupResult
|
|
45
|
+
* // E164PhoneNumber: "STRING_VALUE", // required
|
|
46
|
+
* // DialingCountryCode: "STRING_VALUE",
|
|
47
|
+
* // IsoCountryCode: "STRING_VALUE",
|
|
48
|
+
* // Country: "STRING_VALUE",
|
|
49
|
+
* // MCC: "STRING_VALUE",
|
|
50
|
+
* // MNC: "STRING_VALUE",
|
|
51
|
+
* // Carrier: "STRING_VALUE",
|
|
52
|
+
* // PhoneNumberType: "STRING_VALUE", // required
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param CarrierLookupCommandInput - {@link CarrierLookupCommandInput}
|
|
58
|
+
* @returns {@link CarrierLookupCommandOutput}
|
|
59
|
+
* @see {@link CarrierLookupCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link CarrierLookupCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
70
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* <p>A validation exception for a field.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link PinpointSMSVoiceV2ServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from PinpointSMSVoiceV2 service.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @example Use CarrierLookup
|
|
83
|
+
* ```javascript
|
|
84
|
+
* // Call the CarrierLookup operation to get information about a customer provided phone number, including if the number is valid. The service accepts phone numbers with various formatting characters and returns the number in E164 format.
|
|
85
|
+
* const input = {
|
|
86
|
+
* PhoneNumber: "+1 (555) 555-5333"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new CarrierLookupCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response is
|
|
91
|
+
* {
|
|
92
|
+
* Carrier: "ExampleCorp Mobile",
|
|
93
|
+
* Country: "United States",
|
|
94
|
+
* DialingCountryCode: "1",
|
|
95
|
+
* E164PhoneNumber: "+15555555333",
|
|
96
|
+
* IsoCountryCode: "US",
|
|
97
|
+
* MCC: "310",
|
|
98
|
+
* MNC: "260",
|
|
99
|
+
* PhoneNumberType: "MOBILE"
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export declare class CarrierLookupCommand extends CarrierLookupCommand_base {
|
|
107
|
+
/** @internal type navigation helper, not in runtime. */
|
|
108
|
+
protected static __types: {
|
|
109
|
+
api: {
|
|
110
|
+
input: CarrierLookupRequest;
|
|
111
|
+
output: CarrierLookupResult;
|
|
112
|
+
};
|
|
113
|
+
sdk: {
|
|
114
|
+
input: CarrierLookupCommandInput;
|
|
115
|
+
output: CarrierLookupCommandOutput;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
}
|
|
@@ -27,7 +27,7 @@ declare const CreateOptOutListCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new opt-out list.</p> <p>If the opt-out list name already exists, an error is returned.</p> <p>An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout"> SMS opt out </a> in the
|
|
30
|
+
* <p>Creates a new opt-out list.</p> <p>If the opt-out list name already exists, an error is returned.</p> <p>An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout"> SMS opt out </a> in the End User MessagingSMS User Guide.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteKeywordCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an existing keyword from an origination phone number or pool.</p> <p>A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword,
|
|
30
|
+
* <p>Deletes an existing keyword from an origination phone number or pool.</p> <p>A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User MessagingSMS responds with a customizable message.</p> <p>Keywords "HELP" and "STOP" can't be deleted or modified.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the resource-based policy document attached to the
|
|
30
|
+
* <p>Deletes the resource-based policy document attached to the End User MessagingSMS resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteTextMessageSpendLimitOverrideCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the <code>EnforcedLimit</code> to equal the <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a> in the <i>
|
|
30
|
+
* <p>Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the <code>EnforcedLimit</code> to equal the <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a> in the <i>End User MessagingSMS User Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteVoiceMessageSpendLimitOverrideCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the <code>EnforcedLimit</code> equal to the <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a> in the <i>
|
|
30
|
+
* <p>Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the <code>EnforcedLimit</code> equal to the <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a> in the <i>End User MessagingSMS User Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DescribeAccountLimitsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the current
|
|
30
|
+
* <p>Describes the current End User MessagingSMS SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.</p> <p>When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a> in the <i>End User MessagingSMS User Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DescribeKeywordsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the specified keywords or all keywords on your origination phone number or pool.</p> <p>A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword,
|
|
30
|
+
* <p>Describes the specified keywords or all keywords on your origination phone number or pool.</p> <p>A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User MessagingSMS responds with a customizable message.</p> <p>If you specify a keyword that isn't valid, an error is returned.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DescribeSpendLimitsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the current monthly spend limits for sending voice and text messages.</p> <p>When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html"> Requesting increases to your monthly SMS, MMS, or Voice spending quota </a> in the <i>
|
|
30
|
+
* <p>Describes the current monthly spend limits for sending voice and text messages.</p> <p>When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html"> Requesting increases to your monthly SMS, MMS, or Voice spending quota </a> in the <i>End User MessagingSMS User Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the JSON text of the resource-based policy document attached to the
|
|
30
|
+
* <p>Retrieves the JSON text of the resource-based policy document attached to the End User MessagingSMS resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const PutKeywordCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a keyword configuration on an origination phone number or pool.</p> <p> A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword,
|
|
30
|
+
* <p>Creates or updates a keyword configuration on an origination phone number or pool.</p> <p> A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User MessagingSMS responds with a customizable message.</p> <p>If you specify a keyword that isn't valid, an error is returned.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Attaches a resource-based policy to a
|
|
30
|
+
* <p>Attaches a resource-based policy to a End User MessagingSMS resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html">Working with shared resources</a> in the <i>End User MessagingSMS User Guide</i>. </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const RequestPhoneNumberCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Request an origination phone number for use in your account. For more information on phone number request see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html">Request a phone number</a> in the <i>
|
|
30
|
+
* <p>Request an origination phone number for use in your account. For more information on phone number request see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html">Request a phone number</a> in the <i>End User MessagingSMS User Guide</i>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|