@aws-sdk/client-pinpoint-sms-voice-v2 3.798.0 → 3.799.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 +1 -33
- package/dist-cjs/index.js +3 -1
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/PinpointSMSVoiceV2.d.ts +1 -33
- package/dist-types/PinpointSMSVoiceV2Client.d.ts +1 -33
- package/dist-types/commands/AssociateOriginationIdentityCommand.d.ts +5 -15
- package/dist-types/commands/AssociateProtectConfigurationCommand.d.ts +5 -14
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +5 -15
- package/dist-types/commands/CreateEventDestinationCommand.d.ts +5 -19
- package/dist-types/commands/CreateOptOutListCommand.d.ts +5 -18
- package/dist-types/commands/CreatePoolCommand.d.ts +5 -19
- package/dist-types/commands/CreateProtectConfigurationCommand.d.ts +6 -6
- package/dist-types/commands/CreateRegistrationAssociationCommand.d.ts +4 -10
- package/dist-types/commands/CreateRegistrationAttachmentCommand.d.ts +5 -15
- package/dist-types/commands/CreateRegistrationCommand.d.ts +4 -10
- package/dist-types/commands/CreateRegistrationVersionCommand.d.ts +4 -10
- package/dist-types/commands/CreateVerifiedDestinationNumberCommand.d.ts +5 -12
- package/dist-types/commands/DeleteAccountDefaultProtectConfigurationCommand.d.ts +3 -6
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +4 -10
- package/dist-types/commands/DeleteDefaultMessageTypeCommand.d.ts +4 -12
- package/dist-types/commands/DeleteDefaultSenderIdCommand.d.ts +4 -10
- package/dist-types/commands/DeleteEventDestinationCommand.d.ts +4 -11
- package/dist-types/commands/DeleteKeywordCommand.d.ts +5 -17
- package/dist-types/commands/DeleteMediaMessageSpendLimitOverrideCommand.d.ts +4 -11
- package/dist-types/commands/DeleteOptOutListCommand.d.ts +5 -14
- package/dist-types/commands/DeleteOptedOutNumberCommand.d.ts +5 -15
- package/dist-types/commands/DeletePoolCommand.d.ts +5 -17
- package/dist-types/commands/DeleteProtectConfigurationCommand.d.ts +4 -10
- package/dist-types/commands/DeleteProtectConfigurationRuleSetNumberOverrideCommand.d.ts +3 -6
- package/dist-types/commands/DeleteRegistrationAttachmentCommand.d.ts +4 -10
- package/dist-types/commands/DeleteRegistrationCommand.d.ts +4 -10
- package/dist-types/commands/DeleteRegistrationFieldValueCommand.d.ts +4 -10
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +3 -6
- package/dist-types/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +4 -11
- package/dist-types/commands/DeleteVerifiedDestinationNumberCommand.d.ts +4 -10
- package/dist-types/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +4 -11
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +4 -13
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +4 -13
- package/dist-types/commands/DescribeConfigurationSetsCommand.d.ts +4 -13
- package/dist-types/commands/DescribeKeywordsCommand.d.ts +4 -14
- package/dist-types/commands/DescribeOptOutListsCommand.d.ts +4 -12
- package/dist-types/commands/DescribeOptedOutNumbersCommand.d.ts +4 -14
- package/dist-types/commands/DescribePhoneNumbersCommand.d.ts +4 -13
- package/dist-types/commands/DescribePoolsCommand.d.ts +4 -16
- package/dist-types/commands/DescribeProtectConfigurationsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationAttachmentsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationFieldDefinitionsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationFieldValuesCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationSectionDefinitionsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationTypeDefinitionsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationVersionsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeRegistrationsCommand.d.ts +3 -6
- package/dist-types/commands/DescribeSenderIdsCommand.d.ts +4 -12
- package/dist-types/commands/DescribeSpendLimitsCommand.d.ts +4 -13
- package/dist-types/commands/DescribeVerifiedDestinationNumbersCommand.d.ts +3 -6
- package/dist-types/commands/DisassociateOriginationIdentityCommand.d.ts +5 -13
- package/dist-types/commands/DisassociateProtectConfigurationCommand.d.ts +4 -10
- package/dist-types/commands/DiscardRegistrationVersionCommand.d.ts +4 -10
- package/dist-types/commands/GetProtectConfigurationCountryRuleSetCommand.d.ts +3 -6
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +3 -6
- package/dist-types/commands/ListPoolOriginationIdentitiesCommand.d.ts +4 -9
- package/dist-types/commands/ListProtectConfigurationRuleSetNumberOverridesCommand.d.ts +3 -6
- package/dist-types/commands/ListRegistrationAssociationsCommand.d.ts +3 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -6
- package/dist-types/commands/PutKeywordCommand.d.ts +5 -18
- package/dist-types/commands/PutMessageFeedbackCommand.d.ts +4 -12
- package/dist-types/commands/PutOptedOutNumberCommand.d.ts +4 -9
- package/dist-types/commands/PutProtectConfigurationRuleSetNumberOverrideCommand.d.ts +5 -11
- package/dist-types/commands/PutRegistrationFieldValueCommand.d.ts +4 -10
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +4 -9
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +5 -14
- package/dist-types/commands/ReleaseSenderIdCommand.d.ts +4 -10
- package/dist-types/commands/RequestPhoneNumberCommand.d.ts +5 -12
- package/dist-types/commands/RequestSenderIdCommand.d.ts +4 -10
- package/dist-types/commands/SendDestinationNumberVerificationCodeCommand.d.ts +5 -13
- package/dist-types/commands/SendMediaMessageCommand.d.ts +4 -10
- package/dist-types/commands/SendTextMessageCommand.d.ts +5 -15
- package/dist-types/commands/SendVoiceMessageCommand.d.ts +5 -13
- package/dist-types/commands/SetAccountDefaultProtectConfigurationCommand.d.ts +4 -8
- package/dist-types/commands/SetDefaultMessageFeedbackEnabledCommand.d.ts +3 -6
- package/dist-types/commands/SetDefaultMessageTypeCommand.d.ts +4 -12
- package/dist-types/commands/SetDefaultSenderIdCommand.d.ts +4 -10
- package/dist-types/commands/SetMediaMessageSpendLimitOverrideCommand.d.ts +4 -9
- package/dist-types/commands/SetTextMessageSpendLimitOverrideCommand.d.ts +4 -9
- package/dist-types/commands/SetVoiceMessageSpendLimitOverrideCommand.d.ts +4 -9
- package/dist-types/commands/SubmitRegistrationVersionCommand.d.ts +4 -10
- package/dist-types/commands/TagResourceCommand.d.ts +4 -10
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -8
- package/dist-types/commands/UpdateEventDestinationCommand.d.ts +5 -16
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +5 -15
- package/dist-types/commands/UpdatePoolCommand.d.ts +5 -14
- package/dist-types/commands/UpdateProtectConfigurationCommand.d.ts +3 -6
- package/dist-types/commands/UpdateProtectConfigurationCountryRuleSetCommand.d.ts +4 -7
- package/dist-types/commands/UpdateSenderIdCommand.d.ts +3 -6
- package/dist-types/commands/VerifyDestinationNumberCommand.d.ts +4 -10
- package/dist-types/index.d.ts +1 -33
- package/dist-types/models/models_0.d.ts +253 -1104
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,39 +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>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
10
|
-
This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
11
|
-
resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
12
|
-
<p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
13
|
-
your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS
|
|
14
|
-
and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p>
|
|
15
|
-
<p>If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
|
|
16
|
-
AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
17
|
-
</i> provides tutorials, code samples, and procedures that
|
|
18
|
-
demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
19
|
-
functionality into mobile apps and other types of applications.
|
|
20
|
-
The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
21
|
-
other Amazon Web Services services, and the quotas that apply to use of the
|
|
22
|
-
service.</p>
|
|
23
|
-
<p>
|
|
24
|
-
<b>Regional availability</b>
|
|
25
|
-
</p>
|
|
26
|
-
<p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
27
|
-
available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
28
|
-
these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
29
|
-
available, see <a href="https://docs.aws.amazon.com/general/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
|
|
30
|
-
endpoints and quotas</a> in the Amazon Web Services General Reference. To
|
|
31
|
-
learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing
|
|
32
|
-
Amazon Web Services Regions</a> in the Amazon Web Services General
|
|
33
|
-
Reference.</p>
|
|
34
|
-
<p>In each Region, Amazon Web Services maintains multiple Availability Zones. These
|
|
35
|
-
Availability Zones are physically isolated from each other, but are united by private,
|
|
36
|
-
low-latency, high-throughput, and highly redundant network connections. These
|
|
37
|
-
Availability Zones enable us to provide very high levels of availability and redundancy,
|
|
38
|
-
while also minimizing latency. To learn more about the number of Availability Zones that
|
|
39
|
-
are available in each Region, see <a href="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services
|
|
40
|
-
Global Infrastructure.</a>
|
|
41
|
-
</p>
|
|
9
|
+
<p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>. This guide provides information about AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide </i> provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice 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>AWS End User Messaging SMS and Voice 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/general/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="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
42
10
|
|
|
43
11
|
## Installing
|
|
44
12
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -29,6 +29,7 @@ const getRuntimeConfig = (config) => {
|
|
|
29
29
|
...config,
|
|
30
30
|
runtime: "node",
|
|
31
31
|
defaultsMode,
|
|
32
|
+
authSchemePreference: config?.authSchemePreference ?? (0, node_config_provider_1.loadConfig)(core_1.NODE_AUTH_SCHEME_PREFERENCE_OPTIONS, profileConfig),
|
|
32
33
|
bodyLengthChecker: config?.bodyLengthChecker ?? util_body_length_node_1.calculateBodyLength,
|
|
33
34
|
credentialDefaultProvider: config?.credentialDefaultProvider ?? credential_provider_node_1.defaultProvider,
|
|
34
35
|
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
package/dist-es/runtimeConfig.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import packageInfo from "../package.json";
|
|
2
|
-
import { emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
|
|
2
|
+
import { NODE_AUTH_SCHEME_PREFERENCE_OPTIONS, emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
|
|
3
3
|
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
|
|
4
4
|
import { NODE_APP_ID_CONFIG_OPTIONS, createDefaultUserAgentProvider } from "@aws-sdk/util-user-agent-node";
|
|
5
5
|
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
|
|
@@ -25,6 +25,7 @@ export const getRuntimeConfig = (config) => {
|
|
|
25
25
|
...config,
|
|
26
26
|
runtime: "node",
|
|
27
27
|
defaultsMode,
|
|
28
|
+
authSchemePreference: config?.authSchemePreference ?? loadNodeConfig(NODE_AUTH_SCHEME_PREFERENCE_OPTIONS, profileConfig),
|
|
28
29
|
bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
|
|
29
30
|
credentialDefaultProvider: config?.credentialDefaultProvider ?? credentialDefaultProvider,
|
|
30
31
|
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
|
@@ -652,39 +652,7 @@ export interface PinpointSMSVoiceV2 {
|
|
|
652
652
|
verifyDestinationNumber(args: VerifyDestinationNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyDestinationNumberCommandOutput) => void): void;
|
|
653
653
|
}
|
|
654
654
|
/**
|
|
655
|
-
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
656
|
-
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
657
|
-
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
658
|
-
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
659
|
-
* your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS
|
|
660
|
-
* and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p>
|
|
661
|
-
* <p>If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
|
|
662
|
-
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
663
|
-
* </i> provides tutorials, code samples, and procedures that
|
|
664
|
-
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
665
|
-
* functionality into mobile apps and other types of applications.
|
|
666
|
-
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
667
|
-
* other Amazon Web Services services, and the quotas that apply to use of the
|
|
668
|
-
* service.</p>
|
|
669
|
-
* <p>
|
|
670
|
-
* <b>Regional availability</b>
|
|
671
|
-
* </p>
|
|
672
|
-
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
673
|
-
* available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
674
|
-
* these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
675
|
-
* available, see <a href="https://docs.aws.amazon.com/general/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
|
|
676
|
-
* endpoints and quotas</a> in the Amazon Web Services General Reference. To
|
|
677
|
-
* learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing
|
|
678
|
-
* Amazon Web Services Regions</a> in the Amazon Web Services General
|
|
679
|
-
* Reference.</p>
|
|
680
|
-
* <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These
|
|
681
|
-
* Availability Zones are physically isolated from each other, but are united by private,
|
|
682
|
-
* low-latency, high-throughput, and highly redundant network connections. These
|
|
683
|
-
* Availability Zones enable us to provide very high levels of availability and redundancy,
|
|
684
|
-
* while also minimizing latency. To learn more about the number of Availability Zones that
|
|
685
|
-
* are available in each Region, see <a href="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services
|
|
686
|
-
* Global Infrastructure.</a>
|
|
687
|
-
* </p>
|
|
655
|
+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>. This guide provides information about AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide </i> provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice 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>AWS End User Messaging SMS and Voice 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/general/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="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
688
656
|
* @public
|
|
689
657
|
*/
|
|
690
658
|
export declare class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client implements PinpointSMSVoiceV2 {
|
|
@@ -259,39 +259,7 @@ export type PinpointSMSVoiceV2ClientResolvedConfigType = __SmithyResolvedConfigu
|
|
|
259
259
|
export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoiceV2ClientResolvedConfigType {
|
|
260
260
|
}
|
|
261
261
|
/**
|
|
262
|
-
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
263
|
-
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
264
|
-
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
265
|
-
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
266
|
-
* your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS
|
|
267
|
-
* and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p>
|
|
268
|
-
* <p>If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
|
|
269
|
-
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
270
|
-
* </i> provides tutorials, code samples, and procedures that
|
|
271
|
-
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
272
|
-
* functionality into mobile apps and other types of applications.
|
|
273
|
-
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
274
|
-
* other Amazon Web Services services, and the quotas that apply to use of the
|
|
275
|
-
* service.</p>
|
|
276
|
-
* <p>
|
|
277
|
-
* <b>Regional availability</b>
|
|
278
|
-
* </p>
|
|
279
|
-
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
280
|
-
* available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
281
|
-
* these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
282
|
-
* available, see <a href="https://docs.aws.amazon.com/general/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
|
|
283
|
-
* endpoints and quotas</a> in the Amazon Web Services General Reference. To
|
|
284
|
-
* learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing
|
|
285
|
-
* Amazon Web Services Regions</a> in the Amazon Web Services General
|
|
286
|
-
* Reference.</p>
|
|
287
|
-
* <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These
|
|
288
|
-
* Availability Zones are physically isolated from each other, but are united by private,
|
|
289
|
-
* low-latency, high-throughput, and highly redundant network connections. These
|
|
290
|
-
* Availability Zones enable us to provide very high levels of availability and redundancy,
|
|
291
|
-
* while also minimizing latency. To learn more about the number of Availability Zones that
|
|
292
|
-
* are available in each Region, see <a href="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services
|
|
293
|
-
* Global Infrastructure.</a>
|
|
294
|
-
* </p>
|
|
262
|
+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>. This guide provides information about AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, 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 AWS End User Messaging SMS and Voice, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide </i> provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice 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>AWS End User Messaging SMS and Voice 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/general/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="https://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
|
|
295
263
|
* @public
|
|
296
264
|
*/
|
|
297
265
|
export declare class PinpointSMSVoiceV2Client extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PinpointSMSVoiceV2ClientResolvedConfig> {
|
|
@@ -27,11 +27,7 @@ declare const AssociateOriginationIdentityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associates the specified origination identity with a pool.</p>
|
|
31
|
-
* <p>If the origination identity is a phone number and is already associated with another
|
|
32
|
-
* pool, an error is returned. A sender ID can be associated with multiple pools.</p>
|
|
33
|
-
* <p>If the origination identity configuration doesn't match the pool's configuration, an
|
|
34
|
-
* error is returned.</p>
|
|
30
|
+
* <p>Associates the specified origination identity with a pool.</p> <p>If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.</p> <p>If the origination identity configuration doesn't match the pool's configuration, an error is returned.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -63,18 +59,13 @@ declare const AssociateOriginationIdentityCommand_base: {
|
|
|
63
59
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
64
60
|
*
|
|
65
61
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
67
|
-
* resource.</p>
|
|
62
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
68
63
|
*
|
|
69
64
|
* @throws {@link ConflictException} (client fault)
|
|
70
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
71
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
72
|
-
* requested action isn't valid for the current state or configuration of the
|
|
73
|
-
* resource.</p>
|
|
65
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
74
66
|
*
|
|
75
67
|
* @throws {@link InternalServerException} (server fault)
|
|
76
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
77
|
-
* be able to successfully issue the request again in the future.</p>
|
|
68
|
+
* <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>
|
|
78
69
|
*
|
|
79
70
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
71
|
* <p>A requested resource couldn't be found.</p>
|
|
@@ -83,8 +74,7 @@ declare const AssociateOriginationIdentityCommand_base: {
|
|
|
83
74
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
84
75
|
*
|
|
85
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
87
|
-
* time.</p>
|
|
77
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
88
78
|
*
|
|
89
79
|
* @throws {@link ValidationException} (client fault)
|
|
90
80
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,10 +27,7 @@ declare const AssociateProtectConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associate a protect configuration with a configuration set. This replaces the
|
|
31
|
-
* configuration sets current protect configuration. A configuration set can
|
|
32
|
-
* only be associated with one protect configuration at a time. A protect configuration can
|
|
33
|
-
* be associated with multiple configuration sets.</p>
|
|
30
|
+
* <p>Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -59,25 +56,19 @@ declare const AssociateProtectConfigurationCommand_base: {
|
|
|
59
56
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
60
57
|
*
|
|
61
58
|
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
63
|
-
* resource.</p>
|
|
59
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
64
60
|
*
|
|
65
61
|
* @throws {@link ConflictException} (client fault)
|
|
66
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
67
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
68
|
-
* requested action isn't valid for the current state or configuration of the
|
|
69
|
-
* resource.</p>
|
|
62
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
70
63
|
*
|
|
71
64
|
* @throws {@link InternalServerException} (server fault)
|
|
72
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
73
|
-
* be able to successfully issue the request again in the future.</p>
|
|
65
|
+
* <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>
|
|
74
66
|
*
|
|
75
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
68
|
* <p>A requested resource couldn't be found.</p>
|
|
77
69
|
*
|
|
78
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
80
|
-
* time.</p>
|
|
71
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
81
72
|
*
|
|
82
73
|
* @throws {@link ValidationException} (client fault)
|
|
83
74
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,11 +27,7 @@ declare const CreateConfigurationSetCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new configuration set. After you create the configuration set, you can add
|
|
31
|
-
* one or more event destinations to it.</p>
|
|
32
|
-
* <p>A configuration set is a set of rules that you apply to the SMS and voice messages
|
|
33
|
-
* that you send.</p>
|
|
34
|
-
* <p>When you send a message, you can optionally specify a single configuration set.</p>
|
|
30
|
+
* <p>Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.</p> <p>A configuration set is a set of rules that you apply to the SMS and voice messages that you send.</p> <p>When you send a message, you can optionally specify a single configuration set.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -71,25 +67,19 @@ declare const CreateConfigurationSetCommand_base: {
|
|
|
71
67
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
72
68
|
*
|
|
73
69
|
* @throws {@link AccessDeniedException} (client fault)
|
|
74
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
75
|
-
* resource.</p>
|
|
70
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
76
71
|
*
|
|
77
72
|
* @throws {@link ConflictException} (client fault)
|
|
78
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
79
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
80
|
-
* requested action isn't valid for the current state or configuration of the
|
|
81
|
-
* resource.</p>
|
|
73
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
82
74
|
*
|
|
83
75
|
* @throws {@link InternalServerException} (server fault)
|
|
84
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
85
|
-
* be able to successfully issue the request again in the future.</p>
|
|
76
|
+
* <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>
|
|
86
77
|
*
|
|
87
78
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
88
79
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
89
80
|
*
|
|
90
81
|
* @throws {@link ThrottlingException} (client fault)
|
|
91
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
92
|
-
* time.</p>
|
|
82
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
93
83
|
*
|
|
94
84
|
* @throws {@link ValidationException} (client fault)
|
|
95
85
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,15 +27,7 @@ declare const CreateEventDestinationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new event destination in a configuration set.</p>
|
|
31
|
-
* <p>An event destination is a location where you send message events. The event options
|
|
32
|
-
* are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,
|
|
33
|
-
* when a message is delivered successfully, you can send information about that event to
|
|
34
|
-
* an event destination, or send notifications to endpoints that are subscribed to an
|
|
35
|
-
* Amazon SNS topic.</p>
|
|
36
|
-
* <p>Each configuration set can contain between 0 and 5 event destinations. Each event
|
|
37
|
-
* destination can contain a reference to a single destination, such as a CloudWatch
|
|
38
|
-
* or Firehose destination.</p>
|
|
30
|
+
* <p>Creates a new event destination in a configuration set.</p> <p>An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. </p> <p>You can only create one event destination at a time. You must provide a value for a single event destination using either <code>CloudWatchLogsDestination</code>, <code>KinesisFirehoseDestination</code> or <code>SnsDestination</code>. If an event destination isn't provided then an exception is returned.</p> <p>Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.</p>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -95,18 +87,13 @@ declare const CreateEventDestinationCommand_base: {
|
|
|
95
87
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
96
88
|
*
|
|
97
89
|
* @throws {@link AccessDeniedException} (client fault)
|
|
98
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
99
|
-
* resource.</p>
|
|
90
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
100
91
|
*
|
|
101
92
|
* @throws {@link ConflictException} (client fault)
|
|
102
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
103
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
104
|
-
* requested action isn't valid for the current state or configuration of the
|
|
105
|
-
* resource.</p>
|
|
93
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
106
94
|
*
|
|
107
95
|
* @throws {@link InternalServerException} (server fault)
|
|
108
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
109
|
-
* be able to successfully issue the request again in the future.</p>
|
|
96
|
+
* <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>
|
|
110
97
|
*
|
|
111
98
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
112
99
|
* <p>A requested resource couldn't be found.</p>
|
|
@@ -115,8 +102,7 @@ declare const CreateEventDestinationCommand_base: {
|
|
|
115
102
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
116
103
|
*
|
|
117
104
|
* @throws {@link ThrottlingException} (client fault)
|
|
118
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
119
|
-
* time.</p>
|
|
105
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
120
106
|
*
|
|
121
107
|
* @throws {@link ValidationException} (client fault)
|
|
122
108
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,14 +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>
|
|
31
|
-
* <p>If the opt-out list name already exists, an error is returned.</p>
|
|
32
|
-
* <p>An opt-out list is a list of phone numbers that are opted out, meaning you can't send
|
|
33
|
-
* SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for
|
|
34
|
-
* the phone number is added to the opt-out list. In addition to STOP, your recipients can
|
|
35
|
-
* use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported
|
|
36
|
-
* opt-out keywords, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout">
|
|
37
|
-
* SMS opt out </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
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 <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -74,25 +67,19 @@ declare const CreateOptOutListCommand_base: {
|
|
|
74
67
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
75
68
|
*
|
|
76
69
|
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
78
|
-
* resource.</p>
|
|
70
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
79
71
|
*
|
|
80
72
|
* @throws {@link ConflictException} (client fault)
|
|
81
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
82
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
83
|
-
* requested action isn't valid for the current state or configuration of the
|
|
84
|
-
* resource.</p>
|
|
73
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
85
74
|
*
|
|
86
75
|
* @throws {@link InternalServerException} (server fault)
|
|
87
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
88
|
-
* be able to successfully issue the request again in the future.</p>
|
|
76
|
+
* <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>
|
|
89
77
|
*
|
|
90
78
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
91
79
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
92
80
|
*
|
|
93
81
|
* @throws {@link ThrottlingException} (client fault)
|
|
94
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
95
|
-
* time.</p>
|
|
82
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
96
83
|
*
|
|
97
84
|
* @throws {@link ValidationException} (client fault)
|
|
98
85
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,15 +27,7 @@ declare const CreatePoolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new pool and associates the specified origination identity to the pool. A
|
|
31
|
-
* pool can include one or more phone numbers and SenderIds that are associated with your
|
|
32
|
-
* Amazon Web Services account.</p>
|
|
33
|
-
* <p>The new pool inherits its configuration from the specified origination identity. This
|
|
34
|
-
* includes keywords, message type, opt-out list, two-way configuration, and self-managed
|
|
35
|
-
* opt-out configuration. Deletion protection isn't inherited from the origination identity
|
|
36
|
-
* and defaults to false.</p>
|
|
37
|
-
* <p>If the origination identity is a phone number and is already associated with another
|
|
38
|
-
* pool, an error is returned. A sender ID can be associated with multiple pools.</p>
|
|
30
|
+
* <p>Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.</p> <p>The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.</p> <p>If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.</p>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -87,18 +79,13 @@ declare const CreatePoolCommand_base: {
|
|
|
87
79
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
88
80
|
*
|
|
89
81
|
* @throws {@link AccessDeniedException} (client fault)
|
|
90
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
91
|
-
* resource.</p>
|
|
82
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
92
83
|
*
|
|
93
84
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
95
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
96
|
-
* requested action isn't valid for the current state or configuration of the
|
|
97
|
-
* resource.</p>
|
|
85
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
98
86
|
*
|
|
99
87
|
* @throws {@link InternalServerException} (server fault)
|
|
100
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
101
|
-
* be able to successfully issue the request again in the future.</p>
|
|
88
|
+
* <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>
|
|
102
89
|
*
|
|
103
90
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
104
91
|
* <p>A requested resource couldn't be found.</p>
|
|
@@ -107,8 +94,7 @@ declare const CreatePoolCommand_base: {
|
|
|
107
94
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
108
95
|
*
|
|
109
96
|
* @throws {@link ThrottlingException} (client fault)
|
|
110
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
111
|
-
* time.</p>
|
|
97
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
112
98
|
*
|
|
113
99
|
* @throws {@link ValidationException} (client fault)
|
|
114
100
|
* <p>A validation exception for a field.</p>
|
|
@@ -69,19 +69,19 @@ declare const CreateProtectConfigurationCommand_base: {
|
|
|
69
69
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
73
|
-
*
|
|
72
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ConflictException} (client fault)
|
|
75
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
74
76
|
*
|
|
75
77
|
* @throws {@link InternalServerException} (server fault)
|
|
76
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
77
|
-
* be able to successfully issue the request again in the future.</p>
|
|
78
|
+
* <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>
|
|
78
79
|
*
|
|
79
80
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
80
81
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
81
82
|
*
|
|
82
83
|
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
84
|
-
* time.</p>
|
|
84
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link ValidationException} (client fault)
|
|
87
87
|
* <p>A validation exception for a field.</p>
|
|
@@ -60,18 +60,13 @@ declare const CreateRegistrationAssociationCommand_base: {
|
|
|
60
60
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
64
|
-
* resource.</p>
|
|
63
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
65
64
|
*
|
|
66
65
|
* @throws {@link ConflictException} (client fault)
|
|
67
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
68
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
69
|
-
* requested action isn't valid for the current state or configuration of the
|
|
70
|
-
* resource.</p>
|
|
66
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
71
67
|
*
|
|
72
68
|
* @throws {@link InternalServerException} (server fault)
|
|
73
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
74
|
-
* be able to successfully issue the request again in the future.</p>
|
|
69
|
+
* <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>
|
|
75
70
|
*
|
|
76
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
72
|
* <p>A requested resource couldn't be found.</p>
|
|
@@ -80,8 +75,7 @@ declare const CreateRegistrationAssociationCommand_base: {
|
|
|
80
75
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
81
76
|
*
|
|
82
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
84
|
-
* time.</p>
|
|
78
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
85
79
|
*
|
|
86
80
|
* @throws {@link ValidationException} (client fault)
|
|
87
81
|
* <p>A validation exception for a field.</p>
|
|
@@ -27,11 +27,7 @@ declare const CreateRegistrationAttachmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Create a new registration attachment to use for uploading a file or a URL to a file.
|
|
31
|
-
* The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For
|
|
32
|
-
* example, many sender ID registrations require a signed “letter of authorization” (LOA)
|
|
33
|
-
* to be submitted.</p>
|
|
34
|
-
* <p>Use either <code>AttachmentUrl</code> or <code>AttachmentBody</code> to upload your attachment. If both are specified then an exception is returned.</p>
|
|
30
|
+
* <p>Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.</p> <p>Use either <code>AttachmentUrl</code> or <code>AttachmentBody</code> to upload your attachment. If both are specified then an exception is returned.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -73,25 +69,19 @@ declare const CreateRegistrationAttachmentCommand_base: {
|
|
|
73
69
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
74
70
|
*
|
|
75
71
|
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
77
|
-
* resource.</p>
|
|
72
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
78
73
|
*
|
|
79
74
|
* @throws {@link ConflictException} (client fault)
|
|
80
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
81
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
82
|
-
* requested action isn't valid for the current state or configuration of the
|
|
83
|
-
* resource.</p>
|
|
75
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
84
76
|
*
|
|
85
77
|
* @throws {@link InternalServerException} (server fault)
|
|
86
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
87
|
-
* be able to successfully issue the request again in the future.</p>
|
|
78
|
+
* <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>
|
|
88
79
|
*
|
|
89
80
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
90
81
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
91
82
|
*
|
|
92
83
|
* @throws {@link ThrottlingException} (client fault)
|
|
93
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
94
|
-
* time.</p>
|
|
84
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
95
85
|
*
|
|
96
86
|
* @throws {@link ValidationException} (client fault)
|
|
97
87
|
* <p>A validation exception for a field.</p>
|
|
@@ -73,25 +73,19 @@ declare const CreateRegistrationCommand_base: {
|
|
|
73
73
|
* @see {@link PinpointSMSVoiceV2ClientResolvedConfig | config} for PinpointSMSVoiceV2Client's `config` shape.
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
-
* <p>The request was denied because you don't have sufficient permissions to access the
|
|
77
|
-
* resource.</p>
|
|
76
|
+
* <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link ConflictException} (client fault)
|
|
80
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform
|
|
81
|
-
* more than one operation on the same resource at the same time or it could be that the
|
|
82
|
-
* requested action isn't valid for the current state or configuration of the
|
|
83
|
-
* resource.</p>
|
|
79
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
|
|
84
80
|
*
|
|
85
81
|
* @throws {@link InternalServerException} (server fault)
|
|
86
|
-
* <p>The API encountered an unexpected error and couldn't complete the request. You might
|
|
87
|
-
* be able to successfully issue the request again in the future.</p>
|
|
82
|
+
* <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>
|
|
88
83
|
*
|
|
89
84
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
90
85
|
* <p>The request would cause a service quota to be exceeded.</p>
|
|
91
86
|
*
|
|
92
87
|
* @throws {@link ThrottlingException} (client fault)
|
|
93
|
-
* <p>An error that occurred because too many requests were sent during a certain amount of
|
|
94
|
-
* time.</p>
|
|
88
|
+
* <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
|
|
95
89
|
*
|
|
96
90
|
* @throws {@link ValidationException} (client fault)
|
|
97
91
|
* <p>A validation exception for a field.</p>
|