@aws-sdk/client-ses 3.533.0 → 3.540.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.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/SES.d.ts +14 -1
- package/dist-types/SESClient.d.ts +1 -1
- package/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +2 -1
- package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +2 -1
- package/dist-types/commands/CreateConfigurationSetTrackingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateReceiptFilterCommand.d.ts +2 -1
- package/dist-types/commands/CreateReceiptRuleCommand.d.ts +2 -1
- package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConfigurationSetTrackingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIdentityCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +2 -1
- package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVerifiedEmailAddressCommand.d.ts +2 -1
- package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeConfigurationSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +2 -1
- package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetSendQuotaCommand.d.ts +2 -1
- package/dist-types/commands/GetSendStatisticsCommand.d.ts +2 -1
- package/dist-types/commands/GetTemplateCommand.d.ts +2 -1
- package/dist-types/commands/ListConfigurationSetsCommand.d.ts +2 -1
- package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +2 -1
- package/dist-types/commands/ListIdentitiesCommand.d.ts +2 -1
- package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/ListReceiptFiltersCommand.d.ts +2 -1
- package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +2 -1
- package/dist-types/commands/ListTemplatesCommand.d.ts +2 -1
- package/dist-types/commands/ListVerifiedEmailAddressesCommand.d.ts +2 -1
- package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +2 -1
- package/dist-types/commands/PutIdentityPolicyCommand.d.ts +2 -1
- package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/SendBounceCommand.d.ts +2 -1
- package/dist-types/commands/SendBulkTemplatedEmailCommand.d.ts +2 -1
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +2 -1
- package/dist-types/commands/SendEmailCommand.d.ts +2 -1
- package/dist-types/commands/SendRawEmailCommand.d.ts +2 -1
- package/dist-types/commands/SendTemplatedEmailCommand.d.ts +2 -1
- package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +2 -1
- package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +2 -1
- package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +2 -1
- package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +2 -1
- package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +2 -1
- package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +2 -1
- package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +2 -1
- package/dist-types/commands/TestRenderTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConfigurationSetTrackingOptionsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +2 -1
- package/dist-types/commands/VerifyDomainDkimCommand.d.ts +2 -1
- package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +2 -1
- package/dist-types/commands/VerifyEmailAddressCommand.d.ts +2 -1
- package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +543 -543
- package/dist-types/ts3.4/SES.d.ts +13 -0
- package/dist-types/ts3.4/commands/CloneReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConfigurationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConfigurationSetEventDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConfigurationSetTrackingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateReceiptFilterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateReceiptRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConfigurationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConfigurationSetTrackingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIdentityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIdentityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteReceiptFilterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteReceiptRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteVerifiedEmailAddressCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeActiveReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeConfigurationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeReceiptRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccountSendingEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCustomVerificationEmailTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIdentityDkimAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIdentityNotificationAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIdentityPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIdentityVerificationAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSendQuotaCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSendStatisticsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListConfigurationSetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIdentitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIdentityPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListReceiptFiltersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListReceiptRuleSetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVerifiedEmailAddressesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutIdentityPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReorderReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendBounceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendBulkTemplatedEmailCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendCustomVerificationEmailCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendEmailCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendRawEmailCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendTemplatedEmailCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetActiveReceiptRuleSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetIdentityDkimEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetIdentityMailFromDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetIdentityNotificationTopicCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetReceiptRulePositionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TestRenderTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAccountSendingEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationSetTrackingOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateReceiptRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifyDomainDkimCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifyDomainIdentityCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifyEmailAddressCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifyEmailIdentityCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +41 -41
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SESServiceException as __BaseException } from "./SESServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
6
5
|
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccountSendingPausedException extends __BaseException {
|
|
9
9
|
readonly name: "AccountSendingPausedException";
|
|
@@ -14,38 +14,38 @@ export declare class AccountSendingPausedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccountSendingPausedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>When included in a receipt rule, this action adds a header to the received
|
|
19
18
|
* email.</p>
|
|
20
19
|
* <p>For information about adding a header using a receipt rule, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html">Amazon SES Developer Guide</a>.</p>
|
|
20
|
+
* @public
|
|
21
21
|
*/
|
|
22
22
|
export interface AddHeaderAction {
|
|
23
23
|
/**
|
|
24
|
-
* @public
|
|
25
24
|
* <p>The name of the header to add to the incoming message. The name must contain at least
|
|
26
25
|
* one character, and can contain up to 50 characters. It consists of alphanumeric (a–z,
|
|
27
26
|
* A–Z, 0–9) characters and dashes.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
HeaderName: string | undefined;
|
|
30
30
|
/**
|
|
31
|
-
* @public
|
|
32
31
|
* <p>The content to include in the header. This value can contain up to 2048 characters. It
|
|
33
32
|
* can't contain newline (<code>\n</code>) or carriage return (<code>\r</code>)
|
|
34
33
|
* characters.</p>
|
|
34
|
+
* @public
|
|
35
35
|
*/
|
|
36
36
|
HeaderValue: string | undefined;
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* @public
|
|
40
39
|
* <p>Indicates that a resource could not be created because of a naming conflict.</p>
|
|
40
|
+
* @public
|
|
41
41
|
*/
|
|
42
42
|
export declare class AlreadyExistsException extends __BaseException {
|
|
43
43
|
readonly name: "AlreadyExistsException";
|
|
44
44
|
readonly $fault: "client";
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>Indicates that a resource could not be created because the resource name already
|
|
48
47
|
* exists.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
Name?: string;
|
|
51
51
|
/**
|
|
@@ -66,81 +66,81 @@ export declare const BehaviorOnMXFailure: {
|
|
|
66
66
|
*/
|
|
67
67
|
export type BehaviorOnMXFailure = (typeof BehaviorOnMXFailure)[keyof typeof BehaviorOnMXFailure];
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>Represents textual data, plus an optional character set specification.</p>
|
|
71
70
|
* <p>By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol.
|
|
72
71
|
* If the text must contain any other characters, then you must also specify a character
|
|
73
72
|
* set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
export interface Content {
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The textual data of the content.</p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
Data: string | undefined;
|
|
81
81
|
/**
|
|
82
|
-
* @public
|
|
83
82
|
* <p>The character set of the content.</p>
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
Charset?: string;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>Represents the body of the message. You can specify text, HTML, or both. If you use
|
|
90
89
|
* both, then the message should display correctly in the widest variety of email
|
|
91
90
|
* clients.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export interface Body {
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>The content of the message, in text format. Use this for text-based email clients, or
|
|
97
96
|
* clients on high-latency networks (such as mobile devices).</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
Text?: Content;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>The content of the message, in HTML format. Use this for email clients that can
|
|
103
102
|
* process HTML. You can include clickable links, formatted text, and much more in an HTML
|
|
104
103
|
* message.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
Html?: Content;
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
|
-
* @public
|
|
110
109
|
* <p>When included in a receipt rule, this action rejects the received email by returning a
|
|
111
110
|
* bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service
|
|
112
111
|
* (Amazon SNS).</p>
|
|
113
112
|
* <p>For information about sending a bounce message in response to a received email, see
|
|
114
113
|
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html">Amazon SES Developer Guide</a>.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export interface BounceAction {
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is
|
|
120
119
|
* taken. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
121
120
|
* Amazon SNS.</p>
|
|
122
121
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
122
|
+
* @public
|
|
123
123
|
*/
|
|
124
124
|
TopicArn?: string;
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>The SMTP reply code, as defined by <a href="https://tools.ietf.org/html/rfc5321">RFC 5321</a>.</p>
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
SmtpReplyCode: string | undefined;
|
|
130
130
|
/**
|
|
131
|
-
* @public
|
|
132
131
|
* <p>The SMTP enhanced status code, as defined by <a href="https://tools.ietf.org/html/rfc3463">RFC 3463</a>.</p>
|
|
132
|
+
* @public
|
|
133
133
|
*/
|
|
134
134
|
StatusCode?: string;
|
|
135
135
|
/**
|
|
136
|
-
* @public
|
|
137
136
|
* <p>Human-readable text to include in the bounce message.</p>
|
|
137
|
+
* @public
|
|
138
138
|
*/
|
|
139
139
|
Message: string | undefined;
|
|
140
140
|
/**
|
|
141
|
-
* @public
|
|
142
141
|
* <p>The email address of the sender of the bounced email. This is the address from which
|
|
143
142
|
* the bounce message is sent.</p>
|
|
143
|
+
* @public
|
|
144
144
|
*/
|
|
145
145
|
Sender: string | undefined;
|
|
146
146
|
}
|
|
@@ -176,36 +176,35 @@ export declare const DsnAction: {
|
|
|
176
176
|
*/
|
|
177
177
|
export type DsnAction = (typeof DsnAction)[keyof typeof DsnAction];
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>Additional X-headers to include in the Delivery Status Notification (DSN) when an
|
|
181
180
|
* email that Amazon SES receives on your behalf bounces.</p>
|
|
182
181
|
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
183
182
|
* Guide</a>.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
export interface ExtensionField {
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>The name of the header to add. Must be between 1 and 50 characters, inclusive, and
|
|
189
188
|
* consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
Name: string | undefined;
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The value of the header to add. Must contain 2048 characters or fewer, and must not
|
|
195
194
|
* contain newline characters ("\r" or "\n").</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
Value: string | undefined;
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
|
-
* @public
|
|
201
200
|
* <p>Recipient-related information to include in the Delivery Status Notification (DSN)
|
|
202
201
|
* when an email that Amazon SES receives on your behalf bounces.</p>
|
|
203
202
|
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
204
203
|
* Guide</a>.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
export interface RecipientDsnFields {
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The email address that the message was ultimately delivered to. This corresponds to
|
|
210
209
|
* the <code>Final-Recipient</code> in the DSN. If not specified,
|
|
211
210
|
* <code>FinalRecipient</code> is set to the <code>Recipient</code> specified in the
|
|
@@ -216,82 +215,82 @@ export interface RecipientDsnFields {
|
|
|
216
215
|
* <p>Do not prepend the <code>FinalRecipient</code> email address with <code>rfc
|
|
217
216
|
* 822;</code>, as described in <a href="https://tools.ietf.org/html/rfc3798">RFC 3798</a>.</p>
|
|
218
217
|
* </note>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
FinalRecipient?: string;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The action performed by the reporting mail transfer agent (MTA) as a result of its
|
|
224
223
|
* attempt to deliver the message to the recipient address. This is required by <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>.</p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
Action: DsnAction | undefined;
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>The MTA to which the remote MTA attempted to deliver the message, formatted as
|
|
230
229
|
* specified in <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>
|
|
231
230
|
* (<code>mta-name-type; mta-name</code>). This parameter typically applies only to
|
|
232
231
|
* propagating synchronous bounces.</p>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
RemoteMta?: string;
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The status code that indicates what went wrong. This is required by <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
Status: string | undefined;
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>An extended explanation of what went wrong; this is usually an SMTP response. See
|
|
243
242
|
* <a href="https://tools.ietf.org/html/rfc3463">RFC 3463</a> for the correct
|
|
244
243
|
* formatting of this parameter.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
DiagnosticCode?: string;
|
|
247
247
|
/**
|
|
248
|
-
* @public
|
|
249
248
|
* <p>The time the final delivery attempt was made, in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
LastAttemptDate?: Date;
|
|
252
252
|
/**
|
|
253
|
-
* @public
|
|
254
253
|
* <p>Additional X-headers to include in the DSN.</p>
|
|
254
|
+
* @public
|
|
255
255
|
*/
|
|
256
256
|
ExtensionFields?: ExtensionField[];
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>Recipient-related information to include in the Delivery Status Notification (DSN)
|
|
261
260
|
* when an email that Amazon SES receives on your behalf bounces.</p>
|
|
262
261
|
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
263
262
|
* Guide</a>.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
export interface BouncedRecipientInfo {
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The email address of the recipient of the bounced email.</p>
|
|
268
|
+
* @public
|
|
269
269
|
*/
|
|
270
270
|
Recipient: string | undefined;
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
274
273
|
* that is associated with the sending authorization policy that permits you to receive
|
|
275
274
|
* email for the recipient of the bounced email. For more information about sending
|
|
276
275
|
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
RecipientArn?: string;
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The reason for the bounce. You must provide either this parameter or
|
|
282
281
|
* <code>RecipientDsnFields</code>.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
BounceType?: BounceType;
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>Recipient-related DSN fields, most of which would normally be filled in automatically
|
|
288
287
|
* when provided with a <code>BounceType</code>. You must provide either this parameter or
|
|
289
288
|
* <code>BounceType</code>.</p>
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
RecipientDsnFields?: RecipientDsnFields;
|
|
292
292
|
}
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
296
295
|
* fields.</p>
|
|
297
296
|
* <note>
|
|
@@ -304,35 +303,35 @@ export interface BouncedRecipientInfo {
|
|
|
304
303
|
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
305
304
|
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
306
305
|
* </note>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
export interface Destination {
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>The recipients to place on the To: line of the message.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
ToAddresses?: string[];
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>The recipients to place on the CC: line of the message.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
CcAddresses?: string[];
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The recipients to place on the BCC: line of the message.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
BccAddresses?: string[];
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>Contains the name and value of a tag that you can provide to <code>SendEmail</code> or
|
|
328
327
|
* <code>SendRawEmail</code> to apply to an email.</p>
|
|
329
328
|
* <p>Message tags, which you use with configuration sets, enable you to publish email
|
|
330
329
|
* 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
|
|
331
330
|
* Developer Guide</a>.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
export interface MessageTag {
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>The name of the tag. The name must meet the following requirements:</p>
|
|
337
336
|
* <ul>
|
|
338
337
|
* <li>
|
|
@@ -343,10 +342,10 @@ export interface MessageTag {
|
|
|
343
342
|
* <p>Contain 256 characters or fewer.</p>
|
|
344
343
|
* </li>
|
|
345
344
|
* </ul>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
Name: string | undefined;
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>The value of the tag. The value must meet the following requirements:</p>
|
|
351
350
|
* <ul>
|
|
352
351
|
* <li>
|
|
@@ -357,17 +356,17 @@ export interface MessageTag {
|
|
|
357
356
|
* <p>Contain 256 characters or fewer.</p>
|
|
358
357
|
* </li>
|
|
359
358
|
* </ul>
|
|
359
|
+
* @public
|
|
360
360
|
*/
|
|
361
361
|
Value: string | undefined;
|
|
362
362
|
}
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>An array that contains one or more Destinations, as well as the tags and replacement
|
|
366
365
|
* data associated with each of those Destinations.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
export interface BulkEmailDestination {
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>Represents the destination of the message, consisting of To:, CC:, and BCC:
|
|
372
371
|
* fields.</p>
|
|
373
372
|
* <note>
|
|
@@ -380,20 +379,21 @@ export interface BulkEmailDestination {
|
|
|
380
379
|
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
381
380
|
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
382
381
|
* </note>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
Destination: Destination | undefined;
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
388
387
|
* using <code>SendBulkTemplatedEmail</code>. Tags correspond to characteristics of the
|
|
389
388
|
* email that you define, so that you can publish email sending events.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
ReplacementTags?: MessageTag[];
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
395
394
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
396
395
|
* replacement tags in the email template.</p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
ReplacementTemplateData?: string;
|
|
399
399
|
}
|
|
@@ -422,13 +422,12 @@ export declare const BulkEmailStatus: {
|
|
|
422
422
|
*/
|
|
423
423
|
export type BulkEmailStatus = (typeof BulkEmailStatus)[keyof typeof BulkEmailStatus];
|
|
424
424
|
/**
|
|
425
|
-
* @public
|
|
426
425
|
* <p>An object that contains the response from the <code>SendBulkTemplatedEmail</code>
|
|
427
426
|
* operation.</p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
export interface BulkEmailDestinationStatus {
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>The status of a message sent using the <code>SendBulkTemplatedEmail</code>
|
|
433
432
|
* operation.</p>
|
|
434
433
|
* <p>Possible values for this parameter include:</p>
|
|
@@ -507,32 +506,33 @@ export interface BulkEmailDestinationStatus {
|
|
|
507
506
|
* message for additional information.</p>
|
|
508
507
|
* </li>
|
|
509
508
|
* </ul>
|
|
509
|
+
* @public
|
|
510
510
|
*/
|
|
511
511
|
Status?: BulkEmailStatus;
|
|
512
512
|
/**
|
|
513
|
-
* @public
|
|
514
513
|
* <p>A description of an error that prevented a message being sent using the
|
|
515
514
|
* <code>SendBulkTemplatedEmail</code> operation.</p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
Error?: string;
|
|
518
518
|
/**
|
|
519
|
-
* @public
|
|
520
519
|
* <p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code>
|
|
521
520
|
* operation.</p>
|
|
521
|
+
* @public
|
|
522
522
|
*/
|
|
523
523
|
MessageId?: string;
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>Indicates that the delete operation could not be completed.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
export declare class CannotDeleteException extends __BaseException {
|
|
530
530
|
readonly name: "CannotDeleteException";
|
|
531
531
|
readonly $fault: "client";
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>Indicates that a resource could not be deleted because no resource with the specified
|
|
535
534
|
* name exists.</p>
|
|
535
|
+
* @public
|
|
536
536
|
*/
|
|
537
537
|
Name?: string;
|
|
538
538
|
/**
|
|
@@ -541,14 +541,13 @@ export declare class CannotDeleteException extends __BaseException {
|
|
|
541
541
|
constructor(opts: __ExceptionOptionType<CannotDeleteException, __BaseException>);
|
|
542
542
|
}
|
|
543
543
|
/**
|
|
544
|
-
* @public
|
|
545
544
|
* <p>Represents a request to create a receipt rule set by cloning an existing one. You use
|
|
546
545
|
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
547
546
|
* Developer Guide</a>.</p>
|
|
547
|
+
* @public
|
|
548
548
|
*/
|
|
549
549
|
export interface CloneReceiptRuleSetRequest {
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>The name of the rule set to create. The name must meet the following
|
|
553
552
|
* requirements:</p>
|
|
554
553
|
* <ul>
|
|
@@ -563,25 +562,26 @@ export interface CloneReceiptRuleSetRequest {
|
|
|
563
562
|
* <p>Contain 64 characters or fewer.</p>
|
|
564
563
|
* </li>
|
|
565
564
|
* </ul>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
RuleSetName: string | undefined;
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>The name of the rule set to clone.</p>
|
|
570
|
+
* @public
|
|
571
571
|
*/
|
|
572
572
|
OriginalRuleSetName: string | undefined;
|
|
573
573
|
}
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>An empty element returned on a successful request.</p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
export interface CloneReceiptRuleSetResponse {
|
|
579
579
|
}
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>Indicates that a resource could not be created because of service limits. For a list
|
|
583
582
|
* of Amazon SES limits, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer
|
|
584
583
|
* Guide</a>.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
export declare class LimitExceededException extends __BaseException {
|
|
587
587
|
readonly name: "LimitExceededException";
|
|
@@ -592,15 +592,15 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
592
592
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
593
593
|
}
|
|
594
594
|
/**
|
|
595
|
-
* @public
|
|
596
595
|
* <p>Indicates that the provided receipt rule set does not exist.</p>
|
|
596
|
+
* @public
|
|
597
597
|
*/
|
|
598
598
|
export declare class RuleSetDoesNotExistException extends __BaseException {
|
|
599
599
|
readonly name: "RuleSetDoesNotExistException";
|
|
600
600
|
readonly $fault: "client";
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>Indicates that the named receipt rule set does not exist.</p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
Name?: string;
|
|
606
606
|
/**
|
|
@@ -622,15 +622,14 @@ export declare const DimensionValueSource: {
|
|
|
622
622
|
*/
|
|
623
623
|
export type DimensionValueSource = (typeof DimensionValueSource)[keyof typeof DimensionValueSource];
|
|
624
624
|
/**
|
|
625
|
-
* @public
|
|
626
625
|
* <p>Contains the dimension configuration to use when you publish email sending events to
|
|
627
626
|
* Amazon CloudWatch.</p>
|
|
628
627
|
* <p>For information about publishing email sending events to Amazon CloudWatch, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
629
628
|
* Developer Guide</a>.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
export interface CloudWatchDimensionConfiguration {
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name
|
|
635
634
|
* must meet the following requirements:</p>
|
|
636
635
|
* <ul>
|
|
@@ -642,20 +641,20 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
642
641
|
* <p>Contain 256 characters or fewer.</p>
|
|
643
642
|
* </li>
|
|
644
643
|
* </ul>
|
|
644
|
+
* @public
|
|
645
645
|
*/
|
|
646
646
|
DimensionName: string | undefined;
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use
|
|
650
649
|
* the message tags that you specify using an <code>X-SES-MESSAGE-TAGS</code> header or a
|
|
651
650
|
* parameter to the <code>SendEmail</code>/<code>SendRawEmail</code> API, specify
|
|
652
651
|
* <code>messageTag</code>. To use your own email headers, specify
|
|
653
652
|
* <code>emailHeader</code>. To put a custom tag on any link included in your email,
|
|
654
653
|
* specify <code>linkTag</code>.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
DimensionValueSource: DimensionValueSource | undefined;
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide
|
|
660
659
|
* the value of the dimension when you send an email. The default value must meet the
|
|
661
660
|
* following requirements:</p>
|
|
@@ -668,36 +667,36 @@ export interface CloudWatchDimensionConfiguration {
|
|
|
668
667
|
* <p>Contain 256 characters or fewer.</p>
|
|
669
668
|
* </li>
|
|
670
669
|
* </ul>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
DefaultDimensionValue: string | undefined;
|
|
673
673
|
}
|
|
674
674
|
/**
|
|
675
|
-
* @public
|
|
676
675
|
* <p>Contains information associated with an Amazon CloudWatch event destination to which email
|
|
677
676
|
* sending events are published.</p>
|
|
678
677
|
* <p>Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which
|
|
679
678
|
* enable you to publish email sending events. For information about using configuration
|
|
680
679
|
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
681
680
|
* Guide</a>.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
export interface CloudWatchDestination {
|
|
684
684
|
/**
|
|
685
|
-
* @public
|
|
686
685
|
* <p>A list of dimensions upon which to categorize your emails when you publish email
|
|
687
686
|
* sending events to Amazon CloudWatch.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
DimensionConfigurations: CloudWatchDimensionConfiguration[] | undefined;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The name of the configuration set.</p>
|
|
694
693
|
* <p>Configuration sets let you create groups of rules that you can apply to the emails you
|
|
695
694
|
* send using Amazon SES. For more information about using configuration sets, see <a href="https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html">Using Amazon SES
|
|
696
695
|
* Configuration Sets</a> in the <a href="https://docs.aws.amazon.com/ses/latest/dg/">Amazon SES Developer Guide</a>.</p>
|
|
696
|
+
* @public
|
|
697
697
|
*/
|
|
698
698
|
export interface ConfigurationSet {
|
|
699
699
|
/**
|
|
700
|
-
* @public
|
|
701
700
|
* <p>The name of the configuration set. The name must meet the following
|
|
702
701
|
* requirements:</p>
|
|
703
702
|
* <ul>
|
|
@@ -709,20 +708,21 @@ export interface ConfigurationSet {
|
|
|
709
708
|
* <p>Contain 64 characters or fewer.</p>
|
|
710
709
|
* </li>
|
|
711
710
|
* </ul>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
Name: string | undefined;
|
|
714
714
|
}
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>Indicates that the configuration set could not be created because of a naming
|
|
718
717
|
* conflict.</p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
export declare class ConfigurationSetAlreadyExistsException extends __BaseException {
|
|
721
721
|
readonly name: "ConfigurationSetAlreadyExistsException";
|
|
722
722
|
readonly $fault: "client";
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
ConfigurationSetName?: string;
|
|
728
728
|
/**
|
|
@@ -745,15 +745,15 @@ export declare const ConfigurationSetAttribute: {
|
|
|
745
745
|
*/
|
|
746
746
|
export type ConfigurationSetAttribute = (typeof ConfigurationSetAttribute)[keyof typeof ConfigurationSetAttribute];
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
749
|
+
* @public
|
|
750
750
|
*/
|
|
751
751
|
export declare class ConfigurationSetDoesNotExistException extends __BaseException {
|
|
752
752
|
readonly name: "ConfigurationSetDoesNotExistException";
|
|
753
753
|
readonly $fault: "client";
|
|
754
754
|
/**
|
|
755
|
-
* @public
|
|
756
755
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
756
|
+
* @public
|
|
757
757
|
*/
|
|
758
758
|
ConfigurationSetName?: string;
|
|
759
759
|
/**
|
|
@@ -762,16 +762,16 @@ export declare class ConfigurationSetDoesNotExistException extends __BaseExcepti
|
|
|
762
762
|
constructor(opts: __ExceptionOptionType<ConfigurationSetDoesNotExistException, __BaseException>);
|
|
763
763
|
}
|
|
764
764
|
/**
|
|
765
|
-
* @public
|
|
766
765
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
767
766
|
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
export declare class ConfigurationSetSendingPausedException extends __BaseException {
|
|
770
770
|
readonly name: "ConfigurationSetSendingPausedException";
|
|
771
771
|
readonly $fault: "client";
|
|
772
772
|
/**
|
|
773
|
-
* @public
|
|
774
773
|
* <p>The name of the configuration set for which email sending is disabled.</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
ConfigurationSetName?: string;
|
|
777
777
|
/**
|
|
@@ -780,29 +780,29 @@ export declare class ConfigurationSetSendingPausedException extends __BaseExcept
|
|
|
780
780
|
constructor(opts: __ExceptionOptionType<ConfigurationSetSendingPausedException, __BaseException>);
|
|
781
781
|
}
|
|
782
782
|
/**
|
|
783
|
-
* @public
|
|
784
783
|
* <p>Represents a request to create a configuration set. Configuration sets enable you to
|
|
785
784
|
* publish email sending events. For information about using configuration sets, see the
|
|
786
785
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
787
786
|
* Developer Guide</a>.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
export interface CreateConfigurationSetRequest {
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>A data structure that contains the name of the configuration set.</p>
|
|
792
|
+
* @public
|
|
793
793
|
*/
|
|
794
794
|
ConfigurationSet: ConfigurationSet | undefined;
|
|
795
795
|
}
|
|
796
796
|
/**
|
|
797
|
-
* @public
|
|
798
797
|
* <p>An empty element returned on a successful request.</p>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
export interface CreateConfigurationSetResponse {
|
|
801
801
|
}
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>Indicates that the configuration set is invalid. See the error message for
|
|
805
804
|
* details.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
export declare class InvalidConfigurationSetException extends __BaseException {
|
|
808
808
|
readonly name: "InvalidConfigurationSetException";
|
|
@@ -813,24 +813,24 @@ export declare class InvalidConfigurationSetException extends __BaseException {
|
|
|
813
813
|
constructor(opts: __ExceptionOptionType<InvalidConfigurationSetException, __BaseException>);
|
|
814
814
|
}
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event
|
|
818
817
|
* destination.</p>
|
|
819
818
|
* <p>Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable
|
|
820
819
|
* you to publish email sending events. For information about using configuration sets, see
|
|
821
820
|
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
822
821
|
* Developer Guide</a>.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
export interface KinesisFirehoseDestination {
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose
|
|
828
827
|
* stream.</p>
|
|
828
|
+
* @public
|
|
829
829
|
*/
|
|
830
830
|
IAMRoleARN: string | undefined;
|
|
831
831
|
/**
|
|
832
|
-
* @public
|
|
833
832
|
* <p>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
DeliveryStreamARN: string | undefined;
|
|
836
836
|
}
|
|
@@ -853,24 +853,23 @@ export declare const EventType: {
|
|
|
853
853
|
*/
|
|
854
854
|
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.</p>
|
|
858
857
|
* <p>Event destinations, such as Amazon SNS, are associated with configuration sets, which
|
|
859
858
|
* enable you to publish email sending events. For information about using configuration
|
|
860
859
|
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
861
860
|
* Guide</a>.</p>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
export interface SNSDestination {
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic
|
|
867
866
|
* by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> Amazon SNS operation.</p>
|
|
868
867
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
868
|
+
* @public
|
|
869
869
|
*/
|
|
870
870
|
TopicARN: string | undefined;
|
|
871
871
|
}
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>Contains information about an event destination.</p>
|
|
875
874
|
* <note>
|
|
876
875
|
* <p>When you create or update an event destination, you must provide one, and only
|
|
@@ -880,10 +879,10 @@ export interface SNSDestination {
|
|
|
880
879
|
* email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about
|
|
881
880
|
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
882
881
|
* Guide</a>.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
export interface EventDestination {
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>The name of the event destination. The name must meet the following
|
|
888
887
|
* requirements:</p>
|
|
889
888
|
* <ul>
|
|
@@ -895,18 +894,18 @@ export interface EventDestination {
|
|
|
895
894
|
* <p>Contain 64 characters or fewer.</p>
|
|
896
895
|
* </li>
|
|
897
896
|
* </ul>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
Name: string | undefined;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>Sets whether Amazon SES publishes events to this destination when you send an email with
|
|
903
902
|
* the associated configuration set. Set to <code>true</code> to enable publishing to this
|
|
904
903
|
* destination; set to <code>false</code> to prevent publishing to this destination. The
|
|
905
904
|
* default value is <code>false</code>.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
Enabled?: boolean;
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The type of email sending events to publish to the event destination.</p>
|
|
911
910
|
* <ul>
|
|
912
911
|
* <li>
|
|
@@ -949,71 +948,72 @@ export interface EventDestination {
|
|
|
949
948
|
* template rendering issue.</p>
|
|
950
949
|
* </li>
|
|
951
950
|
* </ul>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
MatchingEventTypes: EventType[] | undefined;
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>An object that contains the delivery stream ARN and the IAM role ARN associated with
|
|
957
956
|
* an Amazon Kinesis Firehose event destination.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
KinesisFirehoseDestination?: KinesisFirehoseDestination;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>An object that contains the names, default values, and sources of the dimensions
|
|
963
962
|
* associated with an Amazon CloudWatch event destination.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
CloudWatchDestination?: CloudWatchDestination;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event
|
|
969
968
|
* destination.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
SNSDestination?: SNSDestination;
|
|
972
972
|
}
|
|
973
973
|
/**
|
|
974
|
-
* @public
|
|
975
974
|
* <p>Represents a request to create a configuration set event destination. A configuration
|
|
976
975
|
* set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service
|
|
977
976
|
* in which Amazon SES publishes the email sending events associated with a configuration set.
|
|
978
977
|
* 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
|
|
979
978
|
* Guide</a>.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
export interface CreateConfigurationSetEventDestinationRequest {
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>The name of the configuration set that the event destination should be associated
|
|
985
984
|
* with.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
ConfigurationSetName: string | undefined;
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>An object that describes the Amazon Web Services service that email sending event where information
|
|
991
990
|
* is published.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
EventDestination: EventDestination | undefined;
|
|
994
994
|
}
|
|
995
995
|
/**
|
|
996
|
-
* @public
|
|
997
996
|
* <p>An empty element returned on a successful request.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
export interface CreateConfigurationSetEventDestinationResponse {
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>Indicates that the event destination could not be created because of a naming
|
|
1004
1003
|
* conflict.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
export declare class EventDestinationAlreadyExistsException extends __BaseException {
|
|
1007
1007
|
readonly name: "EventDestinationAlreadyExistsException";
|
|
1008
1008
|
readonly $fault: "client";
|
|
1009
1009
|
/**
|
|
1010
|
-
* @public
|
|
1011
1010
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
1011
|
+
* @public
|
|
1012
1012
|
*/
|
|
1013
1013
|
ConfigurationSetName?: string;
|
|
1014
1014
|
/**
|
|
1015
|
-
* @public
|
|
1016
1015
|
* <p>Indicates that the event destination does not exist.</p>
|
|
1016
|
+
* @public
|
|
1017
1017
|
*/
|
|
1018
1018
|
EventDestinationName?: string;
|
|
1019
1019
|
/**
|
|
@@ -1022,21 +1022,21 @@ export declare class EventDestinationAlreadyExistsException extends __BaseExcept
|
|
|
1022
1022
|
constructor(opts: __ExceptionOptionType<EventDestinationAlreadyExistsException, __BaseException>);
|
|
1023
1023
|
}
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <p>Indicates that the Amazon CloudWatch destination is invalid. See the error message for
|
|
1027
1026
|
* details.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
export declare class InvalidCloudWatchDestinationException extends __BaseException {
|
|
1030
1030
|
readonly name: "InvalidCloudWatchDestinationException";
|
|
1031
1031
|
readonly $fault: "client";
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
ConfigurationSetName?: string;
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>Indicates that the event destination does not exist.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
EventDestinationName?: string;
|
|
1042
1042
|
/**
|
|
@@ -1045,21 +1045,21 @@ export declare class InvalidCloudWatchDestinationException extends __BaseExcepti
|
|
|
1045
1045
|
constructor(opts: __ExceptionOptionType<InvalidCloudWatchDestinationException, __BaseException>);
|
|
1046
1046
|
}
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>Indicates that the Amazon Kinesis Firehose destination is invalid. See the error
|
|
1050
1049
|
* message for details.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
export declare class InvalidFirehoseDestinationException extends __BaseException {
|
|
1053
1053
|
readonly name: "InvalidFirehoseDestinationException";
|
|
1054
1054
|
readonly $fault: "client";
|
|
1055
1055
|
/**
|
|
1056
|
-
* @public
|
|
1057
1056
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
1057
|
+
* @public
|
|
1058
1058
|
*/
|
|
1059
1059
|
ConfigurationSetName?: string;
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>Indicates that the event destination does not exist.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
EventDestinationName?: string;
|
|
1065
1065
|
/**
|
|
@@ -1068,21 +1068,21 @@ export declare class InvalidFirehoseDestinationException extends __BaseException
|
|
|
1068
1068
|
constructor(opts: __ExceptionOptionType<InvalidFirehoseDestinationException, __BaseException>);
|
|
1069
1069
|
}
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is
|
|
1073
1072
|
* invalid. See the error message for details.</p>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
export declare class InvalidSNSDestinationException extends __BaseException {
|
|
1076
1076
|
readonly name: "InvalidSNSDestinationException";
|
|
1077
1077
|
readonly $fault: "client";
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
ConfigurationSetName?: string;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>Indicates that the event destination does not exist.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
EventDestinationName?: string;
|
|
1088
1088
|
/**
|
|
@@ -1091,51 +1091,50 @@ export declare class InvalidSNSDestinationException extends __BaseException {
|
|
|
1091
1091
|
constructor(opts: __ExceptionOptionType<InvalidSNSDestinationException, __BaseException>);
|
|
1092
1092
|
}
|
|
1093
1093
|
/**
|
|
1094
|
-
* @public
|
|
1095
1094
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
1096
1095
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
1097
1096
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
1098
1097
|
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
1099
1098
|
* Guide</i>.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
export interface TrackingOptions {
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The custom subdomain that is used to redirect email recipients to the Amazon SES event
|
|
1105
1104
|
* tracking domain.</p>
|
|
1105
|
+
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
CustomRedirectDomain?: string;
|
|
1108
1108
|
}
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>Represents a request to create an open and click tracking option object in a
|
|
1112
1111
|
* configuration set. </p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
export interface CreateConfigurationSetTrackingOptionsRequest {
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The name of the configuration set that the tracking options should be associated
|
|
1118
1117
|
* with.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
ConfigurationSetName: string | undefined;
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
1124
1123
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
1125
1124
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
1126
1125
|
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
1127
1126
|
* Guide</i>.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
TrackingOptions: TrackingOptions | undefined;
|
|
1130
1130
|
}
|
|
1131
1131
|
/**
|
|
1132
|
-
* @public
|
|
1133
1132
|
* <p>An empty element returned on a successful request.</p>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface CreateConfigurationSetTrackingOptionsResponse {
|
|
1136
1136
|
}
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>Indicates that the custom domain to be used for open and click tracking redirects is
|
|
1140
1139
|
* invalid. This error appears most often in the following situations:</p>
|
|
1141
1140
|
* <ul>
|
|
@@ -1147,6 +1146,7 @@ export interface CreateConfigurationSetTrackingOptionsResponse {
|
|
|
1147
1146
|
* subdomain.</p>
|
|
1148
1147
|
* </li>
|
|
1149
1148
|
* </ul>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
export declare class InvalidTrackingOptionsException extends __BaseException {
|
|
1152
1152
|
readonly name: "InvalidTrackingOptionsException";
|
|
@@ -1157,17 +1157,17 @@ export declare class InvalidTrackingOptionsException extends __BaseException {
|
|
|
1157
1157
|
constructor(opts: __ExceptionOptionType<InvalidTrackingOptionsException, __BaseException>);
|
|
1158
1158
|
}
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>Indicates that the configuration set you specified already contains a TrackingOptions
|
|
1162
1161
|
* object.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
export declare class TrackingOptionsAlreadyExistsException extends __BaseException {
|
|
1165
1165
|
readonly name: "TrackingOptionsAlreadyExistsException";
|
|
1166
1166
|
readonly $fault: "client";
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>Indicates that a TrackingOptions object already exists in the specified configuration
|
|
1170
1169
|
* set.</p>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
ConfigurationSetName?: string;
|
|
1173
1173
|
/**
|
|
@@ -1176,50 +1176,50 @@ export declare class TrackingOptionsAlreadyExistsException extends __BaseExcepti
|
|
|
1176
1176
|
constructor(opts: __ExceptionOptionType<TrackingOptionsAlreadyExistsException, __BaseException>);
|
|
1177
1177
|
}
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>Represents a request to create a custom verification email template.</p>
|
|
1180
|
+
* @public
|
|
1181
1181
|
*/
|
|
1182
1182
|
export interface CreateCustomVerificationEmailTemplateRequest {
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The name of the custom verification email template.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
TemplateName: string | undefined;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
FromEmailAddress: string | undefined;
|
|
1193
1193
|
/**
|
|
1194
|
-
* @public
|
|
1195
1194
|
* <p>The subject line of the custom verification email.</p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
TemplateSubject: string | undefined;
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
1201
1200
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
1202
1201
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Custom
|
|
1203
1202
|
* Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
1204
1203
|
* Developer Guide</i>.</p>
|
|
1204
|
+
* @public
|
|
1205
1205
|
*/
|
|
1206
1206
|
TemplateContent: string | undefined;
|
|
1207
1207
|
/**
|
|
1208
|
-
* @public
|
|
1209
1208
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1210
1209
|
* is successfully verified.</p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
SuccessRedirectionURL: string | undefined;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1216
1215
|
* is not successfully verified.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
FailureRedirectionURL: string | undefined;
|
|
1219
1219
|
}
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>Indicates that custom verification email template provided content is invalid.</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
export declare class CustomVerificationEmailInvalidContentException extends __BaseException {
|
|
1225
1225
|
readonly name: "CustomVerificationEmailInvalidContentException";
|
|
@@ -1230,17 +1230,17 @@ export declare class CustomVerificationEmailInvalidContentException extends __Ba
|
|
|
1230
1230
|
constructor(opts: __ExceptionOptionType<CustomVerificationEmailInvalidContentException, __BaseException>);
|
|
1231
1231
|
}
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>Indicates that a custom verification email template with the name you specified
|
|
1235
1234
|
* already exists.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export declare class CustomVerificationEmailTemplateAlreadyExistsException extends __BaseException {
|
|
1238
1238
|
readonly name: "CustomVerificationEmailTemplateAlreadyExistsException";
|
|
1239
1239
|
readonly $fault: "client";
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>Indicates that the provided custom verification email template with the specified
|
|
1243
1242
|
* template name already exists.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
CustomVerificationEmailTemplateName?: string;
|
|
1246
1246
|
/**
|
|
@@ -1249,17 +1249,17 @@ export declare class CustomVerificationEmailTemplateAlreadyExistsException exten
|
|
|
1249
1249
|
constructor(opts: __ExceptionOptionType<CustomVerificationEmailTemplateAlreadyExistsException, __BaseException>);
|
|
1250
1250
|
}
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>Indicates that the sender address specified for a custom verification email is not
|
|
1254
1253
|
* verified, and is therefore not eligible to send the custom verification email. </p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
export declare class FromEmailAddressNotVerifiedException extends __BaseException {
|
|
1257
1257
|
readonly name: "FromEmailAddressNotVerifiedException";
|
|
1258
1258
|
readonly $fault: "client";
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>Indicates that the from email address associated with the custom verification email
|
|
1262
1261
|
* template is not verified.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
FromEmailAddress?: string;
|
|
1265
1265
|
/**
|
|
@@ -1280,39 +1280,38 @@ export declare const ReceiptFilterPolicy: {
|
|
|
1280
1280
|
*/
|
|
1281
1281
|
export type ReceiptFilterPolicy = (typeof ReceiptFilterPolicy)[keyof typeof ReceiptFilterPolicy];
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>A receipt IP address filter enables you to specify whether to accept or reject mail
|
|
1285
1284
|
* originating from an IP address or range of IP addresses.</p>
|
|
1286
1285
|
* <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
|
|
1287
1286
|
* Developer Guide</a>.</p>
|
|
1287
|
+
* @public
|
|
1288
1288
|
*/
|
|
1289
1289
|
export interface ReceiptIpFilter {
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>Indicates whether to block or allow incoming mail from the specified IP
|
|
1293
1292
|
* addresses.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
Policy: ReceiptFilterPolicy | undefined;
|
|
1296
1296
|
/**
|
|
1297
|
-
* @public
|
|
1298
1297
|
* <p>A single IP address or a range of IP addresses to block or allow, specified in
|
|
1299
1298
|
* Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is
|
|
1300
1299
|
* 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information
|
|
1301
1300
|
* about CIDR notation, see <a href="https://tools.ietf.org/html/rfc2317">RFC
|
|
1302
1301
|
* 2317</a>.</p>
|
|
1302
|
+
* @public
|
|
1303
1303
|
*/
|
|
1304
1304
|
Cidr: string | undefined;
|
|
1305
1305
|
}
|
|
1306
1306
|
/**
|
|
1307
|
-
* @public
|
|
1308
1307
|
* <p>A receipt IP address filter enables you to specify whether to accept or reject mail
|
|
1309
1308
|
* originating from an IP address or range of IP addresses.</p>
|
|
1310
1309
|
* <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
|
|
1311
1310
|
* Developer Guide</a>.</p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
export interface ReceiptFilter {
|
|
1314
1314
|
/**
|
|
1315
|
-
* @public
|
|
1316
1315
|
* <p>The name of the IP address filter. The name must meet the following
|
|
1317
1316
|
* requirements:</p>
|
|
1318
1317
|
* <ul>
|
|
@@ -1327,32 +1326,33 @@ export interface ReceiptFilter {
|
|
|
1327
1326
|
* <p>Contain 64 characters or fewer.</p>
|
|
1328
1327
|
* </li>
|
|
1329
1328
|
* </ul>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
Name: string | undefined;
|
|
1332
1332
|
/**
|
|
1333
|
-
* @public
|
|
1334
1333
|
* <p>A structure that provides the IP addresses to block or allow, and whether to block or
|
|
1335
1334
|
* allow incoming mail from them.</p>
|
|
1335
|
+
* @public
|
|
1336
1336
|
*/
|
|
1337
1337
|
IpFilter: ReceiptIpFilter | undefined;
|
|
1338
1338
|
}
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>Represents a request to create a new IP address filter. You use IP address filters
|
|
1342
1341
|
* when you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
1343
1342
|
* Developer Guide</a>.</p>
|
|
1343
|
+
* @public
|
|
1344
1344
|
*/
|
|
1345
1345
|
export interface CreateReceiptFilterRequest {
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>A data structure that describes the IP address filter to create, which consists of a
|
|
1349
1348
|
* name, an IP address range, and whether to allow or block mail from it.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
Filter: ReceiptFilter | undefined;
|
|
1352
1352
|
}
|
|
1353
1353
|
/**
|
|
1354
|
-
* @public
|
|
1355
1354
|
* <p>An empty element returned on a successful request.</p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
export interface CreateReceiptFilterResponse {
|
|
1358
1358
|
}
|
|
@@ -1369,7 +1369,6 @@ export declare const InvocationType: {
|
|
|
1369
1369
|
*/
|
|
1370
1370
|
export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType];
|
|
1371
1371
|
/**
|
|
1372
|
-
* @public
|
|
1373
1372
|
* <p>When included in a receipt rule, this action calls an Amazon Web Services Lambda function and,
|
|
1374
1373
|
* optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1375
1374
|
* <p>To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of
|
|
@@ -1378,25 +1377,25 @@ export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType
|
|
|
1378
1377
|
* Guide</a>.</p>
|
|
1379
1378
|
* <p>For information about using Amazon Web Services Lambda actions in receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html">Amazon SES
|
|
1380
1379
|
* Developer Guide</a>.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
export interface LambdaAction {
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is
|
|
1386
1385
|
* executed. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1387
1386
|
* Amazon SNS.</p>
|
|
1388
1387
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1388
|
+
* @public
|
|
1389
1389
|
*/
|
|
1390
1390
|
TopicArn?: string;
|
|
1391
1391
|
/**
|
|
1392
|
-
* @public
|
|
1393
1392
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda
|
|
1394
1393
|
* function ARN is <code>arn:aws:lambda:us-west-2:account-id:function:MyFunction</code>.
|
|
1395
1394
|
* For more information about Amazon Web Services Lambda, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/welcome.html">Amazon Web Services Lambda Developer Guide</a>.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
FunctionArn: string | undefined;
|
|
1398
1398
|
/**
|
|
1399
|
-
* @public
|
|
1400
1399
|
* <p>The invocation type of the Amazon Web Services Lambda function. An invocation type of
|
|
1401
1400
|
* <code>RequestResponse</code> means that the execution of the function immediately
|
|
1402
1401
|
* results in a response, and a value of <code>Event</code> means that the function is
|
|
@@ -1408,11 +1407,11 @@ export interface LambdaAction {
|
|
|
1408
1407
|
* <code>RequestResponse</code> only to make a mail flow decision, such as whether
|
|
1409
1408
|
* to stop the receipt rule or the receipt rule set.</p>
|
|
1410
1409
|
* </important>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
InvocationType?: InvocationType;
|
|
1413
1413
|
}
|
|
1414
1414
|
/**
|
|
1415
|
-
* @public
|
|
1416
1415
|
* <p>When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service
|
|
1417
1416
|
* (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1418
1417
|
* <p>To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt
|
|
@@ -1425,29 +1424,29 @@ export interface LambdaAction {
|
|
|
1425
1424
|
* </note>
|
|
1426
1425
|
* <p>For information about specifying Amazon S3 actions in receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html">Amazon SES
|
|
1427
1426
|
* Developer Guide</a>.</p>
|
|
1427
|
+
* @public
|
|
1428
1428
|
*/
|
|
1429
1429
|
export interface S3Action {
|
|
1430
1430
|
/**
|
|
1431
|
-
* @public
|
|
1432
1431
|
* <p>The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You
|
|
1433
1432
|
* can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1434
1433
|
* Amazon SNS.</p>
|
|
1435
1434
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1435
|
+
* @public
|
|
1436
1436
|
*/
|
|
1437
1437
|
TopicArn?: string;
|
|
1438
1438
|
/**
|
|
1439
|
-
* @public
|
|
1440
1439
|
* <p>The name of the Amazon S3 bucket for incoming email.</p>
|
|
1440
|
+
* @public
|
|
1441
1441
|
*/
|
|
1442
1442
|
BucketName: string | undefined;
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that
|
|
1446
1445
|
* enables you to store similar data under the same directory in a bucket.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
ObjectKeyPrefix?: string;
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>The customer master key that Amazon SES should use to encrypt your emails before saving
|
|
1452
1451
|
* them to the Amazon S3 bucket. You can use the default master key or a custom master key that
|
|
1453
1452
|
* you created in Amazon Web Services KMS as follows:</p>
|
|
@@ -1482,6 +1481,7 @@ export interface S3Action {
|
|
|
1482
1481
|
* more information about client-side encryption using Amazon Web Services KMS master keys, see the
|
|
1483
1482
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 Developer Guide</a>.</p>
|
|
1484
1483
|
* </important>
|
|
1484
|
+
* @public
|
|
1485
1485
|
*/
|
|
1486
1486
|
KmsKeyArn?: string;
|
|
1487
1487
|
}
|
|
@@ -1498,7 +1498,6 @@ export declare const SNSActionEncoding: {
|
|
|
1498
1498
|
*/
|
|
1499
1499
|
export type SNSActionEncoding = (typeof SNSActionEncoding)[keyof typeof SNSActionEncoding];
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service
|
|
1503
1502
|
* (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS
|
|
1504
1503
|
* notifications. Amazon SNS notifications for all other actions simply provide information
|
|
@@ -1515,21 +1514,22 @@ export type SNSActionEncoding = (typeof SNSActionEncoding)[keyof typeof SNSActio
|
|
|
1515
1514
|
* </important>
|
|
1516
1515
|
* <p>For information about using a receipt rule to publish an Amazon SNS notification, see the
|
|
1517
1516
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html">Amazon SES Developer Guide</a>.</p>
|
|
1517
|
+
* @public
|
|
1518
1518
|
*/
|
|
1519
1519
|
export interface SNSAction {
|
|
1520
1520
|
/**
|
|
1521
|
-
* @public
|
|
1522
1521
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a
|
|
1523
1522
|
* topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in Amazon SNS.</p>
|
|
1524
1523
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
TopicArn: string | undefined;
|
|
1527
1527
|
/**
|
|
1528
|
-
* @public
|
|
1529
1528
|
* <p>The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to
|
|
1530
1529
|
* use, but may not preserve all special characters when a message was encoded with a
|
|
1531
1530
|
* different encoding format. Base64 preserves all special characters. The default value is
|
|
1532
1531
|
* UTF-8.</p>
|
|
1532
|
+
* @public
|
|
1533
1533
|
*/
|
|
1534
1534
|
Encoding?: SNSActionEncoding;
|
|
1535
1535
|
}
|
|
@@ -1545,46 +1545,45 @@ export declare const StopScope: {
|
|
|
1545
1545
|
*/
|
|
1546
1546
|
export type StopScope = (typeof StopScope)[keyof typeof StopScope];
|
|
1547
1547
|
/**
|
|
1548
|
-
* @public
|
|
1549
1548
|
* <p>When included in a receipt rule, this action terminates the evaluation of the receipt
|
|
1550
1549
|
* rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1551
1550
|
* <p>For information about setting a stop action in a receipt rule, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html">Amazon SES
|
|
1552
1551
|
* Developer Guide</a>.</p>
|
|
1552
|
+
* @public
|
|
1553
1553
|
*/
|
|
1554
1554
|
export interface StopAction {
|
|
1555
1555
|
/**
|
|
1556
|
-
* @public
|
|
1557
1556
|
* <p>The scope of the StopAction. The only acceptable value is <code>RuleSet</code>.</p>
|
|
1557
|
+
* @public
|
|
1558
1558
|
*/
|
|
1559
1559
|
Scope: StopScope | undefined;
|
|
1560
1560
|
/**
|
|
1561
|
-
* @public
|
|
1562
1561
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is
|
|
1563
1562
|
* taken. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> Amazon SNS operation.</p>
|
|
1564
1563
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
TopicArn?: string;
|
|
1567
1567
|
}
|
|
1568
1568
|
/**
|
|
1569
|
-
* @public
|
|
1570
1569
|
* <p>When included in a receipt rule, this action calls Amazon WorkMail and, optionally,
|
|
1571
1570
|
* publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up
|
|
1572
1571
|
* manually, because Amazon WorkMail adds the rule automatically during its setup
|
|
1573
1572
|
* procedure.</p>
|
|
1574
1573
|
* <p>For information using a receipt rule to call Amazon WorkMail, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html">Amazon SES
|
|
1575
1574
|
* Developer Guide</a>.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
export interface WorkmailAction {
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action
|
|
1581
1580
|
* is called. You can find the ARN of a topic by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html">ListTopics</a> operation in
|
|
1582
1581
|
* Amazon SNS.</p>
|
|
1583
1582
|
* <p>For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
TopicArn?: string;
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <p>The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail
|
|
1589
1588
|
* ARNs use the following format:</p>
|
|
1590
1589
|
* <p>
|
|
@@ -1594,55 +1593,56 @@ export interface WorkmailAction {
|
|
|
1594
1593
|
* organization IDs begin with "<code>m-</code>", followed by a string of alphanumeric
|
|
1595
1594
|
* characters.</p>
|
|
1596
1595
|
* <p>For information about Amazon WorkMail organizations, see the <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html">Amazon WorkMail Administrator Guide</a>.</p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
OrganizationArn: string | undefined;
|
|
1599
1599
|
}
|
|
1600
1600
|
/**
|
|
1601
|
-
* @public
|
|
1602
1601
|
* <p>An action that Amazon SES can take when it receives an email on behalf of one or more email
|
|
1603
1602
|
* addresses or domains that you own. An instance of this data type can represent only one
|
|
1604
1603
|
* action.</p>
|
|
1605
1604
|
* <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
|
|
1606
1605
|
* Developer Guide</a>.</p>
|
|
1606
|
+
* @public
|
|
1607
1607
|
*/
|
|
1608
1608
|
export interface ReceiptAction {
|
|
1609
1609
|
/**
|
|
1610
|
-
* @public
|
|
1611
1610
|
* <p>Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a
|
|
1612
1611
|
* notification to Amazon SNS.</p>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
S3Action?: S3Action;
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>Rejects the received email by returning a bounce response to the sender and,
|
|
1618
1617
|
* optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
BounceAction?: BounceAction;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>Calls Amazon WorkMail and, optionally, publishes a notification to Amazon
|
|
1624
1623
|
* Amazon SNS.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
WorkmailAction?: WorkmailAction;
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.</p>
|
|
1629
|
+
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
LambdaAction?: LambdaAction;
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>Terminates the evaluation of the receipt rule set and optionally publishes a
|
|
1635
1634
|
* notification to Amazon SNS.</p>
|
|
1635
|
+
* @public
|
|
1636
1636
|
*/
|
|
1637
1637
|
StopAction?: StopAction;
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>Adds a header to the received email.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
AddHeaderAction?: AddHeaderAction;
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p>Publishes the email content within a notification to Amazon SNS.</p>
|
|
1645
|
+
* @public
|
|
1646
1646
|
*/
|
|
1647
1647
|
SNSAction?: SNSAction;
|
|
1648
1648
|
}
|
|
@@ -1659,7 +1659,6 @@ export declare const TlsPolicy: {
|
|
|
1659
1659
|
*/
|
|
1660
1660
|
export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>Receipt rules enable you to specify which actions Amazon SES should take when it receives
|
|
1664
1663
|
* mail on behalf of one or more email addresses or domains that you own.</p>
|
|
1665
1664
|
* <p>Each receipt rule defines a set of email addresses or domains that it applies to. If
|
|
@@ -1667,10 +1666,10 @@ export type TlsPolicy = (typeof TlsPolicy)[keyof typeof TlsPolicy];
|
|
|
1667
1666
|
* Amazon SES executes all of the receipt rule's actions on the message.</p>
|
|
1668
1667
|
* <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
|
|
1669
1668
|
* Developer Guide</a>.</p>
|
|
1669
|
+
* @public
|
|
1670
1670
|
*/
|
|
1671
1671
|
export interface ReceiptRule {
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>The name of the receipt rule. The name must meet the following requirements:</p>
|
|
1675
1674
|
* <ul>
|
|
1676
1675
|
* <li>
|
|
@@ -1684,85 +1683,86 @@ export interface ReceiptRule {
|
|
|
1684
1683
|
* <p>Contain 64 characters or fewer.</p>
|
|
1685
1684
|
* </li>
|
|
1686
1685
|
* </ul>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
Name: string | undefined;
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>If <code>true</code>, the receipt rule is active. The default value is
|
|
1692
1691
|
* <code>false</code>.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
Enabled?: boolean;
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Specifies whether Amazon SES should require that incoming email is delivered over a
|
|
1698
1697
|
* connection encrypted with Transport Layer Security (TLS). If this parameter is set to
|
|
1699
1698
|
* <code>Require</code>, Amazon SES bounces emails that are not received over TLS. The
|
|
1700
1699
|
* default is <code>Optional</code>.</p>
|
|
1700
|
+
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
TlsPolicy?: TlsPolicy;
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The recipient domains and email addresses that the receipt rule applies to. If this
|
|
1706
1705
|
* field is not specified, this rule matches all recipients on all verified domains.</p>
|
|
1706
|
+
* @public
|
|
1707
1707
|
*/
|
|
1708
1708
|
Recipients?: string[];
|
|
1709
1709
|
/**
|
|
1710
|
-
* @public
|
|
1711
1710
|
* <p>An ordered list of actions to perform on messages that match at least one of the
|
|
1712
1711
|
* recipient email addresses or domains specified in the receipt rule.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
Actions?: ReceiptAction[];
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>If <code>true</code>, then messages that this receipt rule applies to are scanned for
|
|
1718
1717
|
* spam and viruses. The default value is <code>false</code>.</p>
|
|
1718
|
+
* @public
|
|
1719
1719
|
*/
|
|
1720
1720
|
ScanEnabled?: boolean;
|
|
1721
1721
|
}
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>Represents a request to create a receipt rule. You use receipt rules to receive email
|
|
1725
1724
|
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
1726
1725
|
* Guide</a>.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
export interface CreateReceiptRuleRequest {
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The name of the rule set where the receipt rule is added.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
RuleSetName: string | undefined;
|
|
1734
1734
|
/**
|
|
1735
|
-
* @public
|
|
1736
1735
|
* <p>The name of an existing rule after which the new rule is placed. If this parameter is
|
|
1737
1736
|
* null, the new rule is inserted at the beginning of the rule list.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
After?: string;
|
|
1740
1740
|
/**
|
|
1741
|
-
* @public
|
|
1742
1741
|
* <p>A data structure that contains the specified rule's name, actions, recipients,
|
|
1743
1742
|
* domains, enabled status, scan status, and TLS policy.</p>
|
|
1743
|
+
* @public
|
|
1744
1744
|
*/
|
|
1745
1745
|
Rule: ReceiptRule | undefined;
|
|
1746
1746
|
}
|
|
1747
1747
|
/**
|
|
1748
|
-
* @public
|
|
1749
1748
|
* <p>An empty element returned on a successful request.</p>
|
|
1749
|
+
* @public
|
|
1750
1750
|
*/
|
|
1751
1751
|
export interface CreateReceiptRuleResponse {
|
|
1752
1752
|
}
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could
|
|
1756
1755
|
* not execute the provided function, possibly due to permissions issues. For information
|
|
1757
1756
|
* about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1758
1757
|
* Developer Guide</a>.</p>
|
|
1758
|
+
* @public
|
|
1759
1759
|
*/
|
|
1760
1760
|
export declare class InvalidLambdaFunctionException extends __BaseException {
|
|
1761
1761
|
readonly name: "InvalidLambdaFunctionException";
|
|
1762
1762
|
readonly $fault: "client";
|
|
1763
1763
|
/**
|
|
1764
|
-
* @public
|
|
1765
1764
|
* <p>Indicates that the ARN of the function was not found.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
FunctionArn?: string;
|
|
1768
1768
|
/**
|
|
@@ -1771,18 +1771,18 @@ export declare class InvalidLambdaFunctionException extends __BaseException {
|
|
|
1771
1771
|
constructor(opts: __ExceptionOptionType<InvalidLambdaFunctionException, __BaseException>);
|
|
1772
1772
|
}
|
|
1773
1773
|
/**
|
|
1774
|
-
* @public
|
|
1775
1774
|
* <p>Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid,
|
|
1776
1775
|
* or that Amazon SES could not publish to the bucket, possibly due to permissions issues.
|
|
1777
1776
|
* For information about giving permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1778
1777
|
* Developer Guide</a>.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
export declare class InvalidS3ConfigurationException extends __BaseException {
|
|
1781
1781
|
readonly name: "InvalidS3ConfigurationException";
|
|
1782
1782
|
readonly $fault: "client";
|
|
1783
1783
|
/**
|
|
1784
|
-
* @public
|
|
1785
1784
|
* <p>Indicated that the S3 Bucket was not found.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
Bucket?: string;
|
|
1788
1788
|
/**
|
|
@@ -1791,18 +1791,18 @@ export declare class InvalidS3ConfigurationException extends __BaseException {
|
|
|
1791
1791
|
constructor(opts: __ExceptionOptionType<InvalidS3ConfigurationException, __BaseException>);
|
|
1792
1792
|
}
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not
|
|
1796
1795
|
* publish to the topic, possibly due to permissions issues. For information about giving
|
|
1797
1796
|
* permissions, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES
|
|
1798
1797
|
* Developer Guide</a>.</p>
|
|
1798
|
+
* @public
|
|
1799
1799
|
*/
|
|
1800
1800
|
export declare class InvalidSnsTopicException extends __BaseException {
|
|
1801
1801
|
readonly name: "InvalidSnsTopicException";
|
|
1802
1802
|
readonly $fault: "client";
|
|
1803
1803
|
/**
|
|
1804
|
-
* @public
|
|
1805
1804
|
* <p>Indicates that the topic does not exist.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
Topic?: string;
|
|
1808
1808
|
/**
|
|
@@ -1811,15 +1811,15 @@ export declare class InvalidSnsTopicException extends __BaseException {
|
|
|
1811
1811
|
constructor(opts: __ExceptionOptionType<InvalidSnsTopicException, __BaseException>);
|
|
1812
1812
|
}
|
|
1813
1813
|
/**
|
|
1814
|
-
* @public
|
|
1815
1814
|
* <p>Indicates that the provided receipt rule does not exist.</p>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
export declare class RuleDoesNotExistException extends __BaseException {
|
|
1818
1818
|
readonly name: "RuleDoesNotExistException";
|
|
1819
1819
|
readonly $fault: "client";
|
|
1820
1820
|
/**
|
|
1821
|
-
* @public
|
|
1822
1821
|
* <p>Indicates that the named receipt rule does not exist.</p>
|
|
1822
|
+
* @public
|
|
1823
1823
|
*/
|
|
1824
1824
|
Name?: string;
|
|
1825
1825
|
/**
|
|
@@ -1828,14 +1828,13 @@ export declare class RuleDoesNotExistException extends __BaseException {
|
|
|
1828
1828
|
constructor(opts: __ExceptionOptionType<RuleDoesNotExistException, __BaseException>);
|
|
1829
1829
|
}
|
|
1830
1830
|
/**
|
|
1831
|
-
* @public
|
|
1832
1831
|
* <p>Represents a request to create an empty receipt rule set. You use receipt rule sets to
|
|
1833
1832
|
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
1834
1833
|
* Guide</a>.</p>
|
|
1834
|
+
* @public
|
|
1835
1835
|
*/
|
|
1836
1836
|
export interface CreateReceiptRuleSetRequest {
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>The name of the rule set to create. The name must meet the following
|
|
1840
1839
|
* requirements:</p>
|
|
1841
1840
|
* <ul>
|
|
@@ -1850,55 +1849,56 @@ export interface CreateReceiptRuleSetRequest {
|
|
|
1850
1849
|
* <p>Contain 64 characters or fewer.</p>
|
|
1851
1850
|
* </li>
|
|
1852
1851
|
* </ul>
|
|
1852
|
+
* @public
|
|
1853
1853
|
*/
|
|
1854
1854
|
RuleSetName: string | undefined;
|
|
1855
1855
|
}
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <p>An empty element returned on a successful request.</p>
|
|
1858
|
+
* @public
|
|
1859
1859
|
*/
|
|
1860
1860
|
export interface CreateReceiptRuleSetResponse {
|
|
1861
1861
|
}
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
1865
1864
|
* text-only part.</p>
|
|
1865
|
+
* @public
|
|
1866
1866
|
*/
|
|
1867
1867
|
export interface Template {
|
|
1868
1868
|
/**
|
|
1869
|
-
* @public
|
|
1870
1869
|
* <p>The name of the template. You use this name when you send email using the
|
|
1871
1870
|
* <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code>
|
|
1872
1871
|
* operations.</p>
|
|
1872
|
+
* @public
|
|
1873
1873
|
*/
|
|
1874
1874
|
TemplateName: string | undefined;
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>The subject line of the email.</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
SubjectPart?: string;
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>The email body that is visible to recipients whose email clients do not display HTML
|
|
1883
1882
|
* content.</p>
|
|
1883
|
+
* @public
|
|
1884
1884
|
*/
|
|
1885
1885
|
TextPart?: string;
|
|
1886
1886
|
/**
|
|
1887
|
-
* @public
|
|
1888
1887
|
* <p>The HTML body of the email.</p>
|
|
1888
|
+
* @public
|
|
1889
1889
|
*/
|
|
1890
1890
|
HtmlPart?: string;
|
|
1891
1891
|
}
|
|
1892
1892
|
/**
|
|
1893
|
-
* @public
|
|
1894
1893
|
* <p>Represents a request to create an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES
|
|
1895
1894
|
* Developer Guide</a>.</p>
|
|
1895
|
+
* @public
|
|
1896
1896
|
*/
|
|
1897
1897
|
export interface CreateTemplateRequest {
|
|
1898
1898
|
/**
|
|
1899
|
-
* @public
|
|
1900
1899
|
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
1901
1900
|
* text-only part.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
Template: Template | undefined;
|
|
1904
1904
|
}
|
|
@@ -1908,9 +1908,9 @@ export interface CreateTemplateRequest {
|
|
|
1908
1908
|
export interface CreateTemplateResponse {
|
|
1909
1909
|
}
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>Indicates that the template that you specified could not be rendered. This issue may
|
|
1913
1912
|
* occur when a template refers to a partial that does not exist.</p>
|
|
1913
|
+
* @public
|
|
1914
1914
|
*/
|
|
1915
1915
|
export declare class InvalidTemplateException extends __BaseException {
|
|
1916
1916
|
readonly name: "InvalidTemplateException";
|
|
@@ -1936,49 +1936,49 @@ export declare const CustomMailFromStatus: {
|
|
|
1936
1936
|
*/
|
|
1937
1937
|
export type CustomMailFromStatus = (typeof CustomMailFromStatus)[keyof typeof CustomMailFromStatus];
|
|
1938
1938
|
/**
|
|
1939
|
-
* @public
|
|
1940
1939
|
* <p>Contains information about a custom verification email template.</p>
|
|
1940
|
+
* @public
|
|
1941
1941
|
*/
|
|
1942
1942
|
export interface CustomVerificationEmailTemplate {
|
|
1943
1943
|
/**
|
|
1944
|
-
* @public
|
|
1945
1944
|
* <p>The name of the custom verification email template.</p>
|
|
1945
|
+
* @public
|
|
1946
1946
|
*/
|
|
1947
1947
|
TemplateName?: string;
|
|
1948
1948
|
/**
|
|
1949
|
-
* @public
|
|
1950
1949
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
FromEmailAddress?: string;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The subject line of the custom verification email.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
TemplateSubject?: string;
|
|
1958
1958
|
/**
|
|
1959
|
-
* @public
|
|
1960
1959
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1961
1960
|
* is successfully verified.</p>
|
|
1961
|
+
* @public
|
|
1962
1962
|
*/
|
|
1963
1963
|
SuccessRedirectionURL?: string;
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
1967
1966
|
* is not successfully verified.</p>
|
|
1967
|
+
* @public
|
|
1968
1968
|
*/
|
|
1969
1969
|
FailureRedirectionURL?: string;
|
|
1970
1970
|
}
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>Indicates that a custom verification email template with the name you specified does
|
|
1974
1973
|
* not exist.</p>
|
|
1974
|
+
* @public
|
|
1975
1975
|
*/
|
|
1976
1976
|
export declare class CustomVerificationEmailTemplateDoesNotExistException extends __BaseException {
|
|
1977
1977
|
readonly name: "CustomVerificationEmailTemplateDoesNotExistException";
|
|
1978
1978
|
readonly $fault: "client";
|
|
1979
1979
|
/**
|
|
1980
|
-
* @public
|
|
1981
1980
|
* <p>Indicates that the provided custom verification email template does not exist.</p>
|
|
1981
|
+
* @public
|
|
1982
1982
|
*/
|
|
1983
1983
|
CustomVerificationEmailTemplateName?: string;
|
|
1984
1984
|
/**
|
|
@@ -1987,66 +1987,66 @@ export declare class CustomVerificationEmailTemplateDoesNotExistException extend
|
|
|
1987
1987
|
constructor(opts: __ExceptionOptionType<CustomVerificationEmailTemplateDoesNotExistException, __BaseException>);
|
|
1988
1988
|
}
|
|
1989
1989
|
/**
|
|
1990
|
-
* @public
|
|
1991
1990
|
* <p>Represents a request to delete a configuration set. Configuration sets enable you to
|
|
1992
1991
|
* publish email sending events. For information about using configuration sets, see the
|
|
1993
1992
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
1994
1993
|
* Developer Guide</a>.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
export interface DeleteConfigurationSetRequest {
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>The name of the configuration set to delete.</p>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
ConfigurationSetName: string | undefined;
|
|
2002
2002
|
}
|
|
2003
2003
|
/**
|
|
2004
|
-
* @public
|
|
2005
2004
|
* <p>An empty element returned on a successful request.</p>
|
|
2005
|
+
* @public
|
|
2006
2006
|
*/
|
|
2007
2007
|
export interface DeleteConfigurationSetResponse {
|
|
2008
2008
|
}
|
|
2009
2009
|
/**
|
|
2010
|
-
* @public
|
|
2011
2010
|
* <p>Represents a request to delete a configuration set event destination. Configuration
|
|
2012
2011
|
* set event destinations are associated with configuration sets, which enable you to
|
|
2013
2012
|
* publish email sending events. For information about using configuration sets, see the
|
|
2014
2013
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
2015
2014
|
* Developer Guide</a>.</p>
|
|
2015
|
+
* @public
|
|
2016
2016
|
*/
|
|
2017
2017
|
export interface DeleteConfigurationSetEventDestinationRequest {
|
|
2018
2018
|
/**
|
|
2019
|
-
* @public
|
|
2020
2019
|
* <p>The name of the configuration set from which to delete the event destination.</p>
|
|
2020
|
+
* @public
|
|
2021
2021
|
*/
|
|
2022
2022
|
ConfigurationSetName: string | undefined;
|
|
2023
2023
|
/**
|
|
2024
|
-
* @public
|
|
2025
2024
|
* <p>The name of the event destination to delete.</p>
|
|
2025
|
+
* @public
|
|
2026
2026
|
*/
|
|
2027
2027
|
EventDestinationName: string | undefined;
|
|
2028
2028
|
}
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>An empty element returned on a successful request.</p>
|
|
2031
|
+
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
export interface DeleteConfigurationSetEventDestinationResponse {
|
|
2034
2034
|
}
|
|
2035
2035
|
/**
|
|
2036
|
-
* @public
|
|
2037
2036
|
* <p>Indicates that the event destination does not exist.</p>
|
|
2037
|
+
* @public
|
|
2038
2038
|
*/
|
|
2039
2039
|
export declare class EventDestinationDoesNotExistException extends __BaseException {
|
|
2040
2040
|
readonly name: "EventDestinationDoesNotExistException";
|
|
2041
2041
|
readonly $fault: "client";
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
ConfigurationSetName?: string;
|
|
2047
2047
|
/**
|
|
2048
|
-
* @public
|
|
2049
2048
|
* <p>Indicates that the event destination does not exist.</p>
|
|
2049
|
+
* @public
|
|
2050
2050
|
*/
|
|
2051
2051
|
EventDestinationName?: string;
|
|
2052
2052
|
/**
|
|
@@ -2055,34 +2055,34 @@ export declare class EventDestinationDoesNotExistException extends __BaseExcepti
|
|
|
2055
2055
|
constructor(opts: __ExceptionOptionType<EventDestinationDoesNotExistException, __BaseException>);
|
|
2056
2056
|
}
|
|
2057
2057
|
/**
|
|
2058
|
-
* @public
|
|
2059
2058
|
* <p>Represents a request to delete open and click tracking options in a configuration set.
|
|
2060
2059
|
* </p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
export interface DeleteConfigurationSetTrackingOptionsRequest {
|
|
2063
2063
|
/**
|
|
2064
|
-
* @public
|
|
2065
2064
|
* <p>The name of the configuration set.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
ConfigurationSetName: string | undefined;
|
|
2068
2068
|
}
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>An empty element returned on a successful request.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
export interface DeleteConfigurationSetTrackingOptionsResponse {
|
|
2074
2074
|
}
|
|
2075
2075
|
/**
|
|
2076
|
-
* @public
|
|
2077
2076
|
* <p>Indicates that the TrackingOptions object you specified does not exist.</p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
export declare class TrackingOptionsDoesNotExistException extends __BaseException {
|
|
2080
2080
|
readonly name: "TrackingOptionsDoesNotExistException";
|
|
2081
2081
|
readonly $fault: "client";
|
|
2082
2082
|
/**
|
|
2083
|
-
* @public
|
|
2084
2083
|
* <p>Indicates that a TrackingOptions object does not exist in the specified configuration
|
|
2085
2084
|
* set.</p>
|
|
2085
|
+
* @public
|
|
2086
2086
|
*/
|
|
2087
2087
|
ConfigurationSetName?: string;
|
|
2088
2088
|
/**
|
|
@@ -2091,133 +2091,133 @@ export declare class TrackingOptionsDoesNotExistException extends __BaseExceptio
|
|
|
2091
2091
|
constructor(opts: __ExceptionOptionType<TrackingOptionsDoesNotExistException, __BaseException>);
|
|
2092
2092
|
}
|
|
2093
2093
|
/**
|
|
2094
|
-
* @public
|
|
2095
2094
|
* <p>Represents a request to delete an existing custom verification email template.</p>
|
|
2095
|
+
* @public
|
|
2096
2096
|
*/
|
|
2097
2097
|
export interface DeleteCustomVerificationEmailTemplateRequest {
|
|
2098
2098
|
/**
|
|
2099
|
-
* @public
|
|
2100
2099
|
* <p>The name of the custom verification email template to delete.</p>
|
|
2100
|
+
* @public
|
|
2101
2101
|
*/
|
|
2102
2102
|
TemplateName: string | undefined;
|
|
2103
2103
|
}
|
|
2104
2104
|
/**
|
|
2105
|
-
* @public
|
|
2106
2105
|
* <p>Represents a request to delete one of your Amazon SES identities (an email address or
|
|
2107
2106
|
* domain).</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
export interface DeleteIdentityRequest {
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The identity to be removed from the list of identities for the Amazon Web Services account.</p>
|
|
2112
|
+
* @public
|
|
2113
2113
|
*/
|
|
2114
2114
|
Identity: string | undefined;
|
|
2115
2115
|
}
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>An empty element returned on a successful request.</p>
|
|
2118
|
+
* @public
|
|
2119
2119
|
*/
|
|
2120
2120
|
export interface DeleteIdentityResponse {
|
|
2121
2121
|
}
|
|
2122
2122
|
/**
|
|
2123
|
-
* @public
|
|
2124
2123
|
* <p>Represents a request to delete a sending authorization policy for an identity. Sending
|
|
2125
2124
|
* authorization is an Amazon SES feature that enables you to authorize other senders to use
|
|
2126
2125
|
* your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
export interface DeleteIdentityPolicyRequest {
|
|
2129
2129
|
/**
|
|
2130
|
-
* @public
|
|
2131
2130
|
* <p>The identity that is associated with the policy to delete. You can specify the
|
|
2132
2131
|
* identity by using its name or by using its Amazon Resource Name (ARN). Examples:
|
|
2133
2132
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
2134
2133
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
2135
2134
|
* <p>To successfully call this operation, you must own the identity.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
Identity: string | undefined;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The name of the policy to be deleted.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
PolicyName: string | undefined;
|
|
2143
2143
|
}
|
|
2144
2144
|
/**
|
|
2145
|
-
* @public
|
|
2146
2145
|
* <p>An empty element returned on a successful request.</p>
|
|
2146
|
+
* @public
|
|
2147
2147
|
*/
|
|
2148
2148
|
export interface DeleteIdentityPolicyResponse {
|
|
2149
2149
|
}
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>Represents a request to delete an IP address filter. You use IP address filters when
|
|
2153
2152
|
* you receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2154
2153
|
* Guide</a>.</p>
|
|
2154
|
+
* @public
|
|
2155
2155
|
*/
|
|
2156
2156
|
export interface DeleteReceiptFilterRequest {
|
|
2157
2157
|
/**
|
|
2158
|
-
* @public
|
|
2159
2158
|
* <p>The name of the IP address filter to delete.</p>
|
|
2159
|
+
* @public
|
|
2160
2160
|
*/
|
|
2161
2161
|
FilterName: string | undefined;
|
|
2162
2162
|
}
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>An empty element returned on a successful request.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
export interface DeleteReceiptFilterResponse {
|
|
2168
2168
|
}
|
|
2169
2169
|
/**
|
|
2170
|
-
* @public
|
|
2171
2170
|
* <p>Represents a request to delete a receipt rule. You use receipt rules to receive email
|
|
2172
2171
|
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2173
2172
|
* Guide</a>.</p>
|
|
2173
|
+
* @public
|
|
2174
2174
|
*/
|
|
2175
2175
|
export interface DeleteReceiptRuleRequest {
|
|
2176
2176
|
/**
|
|
2177
|
-
* @public
|
|
2178
2177
|
* <p>The name of the receipt rule set that contains the receipt rule to delete.</p>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
RuleSetName: string | undefined;
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>The name of the receipt rule to delete.</p>
|
|
2183
|
+
* @public
|
|
2184
2184
|
*/
|
|
2185
2185
|
RuleName: string | undefined;
|
|
2186
2186
|
}
|
|
2187
2187
|
/**
|
|
2188
|
-
* @public
|
|
2189
2188
|
* <p>An empty element returned on a successful request.</p>
|
|
2189
|
+
* @public
|
|
2190
2190
|
*/
|
|
2191
2191
|
export interface DeleteReceiptRuleResponse {
|
|
2192
2192
|
}
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>Represents a request to delete a receipt rule set and all of the receipt rules it
|
|
2196
2195
|
* contains. You use receipt rule sets to receive email with Amazon SES. For more information,
|
|
2197
2196
|
* see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer Guide</a>.</p>
|
|
2197
|
+
* @public
|
|
2198
2198
|
*/
|
|
2199
2199
|
export interface DeleteReceiptRuleSetRequest {
|
|
2200
2200
|
/**
|
|
2201
|
-
* @public
|
|
2202
2201
|
* <p>The name of the receipt rule set to delete.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
RuleSetName: string | undefined;
|
|
2205
2205
|
}
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>An empty element returned on a successful request.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
export interface DeleteReceiptRuleSetResponse {
|
|
2211
2211
|
}
|
|
2212
2212
|
/**
|
|
2213
|
-
* @public
|
|
2214
2213
|
* <p>Represents a request to delete an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES
|
|
2215
2214
|
* Developer Guide</a>.</p>
|
|
2215
|
+
* @public
|
|
2216
2216
|
*/
|
|
2217
2217
|
export interface DeleteTemplateRequest {
|
|
2218
2218
|
/**
|
|
2219
|
-
* @public
|
|
2220
2219
|
* <p>The name of the template to be deleted.</p>
|
|
2220
|
+
* @public
|
|
2221
2221
|
*/
|
|
2222
2222
|
TemplateName: string | undefined;
|
|
2223
2223
|
}
|
|
@@ -2227,51 +2227,50 @@ export interface DeleteTemplateRequest {
|
|
|
2227
2227
|
export interface DeleteTemplateResponse {
|
|
2228
2228
|
}
|
|
2229
2229
|
/**
|
|
2230
|
-
* @public
|
|
2231
2230
|
* <p>Represents a request to delete an email address from the list of email addresses you
|
|
2232
2231
|
* have attempted to verify under your Amazon Web Services account.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
export interface DeleteVerifiedEmailAddressRequest {
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>An email address to be removed from the list of verified addresses.</p>
|
|
2237
|
+
* @public
|
|
2238
2238
|
*/
|
|
2239
2239
|
EmailAddress: string | undefined;
|
|
2240
2240
|
}
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
2244
2243
|
* Transport Layer Security (TLS).</p>
|
|
2244
|
+
* @public
|
|
2245
2245
|
*/
|
|
2246
2246
|
export interface DeliveryOptions {
|
|
2247
2247
|
/**
|
|
2248
|
-
* @public
|
|
2249
2248
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
2250
2249
|
* Transport Layer Security (TLS). If the value is <code>Require</code>, messages are only
|
|
2251
2250
|
* delivered if a TLS connection can be established. If the value is <code>Optional</code>,
|
|
2252
2251
|
* messages can be delivered in plain text if a TLS connection can't be established.</p>
|
|
2252
|
+
* @public
|
|
2253
2253
|
*/
|
|
2254
2254
|
TlsPolicy?: TlsPolicy;
|
|
2255
2255
|
}
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>Represents a request to return the metadata and receipt rules for the receipt rule set
|
|
2259
2258
|
* that is currently active. You use receipt rule sets to receive email with Amazon SES. For
|
|
2260
2259
|
* more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2261
2260
|
* Guide</a>.</p>
|
|
2261
|
+
* @public
|
|
2262
2262
|
*/
|
|
2263
2263
|
export interface DescribeActiveReceiptRuleSetRequest {
|
|
2264
2264
|
}
|
|
2265
2265
|
/**
|
|
2266
|
-
* @public
|
|
2267
2266
|
* <p>Information about a receipt rule set.</p>
|
|
2268
2267
|
* <p>A receipt rule set is a collection of rules that specify what Amazon SES should do with
|
|
2269
2268
|
* mail it receives on behalf of your account's verified domains.</p>
|
|
2270
2269
|
* <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>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
export interface ReceiptRuleSetMetadata {
|
|
2273
2273
|
/**
|
|
2274
|
-
* @public
|
|
2275
2274
|
* <p>The name of the receipt rule set. The name must meet the following
|
|
2276
2275
|
* requirements:</p>
|
|
2277
2276
|
* <ul>
|
|
@@ -2286,76 +2285,76 @@ export interface ReceiptRuleSetMetadata {
|
|
|
2286
2285
|
* <p>Contain 64 characters or fewer.</p>
|
|
2287
2286
|
* </li>
|
|
2288
2287
|
* </ul>
|
|
2288
|
+
* @public
|
|
2289
2289
|
*/
|
|
2290
2290
|
Name?: string;
|
|
2291
2291
|
/**
|
|
2292
|
-
* @public
|
|
2293
2292
|
* <p>The date and time the receipt rule set was created.</p>
|
|
2293
|
+
* @public
|
|
2294
2294
|
*/
|
|
2295
2295
|
CreatedTimestamp?: Date;
|
|
2296
2296
|
}
|
|
2297
2297
|
/**
|
|
2298
|
-
* @public
|
|
2299
2298
|
* <p>Represents the metadata and receipt rules for the receipt rule set that is currently
|
|
2300
2299
|
* active.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
export interface DescribeActiveReceiptRuleSetResponse {
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>The metadata for the currently active receipt rule set. The metadata consists of the
|
|
2306
2305
|
* rule set name and a timestamp of when the rule set was created.</p>
|
|
2306
|
+
* @public
|
|
2307
2307
|
*/
|
|
2308
2308
|
Metadata?: ReceiptRuleSetMetadata;
|
|
2309
2309
|
/**
|
|
2310
|
-
* @public
|
|
2311
2310
|
* <p>The receipt rules that belong to the active rule set.</p>
|
|
2311
|
+
* @public
|
|
2312
2312
|
*/
|
|
2313
2313
|
Rules?: ReceiptRule[];
|
|
2314
2314
|
}
|
|
2315
2315
|
/**
|
|
2316
|
-
* @public
|
|
2317
2316
|
* <p>Represents a request to return the details of a configuration set. Configuration sets
|
|
2318
2317
|
* enable you to publish email sending events. For information about using configuration
|
|
2319
2318
|
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
2320
2319
|
* Guide</a>.</p>
|
|
2320
|
+
* @public
|
|
2321
2321
|
*/
|
|
2322
2322
|
export interface DescribeConfigurationSetRequest {
|
|
2323
2323
|
/**
|
|
2324
|
-
* @public
|
|
2325
2324
|
* <p>The name of the configuration set to describe.</p>
|
|
2325
|
+
* @public
|
|
2326
2326
|
*/
|
|
2327
2327
|
ConfigurationSetName: string | undefined;
|
|
2328
2328
|
/**
|
|
2329
|
-
* @public
|
|
2330
2329
|
* <p>A list of configuration set attributes to return.</p>
|
|
2330
|
+
* @public
|
|
2331
2331
|
*/
|
|
2332
2332
|
ConfigurationSetAttributeNames?: ConfigurationSetAttribute[];
|
|
2333
2333
|
}
|
|
2334
2334
|
/**
|
|
2335
|
-
* @public
|
|
2336
2335
|
* <p>Contains information about the reputation settings for a configuration set.</p>
|
|
2336
|
+
* @public
|
|
2337
2337
|
*/
|
|
2338
2338
|
export interface ReputationOptions {
|
|
2339
2339
|
/**
|
|
2340
|
-
* @public
|
|
2341
2340
|
* <p>Describes whether email sending is enabled or disabled for the configuration set. If
|
|
2342
2341
|
* the value is <code>true</code>, then Amazon SES sends emails that use the configuration set.
|
|
2343
2342
|
* If the value is <code>false</code>, Amazon SES does not send emails that use the
|
|
2344
2343
|
* configuration set. The default value is <code>true</code>. You can change this setting
|
|
2345
2344
|
* using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
2345
|
+
* @public
|
|
2346
2346
|
*/
|
|
2347
2347
|
SendingEnabled?: boolean;
|
|
2348
2348
|
/**
|
|
2349
|
-
* @public
|
|
2350
2349
|
* <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
|
|
2351
2350
|
* such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
2352
2351
|
* <p>If the value is <code>true</code>, reputation metrics are published. If the value is
|
|
2353
2352
|
* <code>false</code>, reputation metrics are not published. The default value is
|
|
2354
2353
|
* <code>false</code>.</p>
|
|
2354
|
+
* @public
|
|
2355
2355
|
*/
|
|
2356
2356
|
ReputationMetricsEnabled?: boolean;
|
|
2357
2357
|
/**
|
|
2358
|
-
* @public
|
|
2359
2358
|
* <p>The date and time at which the reputation metrics for the configuration set were last
|
|
2360
2359
|
* reset. Resetting these metrics is known as a <i>fresh start</i>.</p>
|
|
2361
2360
|
* <p>When you disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a> and later re-enable it, the
|
|
@@ -2363,102 +2362,103 @@ export interface ReputationOptions {
|
|
|
2363
2362
|
* reset.</p>
|
|
2364
2363
|
* <p>If email sending for the configuration set has never been disabled and later
|
|
2365
2364
|
* re-enabled, the value of this attribute is <code>null</code>.</p>
|
|
2365
|
+
* @public
|
|
2366
2366
|
*/
|
|
2367
2367
|
LastFreshStart?: Date;
|
|
2368
2368
|
}
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>Represents the details of a configuration set. Configuration sets enable you to
|
|
2372
2371
|
* publish email sending events. For information about using configuration sets, see the
|
|
2373
2372
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES
|
|
2374
2373
|
* Developer Guide</a>.</p>
|
|
2374
|
+
* @public
|
|
2375
2375
|
*/
|
|
2376
2376
|
export interface DescribeConfigurationSetResponse {
|
|
2377
2377
|
/**
|
|
2378
|
-
* @public
|
|
2379
2378
|
* <p>The configuration set object associated with the specified configuration set.</p>
|
|
2379
|
+
* @public
|
|
2380
2380
|
*/
|
|
2381
2381
|
ConfigurationSet?: ConfigurationSet;
|
|
2382
2382
|
/**
|
|
2383
|
-
* @public
|
|
2384
2383
|
* <p>A list of event destinations associated with the configuration set. </p>
|
|
2384
|
+
* @public
|
|
2385
2385
|
*/
|
|
2386
2386
|
EventDestinations?: EventDestination[];
|
|
2387
2387
|
/**
|
|
2388
|
-
* @public
|
|
2389
2388
|
* <p>The name of the custom open and click tracking domain associated with the
|
|
2390
2389
|
* configuration set.</p>
|
|
2390
|
+
* @public
|
|
2391
2391
|
*/
|
|
2392
2392
|
TrackingOptions?: TrackingOptions;
|
|
2393
2393
|
/**
|
|
2394
|
-
* @public
|
|
2395
2394
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
2396
2395
|
* Transport Layer Security (TLS).</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
DeliveryOptions?: DeliveryOptions;
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>An object that represents the reputation settings for the configuration set. </p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
ReputationOptions?: ReputationOptions;
|
|
2404
2404
|
}
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>Represents a request to return the details of a receipt rule. You use receipt rules to
|
|
2408
2407
|
* receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
2409
2408
|
* Guide</a>.</p>
|
|
2409
|
+
* @public
|
|
2410
2410
|
*/
|
|
2411
2411
|
export interface DescribeReceiptRuleRequest {
|
|
2412
2412
|
/**
|
|
2413
|
-
* @public
|
|
2414
2413
|
* <p>The name of the receipt rule set that the receipt rule belongs to.</p>
|
|
2414
|
+
* @public
|
|
2415
2415
|
*/
|
|
2416
2416
|
RuleSetName: string | undefined;
|
|
2417
2417
|
/**
|
|
2418
|
-
* @public
|
|
2419
2418
|
* <p>The name of the receipt rule.</p>
|
|
2419
|
+
* @public
|
|
2420
2420
|
*/
|
|
2421
2421
|
RuleName: string | undefined;
|
|
2422
2422
|
}
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p>Represents the details of a receipt rule.</p>
|
|
2425
|
+
* @public
|
|
2426
2426
|
*/
|
|
2427
2427
|
export interface DescribeReceiptRuleResponse {
|
|
2428
2428
|
/**
|
|
2429
|
-
* @public
|
|
2430
2429
|
* <p>A data structure that contains the specified receipt rule's name, actions, recipients,
|
|
2431
2430
|
* domains, enabled status, scan status, and Transport Layer Security (TLS) policy.</p>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
Rule?: ReceiptRule;
|
|
2434
2434
|
}
|
|
2435
2435
|
/**
|
|
2436
|
-
* @public
|
|
2437
2436
|
* <p>Represents a request to return the details of a receipt rule set. You use receipt rule
|
|
2438
2437
|
* sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
2439
2438
|
* Developer Guide</a>.</p>
|
|
2439
|
+
* @public
|
|
2440
2440
|
*/
|
|
2441
2441
|
export interface DescribeReceiptRuleSetRequest {
|
|
2442
2442
|
/**
|
|
2443
|
-
* @public
|
|
2444
2443
|
* <p>The name of the receipt rule set to describe.</p>
|
|
2444
|
+
* @public
|
|
2445
2445
|
*/
|
|
2446
2446
|
RuleSetName: string | undefined;
|
|
2447
2447
|
}
|
|
2448
2448
|
/**
|
|
2449
|
-
* @public
|
|
2450
2449
|
* <p>Represents the details of the specified receipt rule set.</p>
|
|
2450
|
+
* @public
|
|
2451
2451
|
*/
|
|
2452
2452
|
export interface DescribeReceiptRuleSetResponse {
|
|
2453
2453
|
/**
|
|
2454
|
-
* @public
|
|
2455
2454
|
* <p>The metadata for the receipt rule set, which consists of the rule set name and the
|
|
2456
2455
|
* timestamp of when the rule set was created.</p>
|
|
2456
|
+
* @public
|
|
2457
2457
|
*/
|
|
2458
2458
|
Metadata?: ReceiptRuleSetMetadata;
|
|
2459
2459
|
/**
|
|
2460
|
-
* @public
|
|
2461
2460
|
* <p>A list of the receipt rules that belong to the specified receipt rule set.</p>
|
|
2461
|
+
* @public
|
|
2462
2462
|
*/
|
|
2463
2463
|
Rules?: ReceiptRule[];
|
|
2464
2464
|
}
|
|
@@ -2478,25 +2478,24 @@ export declare const VerificationStatus: {
|
|
|
2478
2478
|
*/
|
|
2479
2479
|
export type VerificationStatus = (typeof VerificationStatus)[keyof typeof VerificationStatus];
|
|
2480
2480
|
/**
|
|
2481
|
-
* @public
|
|
2482
2481
|
* <p>Represents the DKIM attributes of a verified email address or a domain.</p>
|
|
2482
|
+
* @public
|
|
2483
2483
|
*/
|
|
2484
2484
|
export interface IdentityDkimAttributes {
|
|
2485
2485
|
/**
|
|
2486
|
-
* @public
|
|
2487
2486
|
* <p>Is true if DKIM signing is enabled for email sent from the identity. It's false
|
|
2488
2487
|
* otherwise. The default value is true.</p>
|
|
2488
|
+
* @public
|
|
2489
2489
|
*/
|
|
2490
2490
|
DkimEnabled: boolean | undefined;
|
|
2491
2491
|
/**
|
|
2492
|
-
* @public
|
|
2493
2492
|
* <p>Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens)
|
|
2494
2493
|
* published in the domain name's DNS. (This only applies to domain identities, not email
|
|
2495
2494
|
* address identities.)</p>
|
|
2495
|
+
* @public
|
|
2496
2496
|
*/
|
|
2497
2497
|
DkimVerificationStatus: VerificationStatus | undefined;
|
|
2498
2498
|
/**
|
|
2499
|
-
* @public
|
|
2500
2499
|
* <p>A set of character strings that represent the domain's identity. Using these tokens,
|
|
2501
2500
|
* you need to create DNS CNAME records that point to DKIM public keys that are hosted by
|
|
2502
2501
|
* Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection
|
|
@@ -2504,136 +2503,136 @@ export interface IdentityDkimAttributes {
|
|
|
2504
2503
|
* DKIM-sign email originating from that domain. (This only applies to domain identities,
|
|
2505
2504
|
* not email address identities.)</p>
|
|
2506
2505
|
* <p>For more information about creating DNS records using DKIM tokens, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
2506
|
+
* @public
|
|
2507
2507
|
*/
|
|
2508
2508
|
DkimTokens?: string[];
|
|
2509
2509
|
}
|
|
2510
2510
|
/**
|
|
2511
|
-
* @public
|
|
2512
2511
|
* <p>Represents a request to return the email sending status for your Amazon SES account in the
|
|
2513
2512
|
* current Amazon Web Services Region.</p>
|
|
2513
|
+
* @public
|
|
2514
2514
|
*/
|
|
2515
2515
|
export interface GetAccountSendingEnabledResponse {
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
2519
2518
|
* current Amazon Web Services Region.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
Enabled?: boolean;
|
|
2522
2522
|
}
|
|
2523
2523
|
/**
|
|
2524
|
-
* @public
|
|
2525
2524
|
* <p>Represents a request to retrieve an existing custom verification email
|
|
2526
2525
|
* template.</p>
|
|
2526
|
+
* @public
|
|
2527
2527
|
*/
|
|
2528
2528
|
export interface GetCustomVerificationEmailTemplateRequest {
|
|
2529
2529
|
/**
|
|
2530
|
-
* @public
|
|
2531
2530
|
* <p>The name of the custom verification email template to retrieve.</p>
|
|
2531
|
+
* @public
|
|
2532
2532
|
*/
|
|
2533
2533
|
TemplateName: string | undefined;
|
|
2534
2534
|
}
|
|
2535
2535
|
/**
|
|
2536
|
-
* @public
|
|
2537
2536
|
* <p>The content of the custom verification email template.</p>
|
|
2537
|
+
* @public
|
|
2538
2538
|
*/
|
|
2539
2539
|
export interface GetCustomVerificationEmailTemplateResponse {
|
|
2540
2540
|
/**
|
|
2541
|
-
* @public
|
|
2542
2541
|
* <p>The name of the custom verification email template.</p>
|
|
2542
|
+
* @public
|
|
2543
2543
|
*/
|
|
2544
2544
|
TemplateName?: string;
|
|
2545
2545
|
/**
|
|
2546
|
-
* @public
|
|
2547
2546
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
2547
|
+
* @public
|
|
2548
2548
|
*/
|
|
2549
2549
|
FromEmailAddress?: string;
|
|
2550
2550
|
/**
|
|
2551
|
-
* @public
|
|
2552
2551
|
* <p>The subject line of the custom verification email.</p>
|
|
2552
|
+
* @public
|
|
2553
2553
|
*/
|
|
2554
2554
|
TemplateSubject?: string;
|
|
2555
2555
|
/**
|
|
2556
|
-
* @public
|
|
2557
2556
|
* <p>The content of the custom verification email.</p>
|
|
2557
|
+
* @public
|
|
2558
2558
|
*/
|
|
2559
2559
|
TemplateContent?: string;
|
|
2560
2560
|
/**
|
|
2561
|
-
* @public
|
|
2562
2561
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2563
2562
|
* is successfully verified.</p>
|
|
2563
|
+
* @public
|
|
2564
2564
|
*/
|
|
2565
2565
|
SuccessRedirectionURL?: string;
|
|
2566
2566
|
/**
|
|
2567
|
-
* @public
|
|
2568
2567
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
2569
2568
|
* is not successfully verified.</p>
|
|
2569
|
+
* @public
|
|
2570
2570
|
*/
|
|
2571
2571
|
FailureRedirectionURL?: string;
|
|
2572
2572
|
}
|
|
2573
2573
|
/**
|
|
2574
|
-
* @public
|
|
2575
2574
|
* <p>Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For
|
|
2576
2575
|
* domain identities, this request also returns the DKIM tokens that are required for Easy
|
|
2577
2576
|
* DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
|
|
2578
2577
|
* For more information about Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer
|
|
2579
2578
|
* Guide</a>.</p>
|
|
2579
|
+
* @public
|
|
2580
2580
|
*/
|
|
2581
2581
|
export interface GetIdentityDkimAttributesRequest {
|
|
2582
2582
|
/**
|
|
2583
|
-
* @public
|
|
2584
2583
|
* <p>A list of one or more verified identities - email addresses, domains, or both.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
Identities: string[] | undefined;
|
|
2587
2587
|
}
|
|
2588
2588
|
/**
|
|
2589
|
-
* @public
|
|
2590
2589
|
* <p>Represents the status of Amazon SES Easy DKIM signing for an identity. For domain
|
|
2591
2590
|
* identities, this response also contains the DKIM tokens that are required for Easy DKIM
|
|
2592
2591
|
* signing, and whether Amazon SES successfully verified that these tokens were
|
|
2593
2592
|
* published.</p>
|
|
2593
|
+
* @public
|
|
2594
2594
|
*/
|
|
2595
2595
|
export interface GetIdentityDkimAttributesResponse {
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>The DKIM attributes for an email address or a domain.</p>
|
|
2598
|
+
* @public
|
|
2599
2599
|
*/
|
|
2600
2600
|
DkimAttributes: Record<string, IdentityDkimAttributes> | undefined;
|
|
2601
2601
|
}
|
|
2602
2602
|
/**
|
|
2603
|
-
* @public
|
|
2604
2603
|
* <p>Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of
|
|
2605
2604
|
* identities. For information about using a custom MAIL FROM domain, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer
|
|
2606
2605
|
* Guide</a>.</p>
|
|
2606
|
+
* @public
|
|
2607
2607
|
*/
|
|
2608
2608
|
export interface GetIdentityMailFromDomainAttributesRequest {
|
|
2609
2609
|
/**
|
|
2610
|
-
* @public
|
|
2611
2610
|
* <p>A list of one or more identities.</p>
|
|
2611
|
+
* @public
|
|
2612
2612
|
*/
|
|
2613
2613
|
Identities: string[] | undefined;
|
|
2614
2614
|
}
|
|
2615
2615
|
/**
|
|
2616
|
-
* @public
|
|
2617
2616
|
* <p>Represents the custom MAIL FROM domain attributes of a verified identity (email
|
|
2618
2617
|
* address or domain).</p>
|
|
2618
|
+
* @public
|
|
2619
2619
|
*/
|
|
2620
2620
|
export interface IdentityMailFromDomainAttributes {
|
|
2621
2621
|
/**
|
|
2622
|
-
* @public
|
|
2623
2622
|
* <p>The custom MAIL FROM domain that the identity is configured to use.</p>
|
|
2623
|
+
* @public
|
|
2624
2624
|
*/
|
|
2625
2625
|
MailFromDomain: string | undefined;
|
|
2626
2626
|
/**
|
|
2627
|
-
* @public
|
|
2628
2627
|
* <p>The state that indicates whether Amazon SES has successfully read the MX record required
|
|
2629
2628
|
* for custom MAIL FROM domain setup. If the state is <code>Success</code>, Amazon SES uses the
|
|
2630
2629
|
* specified custom MAIL FROM domain when the verified identity sends an email. All other
|
|
2631
2630
|
* states indicate that Amazon SES takes the action described by
|
|
2632
2631
|
* <code>BehaviorOnMXFailure</code>.</p>
|
|
2632
|
+
* @public
|
|
2633
2633
|
*/
|
|
2634
2634
|
MailFromDomainStatus: CustomMailFromStatus | undefined;
|
|
2635
2635
|
/**
|
|
2636
|
-
* @public
|
|
2637
2636
|
* <p>The action that Amazon SES takes if it cannot successfully read the required MX record when
|
|
2638
2637
|
* you send an email. A value of <code>UseDefaultValue</code> indicates that if Amazon SES
|
|
2639
2638
|
* cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as
|
|
@@ -2642,253 +2641,254 @@ export interface IdentityMailFromDomainAttributes {
|
|
|
2642
2641
|
* <code>MailFromDomainNotVerified</code> error and does not send the email.</p>
|
|
2643
2642
|
* <p>The custom MAIL FROM setup states that result in this behavior are
|
|
2644
2643
|
* <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code>.</p>
|
|
2644
|
+
* @public
|
|
2645
2645
|
*/
|
|
2646
2646
|
BehaviorOnMXFailure: BehaviorOnMXFailure | undefined;
|
|
2647
2647
|
}
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>Represents the custom MAIL FROM attributes for a list of identities.</p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
export interface GetIdentityMailFromDomainAttributesResponse {
|
|
2653
2653
|
/**
|
|
2654
|
-
* @public
|
|
2655
2654
|
* <p>A map of identities to custom MAIL FROM attributes.</p>
|
|
2655
|
+
* @public
|
|
2656
2656
|
*/
|
|
2657
2657
|
MailFromDomainAttributes: Record<string, IdentityMailFromDomainAttributes> | undefined;
|
|
2658
2658
|
}
|
|
2659
2659
|
/**
|
|
2660
|
-
* @public
|
|
2661
2660
|
* <p>Represents a request to return the notification attributes for a list of identities
|
|
2662
2661
|
* you verified with Amazon SES. For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html">Amazon SES
|
|
2663
2662
|
* Developer Guide</a>.</p>
|
|
2663
|
+
* @public
|
|
2664
2664
|
*/
|
|
2665
2665
|
export interface GetIdentityNotificationAttributesRequest {
|
|
2666
2666
|
/**
|
|
2667
|
-
* @public
|
|
2668
2667
|
* <p>A list of one or more identities. You can specify an identity by using its name or by
|
|
2669
2668
|
* using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>,
|
|
2670
2669
|
* <code>example.com</code>,
|
|
2671
2670
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
2671
|
+
* @public
|
|
2672
2672
|
*/
|
|
2673
2673
|
Identities: string[] | undefined;
|
|
2674
2674
|
}
|
|
2675
2675
|
/**
|
|
2676
|
-
* @public
|
|
2677
2676
|
* <p>Represents the notification attributes of an identity, including whether an identity
|
|
2678
2677
|
* has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications,
|
|
2679
2678
|
* and whether feedback forwarding is enabled for bounce and complaint
|
|
2680
2679
|
* notifications.</p>
|
|
2680
|
+
* @public
|
|
2681
2681
|
*/
|
|
2682
2682
|
export interface IdentityNotificationAttributes {
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce
|
|
2686
2685
|
* notifications.</p>
|
|
2686
|
+
* @public
|
|
2687
2687
|
*/
|
|
2688
2688
|
BounceTopic: string | undefined;
|
|
2689
2689
|
/**
|
|
2690
|
-
* @public
|
|
2691
2690
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint
|
|
2692
2691
|
* notifications.</p>
|
|
2692
|
+
* @public
|
|
2693
2693
|
*/
|
|
2694
2694
|
ComplaintTopic: string | undefined;
|
|
2695
2695
|
/**
|
|
2696
|
-
* @public
|
|
2697
2696
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery
|
|
2698
2697
|
* notifications.</p>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
DeliveryTopic: string | undefined;
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>Describes whether Amazon SES forwards bounce and complaint notifications as email.
|
|
2704
2703
|
* <code>true</code> indicates that Amazon SES forwards bounce and complaint notifications
|
|
2705
2704
|
* as email, while <code>false</code> indicates that bounce and complaint notifications are
|
|
2706
2705
|
* published only to the specified bounce and complaint Amazon SNS topics.</p>
|
|
2706
|
+
* @public
|
|
2707
2707
|
*/
|
|
2708
2708
|
ForwardingEnabled: boolean | undefined;
|
|
2709
2709
|
/**
|
|
2710
|
-
* @public
|
|
2711
2710
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2712
2711
|
* type <code>Bounce</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2713
2712
|
* headers in bounce notifications, and a value of <code>false</code> specifies that Amazon SES
|
|
2714
2713
|
* does not include headers in bounce notifications.</p>
|
|
2714
|
+
* @public
|
|
2715
2715
|
*/
|
|
2716
2716
|
HeadersInBounceNotificationsEnabled?: boolean;
|
|
2717
2717
|
/**
|
|
2718
|
-
* @public
|
|
2719
2718
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2720
2719
|
* type <code>Complaint</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2721
2720
|
* headers in complaint notifications, and a value of <code>false</code> specifies that
|
|
2722
2721
|
* Amazon SES does not include headers in complaint notifications.</p>
|
|
2722
|
+
* @public
|
|
2723
2723
|
*/
|
|
2724
2724
|
HeadersInComplaintNotificationsEnabled?: boolean;
|
|
2725
2725
|
/**
|
|
2726
|
-
* @public
|
|
2727
2726
|
* <p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of
|
|
2728
2727
|
* type <code>Delivery</code>. A value of <code>true</code> specifies that Amazon SES includes
|
|
2729
2728
|
* headers in delivery notifications, and a value of <code>false</code> specifies that
|
|
2730
2729
|
* Amazon SES does not include headers in delivery notifications.</p>
|
|
2730
|
+
* @public
|
|
2731
2731
|
*/
|
|
2732
2732
|
HeadersInDeliveryNotificationsEnabled?: boolean;
|
|
2733
2733
|
}
|
|
2734
2734
|
/**
|
|
2735
|
-
* @public
|
|
2736
2735
|
* <p>Represents the notification attributes for a list of identities.</p>
|
|
2736
|
+
* @public
|
|
2737
2737
|
*/
|
|
2738
2738
|
export interface GetIdentityNotificationAttributesResponse {
|
|
2739
2739
|
/**
|
|
2740
|
-
* @public
|
|
2741
2740
|
* <p>A map of Identity to IdentityNotificationAttributes.</p>
|
|
2741
|
+
* @public
|
|
2742
2742
|
*/
|
|
2743
2743
|
NotificationAttributes: Record<string, IdentityNotificationAttributes> | undefined;
|
|
2744
2744
|
}
|
|
2745
2745
|
/**
|
|
2746
|
-
* @public
|
|
2747
2746
|
* <p>Represents a request to return the requested sending authorization policies for an
|
|
2748
2747
|
* identity. Sending authorization is an Amazon SES feature that enables you to authorize other
|
|
2749
2748
|
* senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
2749
|
+
* @public
|
|
2750
2750
|
*/
|
|
2751
2751
|
export interface GetIdentityPoliciesRequest {
|
|
2752
2752
|
/**
|
|
2753
|
-
* @public
|
|
2754
2753
|
* <p>The identity for which the policies are retrieved. You can specify an identity by
|
|
2755
2754
|
* using its name or by using its Amazon Resource Name (ARN). Examples:
|
|
2756
2755
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
2757
2756
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
2758
2757
|
* <p>To successfully call this operation, you must own the identity.</p>
|
|
2758
|
+
* @public
|
|
2759
2759
|
*/
|
|
2760
2760
|
Identity: string | undefined;
|
|
2761
2761
|
/**
|
|
2762
|
-
* @public
|
|
2763
2762
|
* <p>A list of the names of policies to be retrieved. You can retrieve a maximum of 20
|
|
2764
2763
|
* policies at a time. If you do not know the names of the policies that are attached to
|
|
2765
2764
|
* the identity, you can use <code>ListIdentityPolicies</code>.</p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
PolicyNames: string[] | undefined;
|
|
2768
2768
|
}
|
|
2769
2769
|
/**
|
|
2770
|
-
* @public
|
|
2771
2770
|
* <p>Represents the requested sending authorization policies.</p>
|
|
2771
|
+
* @public
|
|
2772
2772
|
*/
|
|
2773
2773
|
export interface GetIdentityPoliciesResponse {
|
|
2774
2774
|
/**
|
|
2775
|
-
* @public
|
|
2776
2775
|
* <p>A map of policy names to policies.</p>
|
|
2776
|
+
* @public
|
|
2777
2777
|
*/
|
|
2778
2778
|
Policies: Record<string, string> | undefined;
|
|
2779
2779
|
}
|
|
2780
2780
|
/**
|
|
2781
|
-
* @public
|
|
2782
2781
|
* <p>Represents a request to return the Amazon SES verification status of a list of identities.
|
|
2783
2782
|
* For domain identities, this request also returns the verification token. For information
|
|
2784
2783
|
* about verifying identities with Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
2784
|
+
* @public
|
|
2785
2785
|
*/
|
|
2786
2786
|
export interface GetIdentityVerificationAttributesRequest {
|
|
2787
2787
|
/**
|
|
2788
|
-
* @public
|
|
2789
2788
|
* <p>A list of identities.</p>
|
|
2789
|
+
* @public
|
|
2790
2790
|
*/
|
|
2791
2791
|
Identities: string[] | undefined;
|
|
2792
2792
|
}
|
|
2793
2793
|
/**
|
|
2794
|
-
* @public
|
|
2795
2794
|
* <p>Represents the verification attributes of a single identity.</p>
|
|
2795
|
+
* @public
|
|
2796
2796
|
*/
|
|
2797
2797
|
export interface IdentityVerificationAttributes {
|
|
2798
2798
|
/**
|
|
2799
|
-
* @public
|
|
2800
2799
|
* <p>The verification status of the identity: "Pending", "Success", "Failed", or
|
|
2801
2800
|
* "TemporaryFailure".</p>
|
|
2801
|
+
* @public
|
|
2802
2802
|
*/
|
|
2803
2803
|
VerificationStatus: VerificationStatus | undefined;
|
|
2804
2804
|
/**
|
|
2805
|
-
* @public
|
|
2806
2805
|
* <p>The verification token for a domain identity. Null for email address
|
|
2807
2806
|
* identities.</p>
|
|
2807
|
+
* @public
|
|
2808
2808
|
*/
|
|
2809
2809
|
VerificationToken?: string;
|
|
2810
2810
|
}
|
|
2811
2811
|
/**
|
|
2812
|
-
* @public
|
|
2813
2812
|
* <p>The Amazon SES verification status of a list of identities. For domain identities, this
|
|
2814
2813
|
* response also contains the verification token.</p>
|
|
2814
|
+
* @public
|
|
2815
2815
|
*/
|
|
2816
2816
|
export interface GetIdentityVerificationAttributesResponse {
|
|
2817
2817
|
/**
|
|
2818
|
-
* @public
|
|
2819
2818
|
* <p>A map of Identities to IdentityVerificationAttributes objects.</p>
|
|
2819
|
+
* @public
|
|
2820
2820
|
*/
|
|
2821
2821
|
VerificationAttributes: Record<string, IdentityVerificationAttributes> | undefined;
|
|
2822
2822
|
}
|
|
2823
2823
|
/**
|
|
2824
|
-
* @public
|
|
2825
2824
|
* <p>Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails
|
|
2826
2825
|
* you have sent in the last 24 hours.</p>
|
|
2826
|
+
* @public
|
|
2827
2827
|
*/
|
|
2828
2828
|
export interface GetSendQuotaResponse {
|
|
2829
2829
|
/**
|
|
2830
|
-
* @public
|
|
2831
2830
|
* <p>The maximum number of emails the user is allowed to send in a 24-hour interval. A
|
|
2832
2831
|
* value of -1 signifies an unlimited quota.</p>
|
|
2832
|
+
* @public
|
|
2833
2833
|
*/
|
|
2834
2834
|
Max24HourSend?: number;
|
|
2835
2835
|
/**
|
|
2836
|
-
* @public
|
|
2837
2836
|
* <p>The maximum number of emails that Amazon SES can accept from the user's account per
|
|
2838
2837
|
* second.</p>
|
|
2839
2838
|
* <note>
|
|
2840
2839
|
* <p>The rate at which Amazon SES accepts the user's messages might be less than the maximum
|
|
2841
2840
|
* send rate.</p>
|
|
2842
2841
|
* </note>
|
|
2842
|
+
* @public
|
|
2843
2843
|
*/
|
|
2844
2844
|
MaxSendRate?: number;
|
|
2845
2845
|
/**
|
|
2846
|
-
* @public
|
|
2847
2846
|
* <p>The number of emails sent during the previous 24 hours.</p>
|
|
2847
|
+
* @public
|
|
2848
2848
|
*/
|
|
2849
2849
|
SentLast24Hours?: number;
|
|
2850
2850
|
}
|
|
2851
2851
|
/**
|
|
2852
|
-
* @public
|
|
2853
2852
|
* <p>Represents sending statistics data. Each <code>SendDataPoint</code> contains
|
|
2854
2853
|
* statistics for a 15-minute period of sending activity. </p>
|
|
2854
|
+
* @public
|
|
2855
2855
|
*/
|
|
2856
2856
|
export interface SendDataPoint {
|
|
2857
2857
|
/**
|
|
2858
|
-
* @public
|
|
2859
2858
|
* <p>Time of the data point.</p>
|
|
2859
|
+
* @public
|
|
2860
2860
|
*/
|
|
2861
2861
|
Timestamp?: Date;
|
|
2862
2862
|
/**
|
|
2863
|
-
* @public
|
|
2864
2863
|
* <p>Number of emails that have been sent.</p>
|
|
2864
|
+
* @public
|
|
2865
2865
|
*/
|
|
2866
2866
|
DeliveryAttempts?: number;
|
|
2867
2867
|
/**
|
|
2868
|
-
* @public
|
|
2869
2868
|
* <p>Number of emails that have bounced.</p>
|
|
2869
|
+
* @public
|
|
2870
2870
|
*/
|
|
2871
2871
|
Bounces?: number;
|
|
2872
2872
|
/**
|
|
2873
|
-
* @public
|
|
2874
2873
|
* <p>Number of unwanted emails that were rejected by recipients.</p>
|
|
2874
|
+
* @public
|
|
2875
2875
|
*/
|
|
2876
2876
|
Complaints?: number;
|
|
2877
2877
|
/**
|
|
2878
|
-
* @public
|
|
2879
2878
|
* <p>Number of emails rejected by Amazon SES.</p>
|
|
2879
|
+
* @public
|
|
2880
2880
|
*/
|
|
2881
2881
|
Rejects?: number;
|
|
2882
2882
|
}
|
|
2883
2883
|
/**
|
|
2884
|
-
* @public
|
|
2885
2884
|
* <p>Represents a list of data points. This list contains aggregated data from the previous
|
|
2886
2885
|
* two weeks of your sending activity with Amazon SES.</p>
|
|
2886
|
+
* @public
|
|
2887
2887
|
*/
|
|
2888
2888
|
export interface GetSendStatisticsResponse {
|
|
2889
2889
|
/**
|
|
2890
|
-
* @public
|
|
2891
2890
|
* <p>A list of data points, each of which represents 15 minutes of activity.</p>
|
|
2891
|
+
* @public
|
|
2892
2892
|
*/
|
|
2893
2893
|
SendDataPoints?: SendDataPoint[];
|
|
2894
2894
|
}
|
|
@@ -2897,8 +2897,8 @@ export interface GetSendStatisticsResponse {
|
|
|
2897
2897
|
*/
|
|
2898
2898
|
export interface GetTemplateRequest {
|
|
2899
2899
|
/**
|
|
2900
|
-
* @public
|
|
2901
2900
|
* <p>The name of the template to retrieve.</p>
|
|
2901
|
+
* @public
|
|
2902
2902
|
*/
|
|
2903
2903
|
TemplateName: string | undefined;
|
|
2904
2904
|
}
|
|
@@ -2907,16 +2907,16 @@ export interface GetTemplateRequest {
|
|
|
2907
2907
|
*/
|
|
2908
2908
|
export interface GetTemplateResponse {
|
|
2909
2909
|
/**
|
|
2910
|
-
* @public
|
|
2911
2910
|
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
2912
2911
|
* text-only part.</p>
|
|
2912
|
+
* @public
|
|
2913
2913
|
*/
|
|
2914
2914
|
Template?: Template;
|
|
2915
2915
|
}
|
|
2916
2916
|
/**
|
|
2917
|
-
* @public
|
|
2918
2917
|
* <p>Indicates that the Template object you specified does not exist in your Amazon SES
|
|
2919
2918
|
* account.</p>
|
|
2919
|
+
* @public
|
|
2920
2920
|
*/
|
|
2921
2921
|
export declare class TemplateDoesNotExistException extends __BaseException {
|
|
2922
2922
|
readonly name: "TemplateDoesNotExistException";
|
|
@@ -2940,8 +2940,8 @@ export declare const IdentityType: {
|
|
|
2940
2940
|
*/
|
|
2941
2941
|
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
2942
2942
|
/**
|
|
2943
|
-
* @public
|
|
2944
2943
|
* <p>Indicates that provided delivery option is invalid.</p>
|
|
2944
|
+
* @public
|
|
2945
2945
|
*/
|
|
2946
2946
|
export declare class InvalidDeliveryOptionsException extends __BaseException {
|
|
2947
2947
|
readonly name: "InvalidDeliveryOptionsException";
|
|
@@ -2952,9 +2952,9 @@ export declare class InvalidDeliveryOptionsException extends __BaseException {
|
|
|
2952
2952
|
constructor(opts: __ExceptionOptionType<InvalidDeliveryOptionsException, __BaseException>);
|
|
2953
2953
|
}
|
|
2954
2954
|
/**
|
|
2955
|
-
* @public
|
|
2956
2955
|
* <p>Indicates that the provided policy is invalid. Check the error stack for more
|
|
2957
2956
|
* information about what caused the error.</p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
export declare class InvalidPolicyException extends __BaseException {
|
|
2960
2960
|
readonly name: "InvalidPolicyException";
|
|
@@ -2965,9 +2965,9 @@ export declare class InvalidPolicyException extends __BaseException {
|
|
|
2965
2965
|
constructor(opts: __ExceptionOptionType<InvalidPolicyException, __BaseException>);
|
|
2966
2966
|
}
|
|
2967
2967
|
/**
|
|
2968
|
-
* @public
|
|
2969
2968
|
* <p>Indicates that one or more of the replacement values you provided is invalid. This
|
|
2970
2969
|
* error may occur when the TemplateData object contains invalid JSON.</p>
|
|
2970
|
+
* @public
|
|
2971
2971
|
*/
|
|
2972
2972
|
export declare class InvalidRenderingParameterException extends __BaseException {
|
|
2973
2973
|
readonly name: "InvalidRenderingParameterException";
|
|
@@ -2979,212 +2979,212 @@ export declare class InvalidRenderingParameterException extends __BaseException
|
|
|
2979
2979
|
constructor(opts: __ExceptionOptionType<InvalidRenderingParameterException, __BaseException>);
|
|
2980
2980
|
}
|
|
2981
2981
|
/**
|
|
2982
|
-
* @public
|
|
2983
2982
|
* <p>Represents a request to list the configuration sets associated with your
|
|
2984
2983
|
* Amazon Web Services account. Configuration sets enable you to publish email sending events. For
|
|
2985
2984
|
* information about using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
2986
2985
|
* Guide</a>.</p>
|
|
2986
|
+
* @public
|
|
2987
2987
|
*/
|
|
2988
2988
|
export interface ListConfigurationSetsRequest {
|
|
2989
2989
|
/**
|
|
2990
|
-
* @public
|
|
2991
2990
|
* <p>A token returned from a previous call to <code>ListConfigurationSets</code> to
|
|
2992
2991
|
* indicate the position of the configuration set in the configuration set list.</p>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
NextToken?: string;
|
|
2995
2995
|
/**
|
|
2996
|
-
* @public
|
|
2997
2996
|
* <p>The number of configuration sets to return.</p>
|
|
2997
|
+
* @public
|
|
2998
2998
|
*/
|
|
2999
2999
|
MaxItems?: number;
|
|
3000
3000
|
}
|
|
3001
3001
|
/**
|
|
3002
|
-
* @public
|
|
3003
3002
|
* <p>A list of configuration sets associated with your Amazon Web Services account. Configuration sets
|
|
3004
3003
|
* enable you to publish email sending events. For information about using configuration
|
|
3005
3004
|
* sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
3006
3005
|
* Guide</a>.</p>
|
|
3006
|
+
* @public
|
|
3007
3007
|
*/
|
|
3008
3008
|
export interface ListConfigurationSetsResponse {
|
|
3009
3009
|
/**
|
|
3010
|
-
* @public
|
|
3011
3010
|
* <p>A list of configuration sets.</p>
|
|
3011
|
+
* @public
|
|
3012
3012
|
*/
|
|
3013
3013
|
ConfigurationSets?: ConfigurationSet[];
|
|
3014
3014
|
/**
|
|
3015
|
-
* @public
|
|
3016
3015
|
* <p>A token indicating that there are additional configuration sets available to be
|
|
3017
3016
|
* listed. Pass this token to successive calls of <code>ListConfigurationSets</code>.
|
|
3018
3017
|
* </p>
|
|
3018
|
+
* @public
|
|
3019
3019
|
*/
|
|
3020
3020
|
NextToken?: string;
|
|
3021
3021
|
}
|
|
3022
3022
|
/**
|
|
3023
|
-
* @public
|
|
3024
3023
|
* <p>Represents a request to list the existing custom verification email templates for your
|
|
3025
3024
|
* account.</p>
|
|
3026
3025
|
* <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
|
|
3027
3026
|
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
3028
3027
|
* Guide</i>.</p>
|
|
3028
|
+
* @public
|
|
3029
3029
|
*/
|
|
3030
3030
|
export interface ListCustomVerificationEmailTemplatesRequest {
|
|
3031
3031
|
/**
|
|
3032
|
-
* @public
|
|
3033
3032
|
* <p>An array the contains the name and creation time stamp for each template in your Amazon SES
|
|
3034
3033
|
* account.</p>
|
|
3034
|
+
* @public
|
|
3035
3035
|
*/
|
|
3036
3036
|
NextToken?: string;
|
|
3037
3037
|
/**
|
|
3038
|
-
* @public
|
|
3039
3038
|
* <p>The maximum number of custom verification email templates to return. This value must
|
|
3040
3039
|
* be at least 1 and less than or equal to 50. If you do not specify a value, or if you
|
|
3041
3040
|
* specify a value less than 1 or greater than 50, the operation returns up to 50
|
|
3042
3041
|
* results.</p>
|
|
3042
|
+
* @public
|
|
3043
3043
|
*/
|
|
3044
3044
|
MaxResults?: number;
|
|
3045
3045
|
}
|
|
3046
3046
|
/**
|
|
3047
|
-
* @public
|
|
3048
3047
|
* <p>A paginated list of custom verification email templates.</p>
|
|
3048
|
+
* @public
|
|
3049
3049
|
*/
|
|
3050
3050
|
export interface ListCustomVerificationEmailTemplatesResponse {
|
|
3051
3051
|
/**
|
|
3052
|
-
* @public
|
|
3053
3052
|
* <p>A list of the custom verification email templates that exist in your account.</p>
|
|
3053
|
+
* @public
|
|
3054
3054
|
*/
|
|
3055
3055
|
CustomVerificationEmailTemplates?: CustomVerificationEmailTemplate[];
|
|
3056
3056
|
/**
|
|
3057
|
-
* @public
|
|
3058
3057
|
* <p>A token indicating that there are additional custom verification email templates
|
|
3059
3058
|
* available to be listed. Pass this token to a subsequent call to
|
|
3060
3059
|
* <code>ListTemplates</code> to retrieve the next 50 custom verification email
|
|
3061
3060
|
* templates.</p>
|
|
3061
|
+
* @public
|
|
3062
3062
|
*/
|
|
3063
3063
|
NextToken?: string;
|
|
3064
3064
|
}
|
|
3065
3065
|
/**
|
|
3066
|
-
* @public
|
|
3067
3066
|
* <p>Represents a request to return a list of all identities (email addresses and domains)
|
|
3068
3067
|
* that you have attempted to verify under your Amazon Web Services account, regardless of verification
|
|
3069
3068
|
* status.</p>
|
|
3069
|
+
* @public
|
|
3070
3070
|
*/
|
|
3071
3071
|
export interface ListIdentitiesRequest {
|
|
3072
3072
|
/**
|
|
3073
|
-
* @public
|
|
3074
3073
|
* <p>The type of the identities to list. Possible values are "EmailAddress" and "Domain".
|
|
3075
3074
|
* If this parameter is omitted, then all identities are listed.</p>
|
|
3075
|
+
* @public
|
|
3076
3076
|
*/
|
|
3077
3077
|
IdentityType?: IdentityType;
|
|
3078
3078
|
/**
|
|
3079
|
-
* @public
|
|
3080
3079
|
* <p>The token to use for pagination.</p>
|
|
3080
|
+
* @public
|
|
3081
3081
|
*/
|
|
3082
3082
|
NextToken?: string;
|
|
3083
3083
|
/**
|
|
3084
|
-
* @public
|
|
3085
3084
|
* <p>The maximum number of identities per page. Possible values are 1-1000
|
|
3086
3085
|
* inclusive.</p>
|
|
3086
|
+
* @public
|
|
3087
3087
|
*/
|
|
3088
3088
|
MaxItems?: number;
|
|
3089
3089
|
}
|
|
3090
3090
|
/**
|
|
3091
|
-
* @public
|
|
3092
3091
|
* <p>A list of all identities that you have attempted to verify under your Amazon Web Services account,
|
|
3093
3092
|
* regardless of verification status.</p>
|
|
3093
|
+
* @public
|
|
3094
3094
|
*/
|
|
3095
3095
|
export interface ListIdentitiesResponse {
|
|
3096
3096
|
/**
|
|
3097
|
-
* @public
|
|
3098
3097
|
* <p>A list of identities.</p>
|
|
3098
|
+
* @public
|
|
3099
3099
|
*/
|
|
3100
3100
|
Identities: string[] | undefined;
|
|
3101
3101
|
/**
|
|
3102
|
-
* @public
|
|
3103
3102
|
* <p>The token used for pagination.</p>
|
|
3103
|
+
* @public
|
|
3104
3104
|
*/
|
|
3105
3105
|
NextToken?: string;
|
|
3106
3106
|
}
|
|
3107
3107
|
/**
|
|
3108
|
-
* @public
|
|
3109
3108
|
* <p>Represents a request to return a list of sending authorization policies that are
|
|
3110
3109
|
* attached to an identity. Sending authorization is an Amazon SES feature that enables you to
|
|
3111
3110
|
* authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer
|
|
3112
3111
|
* Guide</a>.</p>
|
|
3112
|
+
* @public
|
|
3113
3113
|
*/
|
|
3114
3114
|
export interface ListIdentityPoliciesRequest {
|
|
3115
3115
|
/**
|
|
3116
|
-
* @public
|
|
3117
3116
|
* <p>The identity that is associated with the policy for which the policies are listed. You
|
|
3118
3117
|
* can specify an identity by using its name or by using its Amazon Resource Name (ARN).
|
|
3119
3118
|
* Examples: <code>user@example.com</code>, <code>example.com</code>,
|
|
3120
3119
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
3121
3120
|
* <p>To successfully call this operation, you must own the identity.</p>
|
|
3121
|
+
* @public
|
|
3122
3122
|
*/
|
|
3123
3123
|
Identity: string | undefined;
|
|
3124
3124
|
}
|
|
3125
3125
|
/**
|
|
3126
|
-
* @public
|
|
3127
3126
|
* <p>A list of names of sending authorization policies that apply to an identity.</p>
|
|
3127
|
+
* @public
|
|
3128
3128
|
*/
|
|
3129
3129
|
export interface ListIdentityPoliciesResponse {
|
|
3130
3130
|
/**
|
|
3131
|
-
* @public
|
|
3132
3131
|
* <p>A list of names of policies that apply to the specified identity.</p>
|
|
3132
|
+
* @public
|
|
3133
3133
|
*/
|
|
3134
3134
|
PolicyNames: string[] | undefined;
|
|
3135
3135
|
}
|
|
3136
3136
|
/**
|
|
3137
|
-
* @public
|
|
3138
3137
|
* <p>Represents a request to list the IP address filters that exist under your
|
|
3139
3138
|
* Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more
|
|
3140
3139
|
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
3141
3140
|
* Guide</a>.</p>
|
|
3141
|
+
* @public
|
|
3142
3142
|
*/
|
|
3143
3143
|
export interface ListReceiptFiltersRequest {
|
|
3144
3144
|
}
|
|
3145
3145
|
/**
|
|
3146
|
-
* @public
|
|
3147
3146
|
* <p>A list of IP address filters that exist under your Amazon Web Services account.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
export interface ListReceiptFiltersResponse {
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>A list of IP address filter data structures, which each consist of a name, an IP
|
|
3153
3152
|
* address range, and whether to allow or block mail from it.</p>
|
|
3153
|
+
* @public
|
|
3154
3154
|
*/
|
|
3155
3155
|
Filters?: ReceiptFilter[];
|
|
3156
3156
|
}
|
|
3157
3157
|
/**
|
|
3158
|
-
* @public
|
|
3159
3158
|
* <p>Represents a request to list the receipt rule sets that exist under your
|
|
3160
3159
|
* Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more
|
|
3161
3160
|
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
3162
3161
|
* Guide</a>.</p>
|
|
3162
|
+
* @public
|
|
3163
3163
|
*/
|
|
3164
3164
|
export interface ListReceiptRuleSetsRequest {
|
|
3165
3165
|
/**
|
|
3166
|
-
* @public
|
|
3167
3166
|
* <p>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate
|
|
3168
3167
|
* the position in the receipt rule set list.</p>
|
|
3168
|
+
* @public
|
|
3169
3169
|
*/
|
|
3170
3170
|
NextToken?: string;
|
|
3171
3171
|
}
|
|
3172
3172
|
/**
|
|
3173
|
-
* @public
|
|
3174
3173
|
* <p>A list of receipt rule sets that exist under your Amazon Web Services account.</p>
|
|
3174
|
+
* @public
|
|
3175
3175
|
*/
|
|
3176
3176
|
export interface ListReceiptRuleSetsResponse {
|
|
3177
3177
|
/**
|
|
3178
|
-
* @public
|
|
3179
3178
|
* <p>The metadata for the currently active receipt rule set. The metadata consists of the
|
|
3180
3179
|
* rule set name and the timestamp of when the rule set was created.</p>
|
|
3180
|
+
* @public
|
|
3181
3181
|
*/
|
|
3182
3182
|
RuleSets?: ReceiptRuleSetMetadata[];
|
|
3183
3183
|
/**
|
|
3184
|
-
* @public
|
|
3185
3184
|
* <p>A token indicating that there are additional receipt rule sets available to be listed.
|
|
3186
3185
|
* Pass this token to successive calls of <code>ListReceiptRuleSets</code> to retrieve up
|
|
3187
3186
|
* to 100 receipt rule sets at a time.</p>
|
|
3187
|
+
* @public
|
|
3188
3188
|
*/
|
|
3189
3189
|
NextToken?: string;
|
|
3190
3190
|
}
|
|
@@ -3193,32 +3193,32 @@ export interface ListReceiptRuleSetsResponse {
|
|
|
3193
3193
|
*/
|
|
3194
3194
|
export interface ListTemplatesRequest {
|
|
3195
3195
|
/**
|
|
3196
|
-
* @public
|
|
3197
3196
|
* <p>A token returned from a previous call to <code>ListTemplates</code> to indicate the
|
|
3198
3197
|
* position in the list of email templates.</p>
|
|
3198
|
+
* @public
|
|
3199
3199
|
*/
|
|
3200
3200
|
NextToken?: string;
|
|
3201
3201
|
/**
|
|
3202
|
-
* @public
|
|
3203
3202
|
* <p>The maximum number of templates to return. This value must be at least 1 and less than
|
|
3204
3203
|
* or equal to 100. If more than 100 items are requested, the page size will automatically
|
|
3205
3204
|
* set to 100. If you do not specify a value, 10 is the default page size. </p>
|
|
3205
|
+
* @public
|
|
3206
3206
|
*/
|
|
3207
3207
|
MaxItems?: number;
|
|
3208
3208
|
}
|
|
3209
3209
|
/**
|
|
3210
|
-
* @public
|
|
3211
3210
|
* <p>Contains information about an email template.</p>
|
|
3211
|
+
* @public
|
|
3212
3212
|
*/
|
|
3213
3213
|
export interface TemplateMetadata {
|
|
3214
3214
|
/**
|
|
3215
|
-
* @public
|
|
3216
3215
|
* <p>The name of the template.</p>
|
|
3216
|
+
* @public
|
|
3217
3217
|
*/
|
|
3218
3218
|
Name?: string;
|
|
3219
3219
|
/**
|
|
3220
|
-
* @public
|
|
3221
3220
|
* <p>The time and date the template was created.</p>
|
|
3221
|
+
* @public
|
|
3222
3222
|
*/
|
|
3223
3223
|
CreatedTimestamp?: Date;
|
|
3224
3224
|
}
|
|
@@ -3227,37 +3227,37 @@ export interface TemplateMetadata {
|
|
|
3227
3227
|
*/
|
|
3228
3228
|
export interface ListTemplatesResponse {
|
|
3229
3229
|
/**
|
|
3230
|
-
* @public
|
|
3231
3230
|
* <p>An array the contains the name and creation time stamp for each template in your Amazon SES
|
|
3232
3231
|
* account.</p>
|
|
3232
|
+
* @public
|
|
3233
3233
|
*/
|
|
3234
3234
|
TemplatesMetadata?: TemplateMetadata[];
|
|
3235
3235
|
/**
|
|
3236
|
-
* @public
|
|
3237
3236
|
* <p>A token indicating that there are additional email templates available to be listed.
|
|
3238
3237
|
* Pass this token to a subsequent call to <code>ListTemplates</code> to retrieve the next
|
|
3239
3238
|
* set of email templates within your page size.</p>
|
|
3239
|
+
* @public
|
|
3240
3240
|
*/
|
|
3241
3241
|
NextToken?: string;
|
|
3242
3242
|
}
|
|
3243
3243
|
/**
|
|
3244
|
-
* @public
|
|
3245
3244
|
* <p>A list of email addresses that you have verified with Amazon SES under your
|
|
3246
3245
|
* Amazon Web Services account.</p>
|
|
3246
|
+
* @public
|
|
3247
3247
|
*/
|
|
3248
3248
|
export interface ListVerifiedEmailAddressesResponse {
|
|
3249
3249
|
/**
|
|
3250
|
-
* @public
|
|
3251
3250
|
* <p>A list of email addresses that have been verified.</p>
|
|
3251
|
+
* @public
|
|
3252
3252
|
*/
|
|
3253
3253
|
VerifiedEmailAddresses?: string[];
|
|
3254
3254
|
}
|
|
3255
3255
|
/**
|
|
3256
|
-
* @public
|
|
3257
3256
|
* <p> Indicates that the message could not be sent because Amazon SES could not read the MX
|
|
3258
3257
|
* record required to use the specified MAIL FROM domain. For information about editing the
|
|
3259
3258
|
* custom MAIL FROM domain settings for an identity, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html">Amazon SES Developer
|
|
3260
3259
|
* Guide</a>.</p>
|
|
3260
|
+
* @public
|
|
3261
3261
|
*/
|
|
3262
3262
|
export declare class MailFromDomainNotVerifiedException extends __BaseException {
|
|
3263
3263
|
readonly name: "MailFromDomainNotVerifiedException";
|
|
@@ -3268,53 +3268,53 @@ export declare class MailFromDomainNotVerifiedException extends __BaseException
|
|
|
3268
3268
|
constructor(opts: __ExceptionOptionType<MailFromDomainNotVerifiedException, __BaseException>);
|
|
3269
3269
|
}
|
|
3270
3270
|
/**
|
|
3271
|
-
* @public
|
|
3272
3271
|
* <p>Represents the message to be sent, composed of a subject and a body.</p>
|
|
3272
|
+
* @public
|
|
3273
3273
|
*/
|
|
3274
3274
|
export interface Message {
|
|
3275
3275
|
/**
|
|
3276
|
-
* @public
|
|
3277
3276
|
* <p>The subject of the message: A short summary of the content, which appears in the
|
|
3278
3277
|
* recipient's inbox.</p>
|
|
3278
|
+
* @public
|
|
3279
3279
|
*/
|
|
3280
3280
|
Subject: Content | undefined;
|
|
3281
3281
|
/**
|
|
3282
|
-
* @public
|
|
3283
3282
|
* <p>The message body.</p>
|
|
3283
|
+
* @public
|
|
3284
3284
|
*/
|
|
3285
3285
|
Body: Body | undefined;
|
|
3286
3286
|
}
|
|
3287
3287
|
/**
|
|
3288
|
-
* @public
|
|
3289
3288
|
* <p>Message-related information to include in the Delivery Status Notification (DSN) when
|
|
3290
3289
|
* an email that Amazon SES receives on your behalf bounces.</p>
|
|
3291
3290
|
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
3292
3291
|
* Guide</a>.</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
export interface MessageDsn {
|
|
3295
3295
|
/**
|
|
3296
|
-
* @public
|
|
3297
3296
|
* <p>The reporting MTA that attempted to deliver the message, formatted as specified in
|
|
3298
3297
|
* <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a>
|
|
3299
3298
|
* (<code>mta-name-type; mta-name</code>). The default value is <code>dns;
|
|
3300
3299
|
* inbound-smtp.[region].amazonaws.com</code>.</p>
|
|
3300
|
+
* @public
|
|
3301
3301
|
*/
|
|
3302
3302
|
ReportingMta: string | undefined;
|
|
3303
3303
|
/**
|
|
3304
|
-
* @public
|
|
3305
3304
|
* <p>When the message was received by the reporting mail transfer agent (MTA), in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format.</p>
|
|
3305
|
+
* @public
|
|
3306
3306
|
*/
|
|
3307
3307
|
ArrivalDate?: Date;
|
|
3308
3308
|
/**
|
|
3309
|
-
* @public
|
|
3310
3309
|
* <p>Additional X-headers to include in the DSN.</p>
|
|
3310
|
+
* @public
|
|
3311
3311
|
*/
|
|
3312
3312
|
ExtensionFields?: ExtensionField[];
|
|
3313
3313
|
}
|
|
3314
3314
|
/**
|
|
3315
|
-
* @public
|
|
3316
3315
|
* <p>Indicates that the action failed, and the message could not be sent. Check the error
|
|
3317
3316
|
* stack for more information about what caused the error.</p>
|
|
3317
|
+
* @public
|
|
3318
3318
|
*/
|
|
3319
3319
|
export declare class MessageRejected extends __BaseException {
|
|
3320
3320
|
readonly name: "MessageRejected";
|
|
@@ -3325,10 +3325,10 @@ export declare class MessageRejected extends __BaseException {
|
|
|
3325
3325
|
constructor(opts: __ExceptionOptionType<MessageRejected, __BaseException>);
|
|
3326
3326
|
}
|
|
3327
3327
|
/**
|
|
3328
|
-
* @public
|
|
3329
3328
|
* <p>Indicates that one or more of the replacement values for the specified template was
|
|
3330
3329
|
* not specified. Ensure that the TemplateData object contains references to all of the
|
|
3331
3330
|
* replacement tags in the specified template.</p>
|
|
3331
|
+
* @public
|
|
3332
3332
|
*/
|
|
3333
3333
|
export declare class MissingRenderingAttributeException extends __BaseException {
|
|
3334
3334
|
readonly name: "MissingRenderingAttributeException";
|
|
@@ -3353,8 +3353,8 @@ export declare const NotificationType: {
|
|
|
3353
3353
|
*/
|
|
3354
3354
|
export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
|
|
3355
3355
|
/**
|
|
3356
|
-
* @public
|
|
3357
3356
|
* <p>Indicates that the account has not been granted production access.</p>
|
|
3357
|
+
* @public
|
|
3358
3358
|
*/
|
|
3359
3359
|
export declare class ProductionAccessNotGrantedException extends __BaseException {
|
|
3360
3360
|
readonly name: "ProductionAccessNotGrantedException";
|
|
@@ -3365,73 +3365,72 @@ export declare class ProductionAccessNotGrantedException extends __BaseException
|
|
|
3365
3365
|
constructor(opts: __ExceptionOptionType<ProductionAccessNotGrantedException, __BaseException>);
|
|
3366
3366
|
}
|
|
3367
3367
|
/**
|
|
3368
|
-
* @public
|
|
3369
3368
|
* <p>A request to modify the delivery options for a configuration set.</p>
|
|
3369
|
+
* @public
|
|
3370
3370
|
*/
|
|
3371
3371
|
export interface PutConfigurationSetDeliveryOptionsRequest {
|
|
3372
3372
|
/**
|
|
3373
|
-
* @public
|
|
3374
3373
|
* <p>The name of the configuration set.</p>
|
|
3374
|
+
* @public
|
|
3375
3375
|
*/
|
|
3376
3376
|
ConfigurationSetName: string | undefined;
|
|
3377
3377
|
/**
|
|
3378
|
-
* @public
|
|
3379
3378
|
* <p>Specifies whether messages that use the configuration set are required to use
|
|
3380
3379
|
* Transport Layer Security (TLS).</p>
|
|
3380
|
+
* @public
|
|
3381
3381
|
*/
|
|
3382
3382
|
DeliveryOptions?: DeliveryOptions;
|
|
3383
3383
|
}
|
|
3384
3384
|
/**
|
|
3385
|
-
* @public
|
|
3386
3385
|
* <p>An HTTP 200 response if the request succeeds, or an error message if the request
|
|
3387
3386
|
* fails.</p>
|
|
3387
|
+
* @public
|
|
3388
3388
|
*/
|
|
3389
3389
|
export interface PutConfigurationSetDeliveryOptionsResponse {
|
|
3390
3390
|
}
|
|
3391
3391
|
/**
|
|
3392
|
-
* @public
|
|
3393
3392
|
* <p>Represents a request to add or update a sending authorization policy for an identity.
|
|
3394
3393
|
* Sending authorization is an Amazon SES feature that enables you to authorize other senders to
|
|
3395
3394
|
* use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3395
|
+
* @public
|
|
3396
3396
|
*/
|
|
3397
3397
|
export interface PutIdentityPolicyRequest {
|
|
3398
3398
|
/**
|
|
3399
|
-
* @public
|
|
3400
3399
|
* <p>The identity to which that the policy applies. You can specify an identity by using
|
|
3401
3400
|
* its name or by using its Amazon Resource Name (ARN). Examples:
|
|
3402
3401
|
* <code>user@example.com</code>, <code>example.com</code>,
|
|
3403
3402
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
3404
3403
|
* <p>To successfully call this operation, you must own the identity.</p>
|
|
3404
|
+
* @public
|
|
3405
3405
|
*/
|
|
3406
3406
|
Identity: string | undefined;
|
|
3407
3407
|
/**
|
|
3408
|
-
* @public
|
|
3409
3408
|
* <p>The name of the policy.</p>
|
|
3410
3409
|
* <p>The policy name cannot exceed 64 characters and can only include alphanumeric
|
|
3411
3410
|
* characters, dashes, and underscores.</p>
|
|
3411
|
+
* @public
|
|
3412
3412
|
*/
|
|
3413
3413
|
PolicyName: string | undefined;
|
|
3414
3414
|
/**
|
|
3415
|
-
* @public
|
|
3416
3415
|
* <p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p>
|
|
3417
3416
|
* <p>For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html">Amazon SES
|
|
3418
3417
|
* Developer Guide</a>. </p>
|
|
3418
|
+
* @public
|
|
3419
3419
|
*/
|
|
3420
3420
|
Policy: string | undefined;
|
|
3421
3421
|
}
|
|
3422
3422
|
/**
|
|
3423
|
-
* @public
|
|
3424
3423
|
* <p>An empty element returned on a successful request.</p>
|
|
3424
|
+
* @public
|
|
3425
3425
|
*/
|
|
3426
3426
|
export interface PutIdentityPolicyResponse {
|
|
3427
3427
|
}
|
|
3428
3428
|
/**
|
|
3429
|
-
* @public
|
|
3430
3429
|
* <p>Represents the raw data of the message.</p>
|
|
3430
|
+
* @public
|
|
3431
3431
|
*/
|
|
3432
3432
|
export interface RawMessage {
|
|
3433
3433
|
/**
|
|
3434
|
-
* @public
|
|
3435
3434
|
* <p>The raw data of the message. This data needs to base64-encoded if you are accessing
|
|
3436
3435
|
* Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services
|
|
3437
3436
|
* SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must
|
|
@@ -3446,97 +3445,97 @@ export interface RawMessage {
|
|
|
3446
3445
|
* Amazon SES before sending the email.</p>
|
|
3447
3446
|
* </important>
|
|
3448
3447
|
* <p>For more information, go to the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Amazon SES Developer Guide</a>.</p>
|
|
3448
|
+
* @public
|
|
3449
3449
|
*/
|
|
3450
3450
|
Data: Uint8Array | undefined;
|
|
3451
3451
|
}
|
|
3452
3452
|
/**
|
|
3453
|
-
* @public
|
|
3454
3453
|
* <p>Represents a request to reorder the receipt rules within a receipt rule set. You use
|
|
3455
3454
|
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
3456
3455
|
* Developer Guide</a>.</p>
|
|
3456
|
+
* @public
|
|
3457
3457
|
*/
|
|
3458
3458
|
export interface ReorderReceiptRuleSetRequest {
|
|
3459
3459
|
/**
|
|
3460
|
-
* @public
|
|
3461
3460
|
* <p>The name of the receipt rule set to reorder.</p>
|
|
3461
|
+
* @public
|
|
3462
3462
|
*/
|
|
3463
3463
|
RuleSetName: string | undefined;
|
|
3464
3464
|
/**
|
|
3465
|
-
* @public
|
|
3466
3465
|
* <p>The specified receipt rule set's receipt rules, in order.</p>
|
|
3466
|
+
* @public
|
|
3467
3467
|
*/
|
|
3468
3468
|
RuleNames: string[] | undefined;
|
|
3469
3469
|
}
|
|
3470
3470
|
/**
|
|
3471
|
-
* @public
|
|
3472
3471
|
* <p>An empty element returned on a successful request.</p>
|
|
3472
|
+
* @public
|
|
3473
3473
|
*/
|
|
3474
3474
|
export interface ReorderReceiptRuleSetResponse {
|
|
3475
3475
|
}
|
|
3476
3476
|
/**
|
|
3477
|
-
* @public
|
|
3478
3477
|
* <p>Represents a request to send a bounce message to the sender of an email you received
|
|
3479
3478
|
* through Amazon SES.</p>
|
|
3479
|
+
* @public
|
|
3480
3480
|
*/
|
|
3481
3481
|
export interface SendBounceRequest {
|
|
3482
3482
|
/**
|
|
3483
|
-
* @public
|
|
3484
3483
|
* <p>The message ID of the message to be bounced.</p>
|
|
3484
|
+
* @public
|
|
3485
3485
|
*/
|
|
3486
3486
|
OriginalMessageId: string | undefined;
|
|
3487
3487
|
/**
|
|
3488
|
-
* @public
|
|
3489
3488
|
* <p>The address to use in the "From" header of the bounce message. This must be an
|
|
3490
3489
|
* identity that you have verified with Amazon SES.</p>
|
|
3490
|
+
* @public
|
|
3491
3491
|
*/
|
|
3492
3492
|
BounceSender: string | undefined;
|
|
3493
3493
|
/**
|
|
3494
|
-
* @public
|
|
3495
3494
|
* <p>Human-readable text for the bounce message to explain the failure. If not specified,
|
|
3496
3495
|
* the text is auto-generated based on the bounced recipient information.</p>
|
|
3496
|
+
* @public
|
|
3497
3497
|
*/
|
|
3498
3498
|
Explanation?: string;
|
|
3499
3499
|
/**
|
|
3500
|
-
* @public
|
|
3501
3500
|
* <p>Message-related DSN fields. If not specified, Amazon SES chooses the values.</p>
|
|
3501
|
+
* @public
|
|
3502
3502
|
*/
|
|
3503
3503
|
MessageDsn?: MessageDsn;
|
|
3504
3504
|
/**
|
|
3505
|
-
* @public
|
|
3506
3505
|
* <p>A list of recipients of the bounced message, including the information required to
|
|
3507
3506
|
* create the Delivery Status Notifications (DSNs) for the recipients. You must specify at
|
|
3508
3507
|
* least one <code>BouncedRecipientInfo</code> in the list.</p>
|
|
3508
|
+
* @public
|
|
3509
3509
|
*/
|
|
3510
3510
|
BouncedRecipientInfoList: BouncedRecipientInfo[] | undefined;
|
|
3511
3511
|
/**
|
|
3512
|
-
* @public
|
|
3513
3512
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3514
3513
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3515
3514
|
* address in the "From" header of the bounce. For more information about sending
|
|
3516
3515
|
* authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3516
|
+
* @public
|
|
3517
3517
|
*/
|
|
3518
3518
|
BounceSenderArn?: string;
|
|
3519
3519
|
}
|
|
3520
3520
|
/**
|
|
3521
|
-
* @public
|
|
3522
3521
|
* <p>Represents a unique message ID.</p>
|
|
3522
|
+
* @public
|
|
3523
3523
|
*/
|
|
3524
3524
|
export interface SendBounceResponse {
|
|
3525
3525
|
/**
|
|
3526
|
-
* @public
|
|
3527
3526
|
* <p>The message ID of the bounce message.</p>
|
|
3527
|
+
* @public
|
|
3528
3528
|
*/
|
|
3529
3529
|
MessageId?: string;
|
|
3530
3530
|
}
|
|
3531
3531
|
/**
|
|
3532
|
-
* @public
|
|
3533
3532
|
* <p>Represents a request to send a templated email to multiple destinations using Amazon SES.
|
|
3534
3533
|
* For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES Developer
|
|
3535
3534
|
* Guide</a>.</p>
|
|
3535
|
+
* @public
|
|
3536
3536
|
*/
|
|
3537
3537
|
export interface SendBulkTemplatedEmailRequest {
|
|
3538
3538
|
/**
|
|
3539
|
-
* @public
|
|
3540
3539
|
* <p>The email address that is sending the email. This email address must be either
|
|
3541
3540
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3542
3541
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
@@ -3554,10 +3553,10 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3554
3553
|
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3555
3554
|
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3556
3555
|
* </note>
|
|
3556
|
+
* @public
|
|
3557
3557
|
*/
|
|
3558
3558
|
Source: string | undefined;
|
|
3559
3559
|
/**
|
|
3560
|
-
* @public
|
|
3561
3560
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3562
3561
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3563
3562
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3568,16 +3567,16 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3568
3567
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3569
3568
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3570
3569
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3570
|
+
* @public
|
|
3571
3571
|
*/
|
|
3572
3572
|
SourceArn?: string;
|
|
3573
3573
|
/**
|
|
3574
|
-
* @public
|
|
3575
3574
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3576
3575
|
* message, each reply-to address receives the reply.</p>
|
|
3576
|
+
* @public
|
|
3577
3577
|
*/
|
|
3578
3578
|
ReplyToAddresses?: string[];
|
|
3579
3579
|
/**
|
|
3580
|
-
* @public
|
|
3581
3580
|
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3582
3581
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3583
3582
|
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
@@ -3585,10 +3584,10 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3585
3584
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3586
3585
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3587
3586
|
* Amazon SES. </p>
|
|
3587
|
+
* @public
|
|
3588
3588
|
*/
|
|
3589
3589
|
ReturnPath?: string;
|
|
3590
3590
|
/**
|
|
3591
|
-
* @public
|
|
3592
3591
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3593
3592
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3594
3593
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3599,44 +3598,45 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3599
3598
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3600
3599
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3601
3600
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3601
|
+
* @public
|
|
3602
3602
|
*/
|
|
3603
3603
|
ReturnPathArn?: string;
|
|
3604
3604
|
/**
|
|
3605
|
-
* @public
|
|
3606
3605
|
* <p>The name of the configuration set to use when you send an email using
|
|
3607
3606
|
* <code>SendBulkTemplatedEmail</code>.</p>
|
|
3607
|
+
* @public
|
|
3608
3608
|
*/
|
|
3609
3609
|
ConfigurationSetName?: string;
|
|
3610
3610
|
/**
|
|
3611
|
-
* @public
|
|
3612
3611
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send to
|
|
3613
3612
|
* a destination using <code>SendBulkTemplatedEmail</code>.</p>
|
|
3613
|
+
* @public
|
|
3614
3614
|
*/
|
|
3615
3615
|
DefaultTags?: MessageTag[];
|
|
3616
3616
|
/**
|
|
3617
|
-
* @public
|
|
3618
3617
|
* <p>The template to use when sending this email.</p>
|
|
3618
|
+
* @public
|
|
3619
3619
|
*/
|
|
3620
3620
|
Template: string | undefined;
|
|
3621
3621
|
/**
|
|
3622
|
-
* @public
|
|
3623
3622
|
* <p>The ARN of the template to use when sending this email.</p>
|
|
3623
|
+
* @public
|
|
3624
3624
|
*/
|
|
3625
3625
|
TemplateArn?: string;
|
|
3626
3626
|
/**
|
|
3627
|
-
* @public
|
|
3628
3627
|
* <p>A list of replacement values to apply to the template when replacement data is not
|
|
3629
3628
|
* specified in a Destination object. These values act as a default or fallback option when
|
|
3630
3629
|
* no other data is available.</p>
|
|
3631
3630
|
* <p>The template data is a JSON object, typically consisting of key-value pairs in which
|
|
3632
3631
|
* the keys correspond to replacement tags in the email template.</p>
|
|
3632
|
+
* @public
|
|
3633
3633
|
*/
|
|
3634
3634
|
DefaultTemplateData?: string;
|
|
3635
3635
|
/**
|
|
3636
|
-
* @public
|
|
3637
3636
|
* <p>One or more <code>Destination</code> objects. All of the recipients in a
|
|
3638
3637
|
* <code>Destination</code> receive the same version of the email. You can specify up
|
|
3639
3638
|
* to 50 <code>Destination</code> objects within a <code>Destinations</code> array.</p>
|
|
3639
|
+
* @public
|
|
3640
3640
|
*/
|
|
3641
3641
|
Destinations: BulkEmailDestination[] | undefined;
|
|
3642
3642
|
}
|
|
@@ -3645,56 +3645,55 @@ export interface SendBulkTemplatedEmailRequest {
|
|
|
3645
3645
|
*/
|
|
3646
3646
|
export interface SendBulkTemplatedEmailResponse {
|
|
3647
3647
|
/**
|
|
3648
|
-
* @public
|
|
3649
3648
|
* <p>One object per intended recipient. Check each response object and retry any messages
|
|
3650
3649
|
* with a failure status. (Note that order of responses will be respective to order of
|
|
3651
3650
|
* destinations in the request.)Receipt rules enable you to specify which actions </p>
|
|
3651
|
+
* @public
|
|
3652
3652
|
*/
|
|
3653
3653
|
Status: BulkEmailDestinationStatus[] | undefined;
|
|
3654
3654
|
}
|
|
3655
3655
|
/**
|
|
3656
|
-
* @public
|
|
3657
3656
|
* <p>Represents a request to send a custom verification email to a specified
|
|
3658
3657
|
* recipient.</p>
|
|
3658
|
+
* @public
|
|
3659
3659
|
*/
|
|
3660
3660
|
export interface SendCustomVerificationEmailRequest {
|
|
3661
3661
|
/**
|
|
3662
|
-
* @public
|
|
3663
3662
|
* <p>The email address to verify.</p>
|
|
3663
|
+
* @public
|
|
3664
3664
|
*/
|
|
3665
3665
|
EmailAddress: string | undefined;
|
|
3666
3666
|
/**
|
|
3667
|
-
* @public
|
|
3668
3667
|
* <p>The name of the custom verification email template to use when sending the
|
|
3669
3668
|
* verification email.</p>
|
|
3669
|
+
* @public
|
|
3670
3670
|
*/
|
|
3671
3671
|
TemplateName: string | undefined;
|
|
3672
3672
|
/**
|
|
3673
|
-
* @public
|
|
3674
3673
|
* <p>Name of a configuration set to use when sending the verification email.</p>
|
|
3674
|
+
* @public
|
|
3675
3675
|
*/
|
|
3676
3676
|
ConfigurationSetName?: string;
|
|
3677
3677
|
}
|
|
3678
3678
|
/**
|
|
3679
|
-
* @public
|
|
3680
3679
|
* <p>The response received when attempting to send the custom verification email.</p>
|
|
3680
|
+
* @public
|
|
3681
3681
|
*/
|
|
3682
3682
|
export interface SendCustomVerificationEmailResponse {
|
|
3683
3683
|
/**
|
|
3684
|
-
* @public
|
|
3685
3684
|
* <p>The unique message identifier returned from the
|
|
3686
3685
|
* <code>SendCustomVerificationEmail</code> operation.</p>
|
|
3686
|
+
* @public
|
|
3687
3687
|
*/
|
|
3688
3688
|
MessageId?: string;
|
|
3689
3689
|
}
|
|
3690
3690
|
/**
|
|
3691
|
-
* @public
|
|
3692
3691
|
* <p>Represents a request to send a single formatted email using Amazon SES. For more
|
|
3693
3692
|
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-formatted.html">Amazon SES Developer Guide</a>.</p>
|
|
3693
|
+
* @public
|
|
3694
3694
|
*/
|
|
3695
3695
|
export interface SendEmailRequest {
|
|
3696
3696
|
/**
|
|
3697
|
-
* @public
|
|
3698
3697
|
* <p>The email address that is sending the email. This email address must be either
|
|
3699
3698
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3700
3699
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
@@ -3712,26 +3711,26 @@ export interface SendEmailRequest {
|
|
|
3712
3711
|
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3713
3712
|
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3714
3713
|
* </note>
|
|
3714
|
+
* @public
|
|
3715
3715
|
*/
|
|
3716
3716
|
Source: string | undefined;
|
|
3717
3717
|
/**
|
|
3718
|
-
* @public
|
|
3719
3718
|
* <p>The destination for this email, composed of To:, CC:, and BCC: fields.</p>
|
|
3719
|
+
* @public
|
|
3720
3720
|
*/
|
|
3721
3721
|
Destination: Destination | undefined;
|
|
3722
3722
|
/**
|
|
3723
|
-
* @public
|
|
3724
3723
|
* <p>The message to be sent.</p>
|
|
3724
|
+
* @public
|
|
3725
3725
|
*/
|
|
3726
3726
|
Message: Message | undefined;
|
|
3727
3727
|
/**
|
|
3728
|
-
* @public
|
|
3729
3728
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3730
3729
|
* message, each reply-to address receives the reply.</p>
|
|
3730
|
+
* @public
|
|
3731
3731
|
*/
|
|
3732
3732
|
ReplyToAddresses?: string[];
|
|
3733
3733
|
/**
|
|
3734
|
-
* @public
|
|
3735
3734
|
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3736
3735
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3737
3736
|
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
@@ -3739,10 +3738,10 @@ export interface SendEmailRequest {
|
|
|
3739
3738
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3740
3739
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3741
3740
|
* Amazon SES. </p>
|
|
3741
|
+
* @public
|
|
3742
3742
|
*/
|
|
3743
3743
|
ReturnPath?: string;
|
|
3744
3744
|
/**
|
|
3745
|
-
* @public
|
|
3746
3745
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3747
3746
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3748
3747
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3753,10 +3752,10 @@ export interface SendEmailRequest {
|
|
|
3753
3752
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3754
3753
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
3755
3754
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3755
|
+
* @public
|
|
3756
3756
|
*/
|
|
3757
3757
|
SourceArn?: string;
|
|
3758
3758
|
/**
|
|
3759
|
-
* @public
|
|
3760
3759
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3761
3760
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3762
3761
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3767,42 +3766,42 @@ export interface SendEmailRequest {
|
|
|
3767
3766
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
3768
3767
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
3769
3768
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
3769
|
+
* @public
|
|
3770
3770
|
*/
|
|
3771
3771
|
ReturnPathArn?: string;
|
|
3772
3772
|
/**
|
|
3773
|
-
* @public
|
|
3774
3773
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
3775
3774
|
* using <code>SendEmail</code>. Tags correspond to characteristics of the email that you
|
|
3776
3775
|
* define, so that you can publish email sending events.</p>
|
|
3776
|
+
* @public
|
|
3777
3777
|
*/
|
|
3778
3778
|
Tags?: MessageTag[];
|
|
3779
3779
|
/**
|
|
3780
|
-
* @public
|
|
3781
3780
|
* <p>The name of the configuration set to use when you send an email using
|
|
3782
3781
|
* <code>SendEmail</code>.</p>
|
|
3782
|
+
* @public
|
|
3783
3783
|
*/
|
|
3784
3784
|
ConfigurationSetName?: string;
|
|
3785
3785
|
}
|
|
3786
3786
|
/**
|
|
3787
|
-
* @public
|
|
3788
3787
|
* <p>Represents a unique message ID.</p>
|
|
3788
|
+
* @public
|
|
3789
3789
|
*/
|
|
3790
3790
|
export interface SendEmailResponse {
|
|
3791
3791
|
/**
|
|
3792
|
-
* @public
|
|
3793
3792
|
* <p>The unique message identifier returned from the <code>SendEmail</code> action. </p>
|
|
3793
|
+
* @public
|
|
3794
3794
|
*/
|
|
3795
3795
|
MessageId: string | undefined;
|
|
3796
3796
|
}
|
|
3797
3797
|
/**
|
|
3798
|
-
* @public
|
|
3799
3798
|
* <p>Represents a request to send a single raw email using Amazon SES. For more information, see
|
|
3800
3799
|
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Amazon SES Developer
|
|
3801
3800
|
* Guide</a>.</p>
|
|
3801
|
+
* @public
|
|
3802
3802
|
*/
|
|
3803
3803
|
export interface SendRawEmailRequest {
|
|
3804
3804
|
/**
|
|
3805
|
-
* @public
|
|
3806
3805
|
* <p>The identity's email address. If you do not provide a value for this parameter, you
|
|
3807
3806
|
* must specify a "From" address in the raw text of the message. (You can also specify
|
|
3808
3807
|
* both.)</p>
|
|
@@ -3819,16 +3818,16 @@ export interface SendRawEmailRequest {
|
|
|
3819
3818
|
* <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled,
|
|
3820
3819
|
* then bounces and complaints are sent to this email address. This takes precedence over
|
|
3821
3820
|
* any Return-Path header that you might include in the raw text of the message.</p>
|
|
3821
|
+
* @public
|
|
3822
3822
|
*/
|
|
3823
3823
|
Source?: string;
|
|
3824
3824
|
/**
|
|
3825
|
-
* @public
|
|
3826
3825
|
* <p>A list of destinations for the message, consisting of To:, CC:, and BCC:
|
|
3827
3826
|
* addresses.</p>
|
|
3827
|
+
* @public
|
|
3828
3828
|
*/
|
|
3829
3829
|
Destinations?: string[];
|
|
3830
3830
|
/**
|
|
3831
|
-
* @public
|
|
3832
3831
|
* <p>The raw email message itself. The message has to meet the following criteria:</p>
|
|
3833
3832
|
* <ul>
|
|
3834
3833
|
* <li>
|
|
@@ -3861,10 +3860,10 @@ export interface SendRawEmailRequest {
|
|
|
3861
3860
|
* <CRLF>, must not exceed 1,000 characters.</p>
|
|
3862
3861
|
* </li>
|
|
3863
3862
|
* </ul>
|
|
3863
|
+
* @public
|
|
3864
3864
|
*/
|
|
3865
3865
|
RawMessage: RawMessage | undefined;
|
|
3866
3866
|
/**
|
|
3867
|
-
* @public
|
|
3868
3867
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3869
3868
|
* that is associated with the sending authorization policy that permits you to specify a
|
|
3870
3869
|
* particular "From" address in the header of the raw email.</p>
|
|
@@ -3877,10 +3876,10 @@ export interface SendRawEmailRequest {
|
|
|
3877
3876
|
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3878
3877
|
* Developer Guide</a>.</p>
|
|
3879
3878
|
* </note>
|
|
3879
|
+
* @public
|
|
3880
3880
|
*/
|
|
3881
3881
|
FromArn?: string;
|
|
3882
3882
|
/**
|
|
3883
|
-
* @public
|
|
3884
3883
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3885
3884
|
* that is associated with the sending authorization policy that permits you to send for
|
|
3886
3885
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -3899,10 +3898,10 @@ export interface SendRawEmailRequest {
|
|
|
3899
3898
|
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3900
3899
|
* Developer Guide</a>.</p>
|
|
3901
3900
|
* </note>
|
|
3901
|
+
* @public
|
|
3902
3902
|
*/
|
|
3903
3903
|
SourceArn?: string;
|
|
3904
3904
|
/**
|
|
3905
|
-
* @public
|
|
3906
3905
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
3907
3906
|
* that is associated with the sending authorization policy that permits you to use the
|
|
3908
3907
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -3921,42 +3920,42 @@ export interface SendRawEmailRequest {
|
|
|
3921
3920
|
* <code>SendRawEmail</code> in this guide, or see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html">Amazon SES
|
|
3922
3921
|
* Developer Guide</a>.</p>
|
|
3923
3922
|
* </note>
|
|
3923
|
+
* @public
|
|
3924
3924
|
*/
|
|
3925
3925
|
ReturnPathArn?: string;
|
|
3926
3926
|
/**
|
|
3927
|
-
* @public
|
|
3928
3927
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
3929
3928
|
* using <code>SendRawEmail</code>. Tags correspond to characteristics of the email that
|
|
3930
3929
|
* you define, so that you can publish email sending events.</p>
|
|
3930
|
+
* @public
|
|
3931
3931
|
*/
|
|
3932
3932
|
Tags?: MessageTag[];
|
|
3933
3933
|
/**
|
|
3934
|
-
* @public
|
|
3935
3934
|
* <p>The name of the configuration set to use when you send an email using
|
|
3936
3935
|
* <code>SendRawEmail</code>.</p>
|
|
3936
|
+
* @public
|
|
3937
3937
|
*/
|
|
3938
3938
|
ConfigurationSetName?: string;
|
|
3939
3939
|
}
|
|
3940
3940
|
/**
|
|
3941
|
-
* @public
|
|
3942
3941
|
* <p>Represents a unique message ID.</p>
|
|
3942
|
+
* @public
|
|
3943
3943
|
*/
|
|
3944
3944
|
export interface SendRawEmailResponse {
|
|
3945
3945
|
/**
|
|
3946
|
-
* @public
|
|
3947
3946
|
* <p>The unique message identifier returned from the <code>SendRawEmail</code> action.
|
|
3948
3947
|
* </p>
|
|
3948
|
+
* @public
|
|
3949
3949
|
*/
|
|
3950
3950
|
MessageId: string | undefined;
|
|
3951
3951
|
}
|
|
3952
3952
|
/**
|
|
3953
|
-
* @public
|
|
3954
3953
|
* <p>Represents a request to send a templated email using Amazon SES. For more information, see
|
|
3955
3954
|
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>
|
|
3955
|
+
* @public
|
|
3956
3956
|
*/
|
|
3957
3957
|
export interface SendTemplatedEmailRequest {
|
|
3958
3958
|
/**
|
|
3959
|
-
* @public
|
|
3960
3959
|
* <p>The email address that is sending the email. This email address must be either
|
|
3961
3960
|
* individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
|
|
3962
3961
|
* For information about verifying identities, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html">Amazon SES Developer Guide</a>.</p>
|
|
@@ -3974,22 +3973,22 @@ export interface SendTemplatedEmailRequest {
|
|
|
3974
3973
|
* "friendly from" name using MIME encoded-word syntax, as described in <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html">Sending raw email
|
|
3975
3974
|
* using the Amazon SES API</a>. For more information about Punycode, see <a href="http://tools.ietf.org/html/rfc3492">RFC 3492</a>.</p>
|
|
3976
3975
|
* </note>
|
|
3976
|
+
* @public
|
|
3977
3977
|
*/
|
|
3978
3978
|
Source: string | undefined;
|
|
3979
3979
|
/**
|
|
3980
|
-
* @public
|
|
3981
3980
|
* <p>The destination for this email, composed of To:, CC:, and BCC: fields. A Destination
|
|
3982
3981
|
* can include up to 50 recipients across these three fields.</p>
|
|
3982
|
+
* @public
|
|
3983
3983
|
*/
|
|
3984
3984
|
Destination: Destination | undefined;
|
|
3985
3985
|
/**
|
|
3986
|
-
* @public
|
|
3987
3986
|
* <p>The reply-to email address(es) for the message. If the recipient replies to the
|
|
3988
3987
|
* message, each reply-to address receives the reply.</p>
|
|
3988
|
+
* @public
|
|
3989
3989
|
*/
|
|
3990
3990
|
ReplyToAddresses?: string[];
|
|
3991
3991
|
/**
|
|
3992
|
-
* @public
|
|
3993
3992
|
* <p>The email address that bounces and complaints are forwarded to when feedback
|
|
3994
3993
|
* forwarding is enabled. If the message cannot be delivered to the recipient, then an
|
|
3995
3994
|
* error message is returned from the recipient's ISP; this message is forwarded to the
|
|
@@ -3997,10 +3996,10 @@ export interface SendTemplatedEmailRequest {
|
|
|
3997
3996
|
* <code>ReturnPath</code> parameter is never overwritten. This email address must be
|
|
3998
3997
|
* either individually verified with Amazon SES, or from a domain that has been verified with
|
|
3999
3998
|
* Amazon SES. </p>
|
|
3999
|
+
* @public
|
|
4000
4000
|
*/
|
|
4001
4001
|
ReturnPath?: string;
|
|
4002
4002
|
/**
|
|
4003
|
-
* @public
|
|
4004
4003
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
4005
4004
|
* that is associated with the sending authorization policy that permits you to send for
|
|
4006
4005
|
* the email address specified in the <code>Source</code> parameter.</p>
|
|
@@ -4011,10 +4010,10 @@ export interface SendTemplatedEmailRequest {
|
|
|
4011
4010
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
4012
4011
|
* <code>Source</code> to be <code>user@example.com</code>.</p>
|
|
4013
4012
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
4013
|
+
* @public
|
|
4014
4014
|
*/
|
|
4015
4015
|
SourceArn?: string;
|
|
4016
4016
|
/**
|
|
4017
|
-
* @public
|
|
4018
4017
|
* <p>This parameter is used only for sending authorization. It is the ARN of the identity
|
|
4019
4018
|
* that is associated with the sending authorization policy that permits you to use the
|
|
4020
4019
|
* email address specified in the <code>ReturnPath</code> parameter.</p>
|
|
@@ -4025,36 +4024,37 @@ export interface SendTemplatedEmailRequest {
|
|
|
4025
4024
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the
|
|
4026
4025
|
* <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p>
|
|
4027
4026
|
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES Developer Guide</a>.</p>
|
|
4027
|
+
* @public
|
|
4028
4028
|
*/
|
|
4029
4029
|
ReturnPathArn?: string;
|
|
4030
4030
|
/**
|
|
4031
|
-
* @public
|
|
4032
4031
|
* <p>A list of tags, in the form of name/value pairs, to apply to an email that you send
|
|
4033
4032
|
* using <code>SendTemplatedEmail</code>. Tags correspond to characteristics of the email
|
|
4034
4033
|
* that you define, so that you can publish email sending events.</p>
|
|
4034
|
+
* @public
|
|
4035
4035
|
*/
|
|
4036
4036
|
Tags?: MessageTag[];
|
|
4037
4037
|
/**
|
|
4038
|
-
* @public
|
|
4039
4038
|
* <p>The name of the configuration set to use when you send an email using
|
|
4040
4039
|
* <code>SendTemplatedEmail</code>.</p>
|
|
4040
|
+
* @public
|
|
4041
4041
|
*/
|
|
4042
4042
|
ConfigurationSetName?: string;
|
|
4043
4043
|
/**
|
|
4044
|
-
* @public
|
|
4045
4044
|
* <p>The template to use when sending this email.</p>
|
|
4045
|
+
* @public
|
|
4046
4046
|
*/
|
|
4047
4047
|
Template: string | undefined;
|
|
4048
4048
|
/**
|
|
4049
|
-
* @public
|
|
4050
4049
|
* <p>The ARN of the template to use when sending this email.</p>
|
|
4050
|
+
* @public
|
|
4051
4051
|
*/
|
|
4052
4052
|
TemplateArn?: string;
|
|
4053
4053
|
/**
|
|
4054
|
-
* @public
|
|
4055
4054
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
4056
4055
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
4057
4056
|
* replacement tags in the email template.</p>
|
|
4057
|
+
* @public
|
|
4058
4058
|
*/
|
|
4059
4059
|
TemplateData: string | undefined;
|
|
4060
4060
|
}
|
|
@@ -4063,73 +4063,72 @@ export interface SendTemplatedEmailRequest {
|
|
|
4063
4063
|
*/
|
|
4064
4064
|
export interface SendTemplatedEmailResponse {
|
|
4065
4065
|
/**
|
|
4066
|
-
* @public
|
|
4067
4066
|
* <p>The unique message identifier returned from the <code>SendTemplatedEmail</code>
|
|
4068
4067
|
* action. </p>
|
|
4068
|
+
* @public
|
|
4069
4069
|
*/
|
|
4070
4070
|
MessageId: string | undefined;
|
|
4071
4071
|
}
|
|
4072
4072
|
/**
|
|
4073
|
-
* @public
|
|
4074
4073
|
* <p>Represents a request to set a receipt rule set as the active receipt rule set. You use
|
|
4075
4074
|
* receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
4076
4075
|
* Developer Guide</a>.</p>
|
|
4076
|
+
* @public
|
|
4077
4077
|
*/
|
|
4078
4078
|
export interface SetActiveReceiptRuleSetRequest {
|
|
4079
4079
|
/**
|
|
4080
|
-
* @public
|
|
4081
4080
|
* <p>The name of the receipt rule set to make active. Setting this value to null disables
|
|
4082
4081
|
* all email receiving.</p>
|
|
4082
|
+
* @public
|
|
4083
4083
|
*/
|
|
4084
4084
|
RuleSetName?: string;
|
|
4085
4085
|
}
|
|
4086
4086
|
/**
|
|
4087
|
-
* @public
|
|
4088
4087
|
* <p>An empty element returned on a successful request.</p>
|
|
4088
|
+
* @public
|
|
4089
4089
|
*/
|
|
4090
4090
|
export interface SetActiveReceiptRuleSetResponse {
|
|
4091
4091
|
}
|
|
4092
4092
|
/**
|
|
4093
|
-
* @public
|
|
4094
4093
|
* <p>Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For
|
|
4095
4094
|
* more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer
|
|
4096
4095
|
* Guide</a>.</p>
|
|
4096
|
+
* @public
|
|
4097
4097
|
*/
|
|
4098
4098
|
export interface SetIdentityDkimEnabledRequest {
|
|
4099
4099
|
/**
|
|
4100
|
-
* @public
|
|
4101
4100
|
* <p>The identity for which DKIM signing should be enabled or disabled.</p>
|
|
4101
|
+
* @public
|
|
4102
4102
|
*/
|
|
4103
4103
|
Identity: string | undefined;
|
|
4104
4104
|
/**
|
|
4105
|
-
* @public
|
|
4106
4105
|
* <p>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to
|
|
4107
4106
|
* enable DKIM signing for this identity; <code>false</code> to disable it. </p>
|
|
4107
|
+
* @public
|
|
4108
4108
|
*/
|
|
4109
4109
|
DkimEnabled: boolean | undefined;
|
|
4110
4110
|
}
|
|
4111
4111
|
/**
|
|
4112
|
-
* @public
|
|
4113
4112
|
* <p>An empty element returned on a successful request.</p>
|
|
4113
|
+
* @public
|
|
4114
4114
|
*/
|
|
4115
4115
|
export interface SetIdentityDkimEnabledResponse {
|
|
4116
4116
|
}
|
|
4117
4117
|
/**
|
|
4118
|
-
* @public
|
|
4119
4118
|
* <p>Represents a request to enable or disable whether Amazon SES forwards you bounce and
|
|
4120
4119
|
* complaint notifications through email. For information about email feedback forwarding,
|
|
4121
4120
|
* see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-email.html">Amazon SES
|
|
4122
4121
|
* Developer Guide</a>.</p>
|
|
4122
|
+
* @public
|
|
4123
4123
|
*/
|
|
4124
4124
|
export interface SetIdentityFeedbackForwardingEnabledRequest {
|
|
4125
4125
|
/**
|
|
4126
|
-
* @public
|
|
4127
4126
|
* <p>The identity for which to set bounce and complaint notification forwarding. Examples:
|
|
4128
4127
|
* <code>user@example.com</code>, <code>example.com</code>.</p>
|
|
4128
|
+
* @public
|
|
4129
4129
|
*/
|
|
4130
4130
|
Identity: string | undefined;
|
|
4131
4131
|
/**
|
|
4132
|
-
* @public
|
|
4133
4132
|
* <p>Sets whether Amazon SES forwards bounce and complaint notifications as email.
|
|
4134
4133
|
* <code>true</code> specifies that Amazon SES forwards bounce and complaint notifications
|
|
4135
4134
|
* as email, in addition to any Amazon SNS topic publishing otherwise specified.
|
|
@@ -4137,75 +4136,75 @@ export interface SetIdentityFeedbackForwardingEnabledRequest {
|
|
|
4137
4136
|
* only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics
|
|
4138
4137
|
* are set for both <code>Bounce</code> and <code>Complaint</code> notification
|
|
4139
4138
|
* types.</p>
|
|
4139
|
+
* @public
|
|
4140
4140
|
*/
|
|
4141
4141
|
ForwardingEnabled: boolean | undefined;
|
|
4142
4142
|
}
|
|
4143
4143
|
/**
|
|
4144
|
-
* @public
|
|
4145
4144
|
* <p>An empty element returned on a successful request.</p>
|
|
4145
|
+
* @public
|
|
4146
4146
|
*/
|
|
4147
4147
|
export interface SetIdentityFeedbackForwardingEnabledResponse {
|
|
4148
4148
|
}
|
|
4149
4149
|
/**
|
|
4150
|
-
* @public
|
|
4151
4150
|
* <p>Represents a request to set whether Amazon SES includes the original email headers in the
|
|
4152
4151
|
* Amazon SNS notifications of a specified type. For information about notifications, see the
|
|
4153
4152
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html">Amazon SES
|
|
4154
4153
|
* Developer Guide</a>.</p>
|
|
4154
|
+
* @public
|
|
4155
4155
|
*/
|
|
4156
4156
|
export interface SetIdentityHeadersInNotificationsEnabledRequest {
|
|
4157
4157
|
/**
|
|
4158
|
-
* @public
|
|
4159
4158
|
* <p>The identity for which to enable or disable headers in notifications. Examples:
|
|
4160
4159
|
* <code>user@example.com</code>, <code>example.com</code>.</p>
|
|
4160
|
+
* @public
|
|
4161
4161
|
*/
|
|
4162
4162
|
Identity: string | undefined;
|
|
4163
4163
|
/**
|
|
4164
|
-
* @public
|
|
4165
4164
|
* <p>The notification type for which to enable or disable headers in notifications. </p>
|
|
4165
|
+
* @public
|
|
4166
4166
|
*/
|
|
4167
4167
|
NotificationType: NotificationType | undefined;
|
|
4168
4168
|
/**
|
|
4169
|
-
* @public
|
|
4170
4169
|
* <p>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the
|
|
4171
4170
|
* specified notification type. A value of <code>true</code> specifies that Amazon SES includes
|
|
4172
4171
|
* headers in notifications, and a value of <code>false</code> specifies that Amazon SES does
|
|
4173
4172
|
* not include headers in notifications.</p>
|
|
4174
4173
|
* <p>This value can only be set when <code>NotificationType</code> is already set to use a
|
|
4175
4174
|
* particular Amazon SNS topic.</p>
|
|
4175
|
+
* @public
|
|
4176
4176
|
*/
|
|
4177
4177
|
Enabled: boolean | undefined;
|
|
4178
4178
|
}
|
|
4179
4179
|
/**
|
|
4180
|
-
* @public
|
|
4181
4180
|
* <p>An empty element returned on a successful request.</p>
|
|
4181
|
+
* @public
|
|
4182
4182
|
*/
|
|
4183
4183
|
export interface SetIdentityHeadersInNotificationsEnabledResponse {
|
|
4184
4184
|
}
|
|
4185
4185
|
/**
|
|
4186
|
-
* @public
|
|
4187
4186
|
* <p>Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for
|
|
4188
4187
|
* a verified identity. For information about using a custom MAIL FROM domain, see the
|
|
4189
4188
|
* <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer
|
|
4190
4189
|
* Guide</a>.</p>
|
|
4190
|
+
* @public
|
|
4191
4191
|
*/
|
|
4192
4192
|
export interface SetIdentityMailFromDomainRequest {
|
|
4193
4193
|
/**
|
|
4194
|
-
* @public
|
|
4195
4194
|
* <p>The verified identity.</p>
|
|
4195
|
+
* @public
|
|
4196
4196
|
*/
|
|
4197
4197
|
Identity: string | undefined;
|
|
4198
4198
|
/**
|
|
4199
|
-
* @public
|
|
4200
4199
|
* <p>The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain
|
|
4201
4200
|
* must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if
|
|
4202
4201
|
* the MAIL FROM domain is the destination of email feedback forwarding (for more
|
|
4203
4202
|
* information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/mail-from.html">Amazon SES Developer Guide</a>), and 3) not be used to receive emails. A value of
|
|
4204
4203
|
* <code>null</code> disables the custom MAIL FROM setting for the identity.</p>
|
|
4204
|
+
* @public
|
|
4205
4205
|
*/
|
|
4206
4206
|
MailFromDomain?: string;
|
|
4207
4207
|
/**
|
|
4208
|
-
* @public
|
|
4209
4208
|
* <p>The action for Amazon SES to take if it cannot successfully read the required MX record
|
|
4210
4209
|
* when you send an email. If you choose <code>UseDefaultValue</code>, Amazon SES uses
|
|
4211
4210
|
* amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose
|
|
@@ -4214,25 +4213,25 @@ export interface SetIdentityMailFromDomainRequest {
|
|
|
4214
4213
|
* <p>The action specified in <code>BehaviorOnMXFailure</code> is taken when the custom MAIL
|
|
4215
4214
|
* FROM domain setup is in the <code>Pending</code>, <code>Failed</code>, and
|
|
4216
4215
|
* <code>TemporaryFailure</code> states.</p>
|
|
4216
|
+
* @public
|
|
4217
4217
|
*/
|
|
4218
4218
|
BehaviorOnMXFailure?: BehaviorOnMXFailure;
|
|
4219
4219
|
}
|
|
4220
4220
|
/**
|
|
4221
|
-
* @public
|
|
4222
4221
|
* <p>An empty element returned on a successful request.</p>
|
|
4222
|
+
* @public
|
|
4223
4223
|
*/
|
|
4224
4224
|
export interface SetIdentityMailFromDomainResponse {
|
|
4225
4225
|
}
|
|
4226
4226
|
/**
|
|
4227
|
-
* @public
|
|
4228
4227
|
* <p>Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce,
|
|
4229
4228
|
* complaint, or delivery notifications for emails sent with that identity as the source.
|
|
4230
4229
|
* For information about Amazon SES notifications, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html">Amazon SES
|
|
4231
4230
|
* Developer Guide</a>.</p>
|
|
4231
|
+
* @public
|
|
4232
4232
|
*/
|
|
4233
4233
|
export interface SetIdentityNotificationTopicRequest {
|
|
4234
4234
|
/**
|
|
4235
|
-
* @public
|
|
4236
4235
|
* <p>The identity (email address or domain) for the Amazon SNS topic.</p>
|
|
4237
4236
|
* <important>
|
|
4238
4237
|
* <p>You can only specify a verified identity for this parameter.</p>
|
|
@@ -4241,53 +4240,54 @@ export interface SetIdentityNotificationTopicRequest {
|
|
|
4241
4240
|
* (ARN). The following examples are all valid identities: <code>sender@example.com</code>,
|
|
4242
4241
|
* <code>example.com</code>,
|
|
4243
4242
|
* <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>
|
|
4243
|
+
* @public
|
|
4244
4244
|
*/
|
|
4245
4245
|
Identity: string | undefined;
|
|
4246
4246
|
/**
|
|
4247
|
-
* @public
|
|
4248
4247
|
* <p>The type of notifications that are published to the specified Amazon SNS topic.</p>
|
|
4248
|
+
* @public
|
|
4249
4249
|
*/
|
|
4250
4250
|
NotificationType: NotificationType | undefined;
|
|
4251
4251
|
/**
|
|
4252
|
-
* @public
|
|
4253
4252
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from
|
|
4254
4253
|
* the request or a null value is passed, <code>SnsTopic</code> is cleared and publishing
|
|
4255
4254
|
* is disabled.</p>
|
|
4255
|
+
* @public
|
|
4256
4256
|
*/
|
|
4257
4257
|
SnsTopic?: string;
|
|
4258
4258
|
}
|
|
4259
4259
|
/**
|
|
4260
|
-
* @public
|
|
4261
4260
|
* <p>An empty element returned on a successful request.</p>
|
|
4261
|
+
* @public
|
|
4262
4262
|
*/
|
|
4263
4263
|
export interface SetIdentityNotificationTopicResponse {
|
|
4264
4264
|
}
|
|
4265
4265
|
/**
|
|
4266
|
-
* @public
|
|
4267
4266
|
* <p>Represents a request to set the position of a receipt rule in a receipt rule set. You
|
|
4268
4267
|
* use receipt rule sets to receive email with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES
|
|
4269
4268
|
* Developer Guide</a>.</p>
|
|
4269
|
+
* @public
|
|
4270
4270
|
*/
|
|
4271
4271
|
export interface SetReceiptRulePositionRequest {
|
|
4272
4272
|
/**
|
|
4273
|
-
* @public
|
|
4274
4273
|
* <p>The name of the receipt rule set that contains the receipt rule to reposition.</p>
|
|
4274
|
+
* @public
|
|
4275
4275
|
*/
|
|
4276
4276
|
RuleSetName: string | undefined;
|
|
4277
4277
|
/**
|
|
4278
|
-
* @public
|
|
4279
4278
|
* <p>The name of the receipt rule to reposition.</p>
|
|
4279
|
+
* @public
|
|
4280
4280
|
*/
|
|
4281
4281
|
RuleName: string | undefined;
|
|
4282
4282
|
/**
|
|
4283
|
-
* @public
|
|
4284
4283
|
* <p>The name of the receipt rule after which to place the specified receipt rule.</p>
|
|
4284
|
+
* @public
|
|
4285
4285
|
*/
|
|
4286
4286
|
After?: string;
|
|
4287
4287
|
}
|
|
4288
4288
|
/**
|
|
4289
|
-
* @public
|
|
4290
4289
|
* <p>An empty element returned on a successful request.</p>
|
|
4290
|
+
* @public
|
|
4291
4291
|
*/
|
|
4292
4292
|
export interface SetReceiptRulePositionResponse {
|
|
4293
4293
|
}
|
|
@@ -4296,15 +4296,15 @@ export interface SetReceiptRulePositionResponse {
|
|
|
4296
4296
|
*/
|
|
4297
4297
|
export interface TestRenderTemplateRequest {
|
|
4298
4298
|
/**
|
|
4299
|
-
* @public
|
|
4300
4299
|
* <p>The name of the template to render.</p>
|
|
4300
|
+
* @public
|
|
4301
4301
|
*/
|
|
4302
4302
|
TemplateName: string | undefined;
|
|
4303
4303
|
/**
|
|
4304
|
-
* @public
|
|
4305
4304
|
* <p>A list of replacement values to apply to the template. This parameter is a JSON
|
|
4306
4305
|
* object, typically consisting of key-value pairs in which the keys correspond to
|
|
4307
4306
|
* replacement tags in the email template.</p>
|
|
4307
|
+
* @public
|
|
4308
4308
|
*/
|
|
4309
4309
|
TemplateData: string | undefined;
|
|
4310
4310
|
}
|
|
@@ -4313,175 +4313,175 @@ export interface TestRenderTemplateRequest {
|
|
|
4313
4313
|
*/
|
|
4314
4314
|
export interface TestRenderTemplateResponse {
|
|
4315
4315
|
/**
|
|
4316
|
-
* @public
|
|
4317
4316
|
* <p>The complete MIME message rendered by applying the data in the TemplateData parameter
|
|
4318
4317
|
* to the template specified in the TemplateName parameter.</p>
|
|
4318
|
+
* @public
|
|
4319
4319
|
*/
|
|
4320
4320
|
RenderedTemplate?: string;
|
|
4321
4321
|
}
|
|
4322
4322
|
/**
|
|
4323
|
-
* @public
|
|
4324
4323
|
* <p>Represents a request to enable or disable the email sending capabilities for your
|
|
4325
4324
|
* entire Amazon SES account.</p>
|
|
4325
|
+
* @public
|
|
4326
4326
|
*/
|
|
4327
4327
|
export interface UpdateAccountSendingEnabledRequest {
|
|
4328
4328
|
/**
|
|
4329
|
-
* @public
|
|
4330
4329
|
* <p>Describes whether email sending is enabled or disabled for your Amazon SES account in the
|
|
4331
4330
|
* current Amazon Web Services Region.</p>
|
|
4331
|
+
* @public
|
|
4332
4332
|
*/
|
|
4333
4333
|
Enabled?: boolean;
|
|
4334
4334
|
}
|
|
4335
4335
|
/**
|
|
4336
|
-
* @public
|
|
4337
4336
|
* <p>Represents a request to update the event destination of a configuration set.
|
|
4338
4337
|
* Configuration sets enable you to publish email sending events. For information about
|
|
4339
4338
|
* using configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
4340
4339
|
* Guide</a>.</p>
|
|
4340
|
+
* @public
|
|
4341
4341
|
*/
|
|
4342
4342
|
export interface UpdateConfigurationSetEventDestinationRequest {
|
|
4343
4343
|
/**
|
|
4344
|
-
* @public
|
|
4345
4344
|
* <p>The name of the configuration set that contains the event destination.</p>
|
|
4345
|
+
* @public
|
|
4346
4346
|
*/
|
|
4347
4347
|
ConfigurationSetName: string | undefined;
|
|
4348
4348
|
/**
|
|
4349
|
-
* @public
|
|
4350
4349
|
* <p>The event destination object.</p>
|
|
4350
|
+
* @public
|
|
4351
4351
|
*/
|
|
4352
4352
|
EventDestination: EventDestination | undefined;
|
|
4353
4353
|
}
|
|
4354
4354
|
/**
|
|
4355
|
-
* @public
|
|
4356
4355
|
* <p>An empty element returned on a successful request.</p>
|
|
4356
|
+
* @public
|
|
4357
4357
|
*/
|
|
4358
4358
|
export interface UpdateConfigurationSetEventDestinationResponse {
|
|
4359
4359
|
}
|
|
4360
4360
|
/**
|
|
4361
|
-
* @public
|
|
4362
4361
|
* <p>Represents a request to modify the reputation metric publishing settings for a
|
|
4363
4362
|
* configuration set.</p>
|
|
4363
|
+
* @public
|
|
4364
4364
|
*/
|
|
4365
4365
|
export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
|
|
4366
4366
|
/**
|
|
4367
|
-
* @public
|
|
4368
4367
|
* <p>The name of the configuration set to update.</p>
|
|
4368
|
+
* @public
|
|
4369
4369
|
*/
|
|
4370
4370
|
ConfigurationSetName: string | undefined;
|
|
4371
4371
|
/**
|
|
4372
|
-
* @public
|
|
4373
4372
|
* <p>Describes whether or not Amazon SES publishes reputation metrics for the configuration set,
|
|
4374
4373
|
* such as bounce and complaint rates, to Amazon CloudWatch.</p>
|
|
4374
|
+
* @public
|
|
4375
4375
|
*/
|
|
4376
4376
|
Enabled: boolean | undefined;
|
|
4377
4377
|
}
|
|
4378
4378
|
/**
|
|
4379
|
-
* @public
|
|
4380
4379
|
* <p>Represents a request to enable or disable the email sending capabilities for a
|
|
4381
4380
|
* specific configuration set.</p>
|
|
4381
|
+
* @public
|
|
4382
4382
|
*/
|
|
4383
4383
|
export interface UpdateConfigurationSetSendingEnabledRequest {
|
|
4384
4384
|
/**
|
|
4385
|
-
* @public
|
|
4386
4385
|
* <p>The name of the configuration set to update.</p>
|
|
4386
|
+
* @public
|
|
4387
4387
|
*/
|
|
4388
4388
|
ConfigurationSetName: string | undefined;
|
|
4389
4389
|
/**
|
|
4390
|
-
* @public
|
|
4391
4390
|
* <p>Describes whether email sending is enabled or disabled for the configuration set.
|
|
4392
4391
|
* </p>
|
|
4392
|
+
* @public
|
|
4393
4393
|
*/
|
|
4394
4394
|
Enabled: boolean | undefined;
|
|
4395
4395
|
}
|
|
4396
4396
|
/**
|
|
4397
|
-
* @public
|
|
4398
4397
|
* <p>Represents a request to update the tracking options for a configuration set. </p>
|
|
4398
|
+
* @public
|
|
4399
4399
|
*/
|
|
4400
4400
|
export interface UpdateConfigurationSetTrackingOptionsRequest {
|
|
4401
4401
|
/**
|
|
4402
|
-
* @public
|
|
4403
4402
|
* <p>The name of the configuration set.</p>
|
|
4403
|
+
* @public
|
|
4404
4404
|
*/
|
|
4405
4405
|
ConfigurationSetName: string | undefined;
|
|
4406
4406
|
/**
|
|
4407
|
-
* @public
|
|
4408
4407
|
* <p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This
|
|
4409
4408
|
* domain captures open and click events generated by Amazon SES emails.</p>
|
|
4410
4409
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html">Configuring Custom
|
|
4411
4410
|
* Domains to Handle Open and Click Tracking</a> in the <i>Amazon SES Developer
|
|
4412
4411
|
* Guide</i>.</p>
|
|
4412
|
+
* @public
|
|
4413
4413
|
*/
|
|
4414
4414
|
TrackingOptions: TrackingOptions | undefined;
|
|
4415
4415
|
}
|
|
4416
4416
|
/**
|
|
4417
|
-
* @public
|
|
4418
4417
|
* <p>An empty element returned on a successful request.</p>
|
|
4418
|
+
* @public
|
|
4419
4419
|
*/
|
|
4420
4420
|
export interface UpdateConfigurationSetTrackingOptionsResponse {
|
|
4421
4421
|
}
|
|
4422
4422
|
/**
|
|
4423
|
-
* @public
|
|
4424
4423
|
* <p>Represents a request to update an existing custom verification email template.</p>
|
|
4424
|
+
* @public
|
|
4425
4425
|
*/
|
|
4426
4426
|
export interface UpdateCustomVerificationEmailTemplateRequest {
|
|
4427
4427
|
/**
|
|
4428
|
-
* @public
|
|
4429
4428
|
* <p>The name of the custom verification email template to update.</p>
|
|
4429
|
+
* @public
|
|
4430
4430
|
*/
|
|
4431
4431
|
TemplateName: string | undefined;
|
|
4432
4432
|
/**
|
|
4433
|
-
* @public
|
|
4434
4433
|
* <p>The email address that the custom verification email is sent from.</p>
|
|
4434
|
+
* @public
|
|
4435
4435
|
*/
|
|
4436
4436
|
FromEmailAddress?: string;
|
|
4437
4437
|
/**
|
|
4438
|
-
* @public
|
|
4439
4438
|
* <p>The subject line of the custom verification email.</p>
|
|
4439
|
+
* @public
|
|
4440
4440
|
*/
|
|
4441
4441
|
TemplateSubject?: string;
|
|
4442
4442
|
/**
|
|
4443
|
-
* @public
|
|
4444
4443
|
* <p>The content of the custom verification email. The total size of the email must be less
|
|
4445
4444
|
* than 10 MB. The message body may contain HTML, with some limitations. For more
|
|
4446
4445
|
* information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Custom
|
|
4447
4446
|
* Verification Email Frequently Asked Questions</a> in the <i>Amazon SES
|
|
4448
4447
|
* Developer Guide</i>.</p>
|
|
4448
|
+
* @public
|
|
4449
4449
|
*/
|
|
4450
4450
|
TemplateContent?: string;
|
|
4451
4451
|
/**
|
|
4452
|
-
* @public
|
|
4453
4452
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
4454
4453
|
* is successfully verified.</p>
|
|
4454
|
+
* @public
|
|
4455
4455
|
*/
|
|
4456
4456
|
SuccessRedirectionURL?: string;
|
|
4457
4457
|
/**
|
|
4458
|
-
* @public
|
|
4459
4458
|
* <p>The URL that the recipient of the verification email is sent to if his or her address
|
|
4460
4459
|
* is not successfully verified.</p>
|
|
4460
|
+
* @public
|
|
4461
4461
|
*/
|
|
4462
4462
|
FailureRedirectionURL?: string;
|
|
4463
4463
|
}
|
|
4464
4464
|
/**
|
|
4465
|
-
* @public
|
|
4466
4465
|
* <p>Represents a request to update a receipt rule. You use receipt rules to receive email
|
|
4467
4466
|
* with Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html">Amazon SES Developer
|
|
4468
4467
|
* Guide</a>.</p>
|
|
4468
|
+
* @public
|
|
4469
4469
|
*/
|
|
4470
4470
|
export interface UpdateReceiptRuleRequest {
|
|
4471
4471
|
/**
|
|
4472
|
-
* @public
|
|
4473
4472
|
* <p>The name of the receipt rule set that the receipt rule belongs to.</p>
|
|
4473
|
+
* @public
|
|
4474
4474
|
*/
|
|
4475
4475
|
RuleSetName: string | undefined;
|
|
4476
4476
|
/**
|
|
4477
|
-
* @public
|
|
4478
4477
|
* <p>A data structure that contains the updated receipt rule information.</p>
|
|
4478
|
+
* @public
|
|
4479
4479
|
*/
|
|
4480
4480
|
Rule: ReceiptRule | undefined;
|
|
4481
4481
|
}
|
|
4482
4482
|
/**
|
|
4483
|
-
* @public
|
|
4484
4483
|
* <p>An empty element returned on a successful request.</p>
|
|
4484
|
+
* @public
|
|
4485
4485
|
*/
|
|
4486
4486
|
export interface UpdateReceiptRuleResponse {
|
|
4487
4487
|
}
|
|
@@ -4490,9 +4490,9 @@ export interface UpdateReceiptRuleResponse {
|
|
|
4490
4490
|
*/
|
|
4491
4491
|
export interface UpdateTemplateRequest {
|
|
4492
4492
|
/**
|
|
4493
|
-
* @public
|
|
4494
4493
|
* <p>The content of the email, composed of a subject line and either an HTML part or a
|
|
4495
4494
|
* text-only part.</p>
|
|
4495
|
+
* @public
|
|
4496
4496
|
*/
|
|
4497
4497
|
Template: Template | undefined;
|
|
4498
4498
|
}
|
|
@@ -4502,25 +4502,24 @@ export interface UpdateTemplateRequest {
|
|
|
4502
4502
|
export interface UpdateTemplateResponse {
|
|
4503
4503
|
}
|
|
4504
4504
|
/**
|
|
4505
|
-
* @public
|
|
4506
4505
|
* <p>Represents a request to generate the CNAME records needed to set up Easy DKIM with
|
|
4507
4506
|
* Amazon SES. For more information about setting up Easy DKIM, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
4507
|
+
* @public
|
|
4508
4508
|
*/
|
|
4509
4509
|
export interface VerifyDomainDkimRequest {
|
|
4510
4510
|
/**
|
|
4511
|
-
* @public
|
|
4512
4511
|
* <p>The name of the domain to be verified for Easy DKIM signing.</p>
|
|
4512
|
+
* @public
|
|
4513
4513
|
*/
|
|
4514
4514
|
Domain: string | undefined;
|
|
4515
4515
|
}
|
|
4516
4516
|
/**
|
|
4517
|
-
* @public
|
|
4518
4517
|
* <p>Returns CNAME records that you must publish to the DNS server of your domain to set up
|
|
4519
4518
|
* Easy DKIM with Amazon SES.</p>
|
|
4519
|
+
* @public
|
|
4520
4520
|
*/
|
|
4521
4521
|
export interface VerifyDomainDkimResponse {
|
|
4522
4522
|
/**
|
|
4523
|
-
* @public
|
|
4524
4523
|
* <p>A set of character strings that represent the domain's identity. If the identity is an
|
|
4525
4524
|
* email address, the tokens represent the domain of that address.</p>
|
|
4526
4525
|
* <p>Using these tokens, you need to create DNS CNAME records that point to DKIM public
|
|
@@ -4529,31 +4528,31 @@ export interface VerifyDomainDkimResponse {
|
|
|
4529
4528
|
* Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to
|
|
4530
4529
|
* domain identities, not email address identities.)</p>
|
|
4531
4530
|
* <p>For more information about creating DNS records using DKIM tokens, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html">Amazon SES Developer Guide</a>.</p>
|
|
4531
|
+
* @public
|
|
4532
4532
|
*/
|
|
4533
4533
|
DkimTokens: string[] | undefined;
|
|
4534
4534
|
}
|
|
4535
4535
|
/**
|
|
4536
|
-
* @public
|
|
4537
4536
|
* <p>Represents a request to begin Amazon SES domain verification and to generate the TXT
|
|
4538
4537
|
* records that you must publish to the DNS server of your domain to complete the
|
|
4539
4538
|
* verification. For information about domain verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure">Amazon SES Developer
|
|
4540
4539
|
* Guide</a>.</p>
|
|
4540
|
+
* @public
|
|
4541
4541
|
*/
|
|
4542
4542
|
export interface VerifyDomainIdentityRequest {
|
|
4543
4543
|
/**
|
|
4544
|
-
* @public
|
|
4545
4544
|
* <p>The domain to be verified.</p>
|
|
4545
|
+
* @public
|
|
4546
4546
|
*/
|
|
4547
4547
|
Domain: string | undefined;
|
|
4548
4548
|
}
|
|
4549
4549
|
/**
|
|
4550
|
-
* @public
|
|
4551
4550
|
* <p>Returns a TXT record that you must publish to the DNS server of your domain to
|
|
4552
4551
|
* complete domain verification with Amazon SES.</p>
|
|
4552
|
+
* @public
|
|
4553
4553
|
*/
|
|
4554
4554
|
export interface VerifyDomainIdentityResponse {
|
|
4555
4555
|
/**
|
|
4556
|
-
* @public
|
|
4557
4556
|
* <p>A TXT record that you must place in the DNS settings of the domain to complete domain
|
|
4558
4557
|
* verification with Amazon SES.</p>
|
|
4559
4558
|
* <p>As Amazon SES searches for the TXT record, the domain's verification status is "Pending".
|
|
@@ -4562,38 +4561,39 @@ export interface VerifyDomainIdentityResponse {
|
|
|
4562
4561
|
* changes to "Failed." In that case, to verify the domain, you must restart the
|
|
4563
4562
|
* verification process from the beginning. The domain's verification status also changes
|
|
4564
4563
|
* to "Success" when it is DKIM verified.</p>
|
|
4564
|
+
* @public
|
|
4565
4565
|
*/
|
|
4566
4566
|
VerificationToken: string | undefined;
|
|
4567
4567
|
}
|
|
4568
4568
|
/**
|
|
4569
|
-
* @public
|
|
4570
4569
|
* <p>Represents a request to begin email address verification with Amazon SES. For information
|
|
4571
4570
|
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure">Amazon SES
|
|
4572
4571
|
* Developer Guide</a>.</p>
|
|
4572
|
+
* @public
|
|
4573
4573
|
*/
|
|
4574
4574
|
export interface VerifyEmailAddressRequest {
|
|
4575
4575
|
/**
|
|
4576
|
-
* @public
|
|
4577
4576
|
* <p>The email address to be verified.</p>
|
|
4577
|
+
* @public
|
|
4578
4578
|
*/
|
|
4579
4579
|
EmailAddress: string | undefined;
|
|
4580
4580
|
}
|
|
4581
4581
|
/**
|
|
4582
|
-
* @public
|
|
4583
4582
|
* <p>Represents a request to begin email address verification with Amazon SES. For information
|
|
4584
4583
|
* about email address verification, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure">Amazon SES
|
|
4585
4584
|
* Developer Guide</a>.</p>
|
|
4585
|
+
* @public
|
|
4586
4586
|
*/
|
|
4587
4587
|
export interface VerifyEmailIdentityRequest {
|
|
4588
4588
|
/**
|
|
4589
|
-
* @public
|
|
4590
4589
|
* <p>The email address to be verified.</p>
|
|
4590
|
+
* @public
|
|
4591
4591
|
*/
|
|
4592
4592
|
EmailAddress: string | undefined;
|
|
4593
4593
|
}
|
|
4594
4594
|
/**
|
|
4595
|
-
* @public
|
|
4596
4595
|
* <p>An empty element returned on a successful request.</p>
|
|
4596
|
+
* @public
|
|
4597
4597
|
*/
|
|
4598
4598
|
export interface VerifyEmailIdentityResponse {
|
|
4599
4599
|
}
|