UNPKG

187 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class SES extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: SES.Types.ClientConfiguration)
14 config: Config & SES.Types.ClientConfiguration;
15 /**
16 * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
17 */
18 cloneReceiptRuleSet(params: SES.Types.CloneReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request<SES.Types.CloneReceiptRuleSetResponse, AWSError>;
19 /**
20 * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
21 */
22 cloneReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request<SES.Types.CloneReceiptRuleSetResponse, AWSError>;
23 /**
24 * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
25 */
26 createConfigurationSet(params: SES.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request<SES.Types.CreateConfigurationSetResponse, AWSError>;
27 /**
28 * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
29 */
30 createConfigurationSet(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request<SES.Types.CreateConfigurationSetResponse, AWSError>;
31 /**
32 * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
33 */
34 createConfigurationSetEventDestination(params: SES.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.CreateConfigurationSetEventDestinationResponse, AWSError>;
35 /**
36 * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
37 */
38 createConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.CreateConfigurationSetEventDestinationResponse, AWSError>;
39 /**
40 * Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
41 */
42 createConfigurationSetTrackingOptions(params: SES.Types.CreateConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.CreateConfigurationSetTrackingOptionsResponse, AWSError>;
43 /**
44 * Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
45 */
46 createConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.CreateConfigurationSetTrackingOptionsResponse, AWSError>;
47 /**
48 * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
49 */
50 createCustomVerificationEmailTemplate(params: SES.Types.CreateCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
51 /**
52 * Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
53 */
54 createCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
55 /**
56 * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
57 */
58 createReceiptFilter(params: SES.Types.CreateReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request<SES.Types.CreateReceiptFilterResponse, AWSError>;
59 /**
60 * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
61 */
62 createReceiptFilter(callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request<SES.Types.CreateReceiptFilterResponse, AWSError>;
63 /**
64 * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
65 */
66 createReceiptRule(params: SES.Types.CreateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request<SES.Types.CreateReceiptRuleResponse, AWSError>;
67 /**
68 * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
69 */
70 createReceiptRule(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request<SES.Types.CreateReceiptRuleResponse, AWSError>;
71 /**
72 * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
73 */
74 createReceiptRuleSet(params: SES.Types.CreateReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request<SES.Types.CreateReceiptRuleSetResponse, AWSError>;
75 /**
76 * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
77 */
78 createReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request<SES.Types.CreateReceiptRuleSetResponse, AWSError>;
79 /**
80 * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
81 */
82 createTemplate(params: SES.Types.CreateTemplateRequest, callback?: (err: AWSError, data: SES.Types.CreateTemplateResponse) => void): Request<SES.Types.CreateTemplateResponse, AWSError>;
83 /**
84 * Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
85 */
86 createTemplate(callback?: (err: AWSError, data: SES.Types.CreateTemplateResponse) => void): Request<SES.Types.CreateTemplateResponse, AWSError>;
87 /**
88 * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
89 */
90 deleteConfigurationSet(params: SES.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request<SES.Types.DeleteConfigurationSetResponse, AWSError>;
91 /**
92 * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
93 */
94 deleteConfigurationSet(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request<SES.Types.DeleteConfigurationSetResponse, AWSError>;
95 /**
96 * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
97 */
98 deleteConfigurationSetEventDestination(params: SES.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SES.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
99 /**
100 * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
101 */
102 deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SES.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
103 /**
104 * Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
105 */
106 deleteConfigurationSetTrackingOptions(params: SES.Types.DeleteConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.DeleteConfigurationSetTrackingOptionsResponse, AWSError>;
107 /**
108 * Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
109 */
110 deleteConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.DeleteConfigurationSetTrackingOptionsResponse, AWSError>;
111 /**
112 * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
113 */
114 deleteCustomVerificationEmailTemplate(params: SES.Types.DeleteCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
115 /**
116 * Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
117 */
118 deleteCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
119 /**
120 * Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second.
121 */
122 deleteIdentity(params: SES.Types.DeleteIdentityRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request<SES.Types.DeleteIdentityResponse, AWSError>;
123 /**
124 * Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second.
125 */
126 deleteIdentity(callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request<SES.Types.DeleteIdentityResponse, AWSError>;
127 /**
128 * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
129 */
130 deleteIdentityPolicy(params: SES.Types.DeleteIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request<SES.Types.DeleteIdentityPolicyResponse, AWSError>;
131 /**
132 * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
133 */
134 deleteIdentityPolicy(callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request<SES.Types.DeleteIdentityPolicyResponse, AWSError>;
135 /**
136 * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
137 */
138 deleteReceiptFilter(params: SES.Types.DeleteReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request<SES.Types.DeleteReceiptFilterResponse, AWSError>;
139 /**
140 * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
141 */
142 deleteReceiptFilter(callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request<SES.Types.DeleteReceiptFilterResponse, AWSError>;
143 /**
144 * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
145 */
146 deleteReceiptRule(params: SES.Types.DeleteReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request<SES.Types.DeleteReceiptRuleResponse, AWSError>;
147 /**
148 * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
149 */
150 deleteReceiptRule(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request<SES.Types.DeleteReceiptRuleResponse, AWSError>;
151 /**
152 * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
153 */
154 deleteReceiptRuleSet(params: SES.Types.DeleteReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request<SES.Types.DeleteReceiptRuleSetResponse, AWSError>;
155 /**
156 * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
157 */
158 deleteReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request<SES.Types.DeleteReceiptRuleSetResponse, AWSError>;
159 /**
160 * Deletes an email template. You can execute this operation no more than once per second.
161 */
162 deleteTemplate(params: SES.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: SES.Types.DeleteTemplateResponse) => void): Request<SES.Types.DeleteTemplateResponse, AWSError>;
163 /**
164 * Deletes an email template. You can execute this operation no more than once per second.
165 */
166 deleteTemplate(callback?: (err: AWSError, data: SES.Types.DeleteTemplateResponse) => void): Request<SES.Types.DeleteTemplateResponse, AWSError>;
167 /**
168 * Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
169 */
170 deleteVerifiedEmailAddress(params: SES.Types.DeleteVerifiedEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
171 /**
172 * Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
173 */
174 deleteVerifiedEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
175 /**
176 * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
177 */
178 describeActiveReceiptRuleSet(params: SES.Types.DescribeActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request<SES.Types.DescribeActiveReceiptRuleSetResponse, AWSError>;
179 /**
180 * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
181 */
182 describeActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request<SES.Types.DescribeActiveReceiptRuleSetResponse, AWSError>;
183 /**
184 * Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
185 */
186 describeConfigurationSet(params: SES.Types.DescribeConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request<SES.Types.DescribeConfigurationSetResponse, AWSError>;
187 /**
188 * Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
189 */
190 describeConfigurationSet(callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request<SES.Types.DescribeConfigurationSetResponse, AWSError>;
191 /**
192 * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
193 */
194 describeReceiptRule(params: SES.Types.DescribeReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request<SES.Types.DescribeReceiptRuleResponse, AWSError>;
195 /**
196 * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
197 */
198 describeReceiptRule(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request<SES.Types.DescribeReceiptRuleResponse, AWSError>;
199 /**
200 * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
201 */
202 describeReceiptRuleSet(params: SES.Types.DescribeReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request<SES.Types.DescribeReceiptRuleSetResponse, AWSError>;
203 /**
204 * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
205 */
206 describeReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request<SES.Types.DescribeReceiptRuleSetResponse, AWSError>;
207 /**
208 * Returns the email sending status of the Amazon SES account for the current region. You can execute this operation no more than once per second.
209 */
210 getAccountSendingEnabled(callback?: (err: AWSError, data: SES.Types.GetAccountSendingEnabledResponse) => void): Request<SES.Types.GetAccountSendingEnabledResponse, AWSError>;
211 /**
212 * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
213 */
214 getCustomVerificationEmailTemplate(params: SES.Types.GetCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: SES.Types.GetCustomVerificationEmailTemplateResponse) => void): Request<SES.Types.GetCustomVerificationEmailTemplateResponse, AWSError>;
215 /**
216 * Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
217 */
218 getCustomVerificationEmailTemplate(callback?: (err: AWSError, data: SES.Types.GetCustomVerificationEmailTemplateResponse) => void): Request<SES.Types.GetCustomVerificationEmailTemplateResponse, AWSError>;
219 /**
220 * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
221 */
222 getIdentityDkimAttributes(params: SES.Types.GetIdentityDkimAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request<SES.Types.GetIdentityDkimAttributesResponse, AWSError>;
223 /**
224 * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
225 */
226 getIdentityDkimAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request<SES.Types.GetIdentityDkimAttributesResponse, AWSError>;
227 /**
228 * Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
229 */
230 getIdentityMailFromDomainAttributes(params: SES.Types.GetIdentityMailFromDomainAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request<SES.Types.GetIdentityMailFromDomainAttributesResponse, AWSError>;
231 /**
232 * Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
233 */
234 getIdentityMailFromDomainAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request<SES.Types.GetIdentityMailFromDomainAttributesResponse, AWSError>;
235 /**
236 * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
237 */
238 getIdentityNotificationAttributes(params: SES.Types.GetIdentityNotificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request<SES.Types.GetIdentityNotificationAttributesResponse, AWSError>;
239 /**
240 * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
241 */
242 getIdentityNotificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request<SES.Types.GetIdentityNotificationAttributesResponse, AWSError>;
243 /**
244 * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
245 */
246 getIdentityPolicies(params: SES.Types.GetIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request<SES.Types.GetIdentityPoliciesResponse, AWSError>;
247 /**
248 * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
249 */
250 getIdentityPolicies(callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request<SES.Types.GetIdentityPoliciesResponse, AWSError>;
251 /**
252 * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
253 */
254 getIdentityVerificationAttributes(params: SES.Types.GetIdentityVerificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>;
255 /**
256 * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
257 */
258 getIdentityVerificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>;
259 /**
260 * Provides the sending limits for the Amazon SES account. You can execute this operation no more than once per second.
261 */
262 getSendQuota(callback?: (err: AWSError, data: SES.Types.GetSendQuotaResponse) => void): Request<SES.Types.GetSendQuotaResponse, AWSError>;
263 /**
264 * Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time. You can execute this operation no more than once per second.
265 */
266 getSendStatistics(callback?: (err: AWSError, data: SES.Types.GetSendStatisticsResponse) => void): Request<SES.Types.GetSendStatisticsResponse, AWSError>;
267 /**
268 * Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second.
269 */
270 getTemplate(params: SES.Types.GetTemplateRequest, callback?: (err: AWSError, data: SES.Types.GetTemplateResponse) => void): Request<SES.Types.GetTemplateResponse, AWSError>;
271 /**
272 * Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second.
273 */
274 getTemplate(callback?: (err: AWSError, data: SES.Types.GetTemplateResponse) => void): Request<SES.Types.GetTemplateResponse, AWSError>;
275 /**
276 * Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
277 */
278 listConfigurationSets(params: SES.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request<SES.Types.ListConfigurationSetsResponse, AWSError>;
279 /**
280 * Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
281 */
282 listConfigurationSets(callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request<SES.Types.ListConfigurationSetsResponse, AWSError>;
283 /**
284 * Lists the existing custom verification email templates for your account in the current AWS Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
285 */
286 listCustomVerificationEmailTemplates(params: SES.Types.ListCustomVerificationEmailTemplatesRequest, callback?: (err: AWSError, data: SES.Types.ListCustomVerificationEmailTemplatesResponse) => void): Request<SES.Types.ListCustomVerificationEmailTemplatesResponse, AWSError>;
287 /**
288 * Lists the existing custom verification email templates for your account in the current AWS Region. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
289 */
290 listCustomVerificationEmailTemplates(callback?: (err: AWSError, data: SES.Types.ListCustomVerificationEmailTemplatesResponse) => void): Request<SES.Types.ListCustomVerificationEmailTemplatesResponse, AWSError>;
291 /**
292 * Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status. You can execute this operation no more than once per second.
293 */
294 listIdentities(params: SES.Types.ListIdentitiesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request<SES.Types.ListIdentitiesResponse, AWSError>;
295 /**
296 * Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status. You can execute this operation no more than once per second.
297 */
298 listIdentities(callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request<SES.Types.ListIdentitiesResponse, AWSError>;
299 /**
300 * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
301 */
302 listIdentityPolicies(params: SES.Types.ListIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request<SES.Types.ListIdentityPoliciesResponse, AWSError>;
303 /**
304 * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
305 */
306 listIdentityPolicies(callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request<SES.Types.ListIdentityPoliciesResponse, AWSError>;
307 /**
308 * Lists the IP address filters associated with your AWS account in the current AWS Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
309 */
310 listReceiptFilters(params: SES.Types.ListReceiptFiltersRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request<SES.Types.ListReceiptFiltersResponse, AWSError>;
311 /**
312 * Lists the IP address filters associated with your AWS account in the current AWS Region. For information about managing IP address filters, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
313 */
314 listReceiptFilters(callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request<SES.Types.ListReceiptFiltersResponse, AWSError>;
315 /**
316 * Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
317 */
318 listReceiptRuleSets(params: SES.Types.ListReceiptRuleSetsRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request<SES.Types.ListReceiptRuleSetsResponse, AWSError>;
319 /**
320 * Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
321 */
322 listReceiptRuleSets(callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request<SES.Types.ListReceiptRuleSetsResponse, AWSError>;
323 /**
324 * Lists the email templates present in your Amazon SES account in the current AWS Region. You can execute this operation no more than once per second.
325 */
326 listTemplates(params: SES.Types.ListTemplatesRequest, callback?: (err: AWSError, data: SES.Types.ListTemplatesResponse) => void): Request<SES.Types.ListTemplatesResponse, AWSError>;
327 /**
328 * Lists the email templates present in your Amazon SES account in the current AWS Region. You can execute this operation no more than once per second.
329 */
330 listTemplates(callback?: (err: AWSError, data: SES.Types.ListTemplatesResponse) => void): Request<SES.Types.ListTemplatesResponse, AWSError>;
331 /**
332 * Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
333 */
334 listVerifiedEmailAddresses(callback?: (err: AWSError, data: SES.Types.ListVerifiedEmailAddressesResponse) => void): Request<SES.Types.ListVerifiedEmailAddressesResponse, AWSError>;
335 /**
336 * Adds or updates the delivery options for a configuration set.
337 */
338 putConfigurationSetDeliveryOptions(params: SES.Types.PutConfigurationSetDeliveryOptionsRequest, callback?: (err: AWSError, data: SES.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<SES.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
339 /**
340 * Adds or updates the delivery options for a configuration set.
341 */
342 putConfigurationSetDeliveryOptions(callback?: (err: AWSError, data: SES.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<SES.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
343 /**
344 * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
345 */
346 putIdentityPolicy(params: SES.Types.PutIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request<SES.Types.PutIdentityPolicyResponse, AWSError>;
347 /**
348 * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
349 */
350 putIdentityPolicy(callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request<SES.Types.PutIdentityPolicyResponse, AWSError>;
351 /**
352 * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
353 */
354 reorderReceiptRuleSet(params: SES.Types.ReorderReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request<SES.Types.ReorderReceiptRuleSetResponse, AWSError>;
355 /**
356 * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
357 */
358 reorderReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request<SES.Types.ReorderReceiptRuleSetResponse, AWSError>;
359 /**
360 * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
361 */
362 sendBounce(params: SES.Types.SendBounceRequest, callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request<SES.Types.SendBounceResponse, AWSError>;
363 /**
364 * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
365 */
366 sendBounce(callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request<SES.Types.SendBounceResponse, AWSError>;
367 /**
368 * Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group. The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.
369 */
370 sendBulkTemplatedEmail(params: SES.Types.SendBulkTemplatedEmailRequest, callback?: (err: AWSError, data: SES.Types.SendBulkTemplatedEmailResponse) => void): Request<SES.Types.SendBulkTemplatedEmailResponse, AWSError>;
371 /**
372 * Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group. The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.
373 */
374 sendBulkTemplatedEmail(callback?: (err: AWSError, data: SES.Types.SendBulkTemplatedEmailResponse) => void): Request<SES.Types.SendBulkTemplatedEmailResponse, AWSError>;
375 /**
376 * Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
377 */
378 sendCustomVerificationEmail(params: SES.Types.SendCustomVerificationEmailRequest, callback?: (err: AWSError, data: SES.Types.SendCustomVerificationEmailResponse) => void): Request<SES.Types.SendCustomVerificationEmailResponse, AWSError>;
379 /**
380 * Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
381 */
382 sendCustomVerificationEmail(callback?: (err: AWSError, data: SES.Types.SendCustomVerificationEmailResponse) => void): Request<SES.Types.SendCustomVerificationEmailResponse, AWSError>;
383 /**
384 * Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements: The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
385 */
386 sendEmail(params: SES.Types.SendEmailRequest, callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request<SES.Types.SendEmailResponse, AWSError>;
387 /**
388 * Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements: The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
389 */
390 sendEmail(callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request<SES.Types.SendEmailResponse, AWSError>;
391 /**
392 * Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments. The SendRawEmail operation has the following requirements: You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator. The maximum message size, including attachments, is 10 MB. Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines. If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid. Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group. Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. Additionally, keep the following considerations in mind when using the SendRawEmail operation: Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email. If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
393 */
394 sendRawEmail(params: SES.Types.SendRawEmailRequest, callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request<SES.Types.SendRawEmailResponse, AWSError>;
395 /**
396 * Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments. The SendRawEmail operation has the following requirements: You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator. The maximum message size, including attachments, is 10 MB. Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines. If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid. Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group. Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide. Additionally, keep the following considerations in mind when using the SendRawEmail operation: Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email. If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
397 */
398 sendRawEmail(callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request<SES.Types.SendRawEmailResponse, AWSError>;
399 /**
400 * Composes an email message using an email template and immediately queues it for sending. In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
401 */
402 sendTemplatedEmail(params: SES.Types.SendTemplatedEmailRequest, callback?: (err: AWSError, data: SES.Types.SendTemplatedEmailResponse) => void): Request<SES.Types.SendTemplatedEmailResponse, AWSError>;
403 /**
404 * Composes an email message using an email template and immediately queues it for sending. In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements: The call must refer to an existing email template. You can create email templates using the CreateTemplate operation. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. The maximum message size is 10 MB. Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid. If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
405 */
406 sendTemplatedEmail(callback?: (err: AWSError, data: SES.Types.SendTemplatedEmailResponse) => void): Request<SES.Types.SendTemplatedEmailResponse, AWSError>;
407 /**
408 * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
409 */
410 setActiveReceiptRuleSet(params: SES.Types.SetActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request<SES.Types.SetActiveReceiptRuleSetResponse, AWSError>;
411 /**
412 * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
413 */
414 setActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request<SES.Types.SetActiveReceiptRuleSetResponse, AWSError>;
415 /**
416 * Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
417 */
418 setIdentityDkimEnabled(params: SES.Types.SetIdentityDkimEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request<SES.Types.SetIdentityDkimEnabledResponse, AWSError>;
419 /**
420 * Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address. For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
421 */
422 setIdentityDkimEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request<SES.Types.SetIdentityDkimEnabledResponse, AWSError>;
423 /**
424 * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
425 */
426 setIdentityFeedbackForwardingEnabled(params: SES.Types.SetIdentityFeedbackForwardingEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request<SES.Types.SetIdentityFeedbackForwardingEnabledResponse, AWSError>;
427 /**
428 * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
429 */
430 setIdentityFeedbackForwardingEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request<SES.Types.SetIdentityFeedbackForwardingEnabledResponse, AWSError>;
431 /**
432 * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
433 */
434 setIdentityHeadersInNotificationsEnabled(params: SES.Types.SetIdentityHeadersInNotificationsEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request<SES.Types.SetIdentityHeadersInNotificationsEnabledResponse, AWSError>;
435 /**
436 * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
437 */
438 setIdentityHeadersInNotificationsEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request<SES.Types.SetIdentityHeadersInNotificationsEnabledResponse, AWSError>;
439 /**
440 * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
441 */
442 setIdentityMailFromDomain(params: SES.Types.SetIdentityMailFromDomainRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request<SES.Types.SetIdentityMailFromDomainResponse, AWSError>;
443 /**
444 * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
445 */
446 setIdentityMailFromDomain(callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request<SES.Types.SetIdentityMailFromDomainResponse, AWSError>;
447 /**
448 * Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide.
449 */
450 setIdentityNotificationTopic(params: SES.Types.SetIdentityNotificationTopicRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request<SES.Types.SetIdentityNotificationTopicResponse, AWSError>;
451 /**
452 * Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify. You can execute this operation no more than once per second. For more information about feedback notification, see the Amazon SES Developer Guide.
453 */
454 setIdentityNotificationTopic(callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request<SES.Types.SetIdentityNotificationTopicResponse, AWSError>;
455 /**
456 * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
457 */
458 setReceiptRulePosition(params: SES.Types.SetReceiptRulePositionRequest, callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request<SES.Types.SetReceiptRulePositionResponse, AWSError>;
459 /**
460 * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
461 */
462 setReceiptRulePosition(callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request<SES.Types.SetReceiptRulePositionResponse, AWSError>;
463 /**
464 * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second.
465 */
466 testRenderTemplate(params: SES.Types.TestRenderTemplateRequest, callback?: (err: AWSError, data: SES.Types.TestRenderTemplateResponse) => void): Request<SES.Types.TestRenderTemplateResponse, AWSError>;
467 /**
468 * Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second.
469 */
470 testRenderTemplate(callback?: (err: AWSError, data: SES.Types.TestRenderTemplateResponse) => void): Request<SES.Types.TestRenderTemplateResponse, AWSError>;
471 /**
472 * Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds. You can execute this operation no more than once per second.
473 */
474 updateAccountSendingEnabled(params: SES.Types.UpdateAccountSendingEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
475 /**
476 * Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds. You can execute this operation no more than once per second.
477 */
478 updateAccountSendingEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
479 /**
480 * Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second.
481 */
482 updateConfigurationSetEventDestination(params: SES.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
483 /**
484 * Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second.
485 */
486 updateConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
487 /**
488 * Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second.
489 */
490 updateConfigurationSetReputationMetricsEnabled(params: SES.Types.UpdateConfigurationSetReputationMetricsEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
491 /**
492 * Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds. You can execute this operation no more than once per second.
493 */
494 updateConfigurationSetReputationMetricsEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
495 /**
496 * Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second.
497 */
498 updateConfigurationSetSendingEnabled(params: SES.Types.UpdateConfigurationSetSendingEnabledRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
499 /**
500 * Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds. You can execute this operation no more than once per second.
501 */
502 updateConfigurationSetSendingEnabled(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
503 /**
504 * Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
505 */
506 updateConfigurationSetTrackingOptions(params: SES.Types.UpdateConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.UpdateConfigurationSetTrackingOptionsResponse, AWSError>;
507 /**
508 * Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
509 */
510 updateConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetTrackingOptionsResponse) => void): Request<SES.Types.UpdateConfigurationSetTrackingOptionsResponse, AWSError>;
511 /**
512 * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
513 */
514 updateCustomVerificationEmailTemplate(params: SES.Types.UpdateCustomVerificationEmailTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
515 /**
516 * Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
517 */
518 updateCustomVerificationEmailTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
519 /**
520 * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
521 */
522 updateReceiptRule(params: SES.Types.UpdateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request<SES.Types.UpdateReceiptRuleResponse, AWSError>;
523 /**
524 * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
525 */
526 updateReceiptRule(callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request<SES.Types.UpdateReceiptRuleResponse, AWSError>;
527 /**
528 * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
529 */
530 updateTemplate(params: SES.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: SES.Types.UpdateTemplateResponse) => void): Request<SES.Types.UpdateTemplateResponse, AWSError>;
531 /**
532 * Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.
533 */
534 updateTemplate(callback?: (err: AWSError, data: SES.Types.UpdateTemplateResponse) => void): Request<SES.Types.UpdateTemplateResponse, AWSError>;
535 /**
536 * Returns a set of DKIM tokens for a domain identity. When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it. You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM. To create the CNAME records for DKIM authentication, use the following values: Name: token._domainkey.example.com Type: CNAME Value: token.dkim.amazonses.com In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation. You can execute this operation no more than once per second.
537 */
538 verifyDomainDkim(params: SES.Types.VerifyDomainDkimRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request<SES.Types.VerifyDomainDkimResponse, AWSError>;
539 /**
540 * Returns a set of DKIM tokens for a domain identity. When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it. You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM. To create the CNAME records for DKIM authentication, use the following values: Name: token._domainkey.example.com Type: CNAME Value: token.dkim.amazonses.com In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation. You can execute this operation no more than once per second.
541 */
542 verifyDomainDkim(callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request<SES.Types.VerifyDomainDkimResponse, AWSError>;
543 /**
544 * Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
545 */
546 verifyDomainIdentity(params: SES.Types.VerifyDomainIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request<SES.Types.VerifyDomainIdentityResponse, AWSError>;
547 /**
548 * Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You can execute this operation no more than once per second.
549 */
550 verifyDomainIdentity(callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request<SES.Types.VerifyDomainIdentityResponse, AWSError>;
551 /**
552 * Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
553 */
554 verifyEmailAddress(params: SES.Types.VerifyEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
555 /**
556 * Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
557 */
558 verifyEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
559 /**
560 * Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address. You can execute this operation no more than once per second.
561 */
562 verifyEmailIdentity(params: SES.Types.VerifyEmailIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request<SES.Types.VerifyEmailIdentityResponse, AWSError>;
563 /**
564 * Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address. You can execute this operation no more than once per second.
565 */
566 verifyEmailIdentity(callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request<SES.Types.VerifyEmailIdentityResponse, AWSError>;
567 /**
568 * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times).
569 */
570 waitFor(state: "identityExists", params: SES.Types.GetIdentityVerificationAttributesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>;
571 /**
572 * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times).
573 */
574 waitFor(state: "identityExists", callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>;
575}
576declare namespace SES {
577 export interface AddHeaderAction {
578 /**
579 * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
580 */
581 HeaderName: HeaderName;
582 /**
583 * Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
584 */
585 HeaderValue: HeaderValue;
586 }
587 export type Address = string;
588 export type AddressList = Address[];
589 export type AmazonResourceName = string;
590 export type ArrivalDate = Date;
591 export type BehaviorOnMXFailure = "UseDefaultValue"|"RejectMessage"|string;
592 export interface Body {
593 /**
594 * The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
595 */
596 Text?: Content;
597 /**
598 * The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
599 */
600 Html?: Content;
601 }
602 export interface BounceAction {
603 /**
604 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
605 */
606 TopicArn?: AmazonResourceName;
607 /**
608 * The SMTP reply code, as defined by RFC 5321.
609 */
610 SmtpReplyCode: BounceSmtpReplyCode;
611 /**
612 * The SMTP enhanced status code, as defined by RFC 3463.
613 */
614 StatusCode?: BounceStatusCode;
615 /**
616 * Human-readable text to include in the bounce message.
617 */
618 Message: BounceMessage;
619 /**
620 * The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
621 */
622 Sender: Address;
623 }
624 export type BounceMessage = string;
625 export type BounceSmtpReplyCode = string;
626 export type BounceStatusCode = string;
627 export type BounceType = "DoesNotExist"|"MessageTooLarge"|"ExceededQuota"|"ContentRejected"|"Undefined"|"TemporaryFailure"|string;
628 export interface BouncedRecipientInfo {
629 /**
630 * The email address of the recipient of the bounced email.
631 */
632 Recipient: Address;
633 /**
634 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
635 */
636 RecipientArn?: AmazonResourceName;
637 /**
638 * The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
639 */
640 BounceType?: BounceType;
641 /**
642 * Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.
643 */
644 RecipientDsnFields?: RecipientDsnFields;
645 }
646 export type BouncedRecipientInfoList = BouncedRecipientInfo[];
647 export interface BulkEmailDestination {
648 Destination: Destination;
649 /**
650 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
651 */
652 ReplacementTags?: MessageTagList;
653 /**
654 * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
655 */
656 ReplacementTemplateData?: TemplateData;
657 }
658 export type BulkEmailDestinationList = BulkEmailDestination[];
659 export interface BulkEmailDestinationStatus {
660 /**
661 * The status of a message sent using the SendBulkTemplatedEmail operation. Possible values for this parameter include: Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients. MessageRejected: The message was rejected because it contained a virus. MailFromDomainNotVerified: The sender's email address or domain was not verified. ConfigurationSetDoesNotExist: The configuration set you specified does not exist. TemplateDoesNotExist: The template you specified does not exist. AccountSuspended: Your account has been shut down because of issues related to your email sending practices. AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit. AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period. InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist. AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation. ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation. InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information. TransientFailure: Amazon SES was unable to process your request because of a temporary issue. Failed: Amazon SES was unable to process your request. See the error message for additional information.
662 */
663 Status?: BulkEmailStatus;
664 /**
665 * A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.
666 */
667 Error?: Error;
668 /**
669 * The unique message identifier returned from the SendBulkTemplatedEmail operation.
670 */
671 MessageId?: MessageId;
672 }
673 export type BulkEmailDestinationStatusList = BulkEmailDestinationStatus[];
674 export type BulkEmailStatus = "Success"|"MessageRejected"|"MailFromDomainNotVerified"|"ConfigurationSetDoesNotExist"|"TemplateDoesNotExist"|"AccountSuspended"|"AccountThrottled"|"AccountDailyQuotaExceeded"|"InvalidSendingPoolName"|"AccountSendingPaused"|"ConfigurationSetSendingPaused"|"InvalidParameterValue"|"TransientFailure"|"Failed"|string;
675 export type Charset = string;
676 export type Cidr = string;
677 export interface CloneReceiptRuleSetRequest {
678 /**
679 * The name of the rule set to create. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters.
680 */
681 RuleSetName: ReceiptRuleSetName;
682 /**
683 * The name of the rule set to clone.
684 */
685 OriginalRuleSetName: ReceiptRuleSetName;
686 }
687 export interface CloneReceiptRuleSetResponse {
688 }
689 export interface CloudWatchDestination {
690 /**
691 * A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
692 */
693 DimensionConfigurations: CloudWatchDimensionConfigurations;
694 }
695 export interface CloudWatchDimensionConfiguration {
696 /**
697 * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters.
698 */
699 DimensionName: DimensionName;
700 /**
701 * The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.
702 */
703 DimensionValueSource: DimensionValueSource;
704 /**
705 * The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters.
706 */
707 DefaultDimensionValue: DefaultDimensionValue;
708 }
709 export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[];
710 export interface ConfigurationSet {
711 /**
712 * The name of the configuration set. The name must meet the following requirements: Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain 64 characters or fewer.
713 */
714 Name: ConfigurationSetName;
715 }
716 export type ConfigurationSetAttribute = "eventDestinations"|"trackingOptions"|"deliveryOptions"|"reputationOptions"|string;
717 export type ConfigurationSetAttributeList = ConfigurationSetAttribute[];
718 export type ConfigurationSetName = string;
719 export type ConfigurationSets = ConfigurationSet[];
720 export interface Content {
721 /**
722 * The textual data of the content.
723 */
724 Data: MessageData;
725 /**
726 * The character set of the content.
727 */
728 Charset?: Charset;
729 }
730 export type Counter = number;
731 export interface CreateConfigurationSetEventDestinationRequest {
732 /**
733 * The name of the configuration set that the event destination should be associated with.
734 */
735 ConfigurationSetName: ConfigurationSetName;
736 /**
737 * An object that describes the AWS service that email sending event information will be published to.
738 */
739 EventDestination: EventDestination;
740 }
741 export interface CreateConfigurationSetEventDestinationResponse {
742 }
743 export interface CreateConfigurationSetRequest {
744 /**
745 * A data structure that contains the name of the configuration set.
746 */
747 ConfigurationSet: ConfigurationSet;
748 }
749 export interface CreateConfigurationSetResponse {
750 }
751 export interface CreateConfigurationSetTrackingOptionsRequest {
752 /**
753 * The name of the configuration set that the tracking options should be associated with.
754 */
755 ConfigurationSetName: ConfigurationSetName;
756 TrackingOptions: TrackingOptions;
757 }
758 export interface CreateConfigurationSetTrackingOptionsResponse {
759 }
760 export interface CreateCustomVerificationEmailTemplateRequest {
761 /**
762 * The name of the custom verification email template.
763 */
764 TemplateName: TemplateName;
765 /**
766 * The email address that the custom verification email is sent from.
767 */
768 FromEmailAddress: FromAddress;
769 /**
770 * The subject line of the custom verification email.
771 */
772 TemplateSubject: Subject;
773 /**
774 * The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
775 */
776 TemplateContent: TemplateContent;
777 /**
778 * The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
779 */
780 SuccessRedirectionURL: SuccessRedirectionURL;
781 /**
782 * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
783 */
784 FailureRedirectionURL: FailureRedirectionURL;
785 }
786 export interface CreateReceiptFilterRequest {
787 /**
788 * A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
789 */
790 Filter: ReceiptFilter;
791 }
792 export interface CreateReceiptFilterResponse {
793 }
794 export interface CreateReceiptRuleRequest {
795 /**
796 * The name of the rule set that the receipt rule will be added to.
797 */
798 RuleSetName: ReceiptRuleSetName;
799 /**
800 * The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
801 */
802 After?: ReceiptRuleName;
803 /**
804 * A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
805 */
806 Rule: ReceiptRule;
807 }
808 export interface CreateReceiptRuleResponse {
809 }
810 export interface CreateReceiptRuleSetRequest {
811 /**
812 * The name of the rule set to create. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters.
813 */
814 RuleSetName: ReceiptRuleSetName;
815 }
816 export interface CreateReceiptRuleSetResponse {
817 }
818 export interface CreateTemplateRequest {
819 /**
820 * The content of the email, composed of a subject line, an HTML part, and a text-only part.
821 */
822 Template: Template;
823 }
824 export interface CreateTemplateResponse {
825 }
826 export type CustomMailFromStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|string;
827 export type CustomRedirectDomain = string;
828 export interface CustomVerificationEmailTemplate {
829 /**
830 * The name of the custom verification email template.
831 */
832 TemplateName?: TemplateName;
833 /**
834 * The email address that the custom verification email is sent from.
835 */
836 FromEmailAddress?: FromAddress;
837 /**
838 * The subject line of the custom verification email.
839 */
840 TemplateSubject?: Subject;
841 /**
842 * The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
843 */
844 SuccessRedirectionURL?: SuccessRedirectionURL;
845 /**
846 * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
847 */
848 FailureRedirectionURL?: FailureRedirectionURL;
849 }
850 export type CustomVerificationEmailTemplates = CustomVerificationEmailTemplate[];
851 export type DefaultDimensionValue = string;
852 export interface DeleteConfigurationSetEventDestinationRequest {
853 /**
854 * The name of the configuration set from which to delete the event destination.
855 */
856 ConfigurationSetName: ConfigurationSetName;
857 /**
858 * The name of the event destination to delete.
859 */
860 EventDestinationName: EventDestinationName;
861 }
862 export interface DeleteConfigurationSetEventDestinationResponse {
863 }
864 export interface DeleteConfigurationSetRequest {
865 /**
866 * The name of the configuration set to delete.
867 */
868 ConfigurationSetName: ConfigurationSetName;
869 }
870 export interface DeleteConfigurationSetResponse {
871 }
872 export interface DeleteConfigurationSetTrackingOptionsRequest {
873 /**
874 * The name of the configuration set from which you want to delete the tracking options.
875 */
876 ConfigurationSetName: ConfigurationSetName;
877 }
878 export interface DeleteConfigurationSetTrackingOptionsResponse {
879 }
880 export interface DeleteCustomVerificationEmailTemplateRequest {
881 /**
882 * The name of the custom verification email template that you want to delete.
883 */
884 TemplateName: TemplateName;
885 }
886 export interface DeleteIdentityPolicyRequest {
887 /**
888 * The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity.
889 */
890 Identity: Identity;
891 /**
892 * The name of the policy to be deleted.
893 */
894 PolicyName: PolicyName;
895 }
896 export interface DeleteIdentityPolicyResponse {
897 }
898 export interface DeleteIdentityRequest {
899 /**
900 * The identity to be removed from the list of identities for the AWS Account.
901 */
902 Identity: Identity;
903 }
904 export interface DeleteIdentityResponse {
905 }
906 export interface DeleteReceiptFilterRequest {
907 /**
908 * The name of the IP address filter to delete.
909 */
910 FilterName: ReceiptFilterName;
911 }
912 export interface DeleteReceiptFilterResponse {
913 }
914 export interface DeleteReceiptRuleRequest {
915 /**
916 * The name of the receipt rule set that contains the receipt rule to delete.
917 */
918 RuleSetName: ReceiptRuleSetName;
919 /**
920 * The name of the receipt rule to delete.
921 */
922 RuleName: ReceiptRuleName;
923 }
924 export interface DeleteReceiptRuleResponse {
925 }
926 export interface DeleteReceiptRuleSetRequest {
927 /**
928 * The name of the receipt rule set to delete.
929 */
930 RuleSetName: ReceiptRuleSetName;
931 }
932 export interface DeleteReceiptRuleSetResponse {
933 }
934 export interface DeleteTemplateRequest {
935 /**
936 * The name of the template to be deleted.
937 */
938 TemplateName: TemplateName;
939 }
940 export interface DeleteTemplateResponse {
941 }
942 export interface DeleteVerifiedEmailAddressRequest {
943 /**
944 * An email address to be removed from the list of verified addresses.
945 */
946 EmailAddress: Address;
947 }
948 export interface DeliveryOptions {
949 /**
950 * Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
951 */
952 TlsPolicy?: TlsPolicy;
953 }
954 export interface DescribeActiveReceiptRuleSetRequest {
955 }
956 export interface DescribeActiveReceiptRuleSetResponse {
957 /**
958 * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
959 */
960 Metadata?: ReceiptRuleSetMetadata;
961 /**
962 * The receipt rules that belong to the active rule set.
963 */
964 Rules?: ReceiptRulesList;
965 }
966 export interface DescribeConfigurationSetRequest {
967 /**
968 * The name of the configuration set to describe.
969 */
970 ConfigurationSetName: ConfigurationSetName;
971 /**
972 * A list of configuration set attributes to return.
973 */
974 ConfigurationSetAttributeNames?: ConfigurationSetAttributeList;
975 }
976 export interface DescribeConfigurationSetResponse {
977 /**
978 * The configuration set object associated with the specified configuration set.
979 */
980 ConfigurationSet?: ConfigurationSet;
981 /**
982 * A list of event destinations associated with the configuration set.
983 */
984 EventDestinations?: EventDestinations;
985 /**
986 * The name of the custom open and click tracking domain associated with the configuration set.
987 */
988 TrackingOptions?: TrackingOptions;
989 DeliveryOptions?: DeliveryOptions;
990 /**
991 * An object that represents the reputation settings for the configuration set.
992 */
993 ReputationOptions?: ReputationOptions;
994 }
995 export interface DescribeReceiptRuleRequest {
996 /**
997 * The name of the receipt rule set that the receipt rule belongs to.
998 */
999 RuleSetName: ReceiptRuleSetName;
1000 /**
1001 * The name of the receipt rule.
1002 */
1003 RuleName: ReceiptRuleName;
1004 }
1005 export interface DescribeReceiptRuleResponse {
1006 /**
1007 * A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
1008 */
1009 Rule?: ReceiptRule;
1010 }
1011 export interface DescribeReceiptRuleSetRequest {
1012 /**
1013 * The name of the receipt rule set to describe.
1014 */
1015 RuleSetName: ReceiptRuleSetName;
1016 }
1017 export interface DescribeReceiptRuleSetResponse {
1018 /**
1019 * The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
1020 */
1021 Metadata?: ReceiptRuleSetMetadata;
1022 /**
1023 * A list of the receipt rules that belong to the specified receipt rule set.
1024 */
1025 Rules?: ReceiptRulesList;
1026 }
1027 export interface Destination {
1028 /**
1029 * The recipients to place on the To: line of the message.
1030 */
1031 ToAddresses?: AddressList;
1032 /**
1033 * The recipients to place on the CC: line of the message.
1034 */
1035 CcAddresses?: AddressList;
1036 /**
1037 * The recipients to place on the BCC: line of the message.
1038 */
1039 BccAddresses?: AddressList;
1040 }
1041 export type DiagnosticCode = string;
1042 export type DimensionName = string;
1043 export type DimensionValueSource = "messageTag"|"emailHeader"|"linkTag"|string;
1044 export type DkimAttributes = {[key: string]: IdentityDkimAttributes};
1045 export type Domain = string;
1046 export type DsnAction = "failed"|"delayed"|"delivered"|"relayed"|"expanded"|string;
1047 export type DsnStatus = string;
1048 export type Enabled = boolean;
1049 export type Error = string;
1050 export interface EventDestination {
1051 /**
1052 * The name of the event destination. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 64 characters.
1053 */
1054 Name: EventDestinationName;
1055 /**
1056 * Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.
1057 */
1058 Enabled?: Enabled;
1059 /**
1060 * The type of email sending events to publish to the event destination.
1061 */
1062 MatchingEventTypes: EventTypes;
1063 /**
1064 * An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
1065 */
1066 KinesisFirehoseDestination?: KinesisFirehoseDestination;
1067 /**
1068 * An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
1069 */
1070 CloudWatchDestination?: CloudWatchDestination;
1071 /**
1072 * An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
1073 */
1074 SNSDestination?: SNSDestination;
1075 }
1076 export type EventDestinationName = string;
1077 export type EventDestinations = EventDestination[];
1078 export type EventType = "send"|"reject"|"bounce"|"complaint"|"delivery"|"open"|"click"|"renderingFailure"|string;
1079 export type EventTypes = EventType[];
1080 export type Explanation = string;
1081 export interface ExtensionField {
1082 /**
1083 * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
1084 */
1085 Name: ExtensionFieldName;
1086 /**
1087 * The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
1088 */
1089 Value: ExtensionFieldValue;
1090 }
1091 export type ExtensionFieldList = ExtensionField[];
1092 export type ExtensionFieldName = string;
1093 export type ExtensionFieldValue = string;
1094 export type FailureRedirectionURL = string;
1095 export type FromAddress = string;
1096 export interface GetAccountSendingEnabledResponse {
1097 /**
1098 * Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
1099 */
1100 Enabled?: Enabled;
1101 }
1102 export interface GetCustomVerificationEmailTemplateRequest {
1103 /**
1104 * The name of the custom verification email template that you want to retrieve.
1105 */
1106 TemplateName: TemplateName;
1107 }
1108 export interface GetCustomVerificationEmailTemplateResponse {
1109 /**
1110 * The name of the custom verification email template.
1111 */
1112 TemplateName?: TemplateName;
1113 /**
1114 * The email address that the custom verification email is sent from.
1115 */
1116 FromEmailAddress?: FromAddress;
1117 /**
1118 * The subject line of the custom verification email.
1119 */
1120 TemplateSubject?: Subject;
1121 /**
1122 * The content of the custom verification email.
1123 */
1124 TemplateContent?: TemplateContent;
1125 /**
1126 * The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
1127 */
1128 SuccessRedirectionURL?: SuccessRedirectionURL;
1129 /**
1130 * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
1131 */
1132 FailureRedirectionURL?: FailureRedirectionURL;
1133 }
1134 export interface GetIdentityDkimAttributesRequest {
1135 /**
1136 * A list of one or more verified identities - email addresses, domains, or both.
1137 */
1138 Identities: IdentityList;
1139 }
1140 export interface GetIdentityDkimAttributesResponse {
1141 /**
1142 * The DKIM attributes for an email address or a domain.
1143 */
1144 DkimAttributes: DkimAttributes;
1145 }
1146 export interface GetIdentityMailFromDomainAttributesRequest {
1147 /**
1148 * A list of one or more identities.
1149 */
1150 Identities: IdentityList;
1151 }
1152 export interface GetIdentityMailFromDomainAttributesResponse {
1153 /**
1154 * A map of identities to custom MAIL FROM attributes.
1155 */
1156 MailFromDomainAttributes: MailFromDomainAttributes;
1157 }
1158 export interface GetIdentityNotificationAttributesRequest {
1159 /**
1160 * A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
1161 */
1162 Identities: IdentityList;
1163 }
1164 export interface GetIdentityNotificationAttributesResponse {
1165 /**
1166 * A map of Identity to IdentityNotificationAttributes.
1167 */
1168 NotificationAttributes: NotificationAttributes;
1169 }
1170 export interface GetIdentityPoliciesRequest {
1171 /**
1172 * The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity.
1173 */
1174 Identity: Identity;
1175 /**
1176 * A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.
1177 */
1178 PolicyNames: PolicyNameList;
1179 }
1180 export interface GetIdentityPoliciesResponse {
1181 /**
1182 * A map of policy names to policies.
1183 */
1184 Policies: PolicyMap;
1185 }
1186 export interface GetIdentityVerificationAttributesRequest {
1187 /**
1188 * A list of identities.
1189 */
1190 Identities: IdentityList;
1191 }
1192 export interface GetIdentityVerificationAttributesResponse {
1193 /**
1194 * A map of Identities to IdentityVerificationAttributes objects.
1195 */
1196 VerificationAttributes: VerificationAttributes;
1197 }
1198 export interface GetSendQuotaResponse {
1199 /**
1200 * The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
1201 */
1202 Max24HourSend?: Max24HourSend;
1203 /**
1204 * The maximum number of emails that Amazon SES can accept from the user's account per second. The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.
1205 */
1206 MaxSendRate?: MaxSendRate;
1207 /**
1208 * The number of emails sent during the previous 24 hours.
1209 */
1210 SentLast24Hours?: SentLast24Hours;
1211 }
1212 export interface GetSendStatisticsResponse {
1213 /**
1214 * A list of data points, each of which represents 15 minutes of activity.
1215 */
1216 SendDataPoints?: SendDataPointList;
1217 }
1218 export interface GetTemplateRequest {
1219 /**
1220 * The name of the template you want to retrieve.
1221 */
1222 TemplateName: TemplateName;
1223 }
1224 export interface GetTemplateResponse {
1225 Template?: Template;
1226 }
1227 export type HeaderName = string;
1228 export type HeaderValue = string;
1229 export type HtmlPart = string;
1230 export type Identity = string;
1231 export interface IdentityDkimAttributes {
1232 /**
1233 * Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.
1234 */
1235 DkimEnabled: Enabled;
1236 /**
1237 * Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
1238 */
1239 DkimVerificationStatus: VerificationStatus;
1240 /**
1241 * A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.) For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
1242 */
1243 DkimTokens?: VerificationTokenList;
1244 }
1245 export type IdentityList = Identity[];
1246 export interface IdentityMailFromDomainAttributes {
1247 /**
1248 * The custom MAIL FROM domain that the identity is configured to use.
1249 */
1250 MailFromDomain: MailFromDomainName;
1251 /**
1252 * The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
1253 */
1254 MailFromDomainStatus: CustomMailFromStatus;
1255 /**
1256 * The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email. The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.
1257 */
1258 BehaviorOnMXFailure: BehaviorOnMXFailure;
1259 }
1260 export interface IdentityNotificationAttributes {
1261 /**
1262 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
1263 */
1264 BounceTopic: NotificationTopic;
1265 /**
1266 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
1267 */
1268 ComplaintTopic: NotificationTopic;
1269 /**
1270 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
1271 */
1272 DeliveryTopic: NotificationTopic;
1273 /**
1274 * Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.
1275 */
1276 ForwardingEnabled: Enabled;
1277 /**
1278 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.
1279 */
1280 HeadersInBounceNotificationsEnabled?: Enabled;
1281 /**
1282 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.
1283 */
1284 HeadersInComplaintNotificationsEnabled?: Enabled;
1285 /**
1286 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.
1287 */
1288 HeadersInDeliveryNotificationsEnabled?: Enabled;
1289 }
1290 export type IdentityType = "EmailAddress"|"Domain"|string;
1291 export interface IdentityVerificationAttributes {
1292 /**
1293 * The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
1294 */
1295 VerificationStatus: VerificationStatus;
1296 /**
1297 * The verification token for a domain identity. Null for email address identities.
1298 */
1299 VerificationToken?: VerificationToken;
1300 }
1301 export type InvocationType = "Event"|"RequestResponse"|string;
1302 export interface KinesisFirehoseDestination {
1303 /**
1304 * The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
1305 */
1306 IAMRoleARN: AmazonResourceName;
1307 /**
1308 * The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
1309 */
1310 DeliveryStreamARN: AmazonResourceName;
1311 }
1312 export interface LambdaAction {
1313 /**
1314 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
1315 */
1316 TopicArn?: AmazonResourceName;
1317 /**
1318 * The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
1319 */
1320 FunctionArn: AmazonResourceName;
1321 /**
1322 * The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
1323 */
1324 InvocationType?: InvocationType;
1325 }
1326 export type LastAttemptDate = Date;
1327 export type LastFreshStart = Date;
1328 export interface ListConfigurationSetsRequest {
1329 /**
1330 * A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.
1331 */
1332 NextToken?: NextToken;
1333 /**
1334 * The number of configuration sets to return.
1335 */
1336 MaxItems?: MaxItems;
1337 }
1338 export interface ListConfigurationSetsResponse {
1339 /**
1340 * A list of configuration sets.
1341 */
1342 ConfigurationSets?: ConfigurationSets;
1343 /**
1344 * A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.
1345 */
1346 NextToken?: NextToken;
1347 }
1348 export interface ListCustomVerificationEmailTemplatesRequest {
1349 /**
1350 * An array the contains the name and creation time stamp for each template in your Amazon SES account.
1351 */
1352 NextToken?: NextToken;
1353 /**
1354 * The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.
1355 */
1356 MaxResults?: MaxResults;
1357 }
1358 export interface ListCustomVerificationEmailTemplatesResponse {
1359 /**
1360 * A list of the custom verification email templates that exist in your account.
1361 */
1362 CustomVerificationEmailTemplates?: CustomVerificationEmailTemplates;
1363 /**
1364 * A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.
1365 */
1366 NextToken?: NextToken;
1367 }
1368 export interface ListIdentitiesRequest {
1369 /**
1370 * The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.
1371 */
1372 IdentityType?: IdentityType;
1373 /**
1374 * The token to use for pagination.
1375 */
1376 NextToken?: NextToken;
1377 /**
1378 * The maximum number of identities per page. Possible values are 1-1000 inclusive.
1379 */
1380 MaxItems?: MaxItems;
1381 }
1382 export interface ListIdentitiesResponse {
1383 /**
1384 * A list of identities.
1385 */
1386 Identities: IdentityList;
1387 /**
1388 * The token used for pagination.
1389 */
1390 NextToken?: NextToken;
1391 }
1392 export interface ListIdentityPoliciesRequest {
1393 /**
1394 * The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity.
1395 */
1396 Identity: Identity;
1397 }
1398 export interface ListIdentityPoliciesResponse {
1399 /**
1400 * A list of names of policies that apply to the specified identity.
1401 */
1402 PolicyNames: PolicyNameList;
1403 }
1404 export interface ListReceiptFiltersRequest {
1405 }
1406 export interface ListReceiptFiltersResponse {
1407 /**
1408 * A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
1409 */
1410 Filters?: ReceiptFilterList;
1411 }
1412 export interface ListReceiptRuleSetsRequest {
1413 /**
1414 * A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.
1415 */
1416 NextToken?: NextToken;
1417 }
1418 export interface ListReceiptRuleSetsResponse {
1419 /**
1420 * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
1421 */
1422 RuleSets?: ReceiptRuleSetsLists;
1423 /**
1424 * A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.
1425 */
1426 NextToken?: NextToken;
1427 }
1428 export interface ListTemplatesRequest {
1429 /**
1430 * A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.
1431 */
1432 NextToken?: NextToken;
1433 /**
1434 * The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.
1435 */
1436 MaxItems?: MaxItems;
1437 }
1438 export interface ListTemplatesResponse {
1439 /**
1440 * An array the contains the name and creation time stamp for each template in your Amazon SES account.
1441 */
1442 TemplatesMetadata?: TemplateMetadataList;
1443 /**
1444 * A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.
1445 */
1446 NextToken?: NextToken;
1447 }
1448 export interface ListVerifiedEmailAddressesResponse {
1449 /**
1450 * A list of email addresses that have been verified.
1451 */
1452 VerifiedEmailAddresses?: AddressList;
1453 }
1454 export type MailFromDomainAttributes = {[key: string]: IdentityMailFromDomainAttributes};
1455 export type MailFromDomainName = string;
1456 export type Max24HourSend = number;
1457 export type MaxItems = number;
1458 export type MaxResults = number;
1459 export type MaxSendRate = number;
1460 export interface Message {
1461 /**
1462 * The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
1463 */
1464 Subject: Content;
1465 /**
1466 * The message body.
1467 */
1468 Body: Body;
1469 }
1470 export type MessageData = string;
1471 export interface MessageDsn {
1472 /**
1473 * The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.
1474 */
1475 ReportingMta: ReportingMta;
1476 /**
1477 * When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
1478 */
1479 ArrivalDate?: ArrivalDate;
1480 /**
1481 * Additional X-headers to include in the DSN.
1482 */
1483 ExtensionFields?: ExtensionFieldList;
1484 }
1485 export type MessageId = string;
1486 export interface MessageTag {
1487 /**
1488 * The name of the tag. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters.
1489 */
1490 Name: MessageTagName;
1491 /**
1492 * The value of the tag. The value must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters.
1493 */
1494 Value: MessageTagValue;
1495 }
1496 export type MessageTagList = MessageTag[];
1497 export type MessageTagName = string;
1498 export type MessageTagValue = string;
1499 export type NextToken = string;
1500 export type NotificationAttributes = {[key: string]: IdentityNotificationAttributes};
1501 export type NotificationTopic = string;
1502 export type NotificationType = "Bounce"|"Complaint"|"Delivery"|string;
1503 export type Policy = string;
1504 export type PolicyMap = {[key: string]: Policy};
1505 export type PolicyName = string;
1506 export type PolicyNameList = PolicyName[];
1507 export interface PutConfigurationSetDeliveryOptionsRequest {
1508 /**
1509 * The name of the configuration set that you want to specify the delivery options for.
1510 */
1511 ConfigurationSetName: ConfigurationSetName;
1512 /**
1513 * Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
1514 */
1515 DeliveryOptions?: DeliveryOptions;
1516 }
1517 export interface PutConfigurationSetDeliveryOptionsResponse {
1518 }
1519 export interface PutIdentityPolicyRequest {
1520 /**
1521 * The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity.
1522 */
1523 Identity: Identity;
1524 /**
1525 * The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
1526 */
1527 PolicyName: PolicyName;
1528 /**
1529 * The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
1530 */
1531 Policy: Policy;
1532 }
1533 export interface PutIdentityPolicyResponse {
1534 }
1535 export interface RawMessage {
1536 /**
1537 * The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail. Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For more information, go to the Amazon SES Developer Guide.
1538 */
1539 Data: RawMessageData;
1540 }
1541 export type RawMessageData = Buffer|Uint8Array|Blob|string;
1542 export interface ReceiptAction {
1543 /**
1544 * Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
1545 */
1546 S3Action?: S3Action;
1547 /**
1548 * Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
1549 */
1550 BounceAction?: BounceAction;
1551 /**
1552 * Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
1553 */
1554 WorkmailAction?: WorkmailAction;
1555 /**
1556 * Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
1557 */
1558 LambdaAction?: LambdaAction;
1559 /**
1560 * Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
1561 */
1562 StopAction?: StopAction;
1563 /**
1564 * Adds a header to the received email.
1565 */
1566 AddHeaderAction?: AddHeaderAction;
1567 /**
1568 * Publishes the email content within a notification to Amazon SNS.
1569 */
1570 SNSAction?: SNSAction;
1571 }
1572 export type ReceiptActionsList = ReceiptAction[];
1573 export interface ReceiptFilter {
1574 /**
1575 * The name of the IP address filter. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters.
1576 */
1577 Name: ReceiptFilterName;
1578 /**
1579 * A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
1580 */
1581 IpFilter: ReceiptIpFilter;
1582 }
1583 export type ReceiptFilterList = ReceiptFilter[];
1584 export type ReceiptFilterName = string;
1585 export type ReceiptFilterPolicy = "Block"|"Allow"|string;
1586 export interface ReceiptIpFilter {
1587 /**
1588 * Indicates whether to block or allow incoming mail from the specified IP addresses.
1589 */
1590 Policy: ReceiptFilterPolicy;
1591 /**
1592 * A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
1593 */
1594 Cidr: Cidr;
1595 }
1596 export interface ReceiptRule {
1597 /**
1598 * The name of the receipt rule. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters.
1599 */
1600 Name: ReceiptRuleName;
1601 /**
1602 * If true, the receipt rule is active. The default value is false.
1603 */
1604 Enabled?: Enabled;
1605 /**
1606 * Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.
1607 */
1608 TlsPolicy?: TlsPolicy;
1609 /**
1610 * The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
1611 */
1612 Recipients?: RecipientsList;
1613 /**
1614 * An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
1615 */
1616 Actions?: ReceiptActionsList;
1617 /**
1618 * If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
1619 */
1620 ScanEnabled?: Enabled;
1621 }
1622 export type ReceiptRuleName = string;
1623 export type ReceiptRuleNamesList = ReceiptRuleName[];
1624 export interface ReceiptRuleSetMetadata {
1625 /**
1626 * The name of the receipt rule set. The name must: This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters.
1627 */
1628 Name?: ReceiptRuleSetName;
1629 /**
1630 * The date and time the receipt rule set was created.
1631 */
1632 CreatedTimestamp?: Timestamp;
1633 }
1634 export type ReceiptRuleSetName = string;
1635 export type ReceiptRuleSetsLists = ReceiptRuleSetMetadata[];
1636 export type ReceiptRulesList = ReceiptRule[];
1637 export type Recipient = string;
1638 export interface RecipientDsnFields {
1639 /**
1640 * The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message. Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
1641 */
1642 FinalRecipient?: Address;
1643 /**
1644 * The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
1645 */
1646 Action: DsnAction;
1647 /**
1648 * The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.
1649 */
1650 RemoteMta?: RemoteMta;
1651 /**
1652 * The status code that indicates what went wrong. This is required by RFC 3464.
1653 */
1654 Status: DsnStatus;
1655 /**
1656 * An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
1657 */
1658 DiagnosticCode?: DiagnosticCode;
1659 /**
1660 * The time the final delivery attempt was made, in RFC 822 date-time format.
1661 */
1662 LastAttemptDate?: LastAttemptDate;
1663 /**
1664 * Additional X-headers to include in the DSN.
1665 */
1666 ExtensionFields?: ExtensionFieldList;
1667 }
1668 export type RecipientsList = Recipient[];
1669 export type RemoteMta = string;
1670 export type RenderedTemplate = string;
1671 export interface ReorderReceiptRuleSetRequest {
1672 /**
1673 * The name of the receipt rule set to reorder.
1674 */
1675 RuleSetName: ReceiptRuleSetName;
1676 /**
1677 * A list of the specified receipt rule set's receipt rules in the order that you want to put them.
1678 */
1679 RuleNames: ReceiptRuleNamesList;
1680 }
1681 export interface ReorderReceiptRuleSetResponse {
1682 }
1683 export type ReportingMta = string;
1684 export interface ReputationOptions {
1685 /**
1686 * Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.
1687 */
1688 SendingEnabled?: Enabled;
1689 /**
1690 * Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.
1691 */
1692 ReputationMetricsEnabled?: Enabled;
1693 /**
1694 * The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start. When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset. If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.
1695 */
1696 LastFreshStart?: LastFreshStart;
1697 }
1698 export interface S3Action {
1699 /**
1700 * The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
1701 */
1702 TopicArn?: AmazonResourceName;
1703 /**
1704 * The name of the Amazon S3 bucket that incoming email will be saved to.
1705 */
1706 BucketName: S3BucketName;
1707 /**
1708 * The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
1709 */
1710 ObjectKeyPrefix?: S3KeyPrefix;
1711 /**
1712 * The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows: To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
1713 */
1714 KmsKeyArn?: AmazonResourceName;
1715 }
1716 export type S3BucketName = string;
1717 export type S3KeyPrefix = string;
1718 export interface SNSAction {
1719 /**
1720 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
1721 */
1722 TopicArn: AmazonResourceName;
1723 /**
1724 * The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
1725 */
1726 Encoding?: SNSActionEncoding;
1727 }
1728 export type SNSActionEncoding = "UTF-8"|"Base64"|string;
1729 export interface SNSDestination {
1730 /**
1731 * The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
1732 */
1733 TopicARN: AmazonResourceName;
1734 }
1735 export interface SendBounceRequest {
1736 /**
1737 * The message ID of the message to be bounced.
1738 */
1739 OriginalMessageId: MessageId;
1740 /**
1741 * The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
1742 */
1743 BounceSender: Address;
1744 /**
1745 * Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
1746 */
1747 Explanation?: Explanation;
1748 /**
1749 * Message-related DSN fields. If not specified, Amazon SES will choose the values.
1750 */
1751 MessageDsn?: MessageDsn;
1752 /**
1753 * A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.
1754 */
1755 BouncedRecipientInfoList: BouncedRecipientInfoList;
1756 /**
1757 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
1758 */
1759 BounceSenderArn?: AmazonResourceName;
1760 }
1761 export interface SendBounceResponse {
1762 /**
1763 * The message ID of the bounce message.
1764 */
1765 MessageId?: MessageId;
1766 }
1767 export interface SendBulkTemplatedEmailRequest {
1768 /**
1769 * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
1770 */
1771 Source: Address;
1772 /**
1773 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1774 */
1775 SourceArn?: AmazonResourceName;
1776 /**
1777 * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
1778 */
1779 ReplyToAddresses?: AddressList;
1780 /**
1781 * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
1782 */
1783 ReturnPath?: Address;
1784 /**
1785 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1786 */
1787 ReturnPathArn?: AmazonResourceName;
1788 /**
1789 * The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
1790 */
1791 ConfigurationSetName?: ConfigurationSetName;
1792 /**
1793 * A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.
1794 */
1795 DefaultTags?: MessageTagList;
1796 /**
1797 * The template to use when sending this email.
1798 */
1799 Template: TemplateName;
1800 /**
1801 * The ARN of the template to use when sending this email.
1802 */
1803 TemplateArn?: AmazonResourceName;
1804 /**
1805 * A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available. The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
1806 */
1807 DefaultTemplateData?: TemplateData;
1808 /**
1809 * One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
1810 */
1811 Destinations: BulkEmailDestinationList;
1812 }
1813 export interface SendBulkTemplatedEmailResponse {
1814 /**
1815 * The unique message identifier returned from the SendBulkTemplatedEmail action.
1816 */
1817 Status: BulkEmailDestinationStatusList;
1818 }
1819 export interface SendCustomVerificationEmailRequest {
1820 /**
1821 * The email address to verify.
1822 */
1823 EmailAddress: Address;
1824 /**
1825 * The name of the custom verification email template to use when sending the verification email.
1826 */
1827 TemplateName: TemplateName;
1828 /**
1829 * Name of a configuration set to use when sending the verification email.
1830 */
1831 ConfigurationSetName?: ConfigurationSetName;
1832 }
1833 export interface SendCustomVerificationEmailResponse {
1834 /**
1835 * The unique message identifier returned from the SendCustomVerificationEmail operation.
1836 */
1837 MessageId?: MessageId;
1838 }
1839 export interface SendDataPoint {
1840 /**
1841 * Time of the data point.
1842 */
1843 Timestamp?: Timestamp;
1844 /**
1845 * Number of emails that have been sent.
1846 */
1847 DeliveryAttempts?: Counter;
1848 /**
1849 * Number of emails that have bounced.
1850 */
1851 Bounces?: Counter;
1852 /**
1853 * Number of unwanted emails that were rejected by recipients.
1854 */
1855 Complaints?: Counter;
1856 /**
1857 * Number of emails rejected by Amazon SES.
1858 */
1859 Rejects?: Counter;
1860 }
1861 export type SendDataPointList = SendDataPoint[];
1862 export interface SendEmailRequest {
1863 /**
1864 * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
1865 */
1866 Source: Address;
1867 /**
1868 * The destination for this email, composed of To:, CC:, and BCC: fields.
1869 */
1870 Destination: Destination;
1871 /**
1872 * The message to be sent.
1873 */
1874 Message: Message;
1875 /**
1876 * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
1877 */
1878 ReplyToAddresses?: AddressList;
1879 /**
1880 * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
1881 */
1882 ReturnPath?: Address;
1883 /**
1884 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1885 */
1886 SourceArn?: AmazonResourceName;
1887 /**
1888 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1889 */
1890 ReturnPathArn?: AmazonResourceName;
1891 /**
1892 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
1893 */
1894 Tags?: MessageTagList;
1895 /**
1896 * The name of the configuration set to use when you send an email using SendEmail.
1897 */
1898 ConfigurationSetName?: ConfigurationSetName;
1899 }
1900 export interface SendEmailResponse {
1901 /**
1902 * The unique message identifier returned from the SendEmail action.
1903 */
1904 MessageId: MessageId;
1905 }
1906 export interface SendRawEmailRequest {
1907 /**
1908 * The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.) Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
1909 */
1910 Source?: Address;
1911 /**
1912 * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
1913 */
1914 Destinations?: AddressList;
1915 /**
1916 * The raw email message itself. The message has to meet the following criteria: The message has to contain a header and a body, separated by a blank line. All of the required header fields must be present in the message. Each part of a multipart MIME message must be formatted properly. Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide. The entire message must be base64-encoded. If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide. Per RFC 5321, the maximum length of each line of text, including the &lt;CRLF&gt;, must not exceed 1,000 characters.
1917 */
1918 RawMessage: RawMessage;
1919 /**
1920 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
1921 */
1922 FromArn?: AmazonResourceName;
1923 /**
1924 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
1925 */
1926 SourceArn?: AmazonResourceName;
1927 /**
1928 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
1929 */
1930 ReturnPathArn?: AmazonResourceName;
1931 /**
1932 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
1933 */
1934 Tags?: MessageTagList;
1935 /**
1936 * The name of the configuration set to use when you send an email using SendRawEmail.
1937 */
1938 ConfigurationSetName?: ConfigurationSetName;
1939 }
1940 export interface SendRawEmailResponse {
1941 /**
1942 * The unique message identifier returned from the SendRawEmail action.
1943 */
1944 MessageId: MessageId;
1945 }
1946 export interface SendTemplatedEmailRequest {
1947 /**
1948 * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
1949 */
1950 Source: Address;
1951 /**
1952 * The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
1953 */
1954 Destination: Destination;
1955 /**
1956 * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
1957 */
1958 ReplyToAddresses?: AddressList;
1959 /**
1960 * The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
1961 */
1962 ReturnPath?: Address;
1963 /**
1964 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1965 */
1966 SourceArn?: AmazonResourceName;
1967 /**
1968 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
1969 */
1970 ReturnPathArn?: AmazonResourceName;
1971 /**
1972 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
1973 */
1974 Tags?: MessageTagList;
1975 /**
1976 * The name of the configuration set to use when you send an email using SendTemplatedEmail.
1977 */
1978 ConfigurationSetName?: ConfigurationSetName;
1979 /**
1980 * The template to use when sending this email.
1981 */
1982 Template: TemplateName;
1983 /**
1984 * The ARN of the template to use when sending this email.
1985 */
1986 TemplateArn?: AmazonResourceName;
1987 /**
1988 * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
1989 */
1990 TemplateData: TemplateData;
1991 }
1992 export interface SendTemplatedEmailResponse {
1993 /**
1994 * The unique message identifier returned from the SendTemplatedEmail action.
1995 */
1996 MessageId: MessageId;
1997 }
1998 export type SentLast24Hours = number;
1999 export interface SetActiveReceiptRuleSetRequest {
2000 /**
2001 * The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
2002 */
2003 RuleSetName?: ReceiptRuleSetName;
2004 }
2005 export interface SetActiveReceiptRuleSetResponse {
2006 }
2007 export interface SetIdentityDkimEnabledRequest {
2008 /**
2009 * The identity for which DKIM signing should be enabled or disabled.
2010 */
2011 Identity: Identity;
2012 /**
2013 * Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
2014 */
2015 DkimEnabled: Enabled;
2016 }
2017 export interface SetIdentityDkimEnabledResponse {
2018 }
2019 export interface SetIdentityFeedbackForwardingEnabledRequest {
2020 /**
2021 * The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.
2022 */
2023 Identity: Identity;
2024 /**
2025 * Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
2026 */
2027 ForwardingEnabled: Enabled;
2028 }
2029 export interface SetIdentityFeedbackForwardingEnabledResponse {
2030 }
2031 export interface SetIdentityHeadersInNotificationsEnabledRequest {
2032 /**
2033 * The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.
2034 */
2035 Identity: Identity;
2036 /**
2037 * The notification type for which to enable or disable headers in notifications.
2038 */
2039 NotificationType: NotificationType;
2040 /**
2041 * Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications. This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
2042 */
2043 Enabled: Enabled;
2044 }
2045 export interface SetIdentityHeadersInNotificationsEnabledResponse {
2046 }
2047 export interface SetIdentityMailFromDomainRequest {
2048 /**
2049 * The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
2050 */
2051 Identity: Identity;
2052 /**
2053 * The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.
2054 */
2055 MailFromDomain?: MailFromDomainName;
2056 /**
2057 * The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email. The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.
2058 */
2059 BehaviorOnMXFailure?: BehaviorOnMXFailure;
2060 }
2061 export interface SetIdentityMailFromDomainResponse {
2062 }
2063 export interface SetIdentityNotificationTopicRequest {
2064 /**
2065 * The identity (email address or domain) that you want to set the Amazon SNS topic for. You can only specify a verified identity for this parameter. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
2066 */
2067 Identity: Identity;
2068 /**
2069 * The type of notifications that will be published to the specified Amazon SNS topic.
2070 */
2071 NotificationType: NotificationType;
2072 /**
2073 * The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.
2074 */
2075 SnsTopic?: NotificationTopic;
2076 }
2077 export interface SetIdentityNotificationTopicResponse {
2078 }
2079 export interface SetReceiptRulePositionRequest {
2080 /**
2081 * The name of the receipt rule set that contains the receipt rule to reposition.
2082 */
2083 RuleSetName: ReceiptRuleSetName;
2084 /**
2085 * The name of the receipt rule to reposition.
2086 */
2087 RuleName: ReceiptRuleName;
2088 /**
2089 * The name of the receipt rule after which to place the specified receipt rule.
2090 */
2091 After?: ReceiptRuleName;
2092 }
2093 export interface SetReceiptRulePositionResponse {
2094 }
2095 export interface StopAction {
2096 /**
2097 * The scope of the StopAction. The only acceptable value is RuleSet.
2098 */
2099 Scope: StopScope;
2100 /**
2101 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
2102 */
2103 TopicArn?: AmazonResourceName;
2104 }
2105 export type StopScope = "RuleSet"|string;
2106 export type Subject = string;
2107 export type SubjectPart = string;
2108 export type SuccessRedirectionURL = string;
2109 export interface Template {
2110 /**
2111 * The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
2112 */
2113 TemplateName: TemplateName;
2114 /**
2115 * The subject line of the email.
2116 */
2117 SubjectPart?: SubjectPart;
2118 /**
2119 * The email body that will be visible to recipients whose email clients do not display HTML.
2120 */
2121 TextPart?: TextPart;
2122 /**
2123 * The HTML body of the email.
2124 */
2125 HtmlPart?: HtmlPart;
2126 }
2127 export type TemplateContent = string;
2128 export type TemplateData = string;
2129 export interface TemplateMetadata {
2130 /**
2131 * The name of the template.
2132 */
2133 Name?: TemplateName;
2134 /**
2135 * The time and date the template was created.
2136 */
2137 CreatedTimestamp?: Timestamp;
2138 }
2139 export type TemplateMetadataList = TemplateMetadata[];
2140 export type TemplateName = string;
2141 export interface TestRenderTemplateRequest {
2142 /**
2143 * The name of the template that you want to render.
2144 */
2145 TemplateName: TemplateName;
2146 /**
2147 * A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
2148 */
2149 TemplateData: TemplateData;
2150 }
2151 export interface TestRenderTemplateResponse {
2152 /**
2153 * The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
2154 */
2155 RenderedTemplate?: RenderedTemplate;
2156 }
2157 export type TextPart = string;
2158 export type Timestamp = Date;
2159 export type TlsPolicy = "Require"|"Optional"|string;
2160 export interface TrackingOptions {
2161 /**
2162 * The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
2163 */
2164 CustomRedirectDomain?: CustomRedirectDomain;
2165 }
2166 export interface UpdateAccountSendingEnabledRequest {
2167 /**
2168 * Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
2169 */
2170 Enabled?: Enabled;
2171 }
2172 export interface UpdateConfigurationSetEventDestinationRequest {
2173 /**
2174 * The name of the configuration set that contains the event destination that you want to update.
2175 */
2176 ConfigurationSetName: ConfigurationSetName;
2177 /**
2178 * The event destination object that you want to apply to the specified configuration set.
2179 */
2180 EventDestination: EventDestination;
2181 }
2182 export interface UpdateConfigurationSetEventDestinationResponse {
2183 }
2184 export interface UpdateConfigurationSetReputationMetricsEnabledRequest {
2185 /**
2186 * The name of the configuration set that you want to update.
2187 */
2188 ConfigurationSetName: ConfigurationSetName;
2189 /**
2190 * Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
2191 */
2192 Enabled: Enabled;
2193 }
2194 export interface UpdateConfigurationSetSendingEnabledRequest {
2195 /**
2196 * The name of the configuration set that you want to update.
2197 */
2198 ConfigurationSetName: ConfigurationSetName;
2199 /**
2200 * Describes whether email sending is enabled or disabled for the configuration set.
2201 */
2202 Enabled: Enabled;
2203 }
2204 export interface UpdateConfigurationSetTrackingOptionsRequest {
2205 /**
2206 * The name of the configuration set for which you want to update the custom tracking domain.
2207 */
2208 ConfigurationSetName: ConfigurationSetName;
2209 TrackingOptions: TrackingOptions;
2210 }
2211 export interface UpdateConfigurationSetTrackingOptionsResponse {
2212 }
2213 export interface UpdateCustomVerificationEmailTemplateRequest {
2214 /**
2215 * The name of the custom verification email template that you want to update.
2216 */
2217 TemplateName: TemplateName;
2218 /**
2219 * The email address that the custom verification email is sent from.
2220 */
2221 FromEmailAddress?: FromAddress;
2222 /**
2223 * The subject line of the custom verification email.
2224 */
2225 TemplateSubject?: Subject;
2226 /**
2227 * The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
2228 */
2229 TemplateContent?: TemplateContent;
2230 /**
2231 * The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
2232 */
2233 SuccessRedirectionURL?: SuccessRedirectionURL;
2234 /**
2235 * The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
2236 */
2237 FailureRedirectionURL?: FailureRedirectionURL;
2238 }
2239 export interface UpdateReceiptRuleRequest {
2240 /**
2241 * The name of the receipt rule set that the receipt rule belongs to.
2242 */
2243 RuleSetName: ReceiptRuleSetName;
2244 /**
2245 * A data structure that contains the updated receipt rule information.
2246 */
2247 Rule: ReceiptRule;
2248 }
2249 export interface UpdateReceiptRuleResponse {
2250 }
2251 export interface UpdateTemplateRequest {
2252 Template: Template;
2253 }
2254 export interface UpdateTemplateResponse {
2255 }
2256 export type VerificationAttributes = {[key: string]: IdentityVerificationAttributes};
2257 export type VerificationStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|"NotStarted"|string;
2258 export type VerificationToken = string;
2259 export type VerificationTokenList = VerificationToken[];
2260 export interface VerifyDomainDkimRequest {
2261 /**
2262 * The name of the domain to be verified for Easy DKIM signing.
2263 */
2264 Domain: Domain;
2265 }
2266 export interface VerifyDomainDkimResponse {
2267 /**
2268 * A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.) For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
2269 */
2270 DkimTokens: VerificationTokenList;
2271 }
2272 export interface VerifyDomainIdentityRequest {
2273 /**
2274 * The domain to be verified.
2275 */
2276 Domain: Domain;
2277 }
2278 export interface VerifyDomainIdentityResponse {
2279 /**
2280 * A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES. As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
2281 */
2282 VerificationToken: VerificationToken;
2283 }
2284 export interface VerifyEmailAddressRequest {
2285 /**
2286 * The email address to be verified.
2287 */
2288 EmailAddress: Address;
2289 }
2290 export interface VerifyEmailIdentityRequest {
2291 /**
2292 * The email address to be verified.
2293 */
2294 EmailAddress: Address;
2295 }
2296 export interface VerifyEmailIdentityResponse {
2297 }
2298 export interface WorkmailAction {
2299 /**
2300 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
2301 */
2302 TopicArn?: AmazonResourceName;
2303 /**
2304 * The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
2305 */
2306 OrganizationArn: AmazonResourceName;
2307 }
2308 /**
2309 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2310 */
2311 export type apiVersion = "2010-12-01"|"latest"|string;
2312 export interface ClientApiVersions {
2313 /**
2314 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2315 */
2316 apiVersion?: apiVersion;
2317 }
2318 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2319 /**
2320 * Contains interfaces for use with the SES client.
2321 */
2322 export import Types = SES;
2323}
2324export = SES;