Skip to content

Commit b47a096

Browse files
author
awstools
committed
docs(client-pinpoint-sms-voice-v2): Update for rebrand to AWS End User Messaging SMS and Voice.
1 parent 08aa23f commit b47a096

23 files changed

+176
-163
lines changed

clients/client-pinpoint-sms-voice-v2/README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,24 @@
66

77
AWS SDK for JavaScript PinpointSMSVoiceV2 Client for Node.js, Browser and React Native.
88

9-
<p>Welcome to the <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i>.
10-
This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
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
1111
resources, including supported HTTP methods, parameters, and schemas.</p>
1212
<p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
13-
your recipients across multiple messaging channels. The Amazon Pinpoint SMS and
14-
Voice, version 2 API provides programmatic access to options that are unique to the SMS
15-
and voice channels. Amazon Pinpoint 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>
16-
<p>If you're new to Amazon Pinpoint SMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
17-
Amazon Pinpoint SMS User Guide</a>. The <i>Amazon Pinpoint
18-
Developer Guide</i> provides tutorials, code samples, and procedures that
19-
demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate
20-
Amazon Pinpoint functionality into mobile apps and other types of applications.
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
2221
other Amazon Web Services services, and the quotas that apply to use of the
2322
service.</p>
2423
<p>
2524
<b>Regional availability</b>
2625
</p>
27-
<p>The <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i> is
26+
<p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
2827
available in several Amazon Web Services Regions and it provides an endpoint for each of
2928
these Regions. For a list of all the Regions and endpoints where the API is currently
3029
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

clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2.ts

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1835,25 +1835,24 @@ export interface PinpointSMSVoiceV2 {
18351835
}
18361836

18371837
/**
1838-
* <p>Welcome to the <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i>.
1839-
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
1838+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
1839+
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
18401840
* resources, including supported HTTP methods, parameters, and schemas.</p>
18411841
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
1842-
* your recipients across multiple messaging channels. The Amazon Pinpoint SMS and
1843-
* Voice, version 2 API provides programmatic access to options that are unique to the SMS
1844-
* and voice channels. Amazon Pinpoint 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>
1845-
* <p>If you're new to Amazon Pinpoint SMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
1846-
* Amazon Pinpoint SMS User Guide</a>. The <i>Amazon Pinpoint
1847-
* Developer Guide</i> provides tutorials, code samples, and procedures that
1848-
* demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate
1849-
* Amazon Pinpoint functionality into mobile apps and other types of applications.
1850-
* The guide also provides key information, such as Amazon Pinpoint integration with
1842+
* 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
1843+
* 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>
1844+
* <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">
1845+
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
1846+
* </i> provides tutorials, code samples, and procedures that
1847+
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
1848+
* functionality into mobile apps and other types of applications.
1849+
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
18511850
* other Amazon Web Services services, and the quotas that apply to use of the
18521851
* service.</p>
18531852
* <p>
18541853
* <b>Regional availability</b>
18551854
* </p>
1856-
* <p>The <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i> is
1855+
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
18571856
* available in several Amazon Web Services Regions and it provides an endpoint for each of
18581857
* these Regions. For a list of all the Regions and endpoints where the API is currently
18591858
* 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

clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2Client.ts

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -663,25 +663,24 @@ export type PinpointSMSVoiceV2ClientResolvedConfigType = __SmithyResolvedConfigu
663663
export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoiceV2ClientResolvedConfigType {}
664664

665665
/**
666-
* <p>Welcome to the <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i>.
667-
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
666+
* <p>Welcome to the <i>AWS End User Messaging SMS and Voice, version 2 API Reference</i>.
667+
* This guide provides information about AWS End User Messaging SMS and Voice, version 2 API
668668
* resources, including supported HTTP methods, parameters, and schemas.</p>
669669
* <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
670-
* your recipients across multiple messaging channels. The Amazon Pinpoint SMS and
671-
* Voice, version 2 API provides programmatic access to options that are unique to the SMS
672-
* and voice channels. Amazon Pinpoint 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>
673-
* <p>If you're new to Amazon Pinpoint SMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html">
674-
* Amazon Pinpoint SMS User Guide</a>. The <i>Amazon Pinpoint
675-
* Developer Guide</i> provides tutorials, code samples, and procedures that
676-
* demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate
677-
* Amazon Pinpoint functionality into mobile apps and other types of applications.
678-
* The guide also provides key information, such as Amazon Pinpoint integration with
670+
* 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
671+
* 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>
672+
* <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">
673+
* AWS End User Messaging SMS User Guide</a>. The <i>AWS End User Messaging SMS User Guide
674+
* </i> provides tutorials, code samples, and procedures that
675+
* demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate
676+
* functionality into mobile apps and other types of applications.
677+
* The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with
679678
* other Amazon Web Services services, and the quotas that apply to use of the
680679
* service.</p>
681680
* <p>
682681
* <b>Regional availability</b>
683682
* </p>
684-
* <p>The <i>Amazon Pinpoint SMS and Voice, version 2 API Reference</i> is
683+
* <p>The <i>AWS End User Messaging SMS and Voice version 2 API Reference</i> is
685684
* available in several Amazon Web Services Regions and it provides an endpoint for each of
686685
* these Regions. For a list of all the Regions and endpoints where the API is currently
687686
* 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

clients/client-pinpoint-sms-voice-v2/src/auth/httpAuthSchemeProvider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: PinpointSMSVoiceV2Http
6060
name: "sms-voice",
6161
region: authParameters.region,
6262
},
63-
propertiesExtractor: (config: PinpointSMSVoiceV2ClientConfig, context) => ({
63+
propertiesExtractor: (config: Partial<PinpointSMSVoiceV2ClientConfig>, context) => ({
6464
/**
6565
* @internal
6666
*/

clients/client-pinpoint-sms-voice-v2/src/commands/CreateEventDestinationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ export interface CreateEventDestinationCommandOutput extends CreateEventDestinat
3434
/**
3535
* <p>Creates a new event destination in a configuration set.</p>
3636
* <p>An event destination is a location where you send message events. The event options
37-
* are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,
37+
* are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,
3838
* when a message is delivered successfully, you can send information about that event to
3939
* an event destination, or send notifications to endpoints that are subscribed to an
4040
* Amazon SNS topic.</p>
4141
* <p>Each configuration set can contain between 0 and 5 event destinations. Each event
4242
* destination can contain a reference to a single destination, such as a CloudWatch
43-
* or Kinesis Data Firehose destination.</p>
43+
* or Firehose destination.</p>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.
4646
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/CreateOptOutListCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ export interface CreateOptOutListCommandOutput extends CreateOptOutListResult, _
3939
* the phone number is added to the opt-out list. In addition to STOP, your recipients can
4040
* use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported
4141
* opt-out keywords, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout">
42-
* SMS opt out </a> in the <i>Amazon Pinpoint User
43-
* Guide</i>.</p>
42+
* SMS opt out </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
4443
* @example
4544
* Use a bare-bones client and the command you need to make an API call.
4645
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/DeleteKeywordCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface DeleteKeywordCommandOutput extends DeleteKeywordResult, __Metad
3636
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
3737
* is also a specific word or phrase that an end user can send to your number to elicit a
3838
* response, such as an informational message or a special offer. When your number receives
39-
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
39+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
4040
* message.</p>
4141
* <p>Keywords "HELP" and "STOP" can't be deleted or modified.</p>
4242
* @example

clients/client-pinpoint-sms-voice-v2/src/commands/DeleteTextMessageSpendLimitOverrideCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ export interface DeleteTextMessageSpendLimitOverrideCommandOutput
4343
* <p>Deletes an account-level monthly spending limit override for sending text messages.
4444
* Deleting a spend limit override will set the <code>EnforcedLimit</code> to equal the
4545
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
46-
* information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html">Amazon Pinpoint quotas </a>
47-
* in the <i>Amazon Pinpoint Developer Guide</i>.</p>
46+
* information on spend limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a>
47+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.
5050
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/DeleteVoiceMessageSpendLimitOverrideCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ export interface DeleteVoiceMessageSpendLimitOverrideCommandOutput
4343
* <p>Deletes an account level monthly spend limit override for sending voice messages.
4444
* Deleting a spend limit override sets the <code>EnforcedLimit</code> equal to the
4545
* <code>MaxLimit</code>, which is controlled by Amazon Web Services. For more
46-
* information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html">Amazon Pinpoint quotas</a>
47-
* in the <i>Amazon Pinpoint Developer Guide</i>.</p>
46+
* information on spending limits (quotas) see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html">Quotas </a>
47+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.
5050
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/DescribeAccountAttributesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
3636
* attributes include account tier, which indicates whether your account is in the sandbox
3737
* or production environment. When you're ready to move your account out of the sandbox,
3838
* create an Amazon Web Services Support case for a service limit increase request.</p>
39-
* <p>New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox
39+
* <p>New accounts are placed into an SMS or voice sandbox. The sandbox
4040
* protects both Amazon Web Services end recipients and SMS or voice recipients from fraud
4141
* and abuse. </p>
4242
* @example

clients/client-pinpoint-sms-voice-v2/src/commands/DescribeAccountLimitsCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,13 @@ export interface DescribeAccountLimitsCommandInput extends DescribeAccountLimits
3232
export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimitsResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your
35+
* <p>Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your
3636
* account. The description for a quota includes the quota name, current usage toward that
3737
* quota, and the quota's maximum value.</p>
3838
* <p>When you establish an Amazon Web Services account, the account has initial quotas on
3939
* the maximum number of configuration sets, opt-out lists, phone numbers, and pools that
40-
* you can create in a given Region. For more information see <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html">
41-
* Amazon Pinpoint quotas </a> in the <i>Amazon Pinpoint Developer
42-
* Guide</i>.</p>
40+
* 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>
41+
* in the <i>AWS End User Messaging SMS User Guide</i>.</p>
4342
* @example
4443
* Use a bare-bones client and the command you need to make an API call.
4544
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/DescribeKeywordsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface DescribeKeywordsCommandOutput extends DescribeKeywordsResult, _
3737
* <p>A keyword is a word that you can search for on a particular phone number or pool. It
3838
* is also a specific word or phrase that an end user can send to your number to elicit a
3939
* response, such as an informational message or a special offer. When your number receives
40-
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
40+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
4141
* message.</p>
4242
* <p>If you specify a keyword that isn't valid, an error is returned.</p>
4343
* @example

clients/client-pinpoint-sms-voice-v2/src/commands/DescribeSpendLimitsCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ export interface DescribeSpendLimitsCommandInput extends DescribeSpendLimitsRequ
3232
export interface DescribeSpendLimitsCommandOutput extends DescribeSpendLimitsResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Describes the current Amazon Pinpoint monthly spend limits for sending voice and
35+
* <p>Describes the current monthly spend limits for sending voice and
3636
* text messages.</p>
3737
* <p>When you establish an Amazon Web Services account, the account has initial monthly
3838
* spend limit in a given Region. For more information on increasing your monthly spend
39-
* limit, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html">
40-
* Requesting increases to your monthly SMS spending quota for Amazon Pinpoint
41-
* </a> in the <i>Amazon Pinpoint User Guide</i>.</p>
39+
* limit, see <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html">
40+
* Requesting increases to your monthly SMS, MMS, or Voice spending quota
41+
* </a> in the <i>AWS End User Messaging SMS User Guide</i>.</p>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.
4444
* ```javascript

clients/client-pinpoint-sms-voice-v2/src/commands/PutKeywordCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface PutKeywordCommandOutput extends PutKeywordResult, __MetadataBea
3737
* <p> A keyword is a word that you can search for on a particular phone number or pool. It
3838
* is also a specific word or phrase that an end user can send to your number to elicit a
3939
* response, such as an informational message or a special offer. When your number receives
40-
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
40+
* a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable
4141
* message.</p>
4242
* <p>If you specify a keyword that isn't valid, an error is returned.</p>
4343
* @example

0 commit comments

Comments
 (0)