Skip to content

Commit 0310a62

Browse files
author
awstools
committed
docs(client-ses): Doc only updates to include: 1) Clarified which part of an email address where it's okay to have Punycode when it contains non-ASCII characters for the SendRawEmail action and other actions where this is applicable. 2) Updated S3Action description with new MB max bucket size from 30 to 40.
1 parent 1524521 commit 0310a62

File tree

75 files changed

+2604
-2770
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2604
-2770
lines changed

‎clients/client-ses/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,31 @@ Guide</a>. </p>
1616
Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
1717
Guide</a>.</p>
1818
</note>
19+
<p>This documentation contains reference information related to the following:</p>
20+
<ul>
21+
<li>
22+
<p>
23+
<a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
24+
</p>
25+
</li>
26+
<li>
27+
<p>
28+
<a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
29+
API Data Types</a>
30+
</p>
31+
</li>
32+
<li>
33+
<p>
34+
<a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
35+
Parameters</a>
36+
</p>
37+
</li>
38+
<li>
39+
<p>
40+
<a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
41+
</p>
42+
</li>
43+
</ul>
1944

2045
## Installing
2146

‎clients/client-ses/src/SES.ts

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1582,14 +1582,39 @@ export interface SES {
15821582
/**
15831583
* @public
15841584
* <fullname>Amazon Simple Email Service</fullname>
1585-
* <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
1585+
* <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
15861586
* 2010-12-01. This document is best used in conjunction with the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
15871587
* Guide</a>. </p>
1588-
* <note>
1588+
* <note>
15891589
* <p> For a list of Amazon SES endpoints to use in service requests, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html">Regions and
15901590
* Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
15911591
* Guide</a>.</p>
1592-
* </note>
1592+
* </note>
1593+
* <p>This documentation contains reference information related to the following:</p>
1594+
* <ul>
1595+
* <li>
1596+
* <p>
1597+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
1598+
* </p>
1599+
* </li>
1600+
* <li>
1601+
* <p>
1602+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
1603+
* API Data Types</a>
1604+
* </p>
1605+
* </li>
1606+
* <li>
1607+
* <p>
1608+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
1609+
* Parameters</a>
1610+
* </p>
1611+
* </li>
1612+
* <li>
1613+
* <p>
1614+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
1615+
* </p>
1616+
* </li>
1617+
* </ul>
15931618
*/
15941619
export class SES extends SESClient implements SES {}
15951620
createAggregatedClient(commands, SES);

‎clients/client-ses/src/SESClient.ts

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -598,14 +598,39 @@ export interface SESClientResolvedConfig extends SESClientResolvedConfigType {}
598598
/**
599599
* @public
600600
* <fullname>Amazon Simple Email Service</fullname>
601-
* <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
601+
* <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
602602
* 2010-12-01. This document is best used in conjunction with the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
603603
* Guide</a>. </p>
604-
* <note>
604+
* <note>
605605
* <p> For a list of Amazon SES endpoints to use in service requests, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html">Regions and
606606
* Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
607607
* Guide</a>.</p>
608-
* </note>
608+
* </note>
609+
* <p>This documentation contains reference information related to the following:</p>
610+
* <ul>
611+
* <li>
612+
* <p>
613+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
614+
* </p>
615+
* </li>
616+
* <li>
617+
* <p>
618+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
619+
* API Data Types</a>
620+
* </p>
621+
* </li>
622+
* <li>
623+
* <p>
624+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
625+
* Parameters</a>
626+
* </p>
627+
* </li>
628+
* <li>
629+
* <p>
630+
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
631+
* </p>
632+
* </li>
633+
* </ul>
609634
*/
610635
export class SESClient extends __Client<
611636
__HttpHandlerOptions,

‎clients/client-ses/src/commands/CloneReceiptRuleSetCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ export interface CloneReceiptRuleSetCommandOutput extends CloneReceiptRuleSetRes
3939
* <p>Creates a receipt rule set by cloning an existing one. All receipt rules and
4040
* configurations are copied to the new receipt rule set and are completely independent of
4141
* the source rule set.</p>
42-
* <p>For information about setting up rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES
43-
* Developer Guide</a>.</p>
44-
* <p>You can execute this operation no more than once per second.</p>
42+
* <p>For information about setting up rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules">Amazon SES Developer Guide</a>.</p>
43+
* <p>You can execute this operation no more than once per second.</p>
4544
* @example
4645
* Use a bare-bones client and the command you need to make an API call.
4746
* ```javascript

‎clients/client-ses/src/commands/CreateConfigurationSetCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
3737
/**
3838
* @public
3939
* <p>Creates a configuration set.</p>
40-
* <p>Configuration sets enable you to publish email sending events. For information about
41-
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer
42-
* Guide</a>.</p>
43-
* <p>You can execute this operation no more than once per second.</p>
40+
* <p>Configuration sets enable you to publish email sending events. For information about
41+
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
42+
* Guide</a>.</p>
43+
* <p>You can execute this operation no more than once per second.</p>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.
4646
* ```javascript

‎clients/client-ses/src/commands/CreateConfigurationSetEventDestinationCommand.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
4646
/**
4747
* @public
4848
* <p>Creates a configuration set event destination.</p>
49-
* <note>
49+
* <note>
5050
* <p>When you create or update an event destination, you must provide one, and only
5151
* one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).</p>
52-
* </note>
53-
* <p>An event destination is the AWS service to which Amazon SES publishes the email sending
52+
* </note>
53+
* <p>An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending
5454
* events associated with a configuration set. For information about using configuration
55-
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer
56-
* Guide</a>.</p>
57-
* <p>You can execute this operation no more than once per second.</p>
55+
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
56+
* Guide</a>.</p>
57+
* <p>You can execute this operation no more than once per second.</p>
5858
* @example
5959
* Use a bare-bones client and the command you need to make an API call.
6060
* ```javascript
@@ -67,7 +67,7 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
6767
* Name: "STRING_VALUE", // required
6868
* Enabled: true || false,
6969
* MatchingEventTypes: [ // EventTypes // required
70-
* "STRING_VALUE",
70+
* "send" || "reject" || "bounce" || "complaint" || "delivery" || "open" || "click" || "renderingFailure",
7171
* ],
7272
* KinesisFirehoseDestination: { // KinesisFirehoseDestination
7373
* IAMRoleARN: "STRING_VALUE", // required
@@ -77,7 +77,7 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
7777
* DimensionConfigurations: [ // CloudWatchDimensionConfigurations // required
7878
* { // CloudWatchDimensionConfiguration
7979
* DimensionName: "STRING_VALUE", // required
80-
* DimensionValueSource: "STRING_VALUE", // required
80+
* DimensionValueSource: "messageTag" || "emailHeader" || "linkTag", // required
8181
* DefaultDimensionValue: "STRING_VALUE", // required
8282
* },
8383
* ],

‎clients/client-ses/src/commands/CreateConfigurationSetTrackingOptionsCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput
4747
* @public
4848
* <p>Creates an association between a configuration set and a custom domain for open and
4949
* click event tracking. </p>
50-
* <p>By default, images and links used for tracking open and click events are hosted on
50+
* <p>By default, images and links used for tracking open and click events are hosted on
5151
* domains operated by Amazon SES. You can configure a subdomain of your own to handle these
52-
* events. For information about using custom domains, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Amazon SES Developer Guide</a>.</p>
52+
* events. For information about using custom domains, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Amazon SES Developer Guide</a>.</p>
5353
* @example
5454
* Use a bare-bones client and the command you need to make an API call.
5555
* ```javascript
@@ -80,12 +80,12 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput
8080
* @throws {@link InvalidTrackingOptionsException} (client fault)
8181
* <p>Indicates that the custom domain to be used for open and click tracking redirects is
8282
* invalid. This error appears most often in the following situations:</p>
83-
* <ul>
83+
* <ul>
8484
* <li>
85-
* <p>When the tracking domain you specified is not verified in Amazon SES.</p>
85+
* <p>When the tracking domain you specified is not verified in Amazon SES.</p>
8686
* </li>
8787
* <li>
88-
* <p>When the tracking domain you specified is not a valid domain or
88+
* <p>When the tracking domain you specified is not a valid domain or
8989
* subdomain.</p>
9090
* </li>
9191
* </ul>

‎clients/client-ses/src/commands/CreateCustomVerificationEmailTemplateCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ export interface CreateCustomVerificationEmailTemplateCommandOutput extends __Me
4141
/**
4242
* @public
4343
* <p>Creates a new custom verification email template.</p>
44-
* <p>For more information about custom verification email templates, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer
44+
* <p>For more information about custom verification email templates, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Using
45+
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
4546
* Guide</i>.</p>
46-
* <p>You can execute this operation no more than once per second.</p>
47+
* <p>You can execute this operation no more than once per second.</p>
4748
* @example
4849
* Use a bare-bones client and the command you need to make an API call.
4950
* ```javascript

‎clients/client-ses/src/commands/CreateReceiptFilterCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes
3737
/**
3838
* @public
3939
* <p>Creates a new IP address filter.</p>
40-
* <p>For information about setting up IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer Guide</a>.</p>
41-
* <p>You can execute this operation no more than once per second.</p>
40+
* <p>For information about setting up IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html">Amazon SES
41+
* Developer Guide</a>.</p>
42+
* <p>You can execute this operation no more than once per second.</p>
4243
* @example
4344
* Use a bare-bones client and the command you need to make an API call.
4445
* ```javascript
@@ -49,7 +50,7 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes
4950
* Filter: { // ReceiptFilter
5051
* Name: "STRING_VALUE", // required
5152
* IpFilter: { // ReceiptIpFilter
52-
* Policy: "STRING_VALUE", // required
53+
* Policy: "Block" || "Allow", // required
5354
* Cidr: "STRING_VALUE", // required
5455
* },
5556
* },

‎clients/client-ses/src/commands/CreateReceiptRuleCommand.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
3737
/**
3838
* @public
3939
* <p>Creates a receipt rule.</p>
40-
* <p>For information about setting up receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer
41-
* Guide</a>.</p>
42-
* <p>You can execute this operation no more than once per second.</p>
40+
* <p>For information about setting up receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
41+
* Developer Guide</a>.</p>
42+
* <p>You can execute this operation no more than once per second.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript
@@ -52,7 +52,7 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
5252
* Rule: { // ReceiptRule
5353
* Name: "STRING_VALUE", // required
5454
* Enabled: true || false,
55-
* TlsPolicy: "STRING_VALUE",
55+
* TlsPolicy: "Require" || "Optional",
5656
* Recipients: [ // RecipientsList
5757
* "STRING_VALUE",
5858
* ],
@@ -78,10 +78,10 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
7878
* LambdaAction: { // LambdaAction
7979
* TopicArn: "STRING_VALUE",
8080
* FunctionArn: "STRING_VALUE", // required
81-
* InvocationType: "STRING_VALUE",
81+
* InvocationType: "Event" || "RequestResponse",
8282
* },
8383
* StopAction: { // StopAction
84-
* Scope: "STRING_VALUE", // required
84+
* Scope: "RuleSet", // required
8585
* TopicArn: "STRING_VALUE",
8686
* },
8787
* AddHeaderAction: { // AddHeaderAction
@@ -90,7 +90,7 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
9090
* },
9191
* SNSAction: { // SNSAction
9292
* TopicArn: "STRING_VALUE", // required
93-
* Encoding: "STRING_VALUE",
93+
* Encoding: "UTF-8" || "Base64",
9494
* },
9595
* },
9696
* ],
@@ -113,15 +113,15 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
113113
* <p>Indicates that a resource could not be created because of a naming conflict.</p>
114114
*
115115
* @throws {@link InvalidLambdaFunctionException} (client fault)
116-
* <p>Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could
116+
* <p>Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could
117117
* not execute the provided function, possibly due to permissions issues. For information
118118
* about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
119119
* Developer Guide</a>.</p>
120120
*
121121
* @throws {@link InvalidS3ConfigurationException} (client fault)
122-
* <p>Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or
123-
* that Amazon SES could not publish to the bucket, possibly due to permissions issues. For
124-
* information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
122+
* <p>Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid,
123+
* or that Amazon SES could not publish to the bucket, possibly due to permissions issues.
124+
* For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
125125
* Developer Guide</a>.</p>
126126
*
127127
* @throws {@link InvalidSnsTopicException} (client fault)

‎clients/client-ses/src/commands/CreateReceiptRuleSetCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ export interface CreateReceiptRuleSetCommandOutput extends CreateReceiptRuleSetR
3737
/**
3838
* @public
3939
* <p>Creates an empty receipt rule set.</p>
40-
* <p>For information about setting up receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES
41-
* Developer Guide</a>.</p>
42-
* <p>You can execute this operation no more than once per second.</p>
40+
* <p>For information about setting up receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules">Amazon SES Developer Guide</a>.</p>
41+
* <p>You can execute this operation no more than once per second.</p>
4342
* @example
4443
* Use a bare-bones client and the command you need to make an API call.
4544
* ```javascript

‎clients/client-ses/src/commands/CreateTemplateCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
3737
/**
3838
* @public
3939
* <p>Creates an email template. Email templates enable you to send personalized email to
40-
* one or more destinations in a single API operation. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer
41-
* Guide</a>.</p>
42-
* <p>You can execute this operation no more than once per second.</p>
40+
* one or more destinations in a single operation. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES
41+
* Developer Guide</a>.</p>
42+
* <p>You can execute this operation no more than once per second.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

0 commit comments

Comments
 (0)