@aws-sdk/client-ses 3.287.0 → 3.289.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.
Files changed (46) hide show
  1. package/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +12 -0
  2. package/dist-types/commands/CreateReceiptFilterCommand.d.ts +17 -0
  3. package/dist-types/commands/CreateReceiptRuleCommand.d.ts +26 -0
  4. package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +11 -0
  5. package/dist-types/commands/DeleteIdentityCommand.d.ts +11 -0
  6. package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +12 -0
  7. package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +11 -0
  8. package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +12 -0
  9. package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +11 -0
  10. package/dist-types/commands/DeleteVerifiedEmailAddressCommand.d.ts +11 -0
  11. package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +33 -0
  12. package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +30 -0
  13. package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +35 -0
  14. package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +14 -0
  15. package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +33 -0
  16. package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +24 -0
  17. package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +28 -0
  18. package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +21 -0
  19. package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +23 -0
  20. package/dist-types/commands/GetSendQuotaCommand.d.ts +16 -0
  21. package/dist-types/commands/GetSendStatisticsCommand.d.ts +36 -0
  22. package/dist-types/commands/ListIdentitiesCommand.d.ts +21 -0
  23. package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +18 -0
  24. package/dist-types/commands/ListReceiptFiltersCommand.d.ts +22 -0
  25. package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +22 -0
  26. package/dist-types/commands/ListVerifiedEmailAddressesCommand.d.ts +17 -0
  27. package/dist-types/commands/PutIdentityPolicyCommand.d.ts +13 -0
  28. package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +15 -0
  29. package/dist-types/commands/SendEmailCommand.d.ts +46 -0
  30. package/dist-types/commands/SendRawEmailCommand.d.ts +23 -0
  31. package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +11 -0
  32. package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +12 -0
  33. package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +12 -0
  34. package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +13 -0
  35. package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +13 -0
  36. package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +13 -0
  37. package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +13 -0
  38. package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +11 -0
  39. package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +12 -0
  40. package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +12 -0
  41. package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +25 -0
  42. package/dist-types/commands/VerifyDomainDkimCommand.d.ts +20 -0
  43. package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +16 -0
  44. package/dist-types/commands/VerifyEmailAddressCommand.d.ts +11 -0
  45. package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +11 -0
  46. package/package.json +30 -30
@@ -33,6 +33,28 @@ export interface ListReceiptFiltersCommandOutput extends ListReceiptFiltersRespo
33
33
  * @see {@link ListReceiptFiltersCommandOutput} for command's `response` shape.
34
34
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
35
35
  *
36
+ * @example ListReceiptFilters
37
+ * ```javascript
38
+ * // The following example lists the IP address filters that are associated with an AWS account:
39
+ * const input = undefined;
40
+ * const command = new ListReceiptFiltersCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "Filters": [
45
+ * {
46
+ * "IpFilter": {
47
+ * "Cidr": "1.2.3.4/24",
48
+ * "Policy": "Block"
49
+ * },
50
+ * "Name": "MyFilter"
51
+ * }
52
+ * ]
53
+ * }
54
+ * *\/
55
+ * // example id: listreceiptfilters-1469120786789
56
+ * ```
57
+ *
36
58
  */
37
59
  export declare class ListReceiptFiltersCommand extends $Command<ListReceiptFiltersCommandInput, ListReceiptFiltersCommandOutput, SESClientResolvedConfig> {
38
60
  readonly input: ListReceiptFiltersCommandInput;
@@ -34,6 +34,28 @@ export interface ListReceiptRuleSetsCommandOutput extends ListReceiptRuleSetsRes
34
34
  * @see {@link ListReceiptRuleSetsCommandOutput} for command's `response` shape.
35
35
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
36
36
  *
37
+ * @example ListReceiptRuleSets
38
+ * ```javascript
39
+ * // The following example lists the receipt rule sets that exist under an AWS account:
40
+ * const input = {
41
+ * "NextToken": ""
42
+ * };
43
+ * const command = new ListReceiptRuleSetsCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "NextToken": "",
48
+ * "RuleSets": [
49
+ * {
50
+ * "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
51
+ * "Name": "MyRuleSet"
52
+ * }
53
+ * ]
54
+ * }
55
+ * *\/
56
+ * // example id: listreceiptrulesets-1469121037235
57
+ * ```
58
+ *
37
59
  */
38
60
  export declare class ListReceiptRuleSetsCommand extends $Command<ListReceiptRuleSetsCommandInput, ListReceiptRuleSetsCommandOutput, SESClientResolvedConfig> {
39
61
  readonly input: ListReceiptRuleSetsCommandInput;
@@ -30,6 +30,23 @@ export interface ListVerifiedEmailAddressesCommandOutput extends ListVerifiedEma
30
30
  * @see {@link ListVerifiedEmailAddressesCommandOutput} for command's `response` shape.
31
31
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
32
32
  *
33
+ * @example ListVerifiedEmailAddresses
34
+ * ```javascript
35
+ * // The following example lists all email addresses that have been submitted for verification with Amazon SES:
36
+ * const input = undefined;
37
+ * const command = new ListVerifiedEmailAddressesCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "VerifiedEmailAddresses": [
42
+ * "user1@example.com",
43
+ * "user2@example.com"
44
+ * ]
45
+ * }
46
+ * *\/
47
+ * // example id: listverifiedemailaddresses-1469051402570
48
+ * ```
49
+ *
33
50
  */
34
51
  export declare class ListVerifiedEmailAddressesCommand extends $Command<ListVerifiedEmailAddressesCommandInput, ListVerifiedEmailAddressesCommandOutput, SESClientResolvedConfig> {
35
52
  readonly input: ListVerifiedEmailAddressesCommandInput;
@@ -39,6 +39,19 @@ export interface PutIdentityPolicyCommandOutput extends PutIdentityPolicyRespons
39
39
  * @see {@link PutIdentityPolicyCommandOutput} for command's `response` shape.
40
40
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
41
41
  *
42
+ * @example PutIdentityPolicy
43
+ * ```javascript
44
+ * // The following example adds a sending authorization policy to an identity:
45
+ * const input = {
46
+ * "Identity": "example.com",
47
+ * "Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}",
48
+ * "PolicyName": "MyPolicy"
49
+ * };
50
+ * const command = new PutIdentityPolicyCommand(input);
51
+ * await client.send(command);
52
+ * // example id: putidentitypolicy-1469124560016
53
+ * ```
54
+ *
42
55
  */
43
56
  export declare class PutIdentityPolicyCommand extends $Command<PutIdentityPolicyCommandInput, PutIdentityPolicyCommandOutput, SESClientResolvedConfig> {
44
57
  readonly input: PutIdentityPolicyCommandInput;
@@ -36,6 +36,21 @@ export interface ReorderReceiptRuleSetCommandOutput extends ReorderReceiptRuleSe
36
36
  * @see {@link ReorderReceiptRuleSetCommandOutput} for command's `response` shape.
37
37
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
38
38
  *
39
+ * @example ReorderReceiptRuleSet
40
+ * ```javascript
41
+ * // The following example reorders the receipt rules within a receipt rule set:
42
+ * const input = {
43
+ * "RuleNames": [
44
+ * "MyRule",
45
+ * "MyOtherRule"
46
+ * ],
47
+ * "RuleSetName": "MyRuleSet"
48
+ * };
49
+ * const command = new ReorderReceiptRuleSetCommand(input);
50
+ * await client.send(command);
51
+ * // example id: reorderreceiptruleset-1469058156806
52
+ * ```
53
+ *
39
54
  */
40
55
  export declare class ReorderReceiptRuleSetCommand extends $Command<ReorderReceiptRuleSetCommandInput, ReorderReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
41
56
  readonly input: ReorderReceiptRuleSetCommandInput;
@@ -73,6 +73,52 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea
73
73
  * @see {@link SendEmailCommandOutput} for command's `response` shape.
74
74
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
75
75
  *
76
+ * @example SendEmail
77
+ * ```javascript
78
+ * // The following example sends a formatted email:
79
+ * const input = {
80
+ * "Destination": {
81
+ * "BccAddresses": [],
82
+ * "CcAddresses": [
83
+ * "recipient3@example.com"
84
+ * ],
85
+ * "ToAddresses": [
86
+ * "recipient1@example.com",
87
+ * "recipient2@example.com"
88
+ * ]
89
+ * },
90
+ * "Message": {
91
+ * "Body": {
92
+ * "Html": {
93
+ * "Charset": "UTF-8",
94
+ * "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>."
95
+ * },
96
+ * "Text": {
97
+ * "Charset": "UTF-8",
98
+ * "Data": "This is the message body in text format."
99
+ * }
100
+ * },
101
+ * "Subject": {
102
+ * "Charset": "UTF-8",
103
+ * "Data": "Test email"
104
+ * }
105
+ * },
106
+ * "ReplyToAddresses": [],
107
+ * "ReturnPath": "",
108
+ * "ReturnPathArn": "",
109
+ * "Source": "sender@example.com",
110
+ * "SourceArn": ""
111
+ * };
112
+ * const command = new SendEmailCommand(input);
113
+ * const response = await client.send(command);
114
+ * /* response ==
115
+ * {
116
+ * "MessageId": "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000"
117
+ * }
118
+ * *\/
119
+ * // example id: sendemail-1469049656296
120
+ * ```
121
+ *
76
122
  */
77
123
  export declare class SendEmailCommand extends $Command<SendEmailCommandInput, SendEmailCommandOutput, SESClientResolvedConfig> {
78
124
  readonly input: SendEmailCommandInput;
@@ -137,6 +137,29 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad
137
137
  * @see {@link SendRawEmailCommandOutput} for command's `response` shape.
138
138
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
139
139
  *
140
+ * @example SendRawEmail
141
+ * ```javascript
142
+ * // The following example sends an email with an attachment:
143
+ * const input = {
144
+ * "Destinations": [],
145
+ * "FromArn": "",
146
+ * "RawMessage": {
147
+ * "Data": "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--"
148
+ * },
149
+ * "ReturnPathArn": "",
150
+ * "Source": "",
151
+ * "SourceArn": ""
152
+ * };
153
+ * const command = new SendRawEmailCommand(input);
154
+ * const response = await client.send(command);
155
+ * /* response ==
156
+ * {
157
+ * "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000"
158
+ * }
159
+ * *\/
160
+ * // example id: sendrawemail-1469118548649
161
+ * ```
162
+ *
140
163
  */
141
164
  export declare class SendRawEmailCommand extends $Command<SendRawEmailCommandInput, SendRawEmailCommandOutput, SESClientResolvedConfig> {
142
165
  readonly input: SendRawEmailCommandInput;
@@ -35,6 +35,17 @@ export interface SetActiveReceiptRuleSetCommandOutput extends SetActiveReceiptRu
35
35
  * @see {@link SetActiveReceiptRuleSetCommandOutput} for command's `response` shape.
36
36
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
37
37
  *
38
+ * @example SetActiveReceiptRuleSet
39
+ * ```javascript
40
+ * // The following example sets the active receipt rule set:
41
+ * const input = {
42
+ * "RuleSetName": "RuleSetToActivate"
43
+ * };
44
+ * const command = new SetActiveReceiptRuleSetCommand(input);
45
+ * await client.send(command);
46
+ * // example id: setactivereceiptruleset-1469058391329
47
+ * ```
48
+ *
38
49
  */
39
50
  export declare class SetActiveReceiptRuleSetCommand extends $Command<SetActiveReceiptRuleSetCommandInput, SetActiveReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
40
51
  readonly input: SetActiveReceiptRuleSetCommandInput;
@@ -41,6 +41,18 @@ export interface SetIdentityDkimEnabledCommandOutput extends SetIdentityDkimEnab
41
41
  * @see {@link SetIdentityDkimEnabledCommandOutput} for command's `response` shape.
42
42
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
43
43
  *
44
+ * @example SetIdentityDkimEnabled
45
+ * ```javascript
46
+ * // The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:
47
+ * const input = {
48
+ * "DkimEnabled": true,
49
+ * "Identity": "user@example.com"
50
+ * };
51
+ * const command = new SetIdentityDkimEnabledCommand(input);
52
+ * await client.send(command);
53
+ * // example id: setidentitydkimenabled-1469057485202
54
+ * ```
55
+ *
44
56
  */
45
57
  export declare class SetIdentityDkimEnabledCommand extends $Command<SetIdentityDkimEnabledCommandInput, SetIdentityDkimEnabledCommandOutput, SESClientResolvedConfig> {
46
58
  readonly input: SetIdentityDkimEnabledCommandInput;
@@ -39,6 +39,18 @@ export interface SetIdentityFeedbackForwardingEnabledCommandOutput extends SetId
39
39
  * @see {@link SetIdentityFeedbackForwardingEnabledCommandOutput} for command's `response` shape.
40
40
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
41
41
  *
42
+ * @example SetIdentityFeedbackForwardingEnabled
43
+ * ```javascript
44
+ * // The following example configures Amazon SES to forward an identity's bounces and complaints via email:
45
+ * const input = {
46
+ * "ForwardingEnabled": true,
47
+ * "Identity": "user@example.com"
48
+ * };
49
+ * const command = new SetIdentityFeedbackForwardingEnabledCommand(input);
50
+ * await client.send(command);
51
+ * // example id: setidentityfeedbackforwardingenabled-1469056811329
52
+ * ```
53
+ *
42
54
  */
43
55
  export declare class SetIdentityFeedbackForwardingEnabledCommand extends $Command<SetIdentityFeedbackForwardingEnabledCommandInput, SetIdentityFeedbackForwardingEnabledCommandOutput, SESClientResolvedConfig> {
44
56
  readonly input: SetIdentityFeedbackForwardingEnabledCommandInput;
@@ -34,6 +34,19 @@ export interface SetIdentityHeadersInNotificationsEnabledCommandOutput extends S
34
34
  * @see {@link SetIdentityHeadersInNotificationsEnabledCommandOutput} for command's `response` shape.
35
35
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
36
36
  *
37
+ * @example SetIdentityHeadersInNotificationsEnabled
38
+ * ```javascript
39
+ * // The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:
40
+ * const input = {
41
+ * "Enabled": true,
42
+ * "Identity": "user@example.com",
43
+ * "NotificationType": "Bounce"
44
+ * };
45
+ * const command = new SetIdentityHeadersInNotificationsEnabledCommand(input);
46
+ * await client.send(command);
47
+ * // example id: setidentityheadersinnotificationsenabled-1469057295001
48
+ * ```
49
+ *
37
50
  */
38
51
  export declare class SetIdentityHeadersInNotificationsEnabledCommand extends $Command<SetIdentityHeadersInNotificationsEnabledCommandInput, SetIdentityHeadersInNotificationsEnabledCommandOutput, SESClientResolvedConfig> {
39
52
  readonly input: SetIdentityHeadersInNotificationsEnabledCommandInput;
@@ -38,6 +38,19 @@ export interface SetIdentityMailFromDomainCommandOutput extends SetIdentityMailF
38
38
  * @see {@link SetIdentityMailFromDomainCommandOutput} for command's `response` shape.
39
39
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
40
40
  *
41
+ * @example SetIdentityMailFromDomain
42
+ * ```javascript
43
+ * // The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:
44
+ * const input = {
45
+ * "BehaviorOnMXFailure": "UseDefaultValue",
46
+ * "Identity": "user@example.com",
47
+ * "MailFromDomain": "bounces.example.com"
48
+ * };
49
+ * const command = new SetIdentityMailFromDomainCommand(input);
50
+ * await client.send(command);
51
+ * // example id: setidentitymailfromdomain-1469057693908
52
+ * ```
53
+ *
41
54
  */
42
55
  export declare class SetIdentityMailFromDomainCommand extends $Command<SetIdentityMailFromDomainCommandInput, SetIdentityMailFromDomainCommandOutput, SESClientResolvedConfig> {
43
56
  readonly input: SetIdentityMailFromDomainCommandInput;
@@ -37,6 +37,19 @@ export interface SetIdentityNotificationTopicCommandOutput extends SetIdentityNo
37
37
  * @see {@link SetIdentityNotificationTopicCommandOutput} for command's `response` shape.
38
38
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
39
39
  *
40
+ * @example SetIdentityNotificationTopic
41
+ * ```javascript
42
+ * // The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:
43
+ * const input = {
44
+ * "Identity": "user@example.com",
45
+ * "NotificationType": "Bounce",
46
+ * "SnsTopic": "arn:aws:sns:us-west-2:111122223333:MyTopic"
47
+ * };
48
+ * const command = new SetIdentityNotificationTopicCommand(input);
49
+ * await client.send(command);
50
+ * // example id: setidentitynotificationtopic-1469057854966
51
+ * ```
52
+ *
40
53
  */
41
54
  export declare class SetIdentityNotificationTopicCommand extends $Command<SetIdentityNotificationTopicCommandInput, SetIdentityNotificationTopicCommandOutput, SESClientResolvedConfig> {
42
55
  readonly input: SetIdentityNotificationTopicCommandInput;
@@ -32,6 +32,19 @@ export interface SetReceiptRulePositionCommandOutput extends SetReceiptRulePosit
32
32
  * @see {@link SetReceiptRulePositionCommandOutput} for command's `response` shape.
33
33
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
34
34
  *
35
+ * @example SetReceiptRulePosition
36
+ * ```javascript
37
+ * // The following example sets the position of a receipt rule in a receipt rule set:
38
+ * const input = {
39
+ * "After": "PutRuleAfterThisRule",
40
+ * "RuleName": "RuleToReposition",
41
+ * "RuleSetName": "MyRuleSet"
42
+ * };
43
+ * const command = new SetReceiptRulePositionCommand(input);
44
+ * await client.send(command);
45
+ * // example id: setreceiptruleposition-1469058530550
46
+ * ```
47
+ *
35
48
  */
36
49
  export declare class SetReceiptRulePositionCommand extends $Command<SetReceiptRulePositionCommandInput, SetReceiptRulePositionCommandOutput, SESClientResolvedConfig> {
37
50
  readonly input: SetReceiptRulePositionCommandInput;
@@ -34,6 +34,17 @@ export interface UpdateAccountSendingEnabledCommandOutput extends __MetadataBear
34
34
  * @see {@link UpdateAccountSendingEnabledCommandOutput} for command's `response` shape.
35
35
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
36
36
  *
37
+ * @example UpdateAccountSendingEnabled
38
+ * ```javascript
39
+ * // The following example updated the sending status for this account.
40
+ * const input = {
41
+ * "Enabled": true
42
+ * };
43
+ * const command = new UpdateAccountSendingEnabledCommand(input);
44
+ * await client.send(command);
45
+ * // example id: updateaccountsendingenabled-1469047741333
46
+ * ```
47
+ *
37
48
  */
38
49
  export declare class UpdateAccountSendingEnabledCommand extends $Command<UpdateAccountSendingEnabledCommandInput, UpdateAccountSendingEnabledCommandOutput, SESClientResolvedConfig> {
39
50
  readonly input: UpdateAccountSendingEnabledCommandInput;
@@ -33,6 +33,18 @@ export interface UpdateConfigurationSetReputationMetricsEnabledCommandOutput ext
33
33
  * @see {@link UpdateConfigurationSetReputationMetricsEnabledCommandOutput} for command's `response` shape.
34
34
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
35
35
  *
36
+ * @example UpdateConfigurationSetReputationMetricsEnabled
37
+ * ```javascript
38
+ * // Set the reputationMetricsEnabled flag for a specific configuration set.
39
+ * const input = {
40
+ * "ConfigurationSetName": "foo",
41
+ * "Enabled": true
42
+ * };
43
+ * const command = new UpdateConfigurationSetReputationMetricsEnabledCommand(input);
44
+ * await client.send(command);
45
+ * // example id: updateconfigurationsetreputationmetricsenabled-2362747741333
46
+ * ```
47
+ *
36
48
  */
37
49
  export declare class UpdateConfigurationSetReputationMetricsEnabledCommand extends $Command<UpdateConfigurationSetReputationMetricsEnabledCommandInput, UpdateConfigurationSetReputationMetricsEnabledCommandOutput, SESClientResolvedConfig> {
38
50
  readonly input: UpdateConfigurationSetReputationMetricsEnabledCommandInput;
@@ -34,6 +34,18 @@ export interface UpdateConfigurationSetSendingEnabledCommandOutput extends __Met
34
34
  * @see {@link UpdateConfigurationSetSendingEnabledCommandOutput} for command's `response` shape.
35
35
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
36
36
  *
37
+ * @example UpdateConfigurationSetReputationMetricsEnabled
38
+ * ```javascript
39
+ * // Set the sending enabled flag for a specific configuration set.
40
+ * const input = {
41
+ * "ConfigurationSetName": "foo",
42
+ * "Enabled": true
43
+ * };
44
+ * const command = new UpdateConfigurationSetSendingEnabledCommand(input);
45
+ * await client.send(command);
46
+ * // example id: updateconfigurationsetsendingenabled-2362747741333
47
+ * ```
48
+ *
37
49
  */
38
50
  export declare class UpdateConfigurationSetSendingEnabledCommand extends $Command<UpdateConfigurationSetSendingEnabledCommandInput, UpdateConfigurationSetSendingEnabledCommandOutput, SESClientResolvedConfig> {
39
51
  readonly input: UpdateConfigurationSetSendingEnabledCommandInput;
@@ -32,6 +32,31 @@ export interface UpdateReceiptRuleCommandOutput extends UpdateReceiptRuleRespons
32
32
  * @see {@link UpdateReceiptRuleCommandOutput} for command's `response` shape.
33
33
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
34
34
  *
35
+ * @example UpdateReceiptRule
36
+ * ```javascript
37
+ * // The following example updates a receipt rule to use an Amazon S3 action:
38
+ * const input = {
39
+ * "Rule": {
40
+ * "Actions": [
41
+ * {
42
+ * "S3Action": {
43
+ * "BucketName": "MyBucket",
44
+ * "ObjectKeyPrefix": "email"
45
+ * }
46
+ * }
47
+ * ],
48
+ * "Enabled": true,
49
+ * "Name": "MyRule",
50
+ * "ScanEnabled": true,
51
+ * "TlsPolicy": "Optional"
52
+ * },
53
+ * "RuleSetName": "MyRuleSet"
54
+ * };
55
+ * const command = new UpdateReceiptRuleCommand(input);
56
+ * await client.send(command);
57
+ * // example id: updatereceiptrule-1469051756940
58
+ * ```
59
+ *
35
60
  */
36
61
  export declare class UpdateReceiptRuleCommand extends $Command<UpdateReceiptRuleCommandInput, UpdateReceiptRuleCommandOutput, SESClientResolvedConfig> {
37
62
  readonly input: UpdateReceiptRuleCommandInput;
@@ -67,6 +67,26 @@ export interface VerifyDomainDkimCommandOutput extends VerifyDomainDkimResponse,
67
67
  * @see {@link VerifyDomainDkimCommandOutput} for command's `response` shape.
68
68
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
69
69
  *
70
+ * @example VerifyDomainDkim
71
+ * ```javascript
72
+ * // The following example generates DKIM tokens for a domain that has been verified with Amazon SES:
73
+ * const input = {
74
+ * "Domain": "example.com"
75
+ * };
76
+ * const command = new VerifyDomainDkimCommand(input);
77
+ * const response = await client.send(command);
78
+ * /* response ==
79
+ * {
80
+ * "DkimTokens": [
81
+ * "EXAMPLEq76owjnks3lnluwg65scbemvw",
82
+ * "EXAMPLEi3dnsj67hstzaj673klariwx2",
83
+ * "EXAMPLEwfbtcukvimehexktmdtaz6naj"
84
+ * ]
85
+ * }
86
+ * *\/
87
+ * // example id: verifydomaindkim-1469049503083
88
+ * ```
89
+ *
70
90
  */
71
91
  export declare class VerifyDomainDkimCommand extends $Command<VerifyDomainDkimCommandInput, VerifyDomainDkimCommandOutput, SESClientResolvedConfig> {
72
92
  readonly input: VerifyDomainDkimCommandInput;
@@ -35,6 +35,22 @@ export interface VerifyDomainIdentityCommandOutput extends VerifyDomainIdentityR
35
35
  * @see {@link VerifyDomainIdentityCommandOutput} for command's `response` shape.
36
36
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
37
37
  *
38
+ * @example VerifyDomainIdentity
39
+ * ```javascript
40
+ * // The following example starts the domain verification process with Amazon SES:
41
+ * const input = {
42
+ * "Domain": "example.com"
43
+ * };
44
+ * const command = new VerifyDomainIdentityCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE"
49
+ * }
50
+ * *\/
51
+ * // example id: verifydomainidentity-1469049165936
52
+ * ```
53
+ *
38
54
  */
39
55
  export declare class VerifyDomainIdentityCommand extends $Command<VerifyDomainIdentityCommandInput, VerifyDomainIdentityCommandOutput, SESClientResolvedConfig> {
40
56
  readonly input: VerifyDomainIdentityCommandInput;
@@ -30,6 +30,17 @@ export interface VerifyEmailAddressCommandOutput extends __MetadataBearer {
30
30
  * @see {@link VerifyEmailAddressCommandOutput} for command's `response` shape.
31
31
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
32
32
  *
33
+ * @example VerifyEmailAddress
34
+ * ```javascript
35
+ * // The following example starts the email address verification process with Amazon SES:
36
+ * const input = {
37
+ * "EmailAddress": "user@example.com"
38
+ * };
39
+ * const command = new VerifyEmailAddressCommand(input);
40
+ * await client.send(command);
41
+ * // example id: verifyemailaddress-1469048849187
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class VerifyEmailAddressCommand extends $Command<VerifyEmailAddressCommandInput, VerifyEmailAddressCommandOutput, SESClientResolvedConfig> {
35
46
  readonly input: VerifyEmailAddressCommandInput;
@@ -32,6 +32,17 @@ export interface VerifyEmailIdentityCommandOutput extends VerifyEmailIdentityRes
32
32
  * @see {@link VerifyEmailIdentityCommandOutput} for command's `response` shape.
33
33
  * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
34
34
  *
35
+ * @example VerifyEmailIdentity
36
+ * ```javascript
37
+ * // The following example starts the email address verification process with Amazon SES:
38
+ * const input = {
39
+ * "EmailAddress": "user@example.com"
40
+ * };
41
+ * const command = new VerifyEmailIdentityCommand(input);
42
+ * await client.send(command);
43
+ * // example id: verifyemailidentity-1469049068623
44
+ * ```
45
+ *
35
46
  */
36
47
  export declare class VerifyEmailIdentityCommand extends $Command<VerifyEmailIdentityCommandInput, VerifyEmailIdentityCommandOutput, SESClientResolvedConfig> {
37
48
  readonly input: VerifyEmailIdentityCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ses",
3
3
  "description": "AWS SDK for JavaScript Ses Client for Node.js, Browser and React Native",
4
- "version": "3.287.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.287.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.287.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.287.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
- "@aws-sdk/util-waiter": "3.272.0",
55
+ "@aws-sdk/util-waiter": "3.289.0",
56
56
  "fast-xml-parser": "4.1.2",
57
57
  "tslib": "^2.3.1"
58
58
  },