From 0310a6225c04b7560d8f03e4076680ab89391265 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 11 Aug 2023 18:16:37 +0000 Subject: [PATCH] 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. --- clients/client-ses/README.md | 25 + clients/client-ses/src/SES.ts | 31 +- clients/client-ses/src/SESClient.ts | 31 +- .../commands/CloneReceiptRuleSetCommand.ts | 5 +- .../commands/CreateConfigurationSetCommand.ts | 8 +- ...ConfigurationSetEventDestinationCommand.ts | 16 +- ...eConfigurationSetTrackingOptionsCommand.ts | 10 +- ...eCustomVerificationEmailTemplateCommand.ts | 5 +- .../commands/CreateReceiptFilterCommand.ts | 7 +- .../src/commands/CreateReceiptRuleCommand.ts | 22 +- .../commands/CreateReceiptRuleSetCommand.ts | 5 +- .../src/commands/CreateTemplateCommand.ts | 6 +- .../commands/DeleteConfigurationSetCommand.ts | 5 +- ...ConfigurationSetEventDestinationCommand.ts | 5 +- ...eConfigurationSetTrackingOptionsCommand.ts | 10 +- ...eCustomVerificationEmailTemplateCommand.ts | 5 +- .../src/commands/DeleteIdentityCommand.ts | 2 +- .../commands/DeleteIdentityPolicyCommand.ts | 20 +- .../commands/DeleteReceiptFilterCommand.ts | 4 +- .../src/commands/DeleteReceiptRuleCommand.ts | 4 +- .../commands/DeleteReceiptRuleSetCommand.ts | 9 +- .../src/commands/DeleteTemplateCommand.ts | 2 +- .../DescribeActiveReceiptRuleSetCommand.ts | 13 +- .../DescribeConfigurationSetCommand.ts | 14 +- .../commands/DescribeReceiptRuleCommand.ts | 14 +- .../commands/DescribeReceiptRuleSetCommand.ts | 13 +- .../GetAccountSendingEnabledCommand.ts | 4 +- ...tCustomVerificationEmailTemplateCommand.ts | 5 +- .../GetIdentityDkimAttributesCommand.ts | 17 +- ...IdentityMailFromDomainAttributesCommand.ts | 6 +- ...etIdentityNotificationAttributesCommand.ts | 4 +- .../commands/GetIdentityPoliciesCommand.ts | 16 +- ...etIdentityVerificationAttributesCommand.ts | 16 +- .../src/commands/GetSendQuotaCommand.ts | 2 +- .../src/commands/GetSendStatisticsCommand.ts | 4 +- .../src/commands/GetTemplateCommand.ts | 2 +- .../commands/ListConfigurationSetsCommand.ts | 11 +- ...CustomVerificationEmailTemplatesCommand.ts | 7 +- .../src/commands/ListIdentitiesCommand.ts | 16 +- .../commands/ListIdentityPoliciesCommand.ts | 20 +- .../src/commands/ListReceiptFiltersCommand.ts | 10 +- .../commands/ListReceiptRuleSetsCommand.ts | 9 +- .../src/commands/ListTemplatesCommand.ts | 6 +- ...tConfigurationSetDeliveryOptionsCommand.ts | 2 +- .../src/commands/PutIdentityPolicyCommand.ts | 16 +- .../commands/ReorderReceiptRuleSetCommand.ts | 14 +- .../src/commands/SendBounceCommand.ts | 21 +- .../commands/SendBulkTemplatedEmailCommand.ts | 38 +- .../SendCustomVerificationEmailCommand.ts | 10 +- .../src/commands/SendEmailCommand.ts | 40 +- .../src/commands/SendRawEmailCommand.ts | 108 +- .../src/commands/SendTemplatedEmailCommand.ts | 43 +- .../SetActiveReceiptRuleSetCommand.ts | 13 +- .../commands/SetIdentityDkimEnabledCommand.ts | 11 +- ...dentityFeedbackForwardingEnabledCommand.ts | 8 +- ...ityHeadersInNotificationsEnabledCommand.ts | 6 +- .../SetIdentityMailFromDomainCommand.ts | 13 +- .../SetIdentityNotificationTopicCommand.ts | 8 +- .../commands/SetReceiptRulePositionCommand.ts | 4 +- .../src/commands/TestRenderTemplateCommand.ts | 2 +- .../UpdateAccountSendingEnabledCommand.ts | 6 +- ...ConfigurationSetEventDestinationCommand.ts | 14 +- ...ationSetReputationMetricsEnabledCommand.ts | 4 +- ...teConfigurationSetSendingEnabledCommand.ts | 4 +- ...eConfigurationSetTrackingOptionsCommand.ts | 10 +- ...eCustomVerificationEmailTemplateCommand.ts | 5 +- .../src/commands/UpdateReceiptRuleCommand.ts | 20 +- .../src/commands/UpdateTemplateCommand.ts | 6 +- .../src/commands/VerifyDomainDkimCommand.ts | 26 +- .../commands/VerifyDomainIdentityCommand.ts | 11 +- .../commands/VerifyEmailIdentityCommand.ts | 4 +- clients/client-ses/src/endpoint/ruleset.ts | 35 +- clients/client-ses/src/index.ts | 31 +- clients/client-ses/src/models/models_0.ts | 1353 ++++---- codegen/sdk-codegen/aws-models/ses.json | 3042 ++++++++--------- 75 files changed, 2604 insertions(+), 2770 deletions(-) diff --git a/clients/client-ses/README.md b/clients/client-ses/README.md index 052b808f3d38..6bc3679994fb 100644 --- a/clients/client-ses/README.md +++ b/clients/client-ses/README.md @@ -16,6 +16,31 @@ Guide.

Amazon SES in the Amazon SES Developer Guide.

+

This documentation contains reference information related to the following:

+ ## Installing diff --git a/clients/client-ses/src/SES.ts b/clients/client-ses/src/SES.ts index 63174bfda619..acb17d8f0310 100644 --- a/clients/client-ses/src/SES.ts +++ b/clients/client-ses/src/SES.ts @@ -1582,14 +1582,39 @@ export interface SES { /** * @public * Amazon Simple Email Service - *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version + *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version * 2010-12-01. This document is best used in conjunction with the Amazon SES Developer * Guide.

- * + * *

For a list of Amazon SES endpoints to use in service requests, see Regions and * Amazon SES in the Amazon SES Developer * Guide.

- * + * + *

This documentation contains reference information related to the following:

+ * */ 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 index a2a39bea9063..1afb62ee4593 100644 --- a/clients/client-ses/src/SESClient.ts +++ b/clients/client-ses/src/SESClient.ts @@ -598,14 +598,39 @@ export interface SESClientResolvedConfig extends SESClientResolvedConfigType {} /** * @public * Amazon Simple Email Service - *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version + *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version * 2010-12-01. This document is best used in conjunction with the Amazon SES Developer * Guide.

- * + * *

For a list of Amazon SES endpoints to use in service requests, see Regions and * Amazon SES in the Amazon SES Developer * Guide.

- * + * + *

This documentation contains reference information related to the following:

+ * */ export class SESClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-ses/src/commands/CloneReceiptRuleSetCommand.ts b/clients/client-ses/src/commands/CloneReceiptRuleSetCommand.ts index 880e974629ed..2fd9a61bf936 100644 --- 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 *

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.

- *

For information about setting up rule sets, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

+ *

For information about setting up rule sets, see the Amazon SES Developer Guide.

+ *

You can execute this operation no more than once per second.

* @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 index 5c0db2dccce7..ce1540fd97fa 100644 --- 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 *

Creates a configuration set.

- *

Configuration sets enable you to publish email sending events. For information about - * using configuration sets, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

+ *

Configuration sets enable you to publish email sending events. For information about + * using configuration sets, see the Amazon SES Developer + * Guide.

+ *

You can execute this operation no more than once per second.

* @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 index b1bae50b67df..adfbf787b85e 100644 --- a/clients/client-ses/src/commands/CreateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-ses/src/commands/CreateConfigurationSetEventDestinationCommand.ts @@ -46,15 +46,15 @@ export interface CreateConfigurationSetEventDestinationCommandOutput /** * @public *

Creates a configuration set event destination.

- * + * *

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).

- * - *

An event destination is the AWS service to which Amazon SES publishes the email sending + * + *

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 Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

+ * sets, see the Amazon SES Developer + * Guide.

+ *

You can execute this operation no more than once per second.

* @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 index a76b59b5c283..878701b3ef2f 100644 --- a/clients/client-ses/src/commands/CreateConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-ses/src/commands/CreateConfigurationSetTrackingOptionsCommand.ts @@ -47,9 +47,9 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput * @public *

Creates an association between a configuration set and a custom domain for open and * click event tracking.

- *

By default, images and links used for tracking open and click events are hosted on + *

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 Amazon SES Developer Guide.

+ * events. For information about using custom domains, see the Amazon SES Developer Guide.

* @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) *

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:

- *