@aws-sdk/client-pinpoint-sms-voice-v2 3.616.0 → 3.620.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 +11 -12
- package/dist-types/PinpointSMSVoiceV2.d.ts +11 -12
- package/dist-types/PinpointSMSVoiceV2Client.d.ts +11 -12
- package/dist-types/commands/CreateEventDestinationCommand.d.ts +2 -2
- package/dist-types/commands/CreateOptOutListCommand.d.ts +1 -2
- package/dist-types/commands/DeleteKeywordCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTextMessageSpendLimitOverrideCommand.d.ts +2 -2
- package/dist-types/commands/DeleteVoiceMessageSpendLimitOverrideCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +3 -4
- package/dist-types/commands/DescribeKeywordsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSpendLimitsCommand.d.ts +4 -4
- package/dist-types/commands/PutKeywordCommand.d.ts +1 -1
- package/dist-types/commands/RequestPhoneNumberCommand.d.ts +1 -2
- package/dist-types/commands/SendTextMessageCommand.d.ts +3 -4
- package/dist-types/commands/SendVoiceMessageCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -3
- package/dist-types/commands/UpdateEventDestinationCommand.d.ts +2 -2
- package/dist-types/index.d.ts +11 -12
- package/dist-types/models/models_0.d.ts +57 -33
- package/package.json +18 -18
package/README.md
CHANGED
|
@@ -6,25 +6,24 @@
|
|
|
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>
|
|
10
|
-
This guide provides information about
|
|
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
11
|
resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
12
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
|
|
14
|
-
Voice, version 2
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
The guide also provides key information, such as Amazon Pinpoint integration 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
|
|
22
21
|
other Amazon Web Services services, and the quotas that apply to use of the
|
|
23
22
|
service.</p>
|
|
24
23
|
<p>
|
|
25
24
|
<b>Regional availability</b>
|
|
26
25
|
</p>
|
|
27
|
-
<p>The <i>
|
|
26
|
+
<p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
28
27
|
available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
29
28
|
these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
30
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
|
|
@@ -596,25 +596,24 @@ export interface PinpointSMSVoiceV2 {
|
|
|
596
596
|
verifyDestinationNumber(args: VerifyDestinationNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyDestinationNumberCommandOutput) => void): void;
|
|
597
597
|
}
|
|
598
598
|
/**
|
|
599
|
-
* <p>Welcome to the <i>
|
|
600
|
-
* This guide provides information about
|
|
599
|
+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
600
|
+
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
601
601
|
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
602
602
|
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
603
|
-
* your recipients across multiple messaging channels. The
|
|
604
|
-
* Voice, version 2
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
* The guide also provides key information, such as Amazon Pinpoint integration with
|
|
603
|
+
* 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
|
|
604
|
+
* 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>
|
|
605
|
+
* <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">
|
|
606
|
+
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
607
|
+
* </i> provides tutorials, code samples, and procedures that
|
|
608
|
+
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
609
|
+
* functionality into mobile apps and other types of applications.
|
|
610
|
+
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
612
611
|
* other Amazon Web Services services, and the quotas that apply to use of the
|
|
613
612
|
* service.</p>
|
|
614
613
|
* <p>
|
|
615
614
|
* <b>Regional availability</b>
|
|
616
615
|
* </p>
|
|
617
|
-
* <p>The <i>
|
|
616
|
+
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
618
617
|
* available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
619
618
|
* these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
620
619
|
* 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
|
|
@@ -233,25 +233,24 @@ export type PinpointSMSVoiceV2ClientResolvedConfigType = __SmithyResolvedConfigu
|
|
|
233
233
|
export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoiceV2ClientResolvedConfigType {
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* <p>Welcome to the <i>
|
|
237
|
-
* This guide provides information about
|
|
236
|
+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
237
|
+
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
238
238
|
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
239
239
|
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
240
|
-
* your recipients across multiple messaging channels. The
|
|
241
|
-
* Voice, version 2
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
* The guide also provides key information, such as Amazon Pinpoint integration with
|
|
240
|
+
* 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
|
|
241
|
+
* 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>
|
|
242
|
+
* <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">
|
|
243
|
+
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
244
|
+
* </i> provides tutorials, code samples, and procedures that
|
|
245
|
+
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
246
|
+
* functionality into mobile apps and other types of applications.
|
|
247
|
+
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
249
248
|
* other Amazon Web Services services, and the quotas that apply to use of the
|
|
250
249
|
* service.</p>
|
|
251
250
|
* <p>
|
|
252
251
|
* <b>Regional availability</b>
|
|
253
252
|
* </p>
|
|
254
|
-
* <p>The <i>
|
|
253
|
+
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
255
254
|
* available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
256
255
|
* these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
257
256
|
* 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
|
|
@@ -29,13 +29,13 @@ declare const CreateEventDestinationCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a new event destination in a configuration set.</p>
|
|
31
31
|
* <p>An event destination is a location where you send message events. The event options
|
|
32
|
-
* are Amazon CloudWatch, Amazon
|
|
32
|
+
* are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,
|
|
33
33
|
* when a message is delivered successfully, you can send information about that event to
|
|
34
34
|
* an event destination, or send notifications to endpoints that are subscribed to an
|
|
35
35
|
* Amazon SNS topic.</p>
|
|
36
36
|
* <p>Each configuration set can contain between 0 and 5 event destinations. Each event
|
|
37
37
|
* destination can contain a reference to a single destination, such as a CloudWatch
|
|
38
|
-
* or
|
|
38
|
+
* or Firehose destination.</p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
41
|
* ```javascript
|
|
@@ -34,8 +34,7 @@ declare const CreateOptOutListCommand_base: {
|
|
|
34
34
|
* the phone number is added to the opt-out list. In addition to STOP, your recipients can
|
|
35
35
|
* use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported
|
|
36
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>
|
|
38
|
-
* Guide</i>.</p>
|
|
37
|
+
* SMS opt out </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
39
38
|
* @example
|
|
40
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
40
|
* ```javascript
|
|
@@ -31,7 +31,7 @@ declare const DeleteKeywordCommand_base: {
|
|
|
31
31
|
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
|
|
32
32
|
* is also a specific word or phrase that an end user can send to your number to elicit a
|
|
33
33
|
* response, such as an informational message or a special offer. When your number receives
|
|
34
|
-
* a message that begins with a keyword,
|
|
34
|
+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
|
|
35
35
|
* message.</p>
|
|
36
36
|
* <p>Keywords "HELP" and "STOP" can't be deleted or modified.</p>
|
|
37
37
|
* @example
|
|
@@ -30,8 +30,8 @@ declare const DeleteTextMessageSpendLimitOverrideCommand_base: {
|
|
|
30
30
|
* <p>Deletes an account-level monthly spending limit override for sending text messages.
|
|
31
31
|
* Deleting a spend limit override will set the <code>EnforcedLimit</code> to equal the
|
|
32
32
|
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
|
|
33
|
-
* information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/
|
|
34
|
-
* in the <i>
|
|
33
|
+
* information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a>
|
|
34
|
+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -30,8 +30,8 @@ declare const DeleteVoiceMessageSpendLimitOverrideCommand_base: {
|
|
|
30
30
|
* <p>Deletes an account level monthly spend limit override for sending voice messages.
|
|
31
31
|
* Deleting a spend limit override sets the <code>EnforcedLimit</code> equal to the
|
|
32
32
|
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
|
|
33
|
-
* information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/
|
|
34
|
-
* in the <i>
|
|
33
|
+
* information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a>
|
|
34
|
+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -31,7 +31,7 @@ declare const DescribeAccountAttributesCommand_base: {
|
|
|
31
31
|
* attributes include account tier, which indicates whether your account is in the sandbox
|
|
32
32
|
* or production environment. When you're ready to move your account out of the sandbox,
|
|
33
33
|
* create an Amazon Web Services Support case for a service limit increase request.</p>
|
|
34
|
-
* <p>New
|
|
34
|
+
* <p>New accounts are placed into an SMS or voice sandbox. The sandbox
|
|
35
35
|
* protects both Amazon Web Services end recipients and SMS or voice recipients from fraud
|
|
36
36
|
* and abuse. </p>
|
|
37
37
|
* @example
|
|
@@ -27,14 +27,13 @@ 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 AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your
|
|
31
31
|
* account. The description for a quota includes the quota name, current usage toward that
|
|
32
32
|
* quota, and the quota's maximum value.</p>
|
|
33
33
|
* <p>When you establish an Amazon Web Services account, the account has initial quotas on
|
|
34
34
|
* the maximum number of configuration sets, opt-out lists, phone numbers, and pools that
|
|
35
|
-
* you can create in a given Region. For more information see <a href="https://docs.aws.amazon.com/
|
|
36
|
-
*
|
|
37
|
-
* Guide</i>.</p>
|
|
35
|
+
* 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>
|
|
36
|
+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
38
37
|
* @example
|
|
39
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
39
|
* ```javascript
|
|
@@ -32,7 +32,7 @@ declare const DescribeKeywordsCommand_base: {
|
|
|
32
32
|
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
|
|
33
33
|
* is also a specific word or phrase that an end user can send to your number to elicit a
|
|
34
34
|
* response, such as an informational message or a special offer. When your number receives
|
|
35
|
-
* a message that begins with a keyword,
|
|
35
|
+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
|
|
36
36
|
* message.</p>
|
|
37
37
|
* <p>If you specify a keyword that isn't valid, an error is returned.</p>
|
|
38
38
|
* @example
|
|
@@ -27,13 +27,13 @@ declare const DescribeSpendLimitsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the current
|
|
30
|
+
* <p>Describes the current monthly spend limits for sending voice and
|
|
31
31
|
* text messages.</p>
|
|
32
32
|
* <p>When you establish an Amazon Web Services account, the account has initial monthly
|
|
33
33
|
* spend limit in a given Region. For more information on increasing your monthly spend
|
|
34
|
-
* limit, see <a href="https://docs.aws.amazon.com/
|
|
35
|
-
* Requesting increases to your monthly SMS
|
|
36
|
-
* </a> in the <i>
|
|
34
|
+
* limit, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html">
|
|
35
|
+
* Requesting increases to your monthly SMS, MMS, or Voice spending quota
|
|
36
|
+
* </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
39
|
* ```javascript
|
|
@@ -32,7 +32,7 @@ declare const PutKeywordCommand_base: {
|
|
|
32
32
|
* <p> A keyword is a word that you can search for on a particular phone number or pool. It
|
|
33
33
|
* is also a specific word or phrase that an end user can send to your number to elicit a
|
|
34
34
|
* response, such as an informational message or a special offer. When your number receives
|
|
35
|
-
* a message that begins with a keyword,
|
|
35
|
+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
|
|
36
36
|
* message.</p>
|
|
37
37
|
* <p>If you specify a keyword that isn't valid, an error is returned.</p>
|
|
38
38
|
* @example
|
|
@@ -28,8 +28,7 @@ declare const RequestPhoneNumberCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Request an origination phone number for use in your account. For more information on
|
|
31
|
-
* phone number request see <a href="https://docs.aws.amazon.com/
|
|
32
|
-
* number </a> in the <i>Amazon Pinpoint User Guide</i>.</p>
|
|
31
|
+
* 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>AWS End User Messaging SMS User Guide</i>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,12 +27,11 @@ declare const SendTextMessageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new text message and sends it to a recipient's phone number.</p>
|
|
30
|
+
* <p>Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.</p>
|
|
31
31
|
* <p>SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit
|
|
32
32
|
* depends on the destination country of your messages, as well as the type of phone number
|
|
33
|
-
* (origination number) that you use to send the message. For more information, see <a href="https://docs.aws.amazon.com/
|
|
34
|
-
* Second (MPS) limits</a> in the <i>
|
|
35
|
-
* Guide</i>.</p>
|
|
33
|
+
* (origination number) that you use to send the message. For more information about MPS, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/sms-limitations-mps.html">Message Parts per
|
|
34
|
+
* Second (MPS) limits</a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
37
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const SendVoiceMessageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows you to send a request that sends a voice message
|
|
30
|
+
* <p>Allows you to send a request that sends a voice message.
|
|
31
31
|
* This operation uses <a href="http://aws.amazon.com/polly/">Amazon Polly</a> to
|
|
32
32
|
* convert a text script into a voice message.</p>
|
|
33
33
|
* @example
|
|
@@ -27,12 +27,10 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Adds or overwrites only the specified tags for the specified
|
|
31
|
-
* Voice, version 2 resource. When you specify an existing tag key, the value is
|
|
30
|
+
* <p>Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is
|
|
32
31
|
* overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag
|
|
33
32
|
* consists of a key and an optional value. Tag keys must be unique per resource. For more
|
|
34
|
-
* information about tags, see <a href="https://docs.aws.amazon.com/
|
|
35
|
-
* Guide</i>.</p>
|
|
33
|
+
* information about tags, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html">Tags </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
36
34
|
* @example
|
|
37
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
36
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes the association of the specified tags from
|
|
31
|
-
* resource. For more information on tags see <a href="https://docs.aws.amazon.com/
|
|
32
|
-
* Guide</i>. </p>
|
|
30
|
+
* <p>Removes the association of the specified tags from a
|
|
31
|
+
* resource. For more information on tags see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html">Tags </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -28,11 +28,11 @@ declare const UpdateEventDestinationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates an existing event destination in a configuration set. You can update the
|
|
31
|
-
* IAM role ARN for CloudWatch Logs and
|
|
31
|
+
* IAM role ARN for CloudWatch Logs and Firehose. You can
|
|
32
32
|
* also enable or disable the event destination.</p>
|
|
33
33
|
* <p>You may want to update an event destination to change its matching event types or
|
|
34
34
|
* updating the destination resource ARN. You can't change an event destination's type
|
|
35
|
-
* between CloudWatch Logs,
|
|
35
|
+
* between CloudWatch Logs, Firehose, and Amazon SNS.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
38
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Welcome to the <i>
|
|
3
|
-
* This guide provides information about
|
|
2
|
+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
|
|
3
|
+
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
|
|
4
4
|
* resources, including supported HTTP methods, parameters, and schemas.</p>
|
|
5
5
|
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
|
|
6
|
-
* your recipients across multiple messaging channels. The
|
|
7
|
-
* Voice, version 2
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* The guide also provides key information, such as Amazon Pinpoint integration with
|
|
6
|
+
* 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
|
|
7
|
+
* 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>
|
|
8
|
+
* <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">
|
|
9
|
+
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
|
|
10
|
+
* </i> provides tutorials, code samples, and procedures that
|
|
11
|
+
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
|
|
12
|
+
* functionality into mobile apps and other types of applications.
|
|
13
|
+
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
|
|
15
14
|
* other Amazon Web Services services, and the quotas that apply to use of the
|
|
16
15
|
* service.</p>
|
|
17
16
|
* <p>
|
|
18
17
|
* <b>Regional availability</b>
|
|
19
18
|
* </p>
|
|
20
|
-
* <p>The <i>
|
|
19
|
+
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
|
|
21
20
|
* available in several Amazon Web Services Regions and it provides an endpoint for each of
|
|
22
21
|
* these Regions. For a list of all the Regions and endpoints where the API is currently
|
|
23
22
|
* 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
|
|
@@ -588,16 +588,16 @@ export declare const MessageType: {
|
|
|
588
588
|
*/
|
|
589
589
|
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
590
590
|
/**
|
|
591
|
-
* <p>Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a
|
|
591
|
+
* <p>Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event
|
|
592
592
|
* destination.</p>
|
|
593
|
-
* <p>Event destinations, such as
|
|
593
|
+
* <p>Event destinations, such as Firehose, are associated with configuration
|
|
594
594
|
* sets, which enable you to publish message sending events.</p>
|
|
595
595
|
* @public
|
|
596
596
|
*/
|
|
597
597
|
export interface KinesisFirehoseDestination {
|
|
598
598
|
/**
|
|
599
599
|
* <p>The ARN of an Identity and Access Management role that is able to write
|
|
600
|
-
* event data to an Amazon
|
|
600
|
+
* event data to an Amazon Data Firehose destination.</p>
|
|
601
601
|
* @public
|
|
602
602
|
*/
|
|
603
603
|
IamRoleArn: string | undefined;
|
|
@@ -675,7 +675,7 @@ export interface SnsDestination {
|
|
|
675
675
|
/**
|
|
676
676
|
* <p>Contains information about an event destination.</p>
|
|
677
677
|
* <p>Event destinations are associated with configuration sets, which enable you to publish
|
|
678
|
-
* message sending events to CloudWatch,
|
|
678
|
+
* message sending events to CloudWatch, Firehose, or Amazon SNS.</p>
|
|
679
679
|
* @public
|
|
680
680
|
*/
|
|
681
681
|
export interface EventDestination {
|
|
@@ -704,7 +704,7 @@ export interface EventDestination {
|
|
|
704
704
|
*/
|
|
705
705
|
CloudWatchLogsDestination?: CloudWatchLogsDestination;
|
|
706
706
|
/**
|
|
707
|
-
* <p>An object that contains information about an event destination for logging to Amazon
|
|
707
|
+
* <p>An object that contains information about an event destination for logging to Amazon Data Firehose.</p>
|
|
708
708
|
* @public
|
|
709
709
|
*/
|
|
710
710
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
@@ -841,7 +841,7 @@ export interface CreateEventDestinationRequest {
|
|
|
841
841
|
EventDestinationName: string | undefined;
|
|
842
842
|
/**
|
|
843
843
|
* <p>An array of event types that determine which events to log. If "ALL" is used, then
|
|
844
|
-
*
|
|
844
|
+
* AWS End User Messaging SMS and Voice logs every event type.</p>
|
|
845
845
|
* <note>
|
|
846
846
|
* <p>The <code>TEXT_SENT</code> event type is not supported.</p>
|
|
847
847
|
* </note>
|
|
@@ -854,7 +854,7 @@ export interface CreateEventDestinationRequest {
|
|
|
854
854
|
*/
|
|
855
855
|
CloudWatchLogsDestination?: CloudWatchLogsDestination;
|
|
856
856
|
/**
|
|
857
|
-
* <p>An object that contains information about an event destination for logging to Amazon
|
|
857
|
+
* <p>An object that contains information about an event destination for logging to Amazon Data Firehose.</p>
|
|
858
858
|
* @public
|
|
859
859
|
*/
|
|
860
860
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
@@ -947,6 +947,7 @@ export interface CreatePoolRequest {
|
|
|
947
947
|
* SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for
|
|
948
948
|
* PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used
|
|
949
949
|
* to get the values for SenderId and SenderIdArn.</p>
|
|
950
|
+
* <p>After the pool is created you can add more origination identities to the pool by using <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html">AssociateOriginationIdentity</a>.</p>
|
|
950
951
|
* @public
|
|
951
952
|
*/
|
|
952
953
|
OriginationIdentity: string | undefined;
|
|
@@ -959,7 +960,7 @@ export interface CreatePoolRequest {
|
|
|
959
960
|
/**
|
|
960
961
|
* <p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or
|
|
961
962
|
* time-sensitive and PROMOTIONAL for messages that aren't critical or
|
|
962
|
-
* time-sensitive.</p>
|
|
963
|
+
* time-sensitive. After the pool is created the MessageType can't be changed.</p>
|
|
963
964
|
* @public
|
|
964
965
|
*/
|
|
965
966
|
MessageType: MessageType | undefined;
|
|
@@ -1049,7 +1050,7 @@ export interface CreatePoolResult {
|
|
|
1049
1050
|
TwoWayChannelRole?: string;
|
|
1050
1051
|
/**
|
|
1051
1052
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
1052
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
1053
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
1053
1054
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
1054
1055
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
1055
1056
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -1062,7 +1063,7 @@ export interface CreatePoolResult {
|
|
|
1062
1063
|
*/
|
|
1063
1064
|
OptOutListName?: string;
|
|
1064
1065
|
/**
|
|
1065
|
-
* <p>Indicates whether shared routes are enabled for the pool
|
|
1066
|
+
* <p>Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages. </p>
|
|
1066
1067
|
* @public
|
|
1067
1068
|
*/
|
|
1068
1069
|
SharedRoutesEnabled?: boolean;
|
|
@@ -2003,7 +2004,7 @@ export interface DeletePoolResult {
|
|
|
2003
2004
|
TwoWayChannelRole?: string;
|
|
2004
2005
|
/**
|
|
2005
2006
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
2006
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
2007
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
2007
2008
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
2008
2009
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
2009
2010
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -2900,7 +2901,7 @@ export interface PhoneNumberInformation {
|
|
|
2900
2901
|
TwoWayChannelRole?: string;
|
|
2901
2902
|
/**
|
|
2902
2903
|
* <p>When set to false an end recipient sends a message that begins with HELP or STOP to
|
|
2903
|
-
* one of your dedicated numbers,
|
|
2904
|
+
* one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a
|
|
2904
2905
|
* customizable message and adds the end recipient to the OptOutList. When set to true
|
|
2905
2906
|
* you're responsible for responding to HELP and STOP requests. You're also responsible for
|
|
2906
2907
|
* tracking and honoring opt-out request. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out">Self-managed opt-outs</a>
|
|
@@ -3057,7 +3058,7 @@ export interface PoolInformation {
|
|
|
3057
3058
|
TwoWayChannelRole?: string;
|
|
3058
3059
|
/**
|
|
3059
3060
|
* <p>When set to false, an end recipient sends a message that begins with HELP or STOP to
|
|
3060
|
-
* one of your dedicated numbers,
|
|
3061
|
+
* one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a
|
|
3061
3062
|
* customizable message and adds the end recipient to the OptOutList. When set to true
|
|
3062
3063
|
* you're responsible for responding to HELP and STOP requests. You're also responsible for
|
|
3063
3064
|
* tracking and honoring opt-out requests. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out">Self-managed opt-outs</a>
|
|
@@ -3074,7 +3075,7 @@ export interface PoolInformation {
|
|
|
3074
3075
|
* <p>Allows you to enable shared routes on your pool.</p>
|
|
3075
3076
|
* <p>By default, this is set to <code>False</code>. If you set this value to
|
|
3076
3077
|
* <code>True</code>, your messages are sent using phone numbers or sender IDs
|
|
3077
|
-
* (depending on the country) that are shared with other
|
|
3078
|
+
* (depending on the country) that are shared with other users. In some
|
|
3078
3079
|
* countries, such as the United States, senders aren't allowed to use shared routes and
|
|
3079
3080
|
* must use a dedicated phone number or short code.</p>
|
|
3080
3081
|
* @public
|
|
@@ -4320,9 +4321,8 @@ export interface SenderIdFilter {
|
|
|
4320
4321
|
}
|
|
4321
4322
|
/**
|
|
4322
4323
|
* <p> The alphanumeric sender ID in a specific country that you want to describe. For more
|
|
4323
|
-
* information on sender IDs see <a href="https://docs.aws.amazon.com/
|
|
4324
|
-
* sender IDs
|
|
4325
|
-
* </a> in the <i>Amazon Pinpoint User Guide</i>.</p>
|
|
4324
|
+
* information on sender IDs see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/sender-id-request.html">Requesting
|
|
4325
|
+
* sender IDs </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
|
|
4326
4326
|
* @public
|
|
4327
4327
|
*/
|
|
4328
4328
|
export interface SenderIdAndCountry {
|
|
@@ -4460,10 +4460,10 @@ export declare const SpendLimitName: {
|
|
|
4460
4460
|
*/
|
|
4461
4461
|
export type SpendLimitName = (typeof SpendLimitName)[keyof typeof SpendLimitName];
|
|
4462
4462
|
/**
|
|
4463
|
-
* <p>Describes the current
|
|
4464
|
-
* text messages. For more information on increasing your monthly spend limit, see <a href="https://docs.aws.amazon.com/
|
|
4465
|
-
* Requesting
|
|
4466
|
-
* </a> in the <i>
|
|
4463
|
+
* <p>Describes the current monthly spend limits for sending voice and
|
|
4464
|
+
* text messages. 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">
|
|
4465
|
+
* Requesting a spending quota increase
|
|
4466
|
+
* </a> in the <i>AWS End User Messaging SMS User Guide</i>. </p>
|
|
4467
4467
|
* @public
|
|
4468
4468
|
*/
|
|
4469
4469
|
export interface SpendLimit {
|
|
@@ -4874,7 +4874,7 @@ export interface GetProtectConfigurationCountryRuleSetResult {
|
|
|
4874
4874
|
NumberCapability: NumberCapability | undefined;
|
|
4875
4875
|
/**
|
|
4876
4876
|
* <p>A map of ProtectConfigurationCountryRuleSetInformation objects that contain the
|
|
4877
|
-
* details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html">Supported countries and regions (SMS channel)</a> in the
|
|
4877
|
+
* details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html">Supported countries and regions (SMS channel)</a> in the AWS End User Messaging SMS User Guide.</p>
|
|
4878
4878
|
* @public
|
|
4879
4879
|
*/
|
|
4880
4880
|
CountryRuleSet: Record<string, ProtectConfigurationCountryRuleSetInformation> | undefined;
|
|
@@ -5423,7 +5423,7 @@ export interface ReleasePhoneNumberResult {
|
|
|
5423
5423
|
TwoWayChannelRole?: string;
|
|
5424
5424
|
/**
|
|
5425
5425
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
5426
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
5426
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
5427
5427
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
5428
5428
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
5429
5429
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -5652,7 +5652,7 @@ export interface RequestPhoneNumberResult {
|
|
|
5652
5652
|
TwoWayChannelRole?: string;
|
|
5653
5653
|
/**
|
|
5654
5654
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
5655
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
5655
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
5656
5656
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
5657
5657
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
5658
5658
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -5957,13 +5957,12 @@ export interface SendTextMessageRequest {
|
|
|
5957
5957
|
*/
|
|
5958
5958
|
ConfigurationSetName?: string;
|
|
5959
5959
|
/**
|
|
5960
|
-
* <p>The maximum amount that you want to spend, in US dollars, per each text message
|
|
5961
|
-
* A text message can contain multiple parts.</p>
|
|
5960
|
+
* <p>The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than <code>MaxPrice</code>, the message is not sent and an error is returned.</p>
|
|
5962
5961
|
* @public
|
|
5963
5962
|
*/
|
|
5964
5963
|
MaxPrice?: string;
|
|
5965
5964
|
/**
|
|
5966
|
-
* <p>How long the text message is valid for. By default this is 72 hours.</p>
|
|
5965
|
+
* <p>How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return <code>TTL_EXPIRED</code> event.</p>
|
|
5967
5966
|
* @public
|
|
5968
5967
|
*/
|
|
5969
5968
|
TimeToLive?: number;
|
|
@@ -5978,12 +5977,37 @@ export interface SendTextMessageRequest {
|
|
|
5978
5977
|
* setting is only used when you send messages to recipients in India using a sender ID.
|
|
5979
5978
|
* For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html">Special requirements for sending SMS messages to recipients in India</a>.
|
|
5980
5979
|
* </p>
|
|
5980
|
+
* <ul>
|
|
5981
|
+
* <li>
|
|
5982
|
+
* <p>
|
|
5983
|
+
* <code>IN_ENTITY_ID</code> The entity ID or Principal
|
|
5984
|
+
* Entity (PE) ID that you received after completing the sender ID
|
|
5985
|
+
* registration process.</p>
|
|
5986
|
+
* </li>
|
|
5987
|
+
* <li>
|
|
5988
|
+
* <p>
|
|
5989
|
+
* <code>IN_TEMPLATE_ID</code> The template ID that you
|
|
5990
|
+
* received after completing the sender ID registration
|
|
5991
|
+
* process.</p>
|
|
5992
|
+
* <important>
|
|
5993
|
+
* <p>Make sure that the Template ID that you specify matches
|
|
5994
|
+
* your message template exactly. If your message doesn't match
|
|
5995
|
+
* the template that you provided during the registration
|
|
5996
|
+
* process, the mobile carriers might reject your
|
|
5997
|
+
* message.</p>
|
|
5998
|
+
* </important>
|
|
5999
|
+
* </li>
|
|
6000
|
+
* </ul>
|
|
5981
6001
|
* @public
|
|
5982
6002
|
*/
|
|
5983
6003
|
DestinationCountryParameters?: Partial<Record<DestinationCountryParameterKey, string>>;
|
|
5984
6004
|
/**
|
|
5985
6005
|
* <p>When set to true, the message is checked and validated, but isn't sent to the end
|
|
5986
|
-
* recipient
|
|
6006
|
+
* recipient. You are not charged for using <code>DryRun</code>.</p>
|
|
6007
|
+
* <p>The Message Parts per Second (MPS) limit when using <code>DryRun</code> is five. If
|
|
6008
|
+
* your origination identity has a lower MPS limit then the lower MPS limit is used. For
|
|
6009
|
+
* more information about MPS limits, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/sms-limitations-mps.html">Message Parts per
|
|
6010
|
+
* Second (MPS) limits</a> in the <i>AWS End User Messaging SMS User Guide</i>..</p>
|
|
5987
6011
|
* @public
|
|
5988
6012
|
*/
|
|
5989
6013
|
DryRun?: boolean;
|
|
@@ -6482,7 +6506,7 @@ export interface UpdateEventDestinationRequest {
|
|
|
6482
6506
|
*/
|
|
6483
6507
|
CloudWatchLogsDestination?: CloudWatchLogsDestination;
|
|
6484
6508
|
/**
|
|
6485
|
-
* <p>An object that contains information about an event destination for logging to
|
|
6509
|
+
* <p>An object that contains information about an event destination for logging to Firehose.</p>
|
|
6486
6510
|
* @public
|
|
6487
6511
|
*/
|
|
6488
6512
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
@@ -6542,7 +6566,7 @@ export interface UpdatePhoneNumberRequest {
|
|
|
6542
6566
|
TwoWayChannelRole?: string;
|
|
6543
6567
|
/**
|
|
6544
6568
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
6545
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
6569
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
6546
6570
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
6547
6571
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
6548
6572
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -6684,7 +6708,7 @@ export interface UpdatePoolRequest {
|
|
|
6684
6708
|
TwoWayChannelRole?: string;
|
|
6685
6709
|
/**
|
|
6686
6710
|
* <p>By default this is set to false. When an end recipient sends a message that begins
|
|
6687
|
-
* with HELP or STOP to one of your dedicated numbers,
|
|
6711
|
+
* with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically
|
|
6688
6712
|
* replies with a customizable message and adds the end recipient to the OptOutList. When
|
|
6689
6713
|
* set to true you're responsible for responding to HELP and STOP requests. You're also
|
|
6690
6714
|
* responsible for tracking and honoring opt-out requests.</p>
|
|
@@ -6750,7 +6774,7 @@ export interface UpdatePoolResult {
|
|
|
6750
6774
|
TwoWayChannelRole?: string;
|
|
6751
6775
|
/**
|
|
6752
6776
|
* <p>When an end recipient sends a message that begins with HELP or STOP to one of your
|
|
6753
|
-
* dedicated numbers,
|
|
6777
|
+
* dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message
|
|
6754
6778
|
* and adds the end recipient to the OptOutList. When set to true you're responsible for
|
|
6755
6779
|
* responding to HELP and STOP requests. You're also responsible for tracking and honoring
|
|
6756
6780
|
* opt-out requests.</p>
|
|
@@ -6841,7 +6865,7 @@ export interface UpdateProtectConfigurationCountryRuleSetRequest {
|
|
|
6841
6865
|
NumberCapability: NumberCapability | undefined;
|
|
6842
6866
|
/**
|
|
6843
6867
|
* <p>A map of ProtectConfigurationCountryRuleSetInformation objects that contain the
|
|
6844
|
-
* details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html">Supported countries and regions (SMS channel)</a> in the
|
|
6868
|
+
* details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html">Supported countries and regions (SMS channel)</a> in the AWS End User Messaging SMS User Guide.</p>
|
|
6845
6869
|
* @public
|
|
6846
6870
|
*/
|
|
6847
6871
|
CountryRuleSetUpdates: Record<string, ProtectConfigurationCountryRuleSetInformation> | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-pinpoint-sms-voice-v2",
|
|
3
3
|
"description": "AWS SDK for JavaScript Pinpoint Sms Voice V2 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.620.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-pinpoint-sms-voice-v2",
|
|
@@ -20,40 +20,40 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.620.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.620.0",
|
|
25
|
+
"@aws-sdk/core": "3.620.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.620.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.620.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.609.0",
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.620.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.620.0",
|
|
31
31
|
"@aws-sdk/region-config-resolver": "3.614.0",
|
|
32
32
|
"@aws-sdk/types": "3.609.0",
|
|
33
33
|
"@aws-sdk/util-endpoints": "3.614.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.609.0",
|
|
35
35
|
"@aws-sdk/util-user-agent-node": "3.614.0",
|
|
36
36
|
"@smithy/config-resolver": "^3.0.5",
|
|
37
|
-
"@smithy/core": "^2.
|
|
38
|
-
"@smithy/fetch-http-handler": "^3.2.
|
|
37
|
+
"@smithy/core": "^2.3.0",
|
|
38
|
+
"@smithy/fetch-http-handler": "^3.2.3",
|
|
39
39
|
"@smithy/hash-node": "^3.0.3",
|
|
40
40
|
"@smithy/invalid-dependency": "^3.0.3",
|
|
41
|
-
"@smithy/middleware-content-length": "^3.0.
|
|
42
|
-
"@smithy/middleware-endpoint": "^3.0
|
|
43
|
-
"@smithy/middleware-retry": "^3.0.
|
|
41
|
+
"@smithy/middleware-content-length": "^3.0.5",
|
|
42
|
+
"@smithy/middleware-endpoint": "^3.1.0",
|
|
43
|
+
"@smithy/middleware-retry": "^3.0.12",
|
|
44
44
|
"@smithy/middleware-serde": "^3.0.3",
|
|
45
45
|
"@smithy/middleware-stack": "^3.0.3",
|
|
46
46
|
"@smithy/node-config-provider": "^3.1.4",
|
|
47
|
-
"@smithy/node-http-handler": "^3.1.
|
|
48
|
-
"@smithy/protocol-http": "^4.0
|
|
49
|
-
"@smithy/smithy-client": "^3.1.
|
|
47
|
+
"@smithy/node-http-handler": "^3.1.4",
|
|
48
|
+
"@smithy/protocol-http": "^4.1.0",
|
|
49
|
+
"@smithy/smithy-client": "^3.1.10",
|
|
50
50
|
"@smithy/types": "^3.3.0",
|
|
51
51
|
"@smithy/url-parser": "^3.0.3",
|
|
52
52
|
"@smithy/util-base64": "^3.0.0",
|
|
53
53
|
"@smithy/util-body-length-browser": "^3.0.0",
|
|
54
54
|
"@smithy/util-body-length-node": "^3.0.0",
|
|
55
|
-
"@smithy/util-defaults-mode-browser": "^3.0.
|
|
56
|
-
"@smithy/util-defaults-mode-node": "^3.0.
|
|
55
|
+
"@smithy/util-defaults-mode-browser": "^3.0.12",
|
|
56
|
+
"@smithy/util-defaults-mode-node": "^3.0.12",
|
|
57
57
|
"@smithy/util-endpoints": "^2.0.5",
|
|
58
58
|
"@smithy/util-middleware": "^3.0.3",
|
|
59
59
|
"@smithy/util-retry": "^3.0.3",
|