UNPKG

113 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 PinpointEmail extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: PinpointEmail.Types.ClientConfiguration)
13 config: Config & PinpointEmail.Types.ClientConfiguration;
14 /**
15 * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. 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.
16 */
17 createConfigurationSet(params: PinpointEmail.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetResponse) => void): Request<PinpointEmail.Types.CreateConfigurationSetResponse, AWSError>;
18 /**
19 * Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. 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.
20 */
21 createConfigurationSet(callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetResponse) => void): Request<PinpointEmail.Types.CreateConfigurationSetResponse, AWSError>;
22 /**
23 * Create an event destination. In Amazon Pinpoint, 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: PinpointEmail.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.Types.CreateConfigurationSetEventDestinationResponse, AWSError>;
26 /**
27 * Create an event destination. In Amazon Pinpoint, 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: PinpointEmail.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.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 Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
32 */
33 createDedicatedIpPool(params: PinpointEmail.Types.CreateDedicatedIpPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateDedicatedIpPoolResponse) => void): Request<PinpointEmail.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 Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
36 */
37 createDedicatedIpPool(callback?: (err: AWSError, data: PinpointEmail.Types.CreateDedicatedIpPoolResponse) => void): Request<PinpointEmail.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 Pinpoint 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: PinpointEmail.Types.CreateDeliverabilityTestReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateDeliverabilityTestReportResponse) => void): Request<PinpointEmail.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 Pinpoint 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: PinpointEmail.Types.CreateDeliverabilityTestReportResponse) => void): Request<PinpointEmail.Types.CreateDeliverabilityTestReportResponse, AWSError>;
46 /**
47 * Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
48 */
49 createEmailIdentity(params: PinpointEmail.Types.CreateEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.CreateEmailIdentityResponse) => void): Request<PinpointEmail.Types.CreateEmailIdentityResponse, AWSError>;
50 /**
51 * Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address. When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
52 */
53 createEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.CreateEmailIdentityResponse) => void): Request<PinpointEmail.Types.CreateEmailIdentityResponse, AWSError>;
54 /**
55 * Delete an existing configuration set. In Amazon Pinpoint, 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: PinpointEmail.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetResponse) => void): Request<PinpointEmail.Types.DeleteConfigurationSetResponse, AWSError>;
58 /**
59 * Delete an existing configuration set. In Amazon Pinpoint, 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: PinpointEmail.Types.DeleteConfigurationSetResponse) => void): Request<PinpointEmail.Types.DeleteConfigurationSetResponse, AWSError>;
62 /**
63 * Delete an event destination. In Amazon Pinpoint, 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: PinpointEmail.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
66 /**
67 * Delete an event destination. In Amazon Pinpoint, 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: PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>;
70 /**
71 * Delete a dedicated IP pool.
72 */
73 deleteDedicatedIpPool(params: PinpointEmail.Types.DeleteDedicatedIpPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteDedicatedIpPoolResponse) => void): Request<PinpointEmail.Types.DeleteDedicatedIpPoolResponse, AWSError>;
74 /**
75 * Delete a dedicated IP pool.
76 */
77 deleteDedicatedIpPool(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteDedicatedIpPoolResponse) => void): Request<PinpointEmail.Types.DeleteDedicatedIpPoolResponse, AWSError>;
78 /**
79 * Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
80 */
81 deleteEmailIdentity(params: PinpointEmail.Types.DeleteEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.DeleteEmailIdentityResponse) => void): Request<PinpointEmail.Types.DeleteEmailIdentityResponse, AWSError>;
82 /**
83 * Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
84 */
85 deleteEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.DeleteEmailIdentityResponse) => void): Request<PinpointEmail.Types.DeleteEmailIdentityResponse, AWSError>;
86 /**
87 * Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
88 */
89 getAccount(params: PinpointEmail.Types.GetAccountRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetAccountResponse) => void): Request<PinpointEmail.Types.GetAccountResponse, AWSError>;
90 /**
91 * Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
92 */
93 getAccount(callback?: (err: AWSError, data: PinpointEmail.Types.GetAccountResponse) => void): Request<PinpointEmail.Types.GetAccountResponse, AWSError>;
94 /**
95 * Retrieve a list of the blacklists that your dedicated IP addresses appear on.
96 */
97 getBlacklistReports(params: PinpointEmail.Types.GetBlacklistReportsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetBlacklistReportsResponse) => void): Request<PinpointEmail.Types.GetBlacklistReportsResponse, AWSError>;
98 /**
99 * Retrieve a list of the blacklists that your dedicated IP addresses appear on.
100 */
101 getBlacklistReports(callback?: (err: AWSError, data: PinpointEmail.Types.GetBlacklistReportsResponse) => void): Request<PinpointEmail.Types.GetBlacklistReportsResponse, AWSError>;
102 /**
103 * 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. In Amazon Pinpoint, 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.
104 */
105 getConfigurationSet(params: PinpointEmail.Types.GetConfigurationSetRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetResponse) => void): Request<PinpointEmail.Types.GetConfigurationSetResponse, AWSError>;
106 /**
107 * 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. In Amazon Pinpoint, 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.
108 */
109 getConfigurationSet(callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetResponse) => void): Request<PinpointEmail.Types.GetConfigurationSetResponse, AWSError>;
110 /**
111 * Retrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, 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.
112 */
113 getConfigurationSetEventDestinations(params: PinpointEmail.Types.GetConfigurationSetEventDestinationsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse) => void): Request<PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse, AWSError>;
114 /**
115 * Retrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, 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.
116 */
117 getConfigurationSetEventDestinations(callback?: (err: AWSError, data: PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse) => void): Request<PinpointEmail.Types.GetConfigurationSetEventDestinationsResponse, AWSError>;
118 /**
119 * 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.
120 */
121 getDedicatedIp(params: PinpointEmail.Types.GetDedicatedIpRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpResponse) => void): Request<PinpointEmail.Types.GetDedicatedIpResponse, AWSError>;
122 /**
123 * 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.
124 */
125 getDedicatedIp(callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpResponse) => void): Request<PinpointEmail.Types.GetDedicatedIpResponse, AWSError>;
126 /**
127 * List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
128 */
129 getDedicatedIps(params: PinpointEmail.Types.GetDedicatedIpsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpsResponse) => void): Request<PinpointEmail.Types.GetDedicatedIpsResponse, AWSError>;
130 /**
131 * List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
132 */
133 getDedicatedIps(callback?: (err: AWSError, data: PinpointEmail.Types.GetDedicatedIpsResponse) => void): Request<PinpointEmail.Types.GetDedicatedIpsResponse, AWSError>;
134 /**
135 * Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint 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 using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
136 */
137 getDeliverabilityDashboardOptions(params: PinpointEmail.Types.GetDeliverabilityDashboardOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request<PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse, AWSError>;
138 /**
139 * Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint 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 using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
140 */
141 getDeliverabilityDashboardOptions(callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse) => void): Request<PinpointEmail.Types.GetDeliverabilityDashboardOptionsResponse, AWSError>;
142 /**
143 * Retrieve the results of a predictive inbox placement test.
144 */
145 getDeliverabilityTestReport(params: PinpointEmail.Types.GetDeliverabilityTestReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityTestReportResponse) => void): Request<PinpointEmail.Types.GetDeliverabilityTestReportResponse, AWSError>;
146 /**
147 * Retrieve the results of a predictive inbox placement test.
148 */
149 getDeliverabilityTestReport(callback?: (err: AWSError, data: PinpointEmail.Types.GetDeliverabilityTestReportResponse) => void): Request<PinpointEmail.Types.GetDeliverabilityTestReportResponse, AWSError>;
150 /**
151 * 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 (PutDeliverabilityDashboardOption operation).
152 */
153 getDomainDeliverabilityCampaign(params: PinpointEmail.Types.GetDomainDeliverabilityCampaignRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainDeliverabilityCampaignResponse) => void): Request<PinpointEmail.Types.GetDomainDeliverabilityCampaignResponse, AWSError>;
154 /**
155 * 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 (PutDeliverabilityDashboardOption operation).
156 */
157 getDomainDeliverabilityCampaign(callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainDeliverabilityCampaignResponse) => void): Request<PinpointEmail.Types.GetDomainDeliverabilityCampaignResponse, AWSError>;
158 /**
159 * Retrieve inbox placement and engagement rates for the domains that you use to send email.
160 */
161 getDomainStatisticsReport(params: PinpointEmail.Types.GetDomainStatisticsReportRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainStatisticsReportResponse) => void): Request<PinpointEmail.Types.GetDomainStatisticsReportResponse, AWSError>;
162 /**
163 * Retrieve inbox placement and engagement rates for the domains that you use to send email.
164 */
165 getDomainStatisticsReport(callback?: (err: AWSError, data: PinpointEmail.Types.GetDomainStatisticsReportResponse) => void): Request<PinpointEmail.Types.GetDomainStatisticsReportResponse, AWSError>;
166 /**
167 * Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
168 */
169 getEmailIdentity(params: PinpointEmail.Types.GetEmailIdentityRequest, callback?: (err: AWSError, data: PinpointEmail.Types.GetEmailIdentityResponse) => void): Request<PinpointEmail.Types.GetEmailIdentityResponse, AWSError>;
170 /**
171 * Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
172 */
173 getEmailIdentity(callback?: (err: AWSError, data: PinpointEmail.Types.GetEmailIdentityResponse) => void): Request<PinpointEmail.Types.GetEmailIdentityResponse, AWSError>;
174 /**
175 * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, 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.
176 */
177 listConfigurationSets(params: PinpointEmail.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListConfigurationSetsResponse) => void): Request<PinpointEmail.Types.ListConfigurationSetsResponse, AWSError>;
178 /**
179 * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, 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.
180 */
181 listConfigurationSets(callback?: (err: AWSError, data: PinpointEmail.Types.ListConfigurationSetsResponse) => void): Request<PinpointEmail.Types.ListConfigurationSetsResponse, AWSError>;
182 /**
183 * List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
184 */
185 listDedicatedIpPools(params: PinpointEmail.Types.ListDedicatedIpPoolsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListDedicatedIpPoolsResponse) => void): Request<PinpointEmail.Types.ListDedicatedIpPoolsResponse, AWSError>;
186 /**
187 * List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
188 */
189 listDedicatedIpPools(callback?: (err: AWSError, data: PinpointEmail.Types.ListDedicatedIpPoolsResponse) => void): Request<PinpointEmail.Types.ListDedicatedIpPoolsResponse, AWSError>;
190 /**
191 * 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.
192 */
193 listDeliverabilityTestReports(params: PinpointEmail.Types.ListDeliverabilityTestReportsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListDeliverabilityTestReportsResponse) => void): Request<PinpointEmail.Types.ListDeliverabilityTestReportsResponse, AWSError>;
194 /**
195 * 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.
196 */
197 listDeliverabilityTestReports(callback?: (err: AWSError, data: PinpointEmail.Types.ListDeliverabilityTestReportsResponse) => void): Request<PinpointEmail.Types.ListDeliverabilityTestReportsResponse, AWSError>;
198 /**
199 * 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 (PutDeliverabilityDashboardOption operation) for the domain.
200 */
201 listDomainDeliverabilityCampaigns(params: PinpointEmail.Types.ListDomainDeliverabilityCampaignsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListDomainDeliverabilityCampaignsResponse) => void): Request<PinpointEmail.Types.ListDomainDeliverabilityCampaignsResponse, AWSError>;
202 /**
203 * 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 (PutDeliverabilityDashboardOption operation) for the domain.
204 */
205 listDomainDeliverabilityCampaigns(callback?: (err: AWSError, data: PinpointEmail.Types.ListDomainDeliverabilityCampaignsResponse) => void): Request<PinpointEmail.Types.ListDomainDeliverabilityCampaignsResponse, AWSError>;
206 /**
207 * Returns a list of all of the email identities that are associated with your Amazon Pinpoint 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.
208 */
209 listEmailIdentities(params: PinpointEmail.Types.ListEmailIdentitiesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListEmailIdentitiesResponse) => void): Request<PinpointEmail.Types.ListEmailIdentitiesResponse, AWSError>;
210 /**
211 * Returns a list of all of the email identities that are associated with your Amazon Pinpoint 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.
212 */
213 listEmailIdentities(callback?: (err: AWSError, data: PinpointEmail.Types.ListEmailIdentitiesResponse) => void): Request<PinpointEmail.Types.ListEmailIdentitiesResponse, AWSError>;
214 /**
215 * 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 in Amazon Pinpoint. 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.
216 */
217 listTagsForResource(params: PinpointEmail.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.ListTagsForResourceResponse) => void): Request<PinpointEmail.Types.ListTagsForResourceResponse, AWSError>;
218 /**
219 * 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 in Amazon Pinpoint. 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.
220 */
221 listTagsForResource(callback?: (err: AWSError, data: PinpointEmail.Types.ListTagsForResourceResponse) => void): Request<PinpointEmail.Types.ListTagsForResourceResponse, AWSError>;
222 /**
223 * Enable or disable the automatic warm-up feature for dedicated IP addresses.
224 */
225 putAccountDedicatedIpWarmupAttributes(params: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request<PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse, AWSError>;
226 /**
227 * Enable or disable the automatic warm-up feature for dedicated IP addresses.
228 */
229 putAccountDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse) => void): Request<PinpointEmail.Types.PutAccountDedicatedIpWarmupAttributesResponse, AWSError>;
230 /**
231 * Enable or disable the ability of your account to send email.
232 */
233 putAccountSendingAttributes(params: PinpointEmail.Types.PutAccountSendingAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountSendingAttributesResponse) => void): Request<PinpointEmail.Types.PutAccountSendingAttributesResponse, AWSError>;
234 /**
235 * Enable or disable the ability of your account to send email.
236 */
237 putAccountSendingAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutAccountSendingAttributesResponse) => void): Request<PinpointEmail.Types.PutAccountSendingAttributesResponse, AWSError>;
238 /**
239 * 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.
240 */
241 putConfigurationSetDeliveryOptions(params: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
242 /**
243 * 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.
244 */
245 putConfigurationSetDeliveryOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetDeliveryOptionsResponse, AWSError>;
246 /**
247 * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
248 */
249 putConfigurationSetReputationOptions(params: PinpointEmail.Types.PutConfigurationSetReputationOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse, AWSError>;
250 /**
251 * Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
252 */
253 putConfigurationSetReputationOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetReputationOptionsResponse, AWSError>;
254 /**
255 * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
256 */
257 putConfigurationSetSendingOptions(params: PinpointEmail.Types.PutConfigurationSetSendingOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse, AWSError>;
258 /**
259 * Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
260 */
261 putConfigurationSetSendingOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetSendingOptionsResponse, AWSError>;
262 /**
263 * Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
264 */
265 putConfigurationSetTrackingOptions(params: PinpointEmail.Types.PutConfigurationSetTrackingOptionsRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse, AWSError>;
266 /**
267 * Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
268 */
269 putConfigurationSetTrackingOptions(callback?: (err: AWSError, data: PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse) => void): Request<PinpointEmail.Types.PutConfigurationSetTrackingOptionsResponse, AWSError>;
270 /**
271 * 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 Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
272 */
273 putDedicatedIpInPool(params: PinpointEmail.Types.PutDedicatedIpInPoolRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpInPoolResponse) => void): Request<PinpointEmail.Types.PutDedicatedIpInPoolResponse, AWSError>;
274 /**
275 * 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 Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
276 */
277 putDedicatedIpInPool(callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpInPoolResponse) => void): Request<PinpointEmail.Types.PutDedicatedIpInPoolResponse, AWSError>;
278 /**
279 *
280 */
281 putDedicatedIpWarmupAttributes(params: PinpointEmail.Types.PutDedicatedIpWarmupAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request<PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse, AWSError>;
282 /**
283 *
284 */
285 putDedicatedIpWarmupAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse) => void): Request<PinpointEmail.Types.PutDedicatedIpWarmupAttributesResponse, AWSError>;
286 /**
287 * Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
288 */
289 putDeliverabilityDashboardOption(params: PinpointEmail.Types.PutDeliverabilityDashboardOptionRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse) => void): Request<PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse, AWSError>;
290 /**
291 * Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
292 */
293 putDeliverabilityDashboardOption(callback?: (err: AWSError, data: PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse) => void): Request<PinpointEmail.Types.PutDeliverabilityDashboardOptionResponse, AWSError>;
294 /**
295 * Used to enable or disable DKIM authentication for an email identity.
296 */
297 putEmailIdentityDkimAttributes(params: PinpointEmail.Types.PutEmailIdentityDkimAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse, AWSError>;
298 /**
299 * Used to enable or disable DKIM authentication for an email identity.
300 */
301 putEmailIdentityDkimAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityDkimAttributesResponse, AWSError>;
302 /**
303 * 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. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
304 */
305 putEmailIdentityFeedbackAttributes(params: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse, AWSError>;
306 /**
307 * 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. When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
308 */
309 putEmailIdentityFeedbackAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityFeedbackAttributesResponse, AWSError>;
310 /**
311 * Used to enable or disable the custom Mail-From domain configuration for an email identity.
312 */
313 putEmailIdentityMailFromAttributes(params: PinpointEmail.Types.PutEmailIdentityMailFromAttributesRequest, callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse, AWSError>;
314 /**
315 * Used to enable or disable the custom Mail-From domain configuration for an email identity.
316 */
317 putEmailIdentityMailFromAttributes(callback?: (err: AWSError, data: PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse) => void): Request<PinpointEmail.Types.PutEmailIdentityMailFromAttributesResponse, AWSError>;
318 /**
319 * Sends an email message. You can use the Amazon Pinpoint Email API 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 Pinpoint 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.
320 */
321 sendEmail(params: PinpointEmail.Types.SendEmailRequest, callback?: (err: AWSError, data: PinpointEmail.Types.SendEmailResponse) => void): Request<PinpointEmail.Types.SendEmailResponse, AWSError>;
322 /**
323 * Sends an email message. You can use the Amazon Pinpoint Email API 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 Pinpoint 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.
324 */
325 sendEmail(callback?: (err: AWSError, data: PinpointEmail.Types.SendEmailResponse) => void): Request<PinpointEmail.Types.SendEmailResponse, AWSError>;
326 /**
327 * 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 in Amazon Pinpoint. 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.
328 */
329 tagResource(params: PinpointEmail.Types.TagResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.TagResourceResponse) => void): Request<PinpointEmail.Types.TagResourceResponse, AWSError>;
330 /**
331 * 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 in Amazon Pinpoint. 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.
332 */
333 tagResource(callback?: (err: AWSError, data: PinpointEmail.Types.TagResourceResponse) => void): Request<PinpointEmail.Types.TagResourceResponse, AWSError>;
334 /**
335 * Remove one or more tags (keys and values) from a specified resource.
336 */
337 untagResource(params: PinpointEmail.Types.UntagResourceRequest, callback?: (err: AWSError, data: PinpointEmail.Types.UntagResourceResponse) => void): Request<PinpointEmail.Types.UntagResourceResponse, AWSError>;
338 /**
339 * Remove one or more tags (keys and values) from a specified resource.
340 */
341 untagResource(callback?: (err: AWSError, data: PinpointEmail.Types.UntagResourceResponse) => void): Request<PinpointEmail.Types.UntagResourceResponse, AWSError>;
342 /**
343 * Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, 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.
344 */
345 updateConfigurationSetEventDestination(params: PinpointEmail.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
346 /**
347 * Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, 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.
348 */
349 updateConfigurationSetEventDestination(callback?: (err: AWSError, data: PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<PinpointEmail.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>;
350}
351declare namespace PinpointEmail {
352 export type AmazonResourceName = string;
353 export type BehaviorOnMxFailure = "USE_DEFAULT_VALUE"|"REJECT_MESSAGE"|string;
354 export type BlacklistEntries = BlacklistEntry[];
355 export interface BlacklistEntry {
356 /**
357 * The name of the blacklist that the IP address appears on.
358 */
359 RblName?: RblName;
360 /**
361 * The time when the blacklisting event occurred, shown in Unix time format.
362 */
363 ListingTime?: Timestamp;
364 /**
365 * Additional information about the blacklisting event, as provided by the blacklist maintainer.
366 */
367 Description?: BlacklistingDescription;
368 }
369 export type BlacklistItemName = string;
370 export type BlacklistItemNames = BlacklistItemName[];
371 export type BlacklistReport = {[key: string]: BlacklistEntries};
372 export type BlacklistingDescription = string;
373 export interface Body {
374 /**
375 * 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.
376 */
377 Text?: Content;
378 /**
379 * 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.
380 */
381 Html?: Content;
382 }
383 export type CampaignId = string;
384 export type Charset = string;
385 export interface CloudWatchDestination {
386 /**
387 * An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
388 */
389 DimensionConfigurations: CloudWatchDimensionConfigurations;
390 }
391 export interface CloudWatchDimensionConfiguration {
392 /**
393 * 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.
394 */
395 DimensionName: DimensionName;
396 /**
397 * The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
398 */
399 DimensionValueSource: DimensionValueSource;
400 /**
401 * 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.
402 */
403 DefaultDimensionValue: DefaultDimensionValue;
404 }
405 export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[];
406 export type ConfigurationSetName = string;
407 export type ConfigurationSetNameList = ConfigurationSetName[];
408 export interface Content {
409 /**
410 * The content of the message itself.
411 */
412 Data: MessageData;
413 /**
414 * The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint 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.
415 */
416 Charset?: Charset;
417 }
418 export interface CreateConfigurationSetEventDestinationRequest {
419 /**
420 * The name of the configuration set that you want to add an event destination to.
421 */
422 ConfigurationSetName: ConfigurationSetName;
423 /**
424 * A name that identifies the event destination within the configuration set.
425 */
426 EventDestinationName: EventDestinationName;
427 /**
428 * An object that defines the event destination.
429 */
430 EventDestination: EventDestinationDefinition;
431 }
432 export interface CreateConfigurationSetEventDestinationResponse {
433 }
434 export interface CreateConfigurationSetRequest {
435 /**
436 * The name of the configuration set.
437 */
438 ConfigurationSetName: ConfigurationSetName;
439 /**
440 * An object that defines the open and click tracking options for emails that you send using the configuration set.
441 */
442 TrackingOptions?: TrackingOptions;
443 /**
444 * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
445 */
446 DeliveryOptions?: DeliveryOptions;
447 /**
448 * An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
449 */
450 ReputationOptions?: ReputationOptions;
451 /**
452 * An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
453 */
454 SendingOptions?: SendingOptions;
455 /**
456 * An array of objects that define the tags (keys and values) that you want to associate with the configuration set.
457 */
458 Tags?: TagList;
459 }
460 export interface CreateConfigurationSetResponse {
461 }
462 export interface CreateDedicatedIpPoolRequest {
463 /**
464 * The name of the dedicated IP pool.
465 */
466 PoolName: PoolName;
467 /**
468 * An object that defines the tags (keys and values) that you want to associate with the pool.
469 */
470 Tags?: TagList;
471 }
472 export interface CreateDedicatedIpPoolResponse {
473 }
474 export interface CreateDeliverabilityTestReportRequest {
475 /**
476 * A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
477 */
478 ReportName?: ReportName;
479 /**
480 * The email address that the predictive inbox placement test email was sent from.
481 */
482 FromEmailAddress: EmailAddress;
483 /**
484 * The HTML body of the message that you sent when you performed the predictive inbox placement test.
485 */
486 Content: EmailContent;
487 /**
488 * An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
489 */
490 Tags?: TagList;
491 }
492 export interface CreateDeliverabilityTestReportResponse {
493 /**
494 * A unique string that identifies the predictive inbox placement test.
495 */
496 ReportId: ReportId;
497 /**
498 * 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.
499 */
500 DeliverabilityTestStatus: DeliverabilityTestStatus;
501 }
502 export interface CreateEmailIdentityRequest {
503 /**
504 * The email address or domain that you want to verify.
505 */
506 EmailIdentity: Identity;
507 /**
508 * An array of objects that define the tags (keys and values) that you want to associate with the email identity.
509 */
510 Tags?: TagList;
511 }
512 export interface CreateEmailIdentityResponse {
513 /**
514 * The email identity type.
515 */
516 IdentityType?: IdentityType;
517 /**
518 * Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
519 */
520 VerifiedForSendingStatus?: Enabled;
521 /**
522 * An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
523 */
524 DkimAttributes?: DkimAttributes;
525 }
526 export type CustomRedirectDomain = string;
527 export interface DailyVolume {
528 /**
529 * The date that the DailyVolume metrics apply to, in Unix time.
530 */
531 StartDate?: Timestamp;
532 /**
533 * An object that contains inbox placement metrics for a specific day in the analysis period.
534 */
535 VolumeStatistics?: VolumeStatistics;
536 /**
537 * An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
538 */
539 DomainIspPlacements?: DomainIspPlacements;
540 }
541 export type DailyVolumes = DailyVolume[];
542 export interface DedicatedIp {
543 /**
544 * An IP address that is reserved for use by your Amazon Pinpoint account.
545 */
546 Ip: Ip;
547 /**
548 * 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.
549 */
550 WarmupStatus: WarmupStatus;
551 /**
552 * 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.
553 */
554 WarmupPercentage: Percentage100Wrapper;
555 /**
556 * The name of the dedicated IP pool that the IP address is associated with.
557 */
558 PoolName?: PoolName;
559 }
560 export type DedicatedIpList = DedicatedIp[];
561 export type DefaultDimensionValue = string;
562 export interface DeleteConfigurationSetEventDestinationRequest {
563 /**
564 * The name of the configuration set that contains the event destination that you want to delete.
565 */
566 ConfigurationSetName: ConfigurationSetName;
567 /**
568 * The name of the event destination that you want to delete.
569 */
570 EventDestinationName: EventDestinationName;
571 }
572 export interface DeleteConfigurationSetEventDestinationResponse {
573 }
574 export interface DeleteConfigurationSetRequest {
575 /**
576 * The name of the configuration set that you want to delete.
577 */
578 ConfigurationSetName: ConfigurationSetName;
579 }
580 export interface DeleteConfigurationSetResponse {
581 }
582 export interface DeleteDedicatedIpPoolRequest {
583 /**
584 * The name of the dedicated IP pool that you want to delete.
585 */
586 PoolName: PoolName;
587 }
588 export interface DeleteDedicatedIpPoolResponse {
589 }
590 export interface DeleteEmailIdentityRequest {
591 /**
592 * The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.
593 */
594 EmailIdentity: Identity;
595 }
596 export interface DeleteEmailIdentityResponse {
597 }
598 export type DeliverabilityDashboardAccountStatus = "ACTIVE"|"PENDING_EXPIRATION"|"DISABLED"|string;
599 export interface DeliverabilityTestReport {
600 /**
601 * A unique string that identifies the predictive inbox placement test.
602 */
603 ReportId?: ReportId;
604 /**
605 * A name that helps you identify a predictive inbox placement test report.
606 */
607 ReportName?: ReportName;
608 /**
609 * The subject line for an email that you submitted in a predictive inbox placement test.
610 */
611 Subject?: DeliverabilityTestSubject;
612 /**
613 * The sender address that you specified for the predictive inbox placement test.
614 */
615 FromEmailAddress?: EmailAddress;
616 /**
617 * The date and time when the predictive inbox placement test was created, in Unix time format.
618 */
619 CreateDate?: Timestamp;
620 /**
621 * 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.
622 */
623 DeliverabilityTestStatus?: DeliverabilityTestStatus;
624 }
625 export type DeliverabilityTestReports = DeliverabilityTestReport[];
626 export type DeliverabilityTestStatus = "IN_PROGRESS"|"COMPLETED"|string;
627 export type DeliverabilityTestSubject = string;
628 export interface DeliveryOptions {
629 /**
630 * 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.
631 */
632 TlsPolicy?: TlsPolicy;
633 /**
634 * The name of the dedicated IP pool that you want to associate with the configuration set.
635 */
636 SendingPoolName?: PoolName;
637 }
638 export interface Destination {
639 /**
640 * An array that contains the email addresses of the "To" recipients for the email.
641 */
642 ToAddresses?: EmailAddressList;
643 /**
644 * An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
645 */
646 CcAddresses?: EmailAddressList;
647 /**
648 * An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
649 */
650 BccAddresses?: EmailAddressList;
651 }
652 export type DimensionName = string;
653 export type DimensionValueSource = "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG"|string;
654 export interface DkimAttributes {
655 /**
656 * If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
657 */
658 SigningEnabled?: Enabled;
659 /**
660 * Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following: PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
661 */
662 Status?: DkimStatus;
663 /**
664 * 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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
665 */
666 Tokens?: DnsTokenList;
667 }
668 export type DkimStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED"|string;
669 export type DnsToken = string;
670 export type DnsTokenList = DnsToken[];
671 export type Domain = string;
672 export interface DomainDeliverabilityCampaign {
673 /**
674 * The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
675 */
676 CampaignId?: CampaignId;
677 /**
678 * The URL of an image that contains a snapshot of the email message that was sent.
679 */
680 ImageUrl?: ImageUrl;
681 /**
682 * The subject line, or title, of the email message.
683 */
684 Subject?: Subject;
685 /**
686 * The verified email address that the email message was sent from.
687 */
688 FromAddress?: Identity;
689 /**
690 * The IP addresses that were used to send the email message.
691 */
692 SendingIps?: IpList;
693 /**
694 * 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.
695 */
696 FirstSeenDateTime?: Timestamp;
697 /**
698 * 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.
699 */
700 LastSeenDateTime?: Timestamp;
701 /**
702 * The number of email messages that were delivered to recipients’ inboxes.
703 */
704 InboxCount?: Volume;
705 /**
706 * The number of email messages that were delivered to recipients' spam or junk mail folders.
707 */
708 SpamCount?: Volume;
709 /**
710 * 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.
711 */
712 ReadRate?: Percentage;
713 /**
714 * 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.
715 */
716 DeleteRate?: Percentage;
717 /**
718 * 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.
719 */
720 ReadDeleteRate?: Percentage;
721 /**
722 * The projected number of recipients that the email message was sent to.
723 */
724 ProjectedVolume?: Volume;
725 /**
726 * The major email providers who handled the email message.
727 */
728 Esps?: Esps;
729 }
730 export type DomainDeliverabilityCampaignList = DomainDeliverabilityCampaign[];
731 export interface DomainDeliverabilityTrackingOption {
732 /**
733 * A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
734 */
735 Domain?: Domain;
736 /**
737 * The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
738 */
739 SubscriptionStartDate?: Timestamp;
740 /**
741 * An object that contains information about the inbox placement data settings for the domain.
742 */
743 InboxPlacementTrackingOption?: InboxPlacementTrackingOption;
744 }
745 export type DomainDeliverabilityTrackingOptions = DomainDeliverabilityTrackingOption[];
746 export interface DomainIspPlacement {
747 /**
748 * The name of the email provider that the inbox placement data applies to.
749 */
750 IspName?: IspName;
751 /**
752 * The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
753 */
754 InboxRawCount?: Volume;
755 /**
756 * 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.
757 */
758 SpamRawCount?: Volume;
759 /**
760 * The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
761 */
762 InboxPercentage?: Percentage;
763 /**
764 * 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.
765 */
766 SpamPercentage?: Percentage;
767 }
768 export type DomainIspPlacements = DomainIspPlacement[];
769 export type EmailAddress = string;
770 export type EmailAddressList = EmailAddress[];
771 export interface EmailContent {
772 /**
773 * The simple email message. The message consists of a subject and a message body.
774 */
775 Simple?: Message;
776 /**
777 * 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 Amazon Pinpoint 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.
778 */
779 Raw?: RawMessage;
780 /**
781 * The template to use for the email message.
782 */
783 Template?: Template;
784 }
785 export type Enabled = boolean;
786 export type Esp = string;
787 export type Esps = Esp[];
788 export interface EventDestination {
789 /**
790 * A name that identifies the event destination.
791 */
792 Name: EventDestinationName;
793 /**
794 * 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.
795 */
796 Enabled?: Enabled;
797 /**
798 * The types of events that Amazon Pinpoint sends to the specified event destinations.
799 */
800 MatchingEventTypes: EventTypes;
801 /**
802 * 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.
803 */
804 KinesisFirehoseDestination?: KinesisFirehoseDestination;
805 /**
806 * 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.
807 */
808 CloudWatchDestination?: CloudWatchDestination;
809 /**
810 * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
811 */
812 SnsDestination?: SnsDestination;
813 /**
814 * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
815 */
816 PinpointDestination?: PinpointDestination;
817 }
818 export interface EventDestinationDefinition {
819 /**
820 * 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.
821 */
822 Enabled?: Enabled;
823 /**
824 * An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.
825 */
826 MatchingEventTypes?: EventTypes;
827 /**
828 * 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.
829 */
830 KinesisFirehoseDestination?: KinesisFirehoseDestination;
831 /**
832 * 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.
833 */
834 CloudWatchDestination?: CloudWatchDestination;
835 /**
836 * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
837 */
838 SnsDestination?: SnsDestination;
839 /**
840 * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
841 */
842 PinpointDestination?: PinpointDestination;
843 }
844 export type EventDestinationName = string;
845 export type EventDestinations = EventDestination[];
846 export type EventType = "SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE"|string;
847 export type EventTypes = EventType[];
848 export type GeneralEnforcementStatus = string;
849 export interface GetAccountRequest {
850 }
851 export interface GetAccountResponse {
852 /**
853 * An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
854 */
855 SendQuota?: SendQuota;
856 /**
857 * Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
858 */
859 SendingEnabled?: Enabled;
860 /**
861 * Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
862 */
863 DedicatedIpAutoWarmupEnabled?: Enabled;
864 /**
865 * The reputation status of your Amazon Pinpoint 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 some issues with your Amazon Pinpoint 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.
866 */
867 EnforcementStatus?: GeneralEnforcementStatus;
868 /**
869 * 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.
870 */
871 ProductionAccessEnabled?: Enabled;
872 }
873 export interface GetBlacklistReportsRequest {
874 /**
875 * 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 Pinpoint or Amazon SES.
876 */
877 BlacklistItemNames: BlacklistItemNames;
878 }
879 export interface GetBlacklistReportsResponse {
880 /**
881 * An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
882 */
883 BlacklistReport: BlacklistReport;
884 }
885 export interface GetConfigurationSetEventDestinationsRequest {
886 /**
887 * The name of the configuration set that contains the event destination.
888 */
889 ConfigurationSetName: ConfigurationSetName;
890 }
891 export interface GetConfigurationSetEventDestinationsResponse {
892 /**
893 * An array that includes all of the events destinations that have been configured for the configuration set.
894 */
895 EventDestinations?: EventDestinations;
896 }
897 export interface GetConfigurationSetRequest {
898 /**
899 * The name of the configuration set that you want to obtain more information about.
900 */
901 ConfigurationSetName: ConfigurationSetName;
902 }
903 export interface GetConfigurationSetResponse {
904 /**
905 * The name of the configuration set.
906 */
907 ConfigurationSetName?: ConfigurationSetName;
908 /**
909 * An object that defines the open and click tracking options for emails that you send using the configuration set.
910 */
911 TrackingOptions?: TrackingOptions;
912 /**
913 * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
914 */
915 DeliveryOptions?: DeliveryOptions;
916 /**
917 * An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
918 */
919 ReputationOptions?: ReputationOptions;
920 /**
921 * An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
922 */
923 SendingOptions?: SendingOptions;
924 /**
925 * An array of objects that define the tags (keys and values) that are associated with the configuration set.
926 */
927 Tags?: TagList;
928 }
929 export interface GetDedicatedIpRequest {
930 /**
931 * 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 Amazon Pinpoint account.
932 */
933 Ip: Ip;
934 }
935 export interface GetDedicatedIpResponse {
936 /**
937 * An object that contains information about a dedicated IP address.
938 */
939 DedicatedIp?: DedicatedIp;
940 }
941 export interface GetDedicatedIpsRequest {
942 /**
943 * The name of the IP pool that the dedicated IP address is associated with.
944 */
945 PoolName?: PoolName;
946 /**
947 * A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
948 */
949 NextToken?: NextToken;
950 /**
951 * 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.
952 */
953 PageSize?: MaxItems;
954 }
955 export interface GetDedicatedIpsResponse {
956 /**
957 * A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
958 */
959 DedicatedIps?: DedicatedIpList;
960 /**
961 * 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.
962 */
963 NextToken?: NextToken;
964 }
965 export interface GetDeliverabilityDashboardOptionsRequest {
966 }
967 export interface GetDeliverabilityDashboardOptionsResponse {
968 /**
969 * Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.
970 */
971 DashboardEnabled: Enabled;
972 /**
973 * 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.
974 */
975 SubscriptionExpiryDate?: Timestamp;
976 /**
977 * 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.
978 */
979 AccountStatus?: DeliverabilityDashboardAccountStatus;
980 /**
981 * 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.
982 */
983 ActiveSubscribedDomains?: DomainDeliverabilityTrackingOptions;
984 /**
985 * 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.
986 */
987 PendingExpirationSubscribedDomains?: DomainDeliverabilityTrackingOptions;
988 }
989 export interface GetDeliverabilityTestReportRequest {
990 /**
991 * A unique string that identifies the predictive inbox placement test.
992 */
993 ReportId: ReportId;
994 }
995 export interface GetDeliverabilityTestReportResponse {
996 /**
997 * An object that contains the results of the predictive inbox placement test.
998 */
999 DeliverabilityTestReport: DeliverabilityTestReport;
1000 /**
1001 * 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.
1002 */
1003 OverallPlacement: PlacementStatistics;
1004 /**
1005 * An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
1006 */
1007 IspPlacements: IspPlacements;
1008 /**
1009 * An object that contains the message that you sent when you performed this predictive inbox placement test.
1010 */
1011 Message?: MessageContent;
1012 /**
1013 * An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
1014 */
1015 Tags?: TagList;
1016 }
1017 export interface GetDomainDeliverabilityCampaignRequest {
1018 /**
1019 * The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
1020 */
1021 CampaignId: CampaignId;
1022 }
1023 export interface GetDomainDeliverabilityCampaignResponse {
1024 /**
1025 * An object that contains the deliverability data for the campaign.
1026 */
1027 DomainDeliverabilityCampaign: DomainDeliverabilityCampaign;
1028 }
1029 export interface GetDomainStatisticsReportRequest {
1030 /**
1031 * The domain that you want to obtain deliverability metrics for.
1032 */
1033 Domain: Identity;
1034 /**
1035 * The first day (in Unix time) that you want to obtain domain deliverability metrics for.
1036 */
1037 StartDate: Timestamp;
1038 /**
1039 * 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.
1040 */
1041 EndDate: Timestamp;
1042 }
1043 export interface GetDomainStatisticsReportResponse {
1044 /**
1045 * 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.
1046 */
1047 OverallVolume: OverallVolume;
1048 /**
1049 * 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.
1050 */
1051 DailyVolumes: DailyVolumes;
1052 }
1053 export interface GetEmailIdentityRequest {
1054 /**
1055 * The email identity that you want to retrieve details for.
1056 */
1057 EmailIdentity: Identity;
1058 }
1059 export interface GetEmailIdentityResponse {
1060 /**
1061 * The email identity type.
1062 */
1063 IdentityType?: IdentityType;
1064 /**
1065 * The feedback forwarding configuration for the identity. If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
1066 */
1067 FeedbackForwardingStatus?: Enabled;
1068 /**
1069 * Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
1070 */
1071 VerifiedForSendingStatus?: Enabled;
1072 /**
1073 * An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
1074 */
1075 DkimAttributes?: DkimAttributes;
1076 /**
1077 * An object that contains information about the Mail-From attributes for the email identity.
1078 */
1079 MailFromAttributes?: MailFromAttributes;
1080 /**
1081 * An array of objects that define the tags (keys and values) that are associated with the email identity.
1082 */
1083 Tags?: TagList;
1084 }
1085 export type Identity = string;
1086 export interface IdentityInfo {
1087 /**
1088 * 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.
1089 */
1090 IdentityType?: IdentityType;
1091 /**
1092 * The address or domain of the identity.
1093 */
1094 IdentityName?: Identity;
1095 /**
1096 * Indicates whether or not you can send email from the identity. In Amazon Pinpoint, 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 Pinpoint to send email from that identity.
1097 */
1098 SendingEnabled?: Enabled;
1099 }
1100 export type IdentityInfoList = IdentityInfo[];
1101 export type IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN"|string;
1102 export type ImageUrl = string;
1103 export interface InboxPlacementTrackingOption {
1104 /**
1105 * Specifies whether inbox placement data is being tracked for the domain.
1106 */
1107 Global?: Enabled;
1108 /**
1109 * An array of strings, one for each major email provider that the inbox placement data applies to.
1110 */
1111 TrackedIsps?: IspNameList;
1112 }
1113 export type Ip = string;
1114 export type IpList = Ip[];
1115 export type IspName = string;
1116 export type IspNameList = IspName[];
1117 export interface IspPlacement {
1118 /**
1119 * The name of the email provider that the inbox placement data applies to.
1120 */
1121 IspName?: IspName;
1122 /**
1123 * An object that contains inbox placement metrics for a specific email provider.
1124 */
1125 PlacementStatistics?: PlacementStatistics;
1126 }
1127 export type IspPlacements = IspPlacement[];
1128 export interface KinesisFirehoseDestination {
1129 /**
1130 * The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
1131 */
1132 IamRoleArn: AmazonResourceName;
1133 /**
1134 * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
1135 */
1136 DeliveryStreamArn: AmazonResourceName;
1137 }
1138 export type LastFreshStart = Date;
1139 export interface ListConfigurationSetsRequest {
1140 /**
1141 * A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
1142 */
1143 NextToken?: NextToken;
1144 /**
1145 * 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.
1146 */
1147 PageSize?: MaxItems;
1148 }
1149 export interface ListConfigurationSetsResponse {
1150 /**
1151 * An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
1152 */
1153 ConfigurationSets?: ConfigurationSetNameList;
1154 /**
1155 * 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.
1156 */
1157 NextToken?: NextToken;
1158 }
1159 export interface ListDedicatedIpPoolsRequest {
1160 /**
1161 * A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
1162 */
1163 NextToken?: NextToken;
1164 /**
1165 * 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.
1166 */
1167 PageSize?: MaxItems;
1168 }
1169 export interface ListDedicatedIpPoolsResponse {
1170 /**
1171 * A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
1172 */
1173 DedicatedIpPools?: ListOfDedicatedIpPools;
1174 /**
1175 * 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.
1176 */
1177 NextToken?: NextToken;
1178 }
1179 export interface ListDeliverabilityTestReportsRequest {
1180 /**
1181 * A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.
1182 */
1183 NextToken?: NextToken;
1184 /**
1185 * 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.
1186 */
1187 PageSize?: MaxItems;
1188 }
1189 export interface ListDeliverabilityTestReportsResponse {
1190 /**
1191 * An object that contains a lists of predictive inbox placement tests that you've performed.
1192 */
1193 DeliverabilityTestReports: DeliverabilityTestReports;
1194 /**
1195 * 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.
1196 */
1197 NextToken?: NextToken;
1198 }
1199 export interface ListDomainDeliverabilityCampaignsRequest {
1200 /**
1201 * The first day, in Unix time format, that you want to obtain deliverability data for.
1202 */
1203 StartDate: Timestamp;
1204 /**
1205 * 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.
1206 */
1207 EndDate: Timestamp;
1208 /**
1209 * The domain to obtain deliverability data for.
1210 */
1211 SubscribedDomain: Domain;
1212 /**
1213 * 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.
1214 */
1215 NextToken?: NextToken;
1216 /**
1217 * 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.
1218 */
1219 PageSize?: MaxItems;
1220 }
1221 export interface ListDomainDeliverabilityCampaignsResponse {
1222 /**
1223 * An array of responses, one for each campaign that used the domain to send email during the specified time range.
1224 */
1225 DomainDeliverabilityCampaigns: DomainDeliverabilityCampaignList;
1226 /**
1227 * 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.
1228 */
1229 NextToken?: NextToken;
1230 }
1231 export interface ListEmailIdentitiesRequest {
1232 /**
1233 * A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
1234 */
1235 NextToken?: NextToken;
1236 /**
1237 * 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.
1238 */
1239 PageSize?: MaxItems;
1240 }
1241 export interface ListEmailIdentitiesResponse {
1242 /**
1243 * An array that includes all of the identities associated with your Amazon Pinpoint account.
1244 */
1245 EmailIdentities?: IdentityInfoList;
1246 /**
1247 * 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.
1248 */
1249 NextToken?: NextToken;
1250 }
1251 export type ListOfDedicatedIpPools = PoolName[];
1252 export interface ListTagsForResourceRequest {
1253 /**
1254 * The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
1255 */
1256 ResourceArn: AmazonResourceName;
1257 }
1258 export interface ListTagsForResourceResponse {
1259 /**
1260 * 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)
1261 */
1262 Tags: TagList;
1263 }
1264 export interface MailFromAttributes {
1265 /**
1266 * The name of a domain that an email identity uses as a custom MAIL FROM domain.
1267 */
1268 MailFromDomain: MailFromDomainName;
1269 /**
1270 * The status of the MAIL FROM domain. This status can have the following values: PENDING – Amazon Pinpoint hasn't started searching for the MX record yet. SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain. FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists. TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
1271 */
1272 MailFromDomainStatus: MailFromDomainStatus;
1273 /**
1274 * The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.
1275 */
1276 BehaviorOnMxFailure: BehaviorOnMxFailure;
1277 }
1278 export type MailFromDomainName = string;
1279 export type MailFromDomainStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|string;
1280 export type Max24HourSend = number;
1281 export type MaxItems = number;
1282 export type MaxSendRate = number;
1283 export interface Message {
1284 /**
1285 * 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.
1286 */
1287 Subject: Content;
1288 /**
1289 * The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
1290 */
1291 Body: Body;
1292 }
1293 export type MessageContent = string;
1294 export type MessageData = string;
1295 export interface MessageTag {
1296 /**
1297 * 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.
1298 */
1299 Name: MessageTagName;
1300 /**
1301 * 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.
1302 */
1303 Value: MessageTagValue;
1304 }
1305 export type MessageTagList = MessageTag[];
1306 export type MessageTagName = string;
1307 export type MessageTagValue = string;
1308 export type NextToken = string;
1309 export type OutboundMessageId = string;
1310 export interface OverallVolume {
1311 /**
1312 * An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
1313 */
1314 VolumeStatistics?: VolumeStatistics;
1315 /**
1316 * The percentage of emails that were sent from the domain that were read by their recipients.
1317 */
1318 ReadRatePercent?: Percentage;
1319 /**
1320 * An object that contains inbox and junk mail placement metrics for individual email providers.
1321 */
1322 DomainIspPlacements?: DomainIspPlacements;
1323 }
1324 export type Percentage = number;
1325 export type Percentage100Wrapper = number;
1326 export interface PinpointDestination {
1327 /**
1328 * The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
1329 */
1330 ApplicationArn?: AmazonResourceName;
1331 }
1332 export interface PlacementStatistics {
1333 /**
1334 * The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
1335 */
1336 InboxPercentage?: Percentage;
1337 /**
1338 * The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
1339 */
1340 SpamPercentage?: Percentage;
1341 /**
1342 * The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
1343 */
1344 MissingPercentage?: Percentage;
1345 /**
1346 * The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
1347 */
1348 SpfPercentage?: Percentage;
1349 /**
1350 * The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
1351 */
1352 DkimPercentage?: Percentage;
1353 }
1354 export type PoolName = string;
1355 export interface PutAccountDedicatedIpWarmupAttributesRequest {
1356 /**
1357 * Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.
1358 */
1359 AutoWarmupEnabled?: Enabled;
1360 }
1361 export interface PutAccountDedicatedIpWarmupAttributesResponse {
1362 }
1363 export interface PutAccountSendingAttributesRequest {
1364 /**
1365 * 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.
1366 */
1367 SendingEnabled?: Enabled;
1368 }
1369 export interface PutAccountSendingAttributesResponse {
1370 }
1371 export interface PutConfigurationSetDeliveryOptionsRequest {
1372 /**
1373 * The name of the configuration set that you want to associate with a dedicated IP pool.
1374 */
1375 ConfigurationSetName: ConfigurationSetName;
1376 /**
1377 * 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.
1378 */
1379 TlsPolicy?: TlsPolicy;
1380 /**
1381 * The name of the dedicated IP pool that you want to associate with the configuration set.
1382 */
1383 SendingPoolName?: SendingPoolName;
1384 }
1385 export interface PutConfigurationSetDeliveryOptionsResponse {
1386 }
1387 export interface PutConfigurationSetReputationOptionsRequest {
1388 /**
1389 * The name of the configuration set that you want to enable or disable reputation metric tracking for.
1390 */
1391 ConfigurationSetName: ConfigurationSetName;
1392 /**
1393 * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
1394 */
1395 ReputationMetricsEnabled?: Enabled;
1396 }
1397 export interface PutConfigurationSetReputationOptionsResponse {
1398 }
1399 export interface PutConfigurationSetSendingOptionsRequest {
1400 /**
1401 * The name of the configuration set that you want to enable or disable email sending for.
1402 */
1403 ConfigurationSetName: ConfigurationSetName;
1404 /**
1405 * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
1406 */
1407 SendingEnabled?: Enabled;
1408 }
1409 export interface PutConfigurationSetSendingOptionsResponse {
1410 }
1411 export interface PutConfigurationSetTrackingOptionsRequest {
1412 /**
1413 * The name of the configuration set that you want to add a custom tracking domain to.
1414 */
1415 ConfigurationSetName: ConfigurationSetName;
1416 /**
1417 * The domain that you want to use to track open and click events.
1418 */
1419 CustomRedirectDomain?: CustomRedirectDomain;
1420 }
1421 export interface PutConfigurationSetTrackingOptionsResponse {
1422 }
1423 export interface PutDedicatedIpInPoolRequest {
1424 /**
1425 * 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 Amazon Pinpoint account.
1426 */
1427 Ip: Ip;
1428 /**
1429 * 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.
1430 */
1431 DestinationPoolName: PoolName;
1432 }
1433 export interface PutDedicatedIpInPoolResponse {
1434 }
1435 export interface PutDedicatedIpWarmupAttributesRequest {
1436 /**
1437 * The dedicated IP address that you want to update the warm-up attributes for.
1438 */
1439 Ip: Ip;
1440 /**
1441 * The warm-up percentage that you want to associate with the dedicated IP address.
1442 */
1443 WarmupPercentage: Percentage100Wrapper;
1444 }
1445 export interface PutDedicatedIpWarmupAttributesResponse {
1446 }
1447 export interface PutDeliverabilityDashboardOptionRequest {
1448 /**
1449 * Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.
1450 */
1451 DashboardEnabled: Enabled;
1452 /**
1453 * An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
1454 */
1455 SubscribedDomains?: DomainDeliverabilityTrackingOptions;
1456 }
1457 export interface PutDeliverabilityDashboardOptionResponse {
1458 }
1459 export interface PutEmailIdentityDkimAttributesRequest {
1460 /**
1461 * The email identity that you want to change the DKIM settings for.
1462 */
1463 EmailIdentity: Identity;
1464 /**
1465 * Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
1466 */
1467 SigningEnabled?: Enabled;
1468 }
1469 export interface PutEmailIdentityDkimAttributesResponse {
1470 }
1471 export interface PutEmailIdentityFeedbackAttributesRequest {
1472 /**
1473 * The email identity that you want to configure bounce and complaint feedback forwarding for.
1474 */
1475 EmailIdentity: Identity;
1476 /**
1477 * Sets the feedback forwarding configuration for the identity. If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email. When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
1478 */
1479 EmailForwardingEnabled?: Enabled;
1480 }
1481 export interface PutEmailIdentityFeedbackAttributesResponse {
1482 }
1483 export interface PutEmailIdentityMailFromAttributesRequest {
1484 /**
1485 * The verified email identity that you want to set up the custom MAIL FROM domain for.
1486 */
1487 EmailIdentity: Identity;
1488 /**
1489 * 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.
1490 */
1491 MailFromDomain?: MailFromDomainName;
1492 /**
1493 * The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.
1494 */
1495 BehaviorOnMxFailure?: BehaviorOnMxFailure;
1496 }
1497 export interface PutEmailIdentityMailFromAttributesResponse {
1498 }
1499 export interface RawMessage {
1500 /**
1501 * 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 Amazon Pinpoint 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.
1502 */
1503 Data: RawMessageData;
1504 }
1505 export type RawMessageData = Buffer|Uint8Array|Blob|string;
1506 export type RblName = string;
1507 export type ReportId = string;
1508 export type ReportName = string;
1509 export interface ReputationOptions {
1510 /**
1511 * If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
1512 */
1513 ReputationMetricsEnabled?: Enabled;
1514 /**
1515 * 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.
1516 */
1517 LastFreshStart?: LastFreshStart;
1518 }
1519 export interface SendEmailRequest {
1520 /**
1521 * The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
1522 */
1523 FromEmailAddress?: EmailAddress;
1524 /**
1525 * An object that contains the recipients of the email message.
1526 */
1527 Destination: Destination;
1528 /**
1529 * The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
1530 */
1531 ReplyToAddresses?: EmailAddressList;
1532 /**
1533 * The address that Amazon Pinpoint should send bounce and complaint notifications to.
1534 */
1535 FeedbackForwardingEmailAddress?: EmailAddress;
1536 /**
1537 * An object that contains the body of the message. You can send either a Simple message or a Raw message.
1538 */
1539 Content: EmailContent;
1540 /**
1541 * 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.
1542 */
1543 EmailTags?: MessageTagList;
1544 /**
1545 * The name of the configuration set that you want to use when sending the email.
1546 */
1547 ConfigurationSetName?: ConfigurationSetName;
1548 }
1549 export interface SendEmailResponse {
1550 /**
1551 * A unique identifier for the message that is generated when Amazon Pinpoint accepts the message. It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
1552 */
1553 MessageId?: OutboundMessageId;
1554 }
1555 export interface SendQuota {
1556 /**
1557 * 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.
1558 */
1559 Max24HourSend?: Max24HourSend;
1560 /**
1561 * 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.
1562 */
1563 MaxSendRate?: MaxSendRate;
1564 /**
1565 * The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
1566 */
1567 SentLast24Hours?: SentLast24Hours;
1568 }
1569 export interface SendingOptions {
1570 /**
1571 * If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
1572 */
1573 SendingEnabled?: Enabled;
1574 }
1575 export type SendingPoolName = string;
1576 export type SentLast24Hours = number;
1577 export interface SnsDestination {
1578 /**
1579 * 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.
1580 */
1581 TopicArn: AmazonResourceName;
1582 }
1583 export type Subject = string;
1584 export interface Tag {
1585 /**
1586 * 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.
1587 */
1588 Key: TagKey;
1589 /**
1590 * 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. Amazon Pinpoint will set the value to an empty string.
1591 */
1592 Value: TagValue;
1593 }
1594 export type TagKey = string;
1595 export type TagKeyList = TagKey[];
1596 export type TagList = Tag[];
1597 export interface TagResourceRequest {
1598 /**
1599 * The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
1600 */
1601 ResourceArn: AmazonResourceName;
1602 /**
1603 * 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.
1604 */
1605 Tags: TagList;
1606 }
1607 export interface TagResourceResponse {
1608 }
1609 export type TagValue = string;
1610 export interface Template {
1611 /**
1612 * The Amazon Resource Name (ARN) of the template.
1613 */
1614 TemplateArn?: TemplateArn;
1615 /**
1616 * 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.
1617 */
1618 TemplateData?: TemplateData;
1619 }
1620 export type TemplateArn = string;
1621 export type TemplateData = string;
1622 export type Timestamp = Date;
1623 export type TlsPolicy = "REQUIRE"|"OPTIONAL"|string;
1624 export interface TrackingOptions {
1625 /**
1626 * The domain that you want to use for tracking open and click events.
1627 */
1628 CustomRedirectDomain: CustomRedirectDomain;
1629 }
1630 export interface UntagResourceRequest {
1631 /**
1632 * The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
1633 */
1634 ResourceArn: AmazonResourceName;
1635 /**
1636 * 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: /v1/email/tags?ResourceArn=ResourceArn&amp;TagKeys=Key1&amp;TagKeys=Key2
1637 */
1638 TagKeys: TagKeyList;
1639 }
1640 export interface UntagResourceResponse {
1641 }
1642 export interface UpdateConfigurationSetEventDestinationRequest {
1643 /**
1644 * The name of the configuration set that contains the event destination that you want to modify.
1645 */
1646 ConfigurationSetName: ConfigurationSetName;
1647 /**
1648 * The name of the event destination that you want to modify.
1649 */
1650 EventDestinationName: EventDestinationName;
1651 /**
1652 * An object that defines the event destination.
1653 */
1654 EventDestination: EventDestinationDefinition;
1655 }
1656 export interface UpdateConfigurationSetEventDestinationResponse {
1657 }
1658 export type Volume = number;
1659 export interface VolumeStatistics {
1660 /**
1661 * The total number of emails that arrived in recipients' inboxes.
1662 */
1663 InboxRawCount?: Volume;
1664 /**
1665 * The total number of emails that arrived in recipients' spam or junk mail folders.
1666 */
1667 SpamRawCount?: Volume;
1668 /**
1669 * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
1670 */
1671 ProjectedInbox?: Volume;
1672 /**
1673 * An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
1674 */
1675 ProjectedSpam?: Volume;
1676 }
1677 export type WarmupStatus = "IN_PROGRESS"|"DONE"|string;
1678 /**
1679 * 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.
1680 */
1681 export type apiVersion = "2018-07-26"|"latest"|string;
1682 export interface ClientApiVersions {
1683 /**
1684 * 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.
1685 */
1686 apiVersion?: apiVersion;
1687 }
1688 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1689 /**
1690 * Contains interfaces for use with the PinpointEmail client.
1691 */
1692 export import Types = PinpointEmail;
1693}
1694export = PinpointEmail;