docs(client-ses): Doc only updates to include: 1) Clarified which par…

…t 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.
aws · Aug 11, 2023 · 0310a62 · 0310a62
1 parent 1524521
commit 0310a62
Show file tree

Hide file tree

Showing 75 changed files with 2,604 additions and 2,770 deletions.
diff --git a/clients/client-ses/README.md b/clients/client-ses/README.md
@@ -16,6 +16,31 @@ Guide</a>. </p>
 Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
 Guide</a>.</p>
 </note>
+<p>This documentation contains reference information related to the following:</p>
+<ul>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
+API Data Types</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
+Parameters</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
+</p>
+</li>
+</ul>
 
 ## Installing
 

diff --git a/clients/client-ses/src/SES.ts b/clients/client-ses/src/SES.ts
@@ -1582,14 +1582,39 @@ export interface SES {
 /**
  * @public
  * <fullname>Amazon Simple Email Service</fullname>
- *         <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
+ *          <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
  *             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
  *                 Guide</a>. </p>
- *         <note>
+ *          <note>
  *             <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
  *                     Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
  *                 Guide</a>.</p>
- *         </note>
+ *          </note>
+ *          <p>This documentation contains reference information related to the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
+ *                         API Data Types</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
+ *                         Parameters</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export class SES extends SESClient implements SES {}
 createAggregatedClient(commands, SES);
diff --git a/clients/client-ses/src/SESClient.ts b/clients/client-ses/src/SESClient.ts
@@ -598,14 +598,39 @@ export interface SESClientResolvedConfig extends SESClientResolvedConfigType {}
 /**
  * @public
  * <fullname>Amazon Simple Email Service</fullname>
- *         <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
+ *          <p> This document contains reference information for the <a href="https://aws.amazon.com/ses/">Amazon Simple Email Service</a> (Amazon SES) API, version
  *             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
  *                 Guide</a>. </p>
- *         <note>
+ *          <note>
  *             <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
  *                     Amazon SES</a> in the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer
  *                 Guide</a>.</p>
- *         </note>
+ *          </note>
+ *          <p>This documentation contains reference information related to the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html">Amazon SES API Actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html">Amazon SES
+ *                         API Data Types</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html">Common
+ *                         Parameters</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html">Common Errors</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export class SESClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-ses/src/commands/CloneReceiptRuleSetCommand.ts b/clients/client-ses/src/commands/CloneReceiptRuleSetCommand.ts
@@ -39,9 +39,8 @@ export interface CloneReceiptRuleSetCommandOutput extends CloneReceiptRuleSetRes
  * <p>Creates a receipt rule set by cloning an existing one. All receipt rules and
  *             configurations are copied to the new receipt rule set and are completely independent of
  *             the source rule set.</p>
- *         <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
- *                 Developer Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <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>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ses/src/commands/CreateConfigurationSetCommand.ts b/clients/client-ses/src/commands/CreateConfigurationSetCommand.ts
@@ -37,10 +37,10 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
 /**
  * @public
  * <p>Creates a configuration set.</p>
- *         <p>Configuration sets enable you to publish email sending events. For information about
- *             using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer
- *                 Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <p>Configuration sets enable you to publish email sending events. For information about
+ *             using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
+ *             Guide</a>.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ses/src/commands/CreateConfigurationSetEventDestinationCommand.ts b/clients/client-ses/src/commands/CreateConfigurationSetEventDestinationCommand.ts
@@ -46,15 +46,15 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
 /**
  * @public
  * <p>Creates a configuration set event destination.</p>
- *         <note>
+ *          <note>
  *             <p>When you create or update an event destination, you must provide one, and only
  *                 one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).</p>
- *         </note>
- *         <p>An event destination is the AWS service to which Amazon SES publishes the email sending
+ *          </note>
+ *          <p>An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending
  *             events associated with a configuration set. For information about using configuration
- *             sets, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer
- *                 Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *             sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
+ *             Guide</a>.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,7 +67,7 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
  *     Name: "STRING_VALUE", // required
  *     Enabled: true || false,
  *     MatchingEventTypes: [ // EventTypes // required
- *       "STRING_VALUE",
+ *       "send" || "reject" || "bounce" || "complaint" || "delivery" || "open" || "click" || "renderingFailure",
  *     ],
  *     KinesisFirehoseDestination: { // KinesisFirehoseDestination
  *       IAMRoleARN: "STRING_VALUE", // required
@@ -77,7 +77,7 @@ export interface CreateConfigurationSetEventDestinationCommandOutput
  *       DimensionConfigurations: [ // CloudWatchDimensionConfigurations // required
  *         { // CloudWatchDimensionConfiguration
  *           DimensionName: "STRING_VALUE", // required
- *           DimensionValueSource: "STRING_VALUE", // required
+ *           DimensionValueSource: "messageTag" || "emailHeader" || "linkTag", // required
  *           DefaultDimensionValue: "STRING_VALUE", // required
  *         },
  *       ],

diff --git a/clients/client-ses/src/commands/CreateConfigurationSetTrackingOptionsCommand.ts b/clients/client-ses/src/commands/CreateConfigurationSetTrackingOptionsCommand.ts
@@ -47,9 +47,9 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput
  * @public
  * <p>Creates an association between a configuration set and a custom domain for open and
  *             click event tracking. </p>
- *         <p>By default, images and links used for tracking open and click events are hosted on
+ *          <p>By default, images and links used for tracking open and click events are hosted on
  *             domains operated by Amazon SES. You can configure a subdomain of your own to handle these
- *             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>
+ *             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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -80,12 +80,12 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput
  * @throws {@link InvalidTrackingOptionsException} (client fault)
  *  <p>Indicates that the custom domain to be used for open and click tracking redirects is
  *             invalid. This error appears most often in the following situations:</p>
- *         <ul>
+ *          <ul>
  *             <li>
- *                 <p>When the tracking domain you specified is not verified in Amazon SES.</p>
+ *                <p>When the tracking domain you specified is not verified in Amazon SES.</p>
  *             </li>
  *             <li>
- *                 <p>When the tracking domain you specified is not a valid domain or
+ *                <p>When the tracking domain you specified is not a valid domain or
  *                     subdomain.</p>
  *             </li>
  *          </ul>

diff --git a/clients/client-ses/src/commands/CreateCustomVerificationEmailTemplateCommand.ts b/clients/client-ses/src/commands/CreateCustomVerificationEmailTemplateCommand.ts
@@ -41,9 +41,10 @@ export interface CreateCustomVerificationEmailTemplateCommandOutput extends __Me
 /**
  * @public
  * <p>Creates a new custom verification email template.</p>
- *         <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
+ *          <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
+ *                 Custom Verification Email Templates</a> in the <i>Amazon SES Developer
  *                 Guide</i>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ses/src/commands/CreateReceiptFilterCommand.ts b/clients/client-ses/src/commands/CreateReceiptFilterCommand.ts
@@ -37,8 +37,9 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes
 /**
  * @public
  * <p>Creates a new IP address filter.</p>
- *         <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>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <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
+ *                 Developer Guide</a>.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -49,7 +50,7 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes
  *   Filter: { // ReceiptFilter
  *     Name: "STRING_VALUE", // required
  *     IpFilter: { // ReceiptIpFilter
- *       Policy: "STRING_VALUE", // required
+ *       Policy: "Block" || "Allow", // required
  *       Cidr: "STRING_VALUE", // required
  *     },
  *   },

diff --git a/clients/client-ses/src/commands/CreateReceiptRuleCommand.ts b/clients/client-ses/src/commands/CreateReceiptRuleCommand.ts
@@ -37,9 +37,9 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
 /**
  * @public
  * <p>Creates a receipt rule.</p>
- *         <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
- *                 Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <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
+ *                 Developer Guide</a>.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,7 +52,7 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
  *   Rule: { // ReceiptRule
  *     Name: "STRING_VALUE", // required
  *     Enabled: true || false,
- *     TlsPolicy: "STRING_VALUE",
+ *     TlsPolicy: "Require" || "Optional",
  *     Recipients: [ // RecipientsList
  *       "STRING_VALUE",
  *     ],
@@ -78,10 +78,10 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
  *         LambdaAction: { // LambdaAction
  *           TopicArn: "STRING_VALUE",
  *           FunctionArn: "STRING_VALUE", // required
- *           InvocationType: "STRING_VALUE",
+ *           InvocationType: "Event" || "RequestResponse",
  *         },
  *         StopAction: { // StopAction
- *           Scope: "STRING_VALUE", // required
+ *           Scope: "RuleSet", // required
  *           TopicArn: "STRING_VALUE",
  *         },
  *         AddHeaderAction: { // AddHeaderAction
@@ -90,7 +90,7 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
  *         },
  *         SNSAction: { // SNSAction
  *           TopicArn: "STRING_VALUE", // required
- *           Encoding: "STRING_VALUE",
+ *           Encoding: "UTF-8" || "Base64",
  *         },
  *       },
  *     ],
@@ -113,15 +113,15 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
  *  <p>Indicates that a resource could not be created because of a naming conflict.</p>
  *
  * @throws {@link InvalidLambdaFunctionException} (client fault)
- *  <p>Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could
+ *  <p>Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could
  *             not execute the provided function, possibly due to permissions issues. For information
  *             about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
  *                 Developer Guide</a>.</p>
  *
  * @throws {@link InvalidS3ConfigurationException} (client fault)
- *  <p>Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or
- *             that Amazon SES could not publish to the bucket, possibly due to permissions issues. For
- *             information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
+ *  <p>Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid,
+ *             or that Amazon SES could not publish to the bucket, possibly due to permissions issues.
+ *             For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
  *                 Developer Guide</a>.</p>
  *
  * @throws {@link InvalidSnsTopicException} (client fault)

diff --git a/clients/client-ses/src/commands/CreateReceiptRuleSetCommand.ts b/clients/client-ses/src/commands/CreateReceiptRuleSetCommand.ts
@@ -37,9 +37,8 @@ export interface CreateReceiptRuleSetCommandOutput extends CreateReceiptRuleSetR
 /**
  * @public
  * <p>Creates an empty receipt rule set.</p>
- *         <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
- *                 Developer Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *          <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>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ses/src/commands/CreateTemplateCommand.ts b/clients/client-ses/src/commands/CreateTemplateCommand.ts
@@ -37,9 +37,9 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
 /**
  * @public
  * <p>Creates an email template. Email templates enable you to send personalized email to
- *             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
- *                 Guide</a>.</p>
- *         <p>You can execute this operation no more than once per second.</p>
+ *             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
+ *                 Developer Guide</a>.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript