UNPKG

127 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class SESV2 extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: SESV2.Types.ClientConfiguration)
13 config: Config & SESV2.Types.ClientConfiguration;
14 /**
15 * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
16 */
17 createConfigurationSet(params: SESV2.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: SESV2.Types.CreateConfigurationSetResponse) => void): Request<SESV2.Types.CreateConfigurationSetResponse, AWSError>;
18 /**
19 * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
20 */
21 createConfigurationSet(callback?: (err: AWSError, data: SESV2.Types.CreateConfigurationSetResponse) => void): Request<SESV2.Types.CreateConfigurationSetResponse, AWSError>;
22 /**
23 * Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination.
24 */
25 createConfigurationSetEventDestination(params: SESV2.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.CreateConfigurationSetEventDestinationResponse, AWSError>;
26 /**
27 * Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination.
28 */
29 createConfigurationSetEventDestination(callback?: (err: AWSError, data: SESV2.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.CreateConfigurationSetEventDestinationResponse, AWSError>;
30 /**
31 * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
32 */
33 createDedicatedIpPool(params: SESV2.Types.CreateDedicatedIpPoolRequest, callback?: (err: AWSError, data: SESV2.Types.CreateDedicatedIpPoolResponse) => void): Request<SESV2.Types.CreateDedicatedIpPoolResponse, AWSError>;
34 /**
35 * Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
36 */
37 createDedicatedIpPool(callback?: (err: AWSError, data: SESV2.Types.CreateDedicatedIpPoolResponse) => void): Request<SESV2.Types.CreateDedicatedIpPoolResponse, AWSError>;
38 /**
39 * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
40 */
41 createDeliverabilityTestReport(params: SESV2.Types.CreateDeliverabilityTestReportRequest, callback?: (err: AWSError, data: SESV2.Types.CreateDeliverabilityTestReportResponse) => void): Request<SESV2.Types.CreateDeliverabilityTestReportResponse, AWSError>;
42 /**
43 * Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
44 */
45 createDeliverabilityTestReport(callback?: (err: AWSError, data: SESV2.Types.CreateDeliverabilityTestReportResponse) => void): Request<SESV2.Types.CreateDeliverabilityTestReportResponse, AWSError>;
46 /**
47 * Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity. When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM. Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.
48 */
49 createEmailIdentity(params: SESV2.Types.CreateEmailIdentityRequest, callback?: (err: AWSError, data: SESV2.Types.CreateEmailIdentityResponse) => void): Request<SESV2.Types.CreateEmailIdentityResponse, AWSError>;
50 /**
51 * Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity. When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM. Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.
52 */
53 createEmailIdentity(callback?: (err: AWSError, data: SESV2.Types.CreateEmailIdentityResponse) => void): Request<SESV2.Types.CreateEmailIdentityResponse, AWSError>;
54 /**
55 * Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
56 */
57 deleteConfigurationSet(params: SESV2.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: SESV2.Types.DeleteConfigurationSetResponse) => void): Request<SESV2.Types.DeleteConfigurationSetResponse, AWSError>;
58 /**
59 * Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
60 */
61 deleteConfigurationSet(callback?: (err: AWSError, data: SESV2.Types.DeleteConfigurationSetResponse) => void): Request<SESV2.Types.DeleteConfigurationSetResponse, AWSError>;
62 /**
63 * Delete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
64 */
65 deleteConfigurationSetEventDestination(params: SESV2.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
66 /**
67 * Delete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
68 */
69 deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: SESV2.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
70 /**
71 * Delete a dedicated IP pool.
72 */
73 deleteDedicatedIpPool(params: SESV2.Types.DeleteDedicatedIpPoolRequest, callback?: (err: AWSError, data: SESV2.Types.DeleteDedicatedIpPoolResponse) => void): Request<SESV2.Types.DeleteDedicatedIpPoolResponse, AWSError>;
74 /**
75 * Delete a dedicated IP pool.
76 */
77 deleteDedicatedIpPool(callback?: (err: AWSError, data: SESV2.Types.DeleteDedicatedIpPoolResponse) => void): Request<SESV2.Types.DeleteDedicatedIpPoolResponse, AWSError>;
78 /**
79 * Deletes an email identity. An identity can be either an email address or a domain name.
80 */
81 deleteEmailIdentity(params: SESV2.Types.DeleteEmailIdentityRequest, callback?: (err: AWSError, data: SESV2.Types.DeleteEmailIdentityResponse) => void): Request<SESV2.Types.DeleteEmailIdentityResponse, AWSError>;
82 /**
83 * Deletes an email identity. An identity can be either an email address or a domain name.
84 */
85 deleteEmailIdentity(callback?: (err: AWSError, data: SESV2.Types.DeleteEmailIdentityResponse) => void): Request<SESV2.Types.DeleteEmailIdentityResponse, AWSError>;
86 /**
87 * Removes an email address from the suppression list for your account.
88 */
89 deleteSuppressedDestination(params: SESV2.Types.DeleteSuppressedDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.DeleteSuppressedDestinationResponse) => void): Request<SESV2.Types.DeleteSuppressedDestinationResponse, AWSError>;
90 /**
91 * Removes an email address from the suppression list for your account.
92 */
93 deleteSuppressedDestination(callback?: (err: AWSError, data: SESV2.Types.DeleteSuppressedDestinationResponse) => void): Request<SESV2.Types.DeleteSuppressedDestinationResponse, AWSError>;
94 /**
95 * Obtain information about the email-sending status and capabilities of your Amazon SES account in the current AWS Region.
96 */
97 getAccount(params: SESV2.Types.GetAccountRequest, callback?: (err: AWSError, data: SESV2.Types.GetAccountResponse) => void): Request<SESV2.Types.GetAccountResponse, AWSError>;
98 /**
99 * Obtain information about the email-sending status and capabilities of your Amazon SES account in the current AWS Region.
100 */
101 getAccount(callback?: (err: AWSError, data: SESV2.Types.GetAccountResponse) => void): Request<SESV2.Types.GetAccountResponse, AWSError>;
102 /**
103 * Retrieve a list of the blacklists that your dedicated IP addresses appear on.
104 */
105 getBlacklistReports(params: SESV2.Types.GetBlacklistReportsRequest, callback?: (err: AWSError, data: SESV2.Types.GetBlacklistReportsResponse) => void): Request<SESV2.Types.GetBlacklistReportsResponse, AWSError>;
106 /**
107 * Retrieve a list of the blacklists that your dedicated IP addresses appear on.
108 */
109 getBlacklistReports(callback?: (err: AWSError, data: SESV2.Types.GetBlacklistReportsResponse) => void): Request<SESV2.Types.GetBlacklistReportsResponse, AWSError>;
110 /**
111 * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
112 */
113 getConfigurationSet(params: SESV2.Types.GetConfigurationSetRequest, callback?: (err: AWSError, data: SESV2.Types.GetConfigurationSetResponse) => void): Request<SESV2.Types.GetConfigurationSetResponse, AWSError>;
114 /**
115 * Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
116 */
117 getConfigurationSet(callback?: (err: AWSError, data: SESV2.Types.GetConfigurationSetResponse) => void): Request<SESV2.Types.GetConfigurationSetResponse, AWSError>;
118 /**
119 * Retrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
120 */
121 getConfigurationSetEventDestinations(params: SESV2.Types.GetConfigurationSetEventDestinationsRequest, callback?: (err: AWSError, data: SESV2.Types.GetConfigurationSetEventDestinationsResponse) => void): Request<SESV2.Types.GetConfigurationSetEventDestinationsResponse, AWSError>;
122 /**
123 * Retrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
124 */
125 getConfigurationSetEventDestinations(callback?: (err: AWSError, data: SESV2.Types.GetConfigurationSetEventDestinationsResponse) => void): Request<SESV2.Types.GetConfigurationSetEventDestinationsResponse, AWSError>;
126 /**
127 * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
128 */
129 getDedicatedIp(params: SESV2.Types.GetDedicatedIpRequest, callback?: (err: AWSError, data: SESV2.Types.GetDedicatedIpResponse) => void): Request<SESV2.Types.GetDedicatedIpResponse, AWSError>;
130 /**
131 * Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
132 */
133 getDedicatedIp(callback?: (err: AWSError, data: SESV2.Types.GetDedicatedIpResponse) => void): Request<SESV2.Types.GetDedicatedIpResponse, AWSError>;
134 /**
135 * List the dedicated IP addresses that are associated with your AWS account.
136 */
137 getDedicatedIps(params: SESV2.Types.GetDedicatedIpsRequest, callback?: (err: AWSError, data: SESV2.Types.GetDedicatedIpsResponse) => void): Request<SESV2.Types.GetDedicatedIpsResponse, AWSError>;
138 /**
139 * List the dedicated IP addresses that are associated with your AWS account.
140 */
141 getDedicatedIps(callback?: (err: AWSError, data: SESV2.Types.GetDedicatedIpsResponse) => void): Request<SESV2.Types.GetDedicatedIpsResponse, AWSError>;
142 /**
143 * Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
144 */
145 getDeliverabilityDashboardOptions(params: SESV2.Types.GetDeliverabilityDashboardOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request<SESV2.Types.GetDeliverabilityDashboardOptionsResponse, AWSError>;
146 /**
147 * Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
148 */
149 getDeliverabilityDashboardOptions(callback?: (err: AWSError, data: SESV2.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request<SESV2.Types.GetDeliverabilityDashboardOptionsResponse, AWSError>;
150 /**
151 * Retrieve the results of a predictive inbox placement test.
152 */
153 getDeliverabilityTestReport(params: SESV2.Types.GetDeliverabilityTestReportRequest, callback?: (err: AWSError, data: SESV2.Types.GetDeliverabilityTestReportResponse) => void): Request<SESV2.Types.GetDeliverabilityTestReportResponse, AWSError>;
154 /**
155 * Retrieve the results of a predictive inbox placement test.
156 */
157 getDeliverabilityTestReport(callback?: (err: AWSError, data: SESV2.Types.GetDeliverabilityTestReportResponse) => void): Request<SESV2.Types.GetDeliverabilityTestReportResponse, AWSError>;
158 /**
159 * Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
160 */
161 getDomainDeliverabilityCampaign(params: SESV2.Types.GetDomainDeliverabilityCampaignRequest, callback?: (err: AWSError, data: SESV2.Types.GetDomainDeliverabilityCampaignResponse) => void): Request<SESV2.Types.GetDomainDeliverabilityCampaignResponse, AWSError>;
162 /**
163 * Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
164 */
165 getDomainDeliverabilityCampaign(callback?: (err: AWSError, data: SESV2.Types.GetDomainDeliverabilityCampaignResponse) => void): Request<SESV2.Types.GetDomainDeliverabilityCampaignResponse, AWSError>;
166 /**
167 * Retrieve inbox placement and engagement rates for the domains that you use to send email.
168 */
169 getDomainStatisticsReport(params: SESV2.Types.GetDomainStatisticsReportRequest, callback?: (err: AWSError, data: SESV2.Types.GetDomainStatisticsReportResponse) => void): Request<SESV2.Types.GetDomainStatisticsReportResponse, AWSError>;
170 /**
171 * Retrieve inbox placement and engagement rates for the domains that you use to send email.
172 */
173 getDomainStatisticsReport(callback?: (err: AWSError, data: SESV2.Types.GetDomainStatisticsReportResponse) => void): Request<SESV2.Types.GetDomainStatisticsReportResponse, AWSError>;
174 /**
175 * Provides information about a specific identity, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
176 */
177 getEmailIdentity(params: SESV2.Types.GetEmailIdentityRequest, callback?: (err: AWSError, data: SESV2.Types.GetEmailIdentityResponse) => void): Request<SESV2.Types.GetEmailIdentityResponse, AWSError>;
178 /**
179 * Provides information about a specific identity, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
180 */
181 getEmailIdentity(callback?: (err: AWSError, data: SESV2.Types.GetEmailIdentityResponse) => void): Request<SESV2.Types.GetEmailIdentityResponse, AWSError>;
182 /**
183 * Retrieves information about a specific email address that's on the suppression list for your account.
184 */
185 getSuppressedDestination(params: SESV2.Types.GetSuppressedDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.GetSuppressedDestinationResponse) => void): Request<SESV2.Types.GetSuppressedDestinationResponse, AWSError>;
186 /**
187 * Retrieves information about a specific email address that's on the suppression list for your account.
188 */
189 getSuppressedDestination(callback?: (err: AWSError, data: SESV2.Types.GetSuppressedDestinationResponse) => void): Request<SESV2.Types.GetSuppressedDestinationResponse, AWSError>;
190 /**
191 * List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
192 */
193 listConfigurationSets(params: SESV2.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: SESV2.Types.ListConfigurationSetsResponse) => void): Request<SESV2.Types.ListConfigurationSetsResponse, AWSError>;
194 /**
195 * List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
196 */
197 listConfigurationSets(callback?: (err: AWSError, data: SESV2.Types.ListConfigurationSetsResponse) => void): Request<SESV2.Types.ListConfigurationSetsResponse, AWSError>;
198 /**
199 * List all of the dedicated IP pools that exist in your AWS account in the current Region.
200 */
201 listDedicatedIpPools(params: SESV2.Types.ListDedicatedIpPoolsRequest, callback?: (err: AWSError, data: SESV2.Types.ListDedicatedIpPoolsResponse) => void): Request<SESV2.Types.ListDedicatedIpPoolsResponse, AWSError>;
202 /**
203 * List all of the dedicated IP pools that exist in your AWS account in the current Region.
204 */
205 listDedicatedIpPools(callback?: (err: AWSError, data: SESV2.Types.ListDedicatedIpPoolsResponse) => void): Request<SESV2.Types.ListDedicatedIpPoolsResponse, AWSError>;
206 /**
207 * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.
208 */
209 listDeliverabilityTestReports(params: SESV2.Types.ListDeliverabilityTestReportsRequest, callback?: (err: AWSError, data: SESV2.Types.ListDeliverabilityTestReportsResponse) => void): Request<SESV2.Types.ListDeliverabilityTestReportsResponse, AWSError>;
210 /**
211 * Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.
212 */
213 listDeliverabilityTestReports(callback?: (err: AWSError, data: SESV2.Types.ListDeliverabilityTestReportsResponse) => void): Request<SESV2.Types.ListDeliverabilityTestReportsResponse, AWSError>;
214 /**
215 * Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
216 */
217 listDomainDeliverabilityCampaigns(params: SESV2.Types.ListDomainDeliverabilityCampaignsRequest, callback?: (err: AWSError, data: SESV2.Types.ListDomainDeliverabilityCampaignsResponse) => void): Request<SESV2.Types.ListDomainDeliverabilityCampaignsResponse, AWSError>;
218 /**
219 * Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
220 */
221 listDomainDeliverabilityCampaigns(callback?: (err: AWSError, data: SESV2.Types.ListDomainDeliverabilityCampaignsResponse) => void): Request<SESV2.Types.ListDomainDeliverabilityCampaignsResponse, AWSError>;
222 /**
223 * Returns a list of all of the email identities that are associated with your AWS account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
224 */
225 listEmailIdentities(params: SESV2.Types.ListEmailIdentitiesRequest, callback?: (err: AWSError, data: SESV2.Types.ListEmailIdentitiesResponse) => void): Request<SESV2.Types.ListEmailIdentitiesResponse, AWSError>;
226 /**
227 * Returns a list of all of the email identities that are associated with your AWS account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
228 */
229 listEmailIdentities(callback?: (err: AWSError, data: SESV2.Types.ListEmailIdentitiesResponse) => void): Request<SESV2.Types.ListEmailIdentitiesResponse, AWSError>;
230 /**
231 * Retrieves a list of email addresses that are on the suppression list for your account.
232 */
233 listSuppressedDestinations(params: SESV2.Types.ListSuppressedDestinationsRequest, callback?: (err: AWSError, data: SESV2.Types.ListSuppressedDestinationsResponse) => void): Request<SESV2.Types.ListSuppressedDestinationsResponse, AWSError>;
234 /**
235 * Retrieves a list of email addresses that are on the suppression list for your account.
236 */
237 listSuppressedDestinations(callback?: (err: AWSError, data: SESV2.Types.ListSuppressedDestinationsResponse) => void): Request<SESV2.Types.ListSuppressedDestinationsResponse, AWSError>;
238 /**
239 * Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
240 */
241 listTagsForResource(params: SESV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SESV2.Types.ListTagsForResourceResponse) => void): Request<SESV2.Types.ListTagsForResourceResponse, AWSError>;
242 /**
243 * Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
244 */
245 listTagsForResource(callback?: (err: AWSError, data: SESV2.Types.ListTagsForResourceResponse) => void): Request<SESV2.Types.ListTagsForResourceResponse, AWSError>;
246 /**
247 * Enable or disable the automatic warm-up feature for dedicated IP addresses.
248 */
249 putAccountDedicatedIpWarmupAttributes(params: SESV2.Types.PutAccountDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request<SESV2.Types.PutAccountDedicatedIpWarmupAttributesResponse, AWSError>;
250 /**
251 * Enable or disable the automatic warm-up feature for dedicated IP addresses.
252 */
253 putAccountDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: SESV2.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request<SESV2.Types.PutAccountDedicatedIpWarmupAttributesResponse, AWSError>;
254 /**
255 * Enable or disable the ability of your account to send email.
256 */
257 putAccountSendingAttributes(params: SESV2.Types.PutAccountSendingAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutAccountSendingAttributesResponse) => void): Request<SESV2.Types.PutAccountSendingAttributesResponse, AWSError>;
258 /**
259 * Enable or disable the ability of your account to send email.
260 */
261 putAccountSendingAttributes(callback?: (err: AWSError, data: SESV2.Types.PutAccountSendingAttributesResponse) => void): Request<SESV2.Types.PutAccountSendingAttributesResponse, AWSError>;
262 /**
263 * Change the settings for the account-level suppression list.
264 */
265 putAccountSuppressionAttributes(params: SESV2.Types.PutAccountSuppressionAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutAccountSuppressionAttributesResponse) => void): Request<SESV2.Types.PutAccountSuppressionAttributesResponse, AWSError>;
266 /**
267 * Change the settings for the account-level suppression list.
268 */
269 putAccountSuppressionAttributes(callback?: (err: AWSError, data: SESV2.Types.PutAccountSuppressionAttributesResponse) => void): Request<SESV2.Types.PutAccountSuppressionAttributesResponse, AWSError>;
270 /**
271 * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
272 */
273 putConfigurationSetDeliveryOptions(params: SESV2.Types.PutConfigurationSetDeliveryOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
274 /**
275 * Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
276 */
277 putConfigurationSetDeliveryOptions(callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
278 /**
279 * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
280 */
281 putConfigurationSetReputationOptions(params: SESV2.Types.PutConfigurationSetReputationOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetReputationOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetReputationOptionsResponse, AWSError>;
282 /**
283 * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
284 */
285 putConfigurationSetReputationOptions(callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetReputationOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetReputationOptionsResponse, AWSError>;
286 /**
287 * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
288 */
289 putConfigurationSetSendingOptions(params: SESV2.Types.PutConfigurationSetSendingOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetSendingOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetSendingOptionsResponse, AWSError>;
290 /**
291 * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
292 */
293 putConfigurationSetSendingOptions(callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetSendingOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetSendingOptionsResponse, AWSError>;
294 /**
295 * Specify the account suppression list preferences for a configuration set.
296 */
297 putConfigurationSetSuppressionOptions(params: SESV2.Types.PutConfigurationSetSuppressionOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetSuppressionOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetSuppressionOptionsResponse, AWSError>;
298 /**
299 * Specify the account suppression list preferences for a configuration set.
300 */
301 putConfigurationSetSuppressionOptions(callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetSuppressionOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetSuppressionOptionsResponse, AWSError>;
302 /**
303 * Specify a custom domain to use for open and click tracking elements in email that you send.
304 */
305 putConfigurationSetTrackingOptions(params: SESV2.Types.PutConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetTrackingOptionsResponse, AWSError>;
306 /**
307 * Specify a custom domain to use for open and click tracking elements in email that you send.
308 */
309 putConfigurationSetTrackingOptions(callback?: (err: AWSError, data: SESV2.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request<SESV2.Types.PutConfigurationSetTrackingOptionsResponse, AWSError>;
310 /**
311 * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your AWS account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
312 */
313 putDedicatedIpInPool(params: SESV2.Types.PutDedicatedIpInPoolRequest, callback?: (err: AWSError, data: SESV2.Types.PutDedicatedIpInPoolResponse) => void): Request<SESV2.Types.PutDedicatedIpInPoolResponse, AWSError>;
314 /**
315 * Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your AWS account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
316 */
317 putDedicatedIpInPool(callback?: (err: AWSError, data: SESV2.Types.PutDedicatedIpInPoolResponse) => void): Request<SESV2.Types.PutDedicatedIpInPoolResponse, AWSError>;
318 /**
319 *
320 */
321 putDedicatedIpWarmupAttributes(params: SESV2.Types.PutDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request<SESV2.Types.PutDedicatedIpWarmupAttributesResponse, AWSError>;
322 /**
323 *
324 */
325 putDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: SESV2.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request<SESV2.Types.PutDedicatedIpWarmupAttributesResponse, AWSError>;
326 /**
327 * Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
328 */
329 putDeliverabilityDashboardOption(params: SESV2.Types.PutDeliverabilityDashboardOptionRequest, callback?: (err: AWSError, data: SESV2.Types.PutDeliverabilityDashboardOptionResponse) => void): Request<SESV2.Types.PutDeliverabilityDashboardOptionResponse, AWSError>;
330 /**
331 * Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
332 */
333 putDeliverabilityDashboardOption(callback?: (err: AWSError, data: SESV2.Types.PutDeliverabilityDashboardOptionResponse) => void): Request<SESV2.Types.PutDeliverabilityDashboardOptionResponse, AWSError>;
334 /**
335 * Used to enable or disable DKIM authentication for an email identity.
336 */
337 putEmailIdentityDkimAttributes(params: SESV2.Types.PutEmailIdentityDkimAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityDkimAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityDkimAttributesResponse, AWSError>;
338 /**
339 * Used to enable or disable DKIM authentication for an email identity.
340 */
341 putEmailIdentityDkimAttributes(callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityDkimAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityDkimAttributesResponse, AWSError>;
342 /**
343 * Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). Change from using no DKIM authentication to using Easy DKIM. Change from using no DKIM authentication to using BYODKIM. Change from using Easy DKIM to using BYODKIM. Change from using BYODKIM to using Easy DKIM.
344 */
345 putEmailIdentityDkimSigningAttributes(params: SESV2.Types.PutEmailIdentityDkimSigningAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityDkimSigningAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityDkimSigningAttributesResponse, AWSError>;
346 /**
347 * Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). Change from using no DKIM authentication to using Easy DKIM. Change from using no DKIM authentication to using BYODKIM. Change from using Easy DKIM to using BYODKIM. Change from using BYODKIM to using Easy DKIM.
348 */
349 putEmailIdentityDkimSigningAttributes(callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityDkimSigningAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityDkimSigningAttributesResponse, AWSError>;
350 /**
351 * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
352 */
353 putEmailIdentityFeedbackAttributes(params: SESV2.Types.PutEmailIdentityFeedbackAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityFeedbackAttributesResponse, AWSError>;
354 /**
355 * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
356 */
357 putEmailIdentityFeedbackAttributes(callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityFeedbackAttributesResponse, AWSError>;
358 /**
359 * Used to enable or disable the custom Mail-From domain configuration for an email identity.
360 */
361 putEmailIdentityMailFromAttributes(params: SESV2.Types.PutEmailIdentityMailFromAttributesRequest, callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityMailFromAttributesResponse, AWSError>;
362 /**
363 * Used to enable or disable the custom Mail-From domain configuration for an email identity.
364 */
365 putEmailIdentityMailFromAttributes(callback?: (err: AWSError, data: SESV2.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request<SESV2.Types.PutEmailIdentityMailFromAttributesResponse, AWSError>;
366 /**
367 * Adds an email address to the suppression list for your account.
368 */
369 putSuppressedDestination(params: SESV2.Types.PutSuppressedDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.PutSuppressedDestinationResponse) => void): Request<SESV2.Types.PutSuppressedDestinationResponse, AWSError>;
370 /**
371 * Adds an email address to the suppression list for your account.
372 */
373 putSuppressedDestination(callback?: (err: AWSError, data: SESV2.Types.PutSuppressedDestinationResponse) => void): Request<SESV2.Types.PutSuppressedDestinationResponse, AWSError>;
374 /**
375 * Sends an email message. You can use the Amazon SES API v2 to send two types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
376 */
377 sendEmail(params: SESV2.Types.SendEmailRequest, callback?: (err: AWSError, data: SESV2.Types.SendEmailResponse) => void): Request<SESV2.Types.SendEmailResponse, AWSError>;
378 /**
379 * Sends an email message. You can use the Amazon SES API v2 to send two types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you. Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
380 */
381 sendEmail(callback?: (err: AWSError, data: SESV2.Types.SendEmailResponse) => void): Request<SESV2.Types.SendEmailResponse, AWSError>;
382 /**
383 * Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
384 */
385 tagResource(params: SESV2.Types.TagResourceRequest, callback?: (err: AWSError, data: SESV2.Types.TagResourceResponse) => void): Request<SESV2.Types.TagResourceResponse, AWSError>;
386 /**
387 * Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
388 */
389 tagResource(callback?: (err: AWSError, data: SESV2.Types.TagResourceResponse) => void): Request<SESV2.Types.TagResourceResponse, AWSError>;
390 /**
391 * Remove one or more tags (keys and values) from a specified resource.
392 */
393 untagResource(params: SESV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: SESV2.Types.UntagResourceResponse) => void): Request<SESV2.Types.UntagResourceResponse, AWSError>;
394 /**
395 * Remove one or more tags (keys and values) from a specified resource.
396 */
397 untagResource(callback?: (err: AWSError, data: SESV2.Types.UntagResourceResponse) => void): Request<SESV2.Types.UntagResourceResponse, AWSError>;
398 /**
399 * Update the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
400 */
401 updateConfigurationSetEventDestination(params: SESV2.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SESV2.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
402 /**
403 * Update the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
404 */
405 updateConfigurationSetEventDestination(callback?: (err: AWSError, data: SESV2.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SESV2.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
406}
407declare namespace SESV2 {
408 export type AmazonResourceName = string;
409 export type BehaviorOnMxFailure = "USE_DEFAULT_VALUE"|"REJECT_MESSAGE"|string;
410 export type BlacklistEntries = BlacklistEntry[];
411 export interface BlacklistEntry {
412 /**
413 * The name of the blacklist that the IP address appears on.
414 */
415 RblName?: RblName;
416 /**
417 * The time when the blacklisting event occurred, shown in Unix time format.
418 */
419 ListingTime?: Timestamp;
420 /**
421 * Additional information about the blacklisting event, as provided by the blacklist maintainer.
422 */
423 Description?: BlacklistingDescription;
424 }
425 export type BlacklistItemName = string;
426 export type BlacklistItemNames = BlacklistItemName[];
427 export type BlacklistReport = {[key: string]: BlacklistEntries};
428 export type BlacklistingDescription = string;
429 export interface Body {
430 /**
431 * An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
432 */
433 Text?: Content;
434 /**
435 * An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
436 */
437 Html?: Content;
438 }
439 export type CampaignId = string;
440 export type Charset = string;
441 export interface CloudWatchDestination {
442 /**
443 * An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
444 */
445 DimensionConfigurations: CloudWatchDimensionConfigurations;
446 }
447 export interface CloudWatchDimensionConfiguration {
448 /**
449 * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
450 */
451 DimensionName: DimensionName;
452 /**
453 * The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. If you want to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. If you want to use your own email headers, choose emailHeader. If you want to use link tags, choose linkTags.
454 */
455 DimensionValueSource: DimensionValueSource;
456 /**
457 * The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
458 */
459 DefaultDimensionValue: DefaultDimensionValue;
460 }
461 export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[];
462 export type ConfigurationSetName = string;
463 export type ConfigurationSetNameList = ConfigurationSetName[];
464 export interface Content {
465 /**
466 * The content of the message itself.
467 */
468 Data: MessageData;
469 /**
470 * The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
471 */
472 Charset?: Charset;
473 }
474 export interface CreateConfigurationSetEventDestinationRequest {
475 /**
476 * The name of the configuration set that you want to add an event destination to.
477 */
478 ConfigurationSetName: ConfigurationSetName;
479 /**
480 * A name that identifies the event destination within the configuration set.
481 */
482 EventDestinationName: EventDestinationName;
483 /**
484 * An object that defines the event destination.
485 */
486 EventDestination: EventDestinationDefinition;
487 }
488 export interface CreateConfigurationSetEventDestinationResponse {
489 }
490 export interface CreateConfigurationSetRequest {
491 /**
492 * The name of the configuration set.
493 */
494 ConfigurationSetName: ConfigurationSetName;
495 /**
496 * An object that defines the open and click tracking options for emails that you send using the configuration set.
497 */
498 TrackingOptions?: TrackingOptions;
499 /**
500 * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
501 */
502 DeliveryOptions?: DeliveryOptions;
503 /**
504 * An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
505 */
506 ReputationOptions?: ReputationOptions;
507 /**
508 * An object that defines whether or not Amazon SES can send email that you send using the configuration set.
509 */
510 SendingOptions?: SendingOptions;
511 /**
512 * An array of objects that define the tags (keys and values) that you want to associate with the configuration set.
513 */
514 Tags?: TagList;
515 SuppressionOptions?: SuppressionOptions;
516 }
517 export interface CreateConfigurationSetResponse {
518 }
519 export interface CreateDedicatedIpPoolRequest {
520 /**
521 * The name of the dedicated IP pool.
522 */
523 PoolName: PoolName;
524 /**
525 * An object that defines the tags (keys and values) that you want to associate with the pool.
526 */
527 Tags?: TagList;
528 }
529 export interface CreateDedicatedIpPoolResponse {
530 }
531 export interface CreateDeliverabilityTestReportRequest {
532 /**
533 * A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
534 */
535 ReportName?: ReportName;
536 /**
537 * The email address that the predictive inbox placement test email was sent from.
538 */
539 FromEmailAddress: EmailAddress;
540 /**
541 * The HTML body of the message that you sent when you performed the predictive inbox placement test.
542 */
543 Content: EmailContent;
544 /**
545 * An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
546 */
547 Tags?: TagList;
548 }
549 export interface CreateDeliverabilityTestReportResponse {
550 /**
551 * A unique string that identifies the predictive inbox placement test.
552 */
553 ReportId: ReportId;
554 /**
555 * The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
556 */
557 DeliverabilityTestStatus: DeliverabilityTestStatus;
558 }
559 export interface CreateEmailIdentityRequest {
560 /**
561 * The email address or domain that you want to verify.
562 */
563 EmailIdentity: Identity;
564 /**
565 * An array of objects that define the tags (keys and values) that you want to associate with the email identity.
566 */
567 Tags?: TagList;
568 /**
569 * If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method, Easy DKIM. You can only specify this object if the email identity is a domain, as opposed to an address.
570 */
571 DkimSigningAttributes?: DkimSigningAttributes;
572 }
573 export interface CreateEmailIdentityResponse {
574 /**
575 * The email identity type.
576 */
577 IdentityType?: IdentityType;
578 /**
579 * Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
580 */
581 VerifiedForSendingStatus?: Enabled;
582 /**
583 * An object that contains information about the DKIM attributes for the identity.
584 */
585 DkimAttributes?: DkimAttributes;
586 }
587 export type CustomRedirectDomain = string;
588 export interface DailyVolume {
589 /**
590 * The date that the DailyVolume metrics apply to, in Unix time.
591 */
592 StartDate?: Timestamp;
593 /**
594 * An object that contains inbox placement metrics for a specific day in the analysis period.
595 */
596 VolumeStatistics?: VolumeStatistics;
597 /**
598 * An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
599 */
600 DomainIspPlacements?: DomainIspPlacements;
601 }
602 export type DailyVolumes = DailyVolume[];
603 export interface DedicatedIp {
604 /**
605 * An IPv4 address.
606 */
607 Ip: Ip;
608 /**
609 * The warm-up status of a dedicated IP address. The status can have one of the following values: IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing. DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.
610 */
611 WarmupStatus: WarmupStatus;
612 /**
613 * Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
614 */
615 WarmupPercentage: Percentage100Wrapper;
616 /**
617 * The name of the dedicated IP pool that the IP address is associated with.
618 */
619 PoolName?: PoolName;
620 }
621 export type DedicatedIpList = DedicatedIp[];
622 export type DefaultDimensionValue = string;
623 export interface DeleteConfigurationSetEventDestinationRequest {
624 /**
625 * The name of the configuration set that contains the event destination that you want to delete.
626 */
627 ConfigurationSetName: ConfigurationSetName;
628 /**
629 * The name of the event destination that you want to delete.
630 */
631 EventDestinationName: EventDestinationName;
632 }
633 export interface DeleteConfigurationSetEventDestinationResponse {
634 }
635 export interface DeleteConfigurationSetRequest {
636 /**
637 * The name of the configuration set that you want to delete.
638 */
639 ConfigurationSetName: ConfigurationSetName;
640 }
641 export interface DeleteConfigurationSetResponse {
642 }
643 export interface DeleteDedicatedIpPoolRequest {
644 /**
645 * The name of the dedicated IP pool that you want to delete.
646 */
647 PoolName: PoolName;
648 }
649 export interface DeleteDedicatedIpPoolResponse {
650 }
651 export interface DeleteEmailIdentityRequest {
652 /**
653 * The identity (that is, the email address or domain) that you want to delete.
654 */
655 EmailIdentity: Identity;
656 }
657 export interface DeleteEmailIdentityResponse {
658 }
659 export interface DeleteSuppressedDestinationRequest {
660 /**
661 * The suppressed email destination to remove from the account suppression list.
662 */
663 EmailAddress: EmailAddress;
664 }
665 export interface DeleteSuppressedDestinationResponse {
666 }
667 export type DeliverabilityDashboardAccountStatus = "ACTIVE"|"PENDING_EXPIRATION"|"DISABLED"|string;
668 export interface DeliverabilityTestReport {
669 /**
670 * A unique string that identifies the predictive inbox placement test.
671 */
672 ReportId?: ReportId;
673 /**
674 * A name that helps you identify a predictive inbox placement test report.
675 */
676 ReportName?: ReportName;
677 /**
678 * The subject line for an email that you submitted in a predictive inbox placement test.
679 */
680 Subject?: DeliverabilityTestSubject;
681 /**
682 * The sender address that you specified for the predictive inbox placement test.
683 */
684 FromEmailAddress?: EmailAddress;
685 /**
686 * The date and time when the predictive inbox placement test was created, in Unix time format.
687 */
688 CreateDate?: Timestamp;
689 /**
690 * The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
691 */
692 DeliverabilityTestStatus?: DeliverabilityTestStatus;
693 }
694 export type DeliverabilityTestReports = DeliverabilityTestReport[];
695 export type DeliverabilityTestStatus = "IN_PROGRESS"|"COMPLETED"|string;
696 export type DeliverabilityTestSubject = string;
697 export interface DeliveryOptions {
698 /**
699 * 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.
700 */
701 TlsPolicy?: TlsPolicy;
702 /**
703 * The name of the dedicated IP pool that you want to associate with the configuration set.
704 */
705 SendingPoolName?: PoolName;
706 }
707 export interface Destination {
708 /**
709 * An array that contains the email addresses of the "To" recipients for the email.
710 */
711 ToAddresses?: EmailAddressList;
712 /**
713 * An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
714 */
715 CcAddresses?: EmailAddressList;
716 /**
717 * An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
718 */
719 BccAddresses?: EmailAddressList;
720 }
721 export type DimensionName = string;
722 export type DimensionValueSource = "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG"|string;
723 export interface DkimAttributes {
724 /**
725 * If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.
726 */
727 SigningEnabled?: Enabled;
728 /**
729 * Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following: PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain. SUCCESS – The verification process completed successfully. FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain. TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain. NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
730 */
731 Status?: DkimStatus;
732 /**
733 * If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
734 */
735 Tokens?: DnsTokenList;
736 /**
737 * A string that indicates how DKIM was configured for the identity. There are two possible values: AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
738 */
739 SigningAttributesOrigin?: DkimSigningAttributesOrigin;
740 }
741 export interface DkimSigningAttributes {
742 /**
743 * A string that's used to identify a public key in the DNS configuration for a domain.
744 */
745 DomainSigningSelector: Selector;
746 /**
747 * A private key that's used to generate a DKIM signature. The private key must use 1024-bit RSA encryption, and must be encoded using base64 encoding.
748 */
749 DomainSigningPrivateKey: PrivateKey;
750 }
751 export type DkimSigningAttributesOrigin = "AWS_SES"|"EXTERNAL"|string;
752 export type DkimStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED"|string;
753 export type DnsToken = string;
754 export type DnsTokenList = DnsToken[];
755 export type Domain = string;
756 export interface DomainDeliverabilityCampaign {
757 /**
758 * The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
759 */
760 CampaignId?: CampaignId;
761 /**
762 * The URL of an image that contains a snapshot of the email message that was sent.
763 */
764 ImageUrl?: ImageUrl;
765 /**
766 * The subject line, or title, of the email message.
767 */
768 Subject?: Subject;
769 /**
770 * The verified email address that the email message was sent from.
771 */
772 FromAddress?: Identity;
773 /**
774 * The IP addresses that were used to send the email message.
775 */
776 SendingIps?: IpList;
777 /**
778 * The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
779 */
780 FirstSeenDateTime?: Timestamp;
781 /**
782 * The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
783 */
784 LastSeenDateTime?: Timestamp;
785 /**
786 * The number of email messages that were delivered to recipients’ inboxes.
787 */
788 InboxCount?: Volume;
789 /**
790 * The number of email messages that were delivered to recipients' spam or junk mail folders.
791 */
792 SpamCount?: Volume;
793 /**
794 * The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
795 */
796 ReadRate?: Percentage;
797 /**
798 * The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
799 */
800 DeleteRate?: Percentage;
801 /**
802 * The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
803 */
804 ReadDeleteRate?: Percentage;
805 /**
806 * The projected number of recipients that the email message was sent to.
807 */
808 ProjectedVolume?: Volume;
809 /**
810 * The major email providers who handled the email message.
811 */
812 Esps?: Esps;
813 }
814 export type DomainDeliverabilityCampaignList = DomainDeliverabilityCampaign[];
815 export interface DomainDeliverabilityTrackingOption {
816 /**
817 * A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
818 */
819 Domain?: Domain;
820 /**
821 * The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
822 */
823 SubscriptionStartDate?: Timestamp;
824 /**
825 * An object that contains information about the inbox placement data settings for the domain.
826 */
827 InboxPlacementTrackingOption?: InboxPlacementTrackingOption;
828 }
829 export type DomainDeliverabilityTrackingOptions = DomainDeliverabilityTrackingOption[];
830 export interface DomainIspPlacement {
831 /**
832 * The name of the email provider that the inbox placement data applies to.
833 */
834 IspName?: IspName;
835 /**
836 * The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
837 */
838 InboxRawCount?: Volume;
839 /**
840 * The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
841 */
842 SpamRawCount?: Volume;
843 /**
844 * The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
845 */
846 InboxPercentage?: Percentage;
847 /**
848 * The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
849 */
850 SpamPercentage?: Percentage;
851 }
852 export type DomainIspPlacements = DomainIspPlacement[];
853 export type EmailAddress = string;
854 export type EmailAddressList = EmailAddress[];
855 export interface EmailContent {
856 /**
857 * The simple email message. The message consists of a subject and a message body.
858 */
859 Simple?: Message;
860 /**
861 * The raw email message. The message has to meet the following criteria: The message has to contain a header and a body, separated by one 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. If you include attachments, they must be in a file format that the Amazon SES API v2 supports. 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, you should encode that content to ensure that recipients' email clients render the message properly. The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
862 */
863 Raw?: RawMessage;
864 /**
865 * The template to use for the email message.
866 */
867 Template?: Template;
868 }
869 export type Enabled = boolean;
870 export type Esp = string;
871 export type Esps = Esp[];
872 export interface EventDestination {
873 /**
874 * A name that identifies the event destination.
875 */
876 Name: EventDestinationName;
877 /**
878 * If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
879 */
880 Enabled?: Enabled;
881 /**
882 * The types of events that Amazon SES sends to the specified event destinations.
883 */
884 MatchingEventTypes: EventTypes;
885 /**
886 * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
887 */
888 KinesisFirehoseDestination?: KinesisFirehoseDestination;
889 /**
890 * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
891 */
892 CloudWatchDestination?: CloudWatchDestination;
893 /**
894 * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
895 */
896 SnsDestination?: SnsDestination;
897 /**
898 * An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
899 */
900 PinpointDestination?: PinpointDestination;
901 }
902 export interface EventDestinationDefinition {
903 /**
904 * If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition. If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
905 */
906 Enabled?: Enabled;
907 /**
908 * An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
909 */
910 MatchingEventTypes?: EventTypes;
911 /**
912 * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
913 */
914 KinesisFirehoseDestination?: KinesisFirehoseDestination;
915 /**
916 * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
917 */
918 CloudWatchDestination?: CloudWatchDestination;
919 /**
920 * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
921 */
922 SnsDestination?: SnsDestination;
923 /**
924 * An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
925 */
926 PinpointDestination?: PinpointDestination;
927 }
928 export type EventDestinationName = string;
929 export type EventDestinations = EventDestination[];
930 export type EventType = "SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE"|string;
931 export type EventTypes = EventType[];
932 export type FeedbackId = string;
933 export type GeneralEnforcementStatus = string;
934 export interface GetAccountRequest {
935 }
936 export interface GetAccountResponse {
937 /**
938 * Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
939 */
940 DedicatedIpAutoWarmupEnabled?: Enabled;
941 /**
942 * The reputation status of your Amazon SES account. The status can be one of the following: HEALTHY – There are no reputation-related issues that currently impact your account. PROBATION – We've identified potential issues with your Amazon SES account. We're placing your account under review while you work on correcting these issues. SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.
943 */
944 EnforcementStatus?: GeneralEnforcementStatus;
945 /**
946 * Indicates whether or not your account has production access in the current AWS Region. If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1. If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
947 */
948 ProductionAccessEnabled?: Enabled;
949 /**
950 * An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current AWS Region.
951 */
952 SendQuota?: SendQuota;
953 /**
954 * Indicates whether or not email sending is enabled for your Amazon SES account in the current AWS Region.
955 */
956 SendingEnabled?: Enabled;
957 /**
958 * An object that contains information about the email address suppression preferences for your account in the current AWS Region.
959 */
960 SuppressionAttributes?: SuppressionAttributes;
961 }
962 export interface GetBlacklistReportsRequest {
963 /**
964 * A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.
965 */
966 BlacklistItemNames: BlacklistItemNames;
967 }
968 export interface GetBlacklistReportsResponse {
969 /**
970 * An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
971 */
972 BlacklistReport: BlacklistReport;
973 }
974 export interface GetConfigurationSetEventDestinationsRequest {
975 /**
976 * The name of the configuration set that contains the event destination.
977 */
978 ConfigurationSetName: ConfigurationSetName;
979 }
980 export interface GetConfigurationSetEventDestinationsResponse {
981 /**
982 * An array that includes all of the events destinations that have been configured for the configuration set.
983 */
984 EventDestinations?: EventDestinations;
985 }
986 export interface GetConfigurationSetRequest {
987 /**
988 * The name of the configuration set that you want to obtain more information about.
989 */
990 ConfigurationSetName: ConfigurationSetName;
991 }
992 export interface GetConfigurationSetResponse {
993 /**
994 * The name of the configuration set.
995 */
996 ConfigurationSetName?: ConfigurationSetName;
997 /**
998 * An object that defines the open and click tracking options for emails that you send using the configuration set.
999 */
1000 TrackingOptions?: TrackingOptions;
1001 /**
1002 * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
1003 */
1004 DeliveryOptions?: DeliveryOptions;
1005 /**
1006 * An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
1007 */
1008 ReputationOptions?: ReputationOptions;
1009 /**
1010 * An object that defines whether or not Amazon SES can send email that you send using the configuration set.
1011 */
1012 SendingOptions?: SendingOptions;
1013 /**
1014 * An array of objects that define the tags (keys and values) that are associated with the configuration set.
1015 */
1016 Tags?: TagList;
1017 /**
1018 * An object that contains information about the suppression list preferences for your account.
1019 */
1020 SuppressionOptions?: SuppressionOptions;
1021 }
1022 export interface GetDedicatedIpRequest {
1023 /**
1024 * The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your AWS account.
1025 */
1026 Ip: Ip;
1027 }
1028 export interface GetDedicatedIpResponse {
1029 /**
1030 * An object that contains information about a dedicated IP address.
1031 */
1032 DedicatedIp?: DedicatedIp;
1033 }
1034 export interface GetDedicatedIpsRequest {
1035 /**
1036 * The name of the IP pool that the dedicated IP address is associated with.
1037 */
1038 PoolName?: PoolName;
1039 /**
1040 * A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
1041 */
1042 NextToken?: NextToken;
1043 /**
1044 * The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
1045 */
1046 PageSize?: MaxItems;
1047 }
1048 export interface GetDedicatedIpsResponse {
1049 /**
1050 * A list of dedicated IP addresses that are associated with your AWS account.
1051 */
1052 DedicatedIps?: DedicatedIpList;
1053 /**
1054 * A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.
1055 */
1056 NextToken?: NextToken;
1057 }
1058 export interface GetDeliverabilityDashboardOptionsRequest {
1059 }
1060 export interface GetDeliverabilityDashboardOptionsResponse {
1061 /**
1062 * Specifies whether the Deliverability dashboard is enabled. If this value is true, the dashboard is enabled.
1063 */
1064 DashboardEnabled: Enabled;
1065 /**
1066 * The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
1067 */
1068 SubscriptionExpiryDate?: Timestamp;
1069 /**
1070 * The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.
1071 */
1072 AccountStatus?: DeliverabilityDashboardAccountStatus;
1073 /**
1074 * An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
1075 */
1076 ActiveSubscribedDomains?: DomainDeliverabilityTrackingOptions;
1077 /**
1078 * An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
1079 */
1080 PendingExpirationSubscribedDomains?: DomainDeliverabilityTrackingOptions;
1081 }
1082 export interface GetDeliverabilityTestReportRequest {
1083 /**
1084 * A unique string that identifies the predictive inbox placement test.
1085 */
1086 ReportId: ReportId;
1087 }
1088 export interface GetDeliverabilityTestReportResponse {
1089 /**
1090 * An object that contains the results of the predictive inbox placement test.
1091 */
1092 DeliverabilityTestReport: DeliverabilityTestReport;
1093 /**
1094 * An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
1095 */
1096 OverallPlacement: PlacementStatistics;
1097 /**
1098 * An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
1099 */
1100 IspPlacements: IspPlacements;
1101 /**
1102 * An object that contains the message that you sent when you performed this predictive inbox placement test.
1103 */
1104 Message?: MessageContent;
1105 /**
1106 * An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
1107 */
1108 Tags?: TagList;
1109 }
1110 export interface GetDomainDeliverabilityCampaignRequest {
1111 /**
1112 * The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
1113 */
1114 CampaignId: CampaignId;
1115 }
1116 export interface GetDomainDeliverabilityCampaignResponse {
1117 /**
1118 * An object that contains the deliverability data for the campaign.
1119 */
1120 DomainDeliverabilityCampaign: DomainDeliverabilityCampaign;
1121 }
1122 export interface GetDomainStatisticsReportRequest {
1123 /**
1124 * The domain that you want to obtain deliverability metrics for.
1125 */
1126 Domain: Identity;
1127 /**
1128 * The first day (in Unix time) that you want to obtain domain deliverability metrics for.
1129 */
1130 StartDate: Timestamp;
1131 /**
1132 * The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.
1133 */
1134 EndDate: Timestamp;
1135 }
1136 export interface GetDomainStatisticsReportResponse {
1137 /**
1138 * An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.
1139 */
1140 OverallVolume: OverallVolume;
1141 /**
1142 * An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.
1143 */
1144 DailyVolumes: DailyVolumes;
1145 }
1146 export interface GetEmailIdentityRequest {
1147 /**
1148 * The email identity that you want to retrieve details for.
1149 */
1150 EmailIdentity: Identity;
1151 }
1152 export interface GetEmailIdentityResponse {
1153 /**
1154 * The email identity type.
1155 */
1156 IdentityType?: IdentityType;
1157 /**
1158 * The feedback forwarding configuration for the identity. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
1159 */
1160 FeedbackForwardingStatus?: Enabled;
1161 /**
1162 * Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
1163 */
1164 VerifiedForSendingStatus?: Enabled;
1165 /**
1166 * An object that contains information about the DKIM attributes for the identity.
1167 */
1168 DkimAttributes?: DkimAttributes;
1169 /**
1170 * An object that contains information about the Mail-From attributes for the email identity.
1171 */
1172 MailFromAttributes?: MailFromAttributes;
1173 /**
1174 * An array of objects that define the tags (keys and values) that are associated with the email identity.
1175 */
1176 Tags?: TagList;
1177 }
1178 export interface GetSuppressedDestinationRequest {
1179 /**
1180 * The email address that's on the account suppression list.
1181 */
1182 EmailAddress: EmailAddress;
1183 }
1184 export interface GetSuppressedDestinationResponse {
1185 /**
1186 * An object containing information about the suppressed email address.
1187 */
1188 SuppressedDestination: SuppressedDestination;
1189 }
1190 export type Identity = string;
1191 export interface IdentityInfo {
1192 /**
1193 * The email identity type. The identity type can be one of the following: EMAIL_ADDRESS – The identity is an email address. DOMAIN – The identity is a domain. MANAGED_DOMAIN – The identity is a domain that is managed by AWS.
1194 */
1195 IdentityType?: IdentityType;
1196 /**
1197 * The address or domain of the identity.
1198 */
1199 IdentityName?: Identity;
1200 /**
1201 * Indicates whether or not you can send email from the identity. An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
1202 */
1203 SendingEnabled?: Enabled;
1204 }
1205 export type IdentityInfoList = IdentityInfo[];
1206 export type IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN"|string;
1207 export type ImageUrl = string;
1208 export interface InboxPlacementTrackingOption {
1209 /**
1210 * Specifies whether inbox placement data is being tracked for the domain.
1211 */
1212 Global?: Enabled;
1213 /**
1214 * An array of strings, one for each major email provider that the inbox placement data applies to.
1215 */
1216 TrackedIsps?: IspNameList;
1217 }
1218 export type Ip = string;
1219 export type IpList = Ip[];
1220 export type IspName = string;
1221 export type IspNameList = IspName[];
1222 export interface IspPlacement {
1223 /**
1224 * The name of the email provider that the inbox placement data applies to.
1225 */
1226 IspName?: IspName;
1227 /**
1228 * An object that contains inbox placement metrics for a specific email provider.
1229 */
1230 PlacementStatistics?: PlacementStatistics;
1231 }
1232 export type IspPlacements = IspPlacement[];
1233 export interface KinesisFirehoseDestination {
1234 /**
1235 * The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
1236 */
1237 IamRoleArn: AmazonResourceName;
1238 /**
1239 * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
1240 */
1241 DeliveryStreamArn: AmazonResourceName;
1242 }
1243 export type LastFreshStart = Date;
1244 export interface ListConfigurationSetsRequest {
1245 /**
1246 * A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
1247 */
1248 NextToken?: NextToken;
1249 /**
1250 * The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
1251 */
1252 PageSize?: MaxItems;
1253 }
1254 export interface ListConfigurationSetsResponse {
1255 /**
1256 * An array that contains all of the configuration sets in your Amazon SES account in the current AWS Region.
1257 */
1258 ConfigurationSets?: ConfigurationSetNameList;
1259 /**
1260 * A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.
1261 */
1262 NextToken?: NextToken;
1263 }
1264 export interface ListDedicatedIpPoolsRequest {
1265 /**
1266 * A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
1267 */
1268 NextToken?: NextToken;
1269 /**
1270 * The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
1271 */
1272 PageSize?: MaxItems;
1273 }
1274 export interface ListDedicatedIpPoolsResponse {
1275 /**
1276 * A list of all of the dedicated IP pools that are associated with your AWS account in the current Region.
1277 */
1278 DedicatedIpPools?: ListOfDedicatedIpPools;
1279 /**
1280 * A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.
1281 */
1282 NextToken?: NextToken;
1283 }
1284 export interface ListDeliverabilityTestReportsRequest {
1285 /**
1286 * A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.
1287 */
1288 NextToken?: NextToken;
1289 /**
1290 * The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000.
1291 */
1292 PageSize?: MaxItems;
1293 }
1294 export interface ListDeliverabilityTestReportsResponse {
1295 /**
1296 * An object that contains a lists of predictive inbox placement tests that you've performed.
1297 */
1298 DeliverabilityTestReports: DeliverabilityTestReports;
1299 /**
1300 * A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.
1301 */
1302 NextToken?: NextToken;
1303 }
1304 export interface ListDomainDeliverabilityCampaignsRequest {
1305 /**
1306 * The first day, in Unix time format, that you want to obtain deliverability data for.
1307 */
1308 StartDate: Timestamp;
1309 /**
1310 * The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
1311 */
1312 EndDate: Timestamp;
1313 /**
1314 * The domain to obtain deliverability data for.
1315 */
1316 SubscribedDomain: Domain;
1317 /**
1318 * A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
1319 */
1320 NextToken?: NextToken;
1321 /**
1322 * The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.
1323 */
1324 PageSize?: MaxItems;
1325 }
1326 export interface ListDomainDeliverabilityCampaignsResponse {
1327 /**
1328 * An array of responses, one for each campaign that used the domain to send email during the specified time range.
1329 */
1330 DomainDeliverabilityCampaigns: DomainDeliverabilityCampaignList;
1331 /**
1332 * A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.
1333 */
1334 NextToken?: NextToken;
1335 }
1336 export interface ListEmailIdentitiesRequest {
1337 /**
1338 * A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
1339 */
1340 NextToken?: NextToken;
1341 /**
1342 * The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000.
1343 */
1344 PageSize?: MaxItems;
1345 }
1346 export interface ListEmailIdentitiesResponse {
1347 /**
1348 * An array that includes all of the email identities associated with your AWS account.
1349 */
1350 EmailIdentities?: IdentityInfoList;
1351 /**
1352 * A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.
1353 */
1354 NextToken?: NextToken;
1355 }
1356 export type ListOfDedicatedIpPools = PoolName[];
1357 export interface ListSuppressedDestinationsRequest {
1358 /**
1359 * The factors that caused the email address to be added to .
1360 */
1361 Reasons?: SuppressionListReasons;
1362 /**
1363 * Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.
1364 */
1365 StartDate?: Timestamp;
1366 /**
1367 * Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.
1368 */
1369 EndDate?: Timestamp;
1370 /**
1371 * A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
1372 */
1373 NextToken?: NextToken;
1374 /**
1375 * The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
1376 */
1377 PageSize?: MaxItems;
1378 }
1379 export interface ListSuppressedDestinationsResponse {
1380 /**
1381 * A list of summaries, each containing a summary for a suppressed email destination.
1382 */
1383 SuppressedDestinationSummaries?: SuppressedDestinationSummaries;
1384 /**
1385 * A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.
1386 */
1387 NextToken?: NextToken;
1388 }
1389 export interface ListTagsForResourceRequest {
1390 /**
1391 * The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
1392 */
1393 ResourceArn: AmazonResourceName;
1394 }
1395 export interface ListTagsForResourceResponse {
1396 /**
1397 * An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)
1398 */
1399 Tags: TagList;
1400 }
1401 export interface MailFromAttributes {
1402 /**
1403 * The name of a domain that an email identity uses as a custom MAIL FROM domain.
1404 */
1405 MailFromDomain: MailFromDomainName;
1406 /**
1407 * The status of the MAIL FROM domain. This status can have the following values: PENDING – Amazon SES hasn't started searching for the MX record yet. SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain. FAILED – Amazon SES can't find the required MX record, or the record no longer exists. TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
1408 */
1409 MailFromDomainStatus: MailFromDomainStatus;
1410 /**
1411 * The action that you want to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
1412 */
1413 BehaviorOnMxFailure: BehaviorOnMxFailure;
1414 }
1415 export type MailFromDomainName = string;
1416 export type MailFromDomainStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|string;
1417 export type Max24HourSend = number;
1418 export type MaxItems = number;
1419 export type MaxSendRate = number;
1420 export interface Message {
1421 /**
1422 * The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
1423 */
1424 Subject: Content;
1425 /**
1426 * The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
1427 */
1428 Body: Body;
1429 }
1430 export type MessageContent = string;
1431 export type MessageData = string;
1432 export interface MessageTag {
1433 /**
1434 * The name of the message tag. The message tag name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
1435 */
1436 Name: MessageTagName;
1437 /**
1438 * The value of the message tag. The message tag value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
1439 */
1440 Value: MessageTagValue;
1441 }
1442 export type MessageTagList = MessageTag[];
1443 export type MessageTagName = string;
1444 export type MessageTagValue = string;
1445 export type NextToken = string;
1446 export type OutboundMessageId = string;
1447 export interface OverallVolume {
1448 /**
1449 * An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
1450 */
1451 VolumeStatistics?: VolumeStatistics;
1452 /**
1453 * The percentage of emails that were sent from the domain that were read by their recipients.
1454 */
1455 ReadRatePercent?: Percentage;
1456 /**
1457 * An object that contains inbox and junk mail placement metrics for individual email providers.
1458 */
1459 DomainIspPlacements?: DomainIspPlacements;
1460 }
1461 export type Percentage = number;
1462 export type Percentage100Wrapper = number;
1463 export interface PinpointDestination {
1464 /**
1465 * The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
1466 */
1467 ApplicationArn?: AmazonResourceName;
1468 }
1469 export interface PlacementStatistics {
1470 /**
1471 * The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
1472 */
1473 InboxPercentage?: Percentage;
1474 /**
1475 * The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
1476 */
1477 SpamPercentage?: Percentage;
1478 /**
1479 * The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
1480 */
1481 MissingPercentage?: Percentage;
1482 /**
1483 * The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
1484 */
1485 SpfPercentage?: Percentage;
1486 /**
1487 * The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
1488 */
1489 DkimPercentage?: Percentage;
1490 }
1491 export type PoolName = string;
1492 export type PrivateKey = string;
1493 export interface PutAccountDedicatedIpWarmupAttributesRequest {
1494 /**
1495 * Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.
1496 */
1497 AutoWarmupEnabled?: Enabled;
1498 }
1499 export interface PutAccountDedicatedIpWarmupAttributesResponse {
1500 }
1501 export interface PutAccountSendingAttributesRequest {
1502 /**
1503 * Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending. If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
1504 */
1505 SendingEnabled?: Enabled;
1506 }
1507 export interface PutAccountSendingAttributesResponse {
1508 }
1509 export interface PutAccountSuppressionAttributesRequest {
1510 /**
1511 * A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
1512 */
1513 SuppressedReasons?: SuppressionListReasons;
1514 }
1515 export interface PutAccountSuppressionAttributesResponse {
1516 }
1517 export interface PutConfigurationSetDeliveryOptionsRequest {
1518 /**
1519 * The name of the configuration set that you want to associate with a dedicated IP pool.
1520 */
1521 ConfigurationSetName: ConfigurationSetName;
1522 /**
1523 * 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.
1524 */
1525 TlsPolicy?: TlsPolicy;
1526 /**
1527 * The name of the dedicated IP pool that you want to associate with the configuration set.
1528 */
1529 SendingPoolName?: SendingPoolName;
1530 }
1531 export interface PutConfigurationSetDeliveryOptionsResponse {
1532 }
1533 export interface PutConfigurationSetReputationOptionsRequest {
1534 /**
1535 * The name of the configuration set that you want to enable or disable reputation metric tracking for.
1536 */
1537 ConfigurationSetName: ConfigurationSetName;
1538 /**
1539 * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
1540 */
1541 ReputationMetricsEnabled?: Enabled;
1542 }
1543 export interface PutConfigurationSetReputationOptionsResponse {
1544 }
1545 export interface PutConfigurationSetSendingOptionsRequest {
1546 /**
1547 * The name of the configuration set that you want to enable or disable email sending for.
1548 */
1549 ConfigurationSetName: ConfigurationSetName;
1550 /**
1551 * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
1552 */
1553 SendingEnabled?: Enabled;
1554 }
1555 export interface PutConfigurationSetSendingOptionsResponse {
1556 }
1557 export interface PutConfigurationSetSuppressionOptionsRequest {
1558 /**
1559 * The name of the configuration set that you want to change the suppression list preferences for.
1560 */
1561 ConfigurationSetName: ConfigurationSetName;
1562 /**
1563 * A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
1564 */
1565 SuppressedReasons?: SuppressionListReasons;
1566 }
1567 export interface PutConfigurationSetSuppressionOptionsResponse {
1568 }
1569 export interface PutConfigurationSetTrackingOptionsRequest {
1570 /**
1571 * The name of the configuration set that you want to add a custom tracking domain to.
1572 */
1573 ConfigurationSetName: ConfigurationSetName;
1574 /**
1575 * The domain that you want to use to track open and click events.
1576 */
1577 CustomRedirectDomain?: CustomRedirectDomain;
1578 }
1579 export interface PutConfigurationSetTrackingOptionsResponse {
1580 }
1581 export interface PutDedicatedIpInPoolRequest {
1582 /**
1583 * The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your AWS account.
1584 */
1585 Ip: Ip;
1586 /**
1587 * The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
1588 */
1589 DestinationPoolName: PoolName;
1590 }
1591 export interface PutDedicatedIpInPoolResponse {
1592 }
1593 export interface PutDedicatedIpWarmupAttributesRequest {
1594 /**
1595 * The dedicated IP address that you want to update the warm-up attributes for.
1596 */
1597 Ip: Ip;
1598 /**
1599 * The warm-up percentage that you want to associate with the dedicated IP address.
1600 */
1601 WarmupPercentage: Percentage100Wrapper;
1602 }
1603 export interface PutDedicatedIpWarmupAttributesResponse {
1604 }
1605 export interface PutDeliverabilityDashboardOptionRequest {
1606 /**
1607 * Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.
1608 */
1609 DashboardEnabled: Enabled;
1610 /**
1611 * An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
1612 */
1613 SubscribedDomains?: DomainDeliverabilityTrackingOptions;
1614 }
1615 export interface PutDeliverabilityDashboardOptionResponse {
1616 }
1617 export interface PutEmailIdentityDkimAttributesRequest {
1618 /**
1619 * The email identity that you want to change the DKIM settings for.
1620 */
1621 EmailIdentity: Identity;
1622 /**
1623 * Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
1624 */
1625 SigningEnabled?: Enabled;
1626 }
1627 export interface PutEmailIdentityDkimAttributesResponse {
1628 }
1629 export interface PutEmailIdentityDkimSigningAttributesRequest {
1630 /**
1631 * The email identity that you want to configure DKIM for.
1632 */
1633 EmailIdentity: Identity;
1634 /**
1635 * The method that you want to use to configure DKIM for the identity. There are two possible values: AWS_SES – Configure DKIM for the identity by using Easy DKIM. EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).
1636 */
1637 SigningAttributesOrigin: DkimSigningAttributesOrigin;
1638 /**
1639 * An object that contains information about the private key and selector that you want to use to configure DKIM for the identity. This object is only required if you want to configure Bring Your Own DKIM (BYODKIM) for the identity.
1640 */
1641 SigningAttributes?: DkimSigningAttributes;
1642 }
1643 export interface PutEmailIdentityDkimSigningAttributesResponse {
1644 /**
1645 * The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity. The status can be one of the following: PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain. SUCCESS – The verification process completed successfully. FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain. TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain. NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
1646 */
1647 DkimStatus?: DkimStatus;
1648 /**
1649 * If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key. Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
1650 */
1651 DkimTokens?: DnsTokenList;
1652 }
1653 export interface PutEmailIdentityFeedbackAttributesRequest {
1654 /**
1655 * The email identity that you want to configure bounce and complaint feedback forwarding for.
1656 */
1657 EmailIdentity: Identity;
1658 /**
1659 * Sets the feedback forwarding configuration for the identity. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
1660 */
1661 EmailForwardingEnabled?: Enabled;
1662 }
1663 export interface PutEmailIdentityFeedbackAttributesResponse {
1664 }
1665 export interface PutEmailIdentityMailFromAttributesRequest {
1666 /**
1667 * The verified email identity that you want to set up the custom MAIL FROM domain for.
1668 */
1669 EmailIdentity: Identity;
1670 /**
1671 * The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria: It has to be a subdomain of the verified identity. It can't be used to receive email. It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
1672 */
1673 MailFromDomain?: MailFromDomainName;
1674 /**
1675 * The action that you want to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
1676 */
1677 BehaviorOnMxFailure?: BehaviorOnMxFailure;
1678 }
1679 export interface PutEmailIdentityMailFromAttributesResponse {
1680 }
1681 export interface PutSuppressedDestinationRequest {
1682 /**
1683 * The email address that should be added to the suppression list for your account.
1684 */
1685 EmailAddress: EmailAddress;
1686 /**
1687 * The factors that should cause the email address to be added to the suppression list for your account.
1688 */
1689 Reason: SuppressionListReason;
1690 }
1691 export interface PutSuppressedDestinationResponse {
1692 }
1693 export interface RawMessage {
1694 /**
1695 * The raw email message. The message has to meet the following criteria: The message has to contain a header and a body, separated by one 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 in a file format that the Amazon SES supports. 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, you should encode that content to ensure that recipients' email clients render the message properly. The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
1696 */
1697 Data: RawMessageData;
1698 }
1699 export type RawMessageData = Buffer|Uint8Array|Blob|string;
1700 export type RblName = string;
1701 export type ReportId = string;
1702 export type ReportName = string;
1703 export interface ReputationOptions {
1704 /**
1705 * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
1706 */
1707 ReputationMetricsEnabled?: Enabled;
1708 /**
1709 * The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
1710 */
1711 LastFreshStart?: LastFreshStart;
1712 }
1713 export type Selector = string;
1714 export interface SendEmailRequest {
1715 /**
1716 * The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
1717 */
1718 FromEmailAddress?: EmailAddress;
1719 /**
1720 * An object that contains the recipients of the email message.
1721 */
1722 Destination: Destination;
1723 /**
1724 * The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
1725 */
1726 ReplyToAddresses?: EmailAddressList;
1727 /**
1728 * The address that you want bounce and complaint notifications to be sent to.
1729 */
1730 FeedbackForwardingEmailAddress?: EmailAddress;
1731 /**
1732 * An object that contains the body of the message. You can send either a Simple message or a Raw message.
1733 */
1734 Content: EmailContent;
1735 /**
1736 * A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
1737 */
1738 EmailTags?: MessageTagList;
1739 /**
1740 * The name of the configuration set that you want to use when sending the email.
1741 */
1742 ConfigurationSetName?: ConfigurationSetName;
1743 }
1744 export interface SendEmailResponse {
1745 /**
1746 * A unique identifier for the message that is generated when the message is accepted. It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.
1747 */
1748 MessageId?: OutboundMessageId;
1749 }
1750 export interface SendQuota {
1751 /**
1752 * The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.
1753 */
1754 Max24HourSend?: Max24HourSend;
1755 /**
1756 * The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.
1757 */
1758 MaxSendRate?: MaxSendRate;
1759 /**
1760 * The number of emails sent from your Amazon SES account in the current AWS Region over the past 24 hours.
1761 */
1762 SentLast24Hours?: SentLast24Hours;
1763 }
1764 export interface SendingOptions {
1765 /**
1766 * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
1767 */
1768 SendingEnabled?: Enabled;
1769 }
1770 export type SendingPoolName = string;
1771 export type SentLast24Hours = number;
1772 export interface SnsDestination {
1773 /**
1774 * The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
1775 */
1776 TopicArn: AmazonResourceName;
1777 }
1778 export type Subject = string;
1779 export interface SuppressedDestination {
1780 /**
1781 * The email address that is on the suppression list for your account.
1782 */
1783 EmailAddress: EmailAddress;
1784 /**
1785 * The reason that the address was added to the suppression list for your account.
1786 */
1787 Reason: SuppressionListReason;
1788 /**
1789 * The date and time when the suppressed destination was last updated, shown in Unix time format.
1790 */
1791 LastUpdateTime: Timestamp;
1792 /**
1793 * An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.
1794 */
1795 Attributes?: SuppressedDestinationAttributes;
1796 }
1797 export interface SuppressedDestinationAttributes {
1798 /**
1799 * The unique identifier of the email message that caused the email address to be added to the suppression list for your account.
1800 */
1801 MessageId?: OutboundMessageId;
1802 /**
1803 * A unique identifier that's generated when an email address is added to the suppression list for your account.
1804 */
1805 FeedbackId?: FeedbackId;
1806 }
1807 export type SuppressedDestinationSummaries = SuppressedDestinationSummary[];
1808 export interface SuppressedDestinationSummary {
1809 /**
1810 * The email address that's on the suppression list for your account.
1811 */
1812 EmailAddress: EmailAddress;
1813 /**
1814 * The reason that the address was added to the suppression list for your account.
1815 */
1816 Reason: SuppressionListReason;
1817 /**
1818 * The date and time when the suppressed destination was last updated, shown in Unix time format.
1819 */
1820 LastUpdateTime: Timestamp;
1821 }
1822 export interface SuppressionAttributes {
1823 /**
1824 * A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
1825 */
1826 SuppressedReasons?: SuppressionListReasons;
1827 }
1828 export type SuppressionListReason = "BOUNCE"|"COMPLAINT"|string;
1829 export type SuppressionListReasons = SuppressionListReason[];
1830 export interface SuppressionOptions {
1831 /**
1832 * A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
1833 */
1834 SuppressedReasons?: SuppressionListReasons;
1835 }
1836 export interface Tag {
1837 /**
1838 * One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
1839 */
1840 Key: TagKey;
1841 /**
1842 * The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.
1843 */
1844 Value: TagValue;
1845 }
1846 export type TagKey = string;
1847 export type TagKeyList = TagKey[];
1848 export type TagList = Tag[];
1849 export interface TagResourceRequest {
1850 /**
1851 * The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
1852 */
1853 ResourceArn: AmazonResourceName;
1854 /**
1855 * A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
1856 */
1857 Tags: TagList;
1858 }
1859 export interface TagResourceResponse {
1860 }
1861 export type TagValue = string;
1862 export interface Template {
1863 /**
1864 * The Amazon Resource Name (ARN) of the template.
1865 */
1866 TemplateArn?: TemplateArn;
1867 /**
1868 * An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
1869 */
1870 TemplateData?: TemplateData;
1871 }
1872 export type TemplateArn = string;
1873 export type TemplateData = string;
1874 export type Timestamp = Date;
1875 export type TlsPolicy = "REQUIRE"|"OPTIONAL"|string;
1876 export interface TrackingOptions {
1877 /**
1878 * The domain that you want to use for tracking open and click events.
1879 */
1880 CustomRedirectDomain: CustomRedirectDomain;
1881 }
1882 export interface UntagResourceRequest {
1883 /**
1884 * The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
1885 */
1886 ResourceArn: AmazonResourceName;
1887 /**
1888 * The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value. To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&amp;TagKeys=Key1&amp;TagKeys=Key2
1889 */
1890 TagKeys: TagKeyList;
1891 }
1892 export interface UntagResourceResponse {
1893 }
1894 export interface UpdateConfigurationSetEventDestinationRequest {
1895 /**
1896 * The name of the configuration set that contains the event destination that you want to modify.
1897 */
1898 ConfigurationSetName: ConfigurationSetName;
1899 /**
1900 * The name of the event destination that you want to modify.
1901 */
1902 EventDestinationName: EventDestinationName;
1903 /**
1904 * An object that defines the event destination.
1905 */
1906 EventDestination: EventDestinationDefinition;
1907 }
1908 export interface UpdateConfigurationSetEventDestinationResponse {
1909 }
1910 export type Volume = number;
1911 export interface VolumeStatistics {
1912 /**
1913 * The total number of emails that arrived in recipients' inboxes.
1914 */
1915 InboxRawCount?: Volume;
1916 /**
1917 * The total number of emails that arrived in recipients' spam or junk mail folders.
1918 */
1919 SpamRawCount?: Volume;
1920 /**
1921 * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
1922 */
1923 ProjectedInbox?: Volume;
1924 /**
1925 * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
1926 */
1927 ProjectedSpam?: Volume;
1928 }
1929 export type WarmupStatus = "IN_PROGRESS"|"DONE"|string;
1930 /**
1931 * 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.
1932 */
1933 export type apiVersion = "2019-09-27"|"latest"|string;
1934 export interface ClientApiVersions {
1935 /**
1936 * 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.
1937 */
1938 apiVersion?: apiVersion;
1939 }
1940 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1941 /**
1942 * Contains interfaces for use with the SESV2 client.
1943 */
1944 export import Types = SESV2;
1945}
1946export = SESV2;