💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2024-09-29 at 00:42:45. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2023-01-29)
-=-=-=-=-=-=-
ses.d.ts (121821B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class SES extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: SES.Types.ClientConfiguration) 13 config: Config & SES.Types.ClientConfiguration; 14 /** 15 * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 16 */ 17 cloneReceiptRuleSet(params: SES.Types.CloneReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request<SES.Types.CloneReceiptRuleSetResponse, AWSError>; 18 /** 19 * Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 20 */ 21 cloneReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CloneReceiptRuleSetResponse) => void): Request<SES.Types.CloneReceiptRuleSetResponse, AWSError>; 22 /** 23 * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 24 */ 25 createConfigurationSet(params: SES.Types.CreateConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request<SES.Types.CreateConfigurationSetResponse, AWSError>; 26 /** 27 * Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 28 */ 29 createConfigurationSet(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetResponse) => void): Request<SES.Types.CreateConfigurationSetResponse, AWSError>; 30 /** 31 * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose. An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 32 */ 33 createConfigurationSetEventDestination(params: SES.Types.CreateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.CreateConfigurationSetEventDestinationResponse, AWSError>; 34 /** 35 * Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose. An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 36 */ 37 createConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.CreateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.CreateConfigurationSetEventDestinationResponse, AWSError>; 38 /** 39 * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 40 */ 41 createReceiptFilter(params: SES.Types.CreateReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request<SES.Types.CreateReceiptFilterResponse, AWSError>; 42 /** 43 * Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 44 */ 45 createReceiptFilter(callback?: (err: AWSError, data: SES.Types.CreateReceiptFilterResponse) => void): Request<SES.Types.CreateReceiptFilterResponse, AWSError>; 46 /** 47 * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 48 */ 49 createReceiptRule(params: SES.Types.CreateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request<SES.Types.CreateReceiptRuleResponse, AWSError>; 50 /** 51 * Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 52 */ 53 createReceiptRule(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleResponse) => void): Request<SES.Types.CreateReceiptRuleResponse, AWSError>; 54 /** 55 * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 56 */ 57 createReceiptRuleSet(params: SES.Types.CreateReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request<SES.Types.CreateReceiptRuleSetResponse, AWSError>; 58 /** 59 * Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 60 */ 61 createReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.CreateReceiptRuleSetResponse) => void): Request<SES.Types.CreateReceiptRuleSetResponse, AWSError>; 62 /** 63 * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 64 */ 65 deleteConfigurationSet(params: SES.Types.DeleteConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request<SES.Types.DeleteConfigurationSetResponse, AWSError>; 66 /** 67 * Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 68 */ 69 deleteConfigurationSet(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetResponse) => void): Request<SES.Types.DeleteConfigurationSetResponse, AWSError>; 70 /** 71 * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 72 */ 73 deleteConfigurationSetEventDestination(params: SES.Types.DeleteConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SES.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>; 74 /** 75 * Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 76 */ 77 deleteConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.DeleteConfigurationSetEventDestinationResponse) => void): Request<SES.Types.DeleteConfigurationSetEventDestinationResponse, AWSError>; 78 /** 79 * Deletes the specified identity (an email address or a domain) from the list of verified identities. This action is throttled at one request per second. 80 */ 81 deleteIdentity(params: SES.Types.DeleteIdentityRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request<SES.Types.DeleteIdentityResponse, AWSError>; 82 /** 83 * Deletes the specified identity (an email address or a domain) from the list of verified identities. This action is throttled at one request per second. 84 */ 85 deleteIdentity(callback?: (err: AWSError, data: SES.Types.DeleteIdentityResponse) => void): Request<SES.Types.DeleteIdentityResponse, AWSError>; 86 /** 87 * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 88 */ 89 deleteIdentityPolicy(params: SES.Types.DeleteIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request<SES.Types.DeleteIdentityPolicyResponse, AWSError>; 90 /** 91 * Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 92 */ 93 deleteIdentityPolicy(callback?: (err: AWSError, data: SES.Types.DeleteIdentityPolicyResponse) => void): Request<SES.Types.DeleteIdentityPolicyResponse, AWSError>; 94 /** 95 * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 96 */ 97 deleteReceiptFilter(params: SES.Types.DeleteReceiptFilterRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request<SES.Types.DeleteReceiptFilterResponse, AWSError>; 98 /** 99 * Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 100 */ 101 deleteReceiptFilter(callback?: (err: AWSError, data: SES.Types.DeleteReceiptFilterResponse) => void): Request<SES.Types.DeleteReceiptFilterResponse, AWSError>; 102 /** 103 * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 104 */ 105 deleteReceiptRule(params: SES.Types.DeleteReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request<SES.Types.DeleteReceiptRuleResponse, AWSError>; 106 /** 107 * Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 108 */ 109 deleteReceiptRule(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleResponse) => void): Request<SES.Types.DeleteReceiptRuleResponse, AWSError>; 110 /** 111 * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 112 */ 113 deleteReceiptRuleSet(params: SES.Types.DeleteReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request<SES.Types.DeleteReceiptRuleSetResponse, AWSError>; 114 /** 115 * Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 116 */ 117 deleteReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DeleteReceiptRuleSetResponse) => void): Request<SES.Types.DeleteReceiptRuleSetResponse, AWSError>; 118 /** 119 * Deletes the specified email address from the list of verified addresses. The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred. This action is throttled at one request per second. 120 */ 121 deleteVerifiedEmailAddress(params: SES.Types.DeleteVerifiedEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 122 /** 123 * Deletes the specified email address from the list of verified addresses. The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred. This action is throttled at one request per second. 124 */ 125 deleteVerifiedEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 126 /** 127 * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 128 */ 129 describeActiveReceiptRuleSet(params: SES.Types.DescribeActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request<SES.Types.DescribeActiveReceiptRuleSetResponse, AWSError>; 130 /** 131 * Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 132 */ 133 describeActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeActiveReceiptRuleSetResponse) => void): Request<SES.Types.DescribeActiveReceiptRuleSetResponse, AWSError>; 134 /** 135 * Returns the details of the specified configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 136 */ 137 describeConfigurationSet(params: SES.Types.DescribeConfigurationSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request<SES.Types.DescribeConfigurationSetResponse, AWSError>; 138 /** 139 * Returns the details of the specified configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 140 */ 141 describeConfigurationSet(callback?: (err: AWSError, data: SES.Types.DescribeConfigurationSetResponse) => void): Request<SES.Types.DescribeConfigurationSetResponse, AWSError>; 142 /** 143 * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 144 */ 145 describeReceiptRule(params: SES.Types.DescribeReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request<SES.Types.DescribeReceiptRuleResponse, AWSError>; 146 /** 147 * Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 148 */ 149 describeReceiptRule(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleResponse) => void): Request<SES.Types.DescribeReceiptRuleResponse, AWSError>; 150 /** 151 * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 152 */ 153 describeReceiptRuleSet(params: SES.Types.DescribeReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request<SES.Types.DescribeReceiptRuleSetResponse, AWSError>; 154 /** 155 * Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 156 */ 157 describeReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.DescribeReceiptRuleSetResponse) => void): Request<SES.Types.DescribeReceiptRuleSetResponse, AWSError>; 158 /** 159 * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This action takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 160 */ 161 getIdentityDkimAttributes(params: SES.Types.GetIdentityDkimAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request<SES.Types.GetIdentityDkimAttributesResponse, AWSError>; 162 /** 163 * Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This action takes a list of identities as input and returns the following information for each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 164 */ 165 getIdentityDkimAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityDkimAttributesResponse) => void): Request<SES.Types.GetIdentityDkimAttributesResponse, AWSError>; 166 /** 167 * Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains). This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. 168 */ 169 getIdentityMailFromDomainAttributes(params: SES.Types.GetIdentityMailFromDomainAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request<SES.Types.GetIdentityMailFromDomainAttributesResponse, AWSError>; 170 /** 171 * Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains). This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. 172 */ 173 getIdentityMailFromDomainAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityMailFromDomainAttributesResponse) => void): Request<SES.Types.GetIdentityMailFromDomainAttributesResponse, AWSError>; 174 /** 175 * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 176 */ 177 getIdentityNotificationAttributes(params: SES.Types.GetIdentityNotificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request<SES.Types.GetIdentityNotificationAttributesResponse, AWSError>; 178 /** 179 * Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 180 */ 181 getIdentityNotificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityNotificationAttributesResponse) => void): Request<SES.Types.GetIdentityNotificationAttributesResponse, AWSError>; 182 /** 183 * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 184 */ 185 getIdentityPolicies(params: SES.Types.GetIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request<SES.Types.GetIdentityPoliciesResponse, AWSError>; 186 /** 187 * Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 188 */ 189 getIdentityPolicies(callback?: (err: AWSError, data: SES.Types.GetIdentityPoliciesResponse) => void): Request<SES.Types.GetIdentityPoliciesResponse, AWSError>; 190 /** 191 * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. 192 */ 193 getIdentityVerificationAttributes(params: SES.Types.GetIdentityVerificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>; 194 /** 195 * Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. 196 */ 197 getIdentityVerificationAttributes(callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>; 198 /** 199 * Returns the user's current sending limits. This action is throttled at one request per second. 200 */ 201 getSendQuota(callback?: (err: AWSError, data: SES.Types.GetSendQuotaResponse) => void): Request<SES.Types.GetSendQuotaResponse, AWSError>; 202 /** 203 * Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute interval. This action is throttled at one request per second. 204 */ 205 getSendStatistics(callback?: (err: AWSError, data: SES.Types.GetSendStatisticsResponse) => void): Request<SES.Types.GetSendStatisticsResponse, AWSError>; 206 /** 207 * Lists the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second and can return up to 50 configuration sets at a time. 208 */ 209 listConfigurationSets(params: SES.Types.ListConfigurationSetsRequest, callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request<SES.Types.ListConfigurationSetsResponse, AWSError>; 210 /** 211 * Lists the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second and can return up to 50 configuration sets at a time. 212 */ 213 listConfigurationSets(callback?: (err: AWSError, data: SES.Types.ListConfigurationSetsResponse) => void): Request<SES.Types.ListConfigurationSetsResponse, AWSError>; 214 /** 215 * Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status. This action is throttled at one request per second. 216 */ 217 listIdentities(params: SES.Types.ListIdentitiesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request<SES.Types.ListIdentitiesResponse, AWSError>; 218 /** 219 * Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status. This action is throttled at one request per second. 220 */ 221 listIdentities(callback?: (err: AWSError, data: SES.Types.ListIdentitiesResponse) => void): Request<SES.Types.ListIdentitiesResponse, AWSError>; 222 /** 223 * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 224 */ 225 listIdentityPolicies(params: SES.Types.ListIdentityPoliciesRequest, callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request<SES.Types.ListIdentityPoliciesResponse, AWSError>; 226 /** 227 * Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 228 */ 229 listIdentityPolicies(callback?: (err: AWSError, data: SES.Types.ListIdentityPoliciesResponse) => void): Request<SES.Types.ListIdentityPoliciesResponse, AWSError>; 230 /** 231 * Lists the IP address filters associated with your AWS account. For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 232 */ 233 listReceiptFilters(params: SES.Types.ListReceiptFiltersRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request<SES.Types.ListReceiptFiltersResponse, AWSError>; 234 /** 235 * Lists the IP address filters associated with your AWS account. For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. 236 */ 237 listReceiptFilters(callback?: (err: AWSError, data: SES.Types.ListReceiptFiltersResponse) => void): Request<SES.Types.ListReceiptFiltersResponse, AWSError>; 238 /** 239 * Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 240 */ 241 listReceiptRuleSets(params: SES.Types.ListReceiptRuleSetsRequest, callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request<SES.Types.ListReceiptRuleSetsResponse, AWSError>; 242 /** 243 * Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 244 */ 245 listReceiptRuleSets(callback?: (err: AWSError, data: SES.Types.ListReceiptRuleSetsResponse) => void): Request<SES.Types.ListReceiptRuleSetsResponse, AWSError>; 246 /** 247 * Returns a list containing all of the email addresses that have been verified. The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred. This action is throttled at one request per second. 248 */ 249 listVerifiedEmailAddresses(callback?: (err: AWSError, data: SES.Types.ListVerifiedEmailAddressesResponse) => void): Request<SES.Types.ListVerifiedEmailAddressesResponse, AWSError>; 250 /** 251 * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 252 */ 253 putIdentityPolicy(params: SES.Types.PutIdentityPolicyRequest, callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request<SES.Types.PutIdentityPolicyResponse, AWSError>; 254 /** 255 * Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide. This action is throttled at one request per second. 256 */ 257 putIdentityPolicy(callback?: (err: AWSError, data: SES.Types.PutIdentityPolicyResponse) => void): Request<SES.Types.PutIdentityPolicyResponse, AWSError>; 258 /** 259 * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 260 */ 261 reorderReceiptRuleSet(params: SES.Types.ReorderReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request<SES.Types.ReorderReceiptRuleSetResponse, AWSError>; 262 /** 263 * Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 264 */ 265 reorderReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.ReorderReceiptRuleSetResponse) => void): Request<SES.Types.ReorderReceiptRuleSetResponse, AWSError>; 266 /** 267 * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. This action is throttled at one request per second. 268 */ 269 sendBounce(params: SES.Types.SendBounceRequest, callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request<SES.Types.SendBounceResponse, AWSError>; 270 /** 271 * Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. This action is throttled at one request per second. 272 */ 273 sendBounce(callback?: (err: AWSError, data: SES.Types.SendBounceResponse) => void): Request<SES.Types.SendBounceResponse, AWSError>; 274 /** 275 * Composes an email message based on input data, and then immediately queues the message for sending. There are several important points to know about SendEmail: You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. 276 */ 277 sendEmail(params: SES.Types.SendEmailRequest, callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request<SES.Types.SendEmailResponse, AWSError>; 278 /** 279 * Composes an email message based on input data, and then immediately queues the message for sending. There are several important points to know about SendEmail: You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. 280 */ 281 sendEmail(callback?: (err: AWSError, data: SES.Types.SendEmailResponse) => void): Request<SES.Types.SendEmailResponse, AWSError>; 282 /** 283 * Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. There are several important points to know about SendRawEmail: You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit. Amazon SES overrides any Message-ID and Date headers you provide. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide. 284 */ 285 sendRawEmail(params: SES.Types.SendRawEmailRequest, callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request<SES.Types.SendRawEmailResponse, AWSError>; 286 /** 287 * Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. There are several important points to know about SendRawEmail: You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide. The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message. Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group. The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit. Amazon SES overrides any Message-ID and Date headers you provide. For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide. If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN X-SES-RETURN-PATH-ARN Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide. 288 */ 289 sendRawEmail(callback?: (err: AWSError, data: SES.Types.SendRawEmailResponse) => void): Request<SES.Types.SendRawEmailResponse, AWSError>; 290 /** 291 * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 292 */ 293 setActiveReceiptRuleSet(params: SES.Types.SetActiveReceiptRuleSetRequest, callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request<SES.Types.SetActiveReceiptRuleSetResponse, AWSError>; 294 /** 295 * Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 296 */ 297 setActiveReceiptRuleSet(callback?: (err: AWSError, data: SES.Types.SetActiveReceiptRuleSetResponse) => void): Request<SES.Types.SetActiveReceiptRuleSetResponse, AWSError>; 298 /** 299 * Enables or disables Easy DKIM signing of email sent from an identity: If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com). If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address. For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action. This action is throttled at one request per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. 300 */ 301 setIdentityDkimEnabled(params: SES.Types.SetIdentityDkimEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request<SES.Types.SetIdentityDkimEnabledResponse, AWSError>; 302 /** 303 * Enables or disables Easy DKIM signing of email sent from an identity: If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com). If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address. For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action. This action is throttled at one request per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. 304 */ 305 setIdentityDkimEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityDkimEnabledResponse) => void): Request<SES.Types.SetIdentityDkimEnabledResponse, AWSError>; 306 /** 307 * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. This action is throttled at one request per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 308 */ 309 setIdentityFeedbackForwardingEnabled(params: SES.Types.SetIdentityFeedbackForwardingEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request<SES.Types.SetIdentityFeedbackForwardingEnabledResponse, AWSError>; 310 /** 311 * Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. This action is throttled at one request per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 312 */ 313 setIdentityFeedbackForwardingEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityFeedbackForwardingEnabledResponse) => void): Request<SES.Types.SetIdentityFeedbackForwardingEnabledResponse, AWSError>; 314 /** 315 * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. This action is throttled at one request per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 316 */ 317 setIdentityHeadersInNotificationsEnabled(params: SES.Types.SetIdentityHeadersInNotificationsEnabledRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request<SES.Types.SetIdentityHeadersInNotificationsEnabledResponse, AWSError>; 318 /** 319 * Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. This action is throttled at one request per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. 320 */ 321 setIdentityHeadersInNotificationsEnabled(callback?: (err: AWSError, data: SES.Types.SetIdentityHeadersInNotificationsEnabledResponse) => void): Request<SES.Types.SetIdentityHeadersInNotificationsEnabledResponse, AWSError>; 322 /** 323 * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. This action is throttled at one request per second. 324 */ 325 setIdentityMailFromDomain(params: SES.Types.SetIdentityMailFromDomainRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request<SES.Types.SetIdentityMailFromDomainResponse, AWSError>; 326 /** 327 * Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide. This action is throttled at one request per second. 328 */ 329 setIdentityMailFromDomain(callback?: (err: AWSError, data: SES.Types.SetIdentityMailFromDomainResponse) => void): Request<SES.Types.SetIdentityMailFromDomainResponse, AWSError>; 330 /** 331 * Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source. Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled. This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. 332 */ 333 setIdentityNotificationTopic(params: SES.Types.SetIdentityNotificationTopicRequest, callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request<SES.Types.SetIdentityNotificationTopicResponse, AWSError>; 334 /** 335 * Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source. Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled. This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. 336 */ 337 setIdentityNotificationTopic(callback?: (err: AWSError, data: SES.Types.SetIdentityNotificationTopicResponse) => void): Request<SES.Types.SetIdentityNotificationTopicResponse, AWSError>; 338 /** 339 * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 340 */ 341 setReceiptRulePosition(params: SES.Types.SetReceiptRulePositionRequest, callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request<SES.Types.SetReceiptRulePositionResponse, AWSError>; 342 /** 343 * Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 344 */ 345 setReceiptRulePosition(callback?: (err: AWSError, data: SES.Types.SetReceiptRulePositionResponse) => void): Request<SES.Types.SetReceiptRulePositionResponse, AWSError>; 346 /** 347 * Updates the event destination of a configuration set. When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 348 */ 349 updateConfigurationSetEventDestination(params: SES.Types.UpdateConfigurationSetEventDestinationRequest, callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>; 350 /** 351 * Updates the event destination of a configuration set. When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. 352 */ 353 updateConfigurationSetEventDestination(callback?: (err: AWSError, data: SES.Types.UpdateConfigurationSetEventDestinationResponse) => void): Request<SES.Types.UpdateConfigurationSetEventDestinationResponse, AWSError>; 354 /** 355 * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 356 */ 357 updateReceiptRule(params: SES.Types.UpdateReceiptRuleRequest, callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request<SES.Types.UpdateReceiptRuleResponse, AWSError>; 358 /** 359 * Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. 360 */ 361 updateReceiptRule(callback?: (err: AWSError, data: SES.Types.UpdateReceiptRuleResponse) => void): Request<SES.Types.UpdateReceiptRuleResponse, AWSError>; 362 /** 363 * Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. This action is throttled at one request per second. To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 364 */ 365 verifyDomainDkim(params: SES.Types.VerifyDomainDkimRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request<SES.Types.VerifyDomainDkimResponse, AWSError>; 366 /** 367 * Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. This action is throttled at one request per second. To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 368 */ 369 verifyDomainDkim(callback?: (err: AWSError, data: SES.Types.VerifyDomainDkimResponse) => void): Request<SES.Types.VerifyDomainDkimResponse, AWSError>; 370 /** 371 * Verifies a domain. This action is throttled at one request per second. 372 */ 373 verifyDomainIdentity(params: SES.Types.VerifyDomainIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request<SES.Types.VerifyDomainIdentityResponse, AWSError>; 374 /** 375 * Verifies a domain. This action is throttled at one request per second. 376 */ 377 verifyDomainIdentity(callback?: (err: AWSError, data: SES.Types.VerifyDomainIdentityResponse) => void): Request<SES.Types.VerifyDomainIdentityResponse, AWSError>; 378 /** 379 * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred. This action is throttled at one request per second. 380 */ 381 verifyEmailAddress(params: SES.Types.VerifyEmailAddressRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 382 /** 383 * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred. This action is throttled at one request per second. 384 */ 385 verifyEmailAddress(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 386 /** 387 * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. This action is throttled at one request per second. 388 */ 389 verifyEmailIdentity(params: SES.Types.VerifyEmailIdentityRequest, callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request<SES.Types.VerifyEmailIdentityResponse, AWSError>; 390 /** 391 * Verifies an email address. This action causes a confirmation email message to be sent to the specified address. This action is throttled at one request per second. 392 */ 393 verifyEmailIdentity(callback?: (err: AWSError, data: SES.Types.VerifyEmailIdentityResponse) => void): Request<SES.Types.VerifyEmailIdentityResponse, AWSError>; 394 /** 395 * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times). 396 */ 397 waitFor(state: "identityExists", params: SES.Types.GetIdentityVerificationAttributesRequest, callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>; 398 /** 399 * Waits for the identityExists state by periodically calling the underlying SES.getIdentityVerificationAttributesoperation every 3 seconds (at most 20 times). 400 */ 401 waitFor(state: "identityExists", callback?: (err: AWSError, data: SES.Types.GetIdentityVerificationAttributesResponse) => void): Request<SES.Types.GetIdentityVerificationAttributesResponse, AWSError>; 402 } 403 declare namespace SES.Types { 404 export interface AddHeaderAction { 405 /** 406 * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. 407 */ 408 HeaderName: HeaderName; 409 /** 410 * Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n"). 411 */ 412 HeaderValue: HeaderValue; 413 } 414 export type Address = string; 415 export type AddressList = Address[]; 416 export type AmazonResourceName = string; 417 export type ArrivalDate = Date; 418 export type BehaviorOnMXFailure = "UseDefaultValue"|"RejectMessage"|string; 419 export interface Body { 420 /** 421 * The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices). 422 */ 423 Text?: Content; 424 /** 425 * The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message. 426 */ 427 Html?: Content; 428 } 429 export interface BounceAction { 430 /** 431 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 432 */ 433 TopicArn?: AmazonResourceName; 434 /** 435 * The SMTP reply code, as defined by RFC 5321. 436 */ 437 SmtpReplyCode: BounceSmtpReplyCode; 438 /** 439 * The SMTP enhanced status code, as defined by RFC 3463. 440 */ 441 StatusCode?: BounceStatusCode; 442 /** 443 * Human-readable text to include in the bounce message. 444 */ 445 Message: BounceMessage; 446 /** 447 * The email address of the sender of the bounced email. This is the address from which the bounce message will be sent. 448 */ 449 Sender: Address; 450 } 451 export type BounceMessage = string; 452 export type BounceSmtpReplyCode = string; 453 export type BounceStatusCode = string; 454 export type BounceType = "DoesNotExist"|"MessageTooLarge"|"ExceededQuota"|"ContentRejected"|"Undefined"|"TemporaryFailure"|string; 455 export interface BouncedRecipientInfo { 456 /** 457 * The email address of the recipient of the bounced email. 458 */ 459 Recipient: Address; 460 /** 461 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide. 462 */ 463 RecipientArn?: AmazonResourceName; 464 /** 465 * The reason for the bounce. You must provide either this parameter or RecipientDsnFields. 466 */ 467 BounceType?: BounceType; 468 /** 469 * Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType. 470 */ 471 RecipientDsnFields?: RecipientDsnFields; 472 } 473 export type BouncedRecipientInfoList = BouncedRecipientInfo[]; 474 export type Charset = string; 475 export type Cidr = string; 476 export interface CloneReceiptRuleSetRequest { 477 /** 478 * The name of the rule set to create. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. 479 */ 480 RuleSetName: ReceiptRuleSetName; 481 /** 482 * The name of the rule set to clone. 483 */ 484 OriginalRuleSetName: ReceiptRuleSetName; 485 } 486 export interface CloneReceiptRuleSetResponse { 487 } 488 export interface CloudWatchDestination { 489 /** 490 * A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. 491 */ 492 DimensionConfigurations: CloudWatchDimensionConfigurations; 493 } 494 export interface CloudWatchDimensionConfiguration { 495 /** 496 * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. 497 */ 498 DimensionName: DimensionName; 499 /** 500 * The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader. 501 */ 502 DimensionValueSource: DimensionValueSource; 503 /** 504 * The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. 505 */ 506 DefaultDimensionValue: DefaultDimensionValue; 507 } 508 export type CloudWatchDimensionConfigurations = CloudWatchDimensionConfiguration[]; 509 export interface ConfigurationSet { 510 /** 511 * The name of the configuration set. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 64 characters. 512 */ 513 Name: ConfigurationSetName; 514 } 515 export type ConfigurationSetAttribute = "eventDestinations"|string; 516 export type ConfigurationSetAttributeList = ConfigurationSetAttribute[]; 517 export type ConfigurationSetName = string; 518 export type ConfigurationSets = ConfigurationSet[]; 519 export interface Content { 520 /** 521 * The textual data of the content. 522 */ 523 Data: MessageData; 524 /** 525 * The character set of the content. 526 */ 527 Charset?: Charset; 528 } 529 export type Counter = number; 530 export interface CreateConfigurationSetEventDestinationRequest { 531 /** 532 * The name of the configuration set to which to apply the event destination. 533 */ 534 ConfigurationSetName: ConfigurationSetName; 535 /** 536 * An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set. 537 */ 538 EventDestination: EventDestination; 539 } 540 export interface CreateConfigurationSetEventDestinationResponse { 541 } 542 export interface CreateConfigurationSetRequest { 543 /** 544 * A data structure that contains the name of the configuration set. 545 */ 546 ConfigurationSet: ConfigurationSet; 547 } 548 export interface CreateConfigurationSetResponse { 549 } 550 export interface CreateReceiptFilterRequest { 551 /** 552 * A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it. 553 */ 554 Filter: ReceiptFilter; 555 } 556 export interface CreateReceiptFilterResponse { 557 } 558 export interface CreateReceiptRuleRequest { 559 /** 560 * The name of the rule set to which to add the rule. 561 */ 562 RuleSetName: ReceiptRuleSetName; 563 /** 564 * The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. 565 */ 566 After?: ReceiptRuleName; 567 /** 568 * A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy. 569 */ 570 Rule: ReceiptRule; 571 } 572 export interface CreateReceiptRuleResponse { 573 } 574 export interface CreateReceiptRuleSetRequest { 575 /** 576 * The name of the rule set to create. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. 577 */ 578 RuleSetName: ReceiptRuleSetName; 579 } 580 export interface CreateReceiptRuleSetResponse { 581 } 582 export type CustomMailFromStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|string; 583 export type DefaultDimensionValue = string; 584 export interface DeleteConfigurationSetEventDestinationRequest { 585 /** 586 * The name of the configuration set from which to delete the event destination. 587 */ 588 ConfigurationSetName: ConfigurationSetName; 589 /** 590 * The name of the event destination to delete. 591 */ 592 EventDestinationName: EventDestinationName; 593 } 594 export interface DeleteConfigurationSetEventDestinationResponse { 595 } 596 export interface DeleteConfigurationSetRequest { 597 /** 598 * The name of the configuration set to delete. 599 */ 600 ConfigurationSetName: ConfigurationSetName; 601 } 602 export interface DeleteConfigurationSetResponse { 603 } 604 export interface DeleteIdentityPolicyRequest { 605 /** 606 * The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. 607 */ 608 Identity: Identity; 609 /** 610 * The name of the policy to be deleted. 611 */ 612 PolicyName: PolicyName; 613 } 614 export interface DeleteIdentityPolicyResponse { 615 } 616 export interface DeleteIdentityRequest { 617 /** 618 * The identity to be removed from the list of identities for the AWS Account. 619 */ 620 Identity: Identity; 621 } 622 export interface DeleteIdentityResponse { 623 } 624 export interface DeleteReceiptFilterRequest { 625 /** 626 * The name of the IP address filter to delete. 627 */ 628 FilterName: ReceiptFilterName; 629 } 630 export interface DeleteReceiptFilterResponse { 631 } 632 export interface DeleteReceiptRuleRequest { 633 /** 634 * The name of the receipt rule set that contains the receipt rule to delete. 635 */ 636 RuleSetName: ReceiptRuleSetName; 637 /** 638 * The name of the receipt rule to delete. 639 */ 640 RuleName: ReceiptRuleName; 641 } 642 export interface DeleteReceiptRuleResponse { 643 } 644 export interface DeleteReceiptRuleSetRequest { 645 /** 646 * The name of the receipt rule set to delete. 647 */ 648 RuleSetName: ReceiptRuleSetName; 649 } 650 export interface DeleteReceiptRuleSetResponse { 651 } 652 export interface DeleteVerifiedEmailAddressRequest { 653 /** 654 * An email address to be removed from the list of verified addresses. 655 */ 656 EmailAddress: Address; 657 } 658 export interface DescribeActiveReceiptRuleSetRequest { 659 } 660 export interface DescribeActiveReceiptRuleSetResponse { 661 /** 662 * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created. 663 */ 664 Metadata?: ReceiptRuleSetMetadata; 665 /** 666 * The receipt rules that belong to the active rule set. 667 */ 668 Rules?: ReceiptRulesList; 669 } 670 export interface DescribeConfigurationSetRequest { 671 /** 672 * The name of the configuration set to describe. 673 */ 674 ConfigurationSetName: ConfigurationSetName; 675 /** 676 * A list of configuration set attributes to return. 677 */ 678 ConfigurationSetAttributeNames?: ConfigurationSetAttributeList; 679 } 680 export interface DescribeConfigurationSetResponse { 681 /** 682 * The configuration set object associated with the specified configuration set. 683 */ 684 ConfigurationSet?: ConfigurationSet; 685 /** 686 * A list of event destinations associated with the configuration set. 687 */ 688 EventDestinations?: EventDestinations; 689 } 690 export interface DescribeReceiptRuleRequest { 691 /** 692 * The name of the receipt rule set to which the receipt rule belongs. 693 */ 694 RuleSetName: ReceiptRuleSetName; 695 /** 696 * The name of the receipt rule. 697 */ 698 RuleName: ReceiptRuleName; 699 } 700 export interface DescribeReceiptRuleResponse { 701 /** 702 * A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy. 703 */ 704 Rule?: ReceiptRule; 705 } 706 export interface DescribeReceiptRuleSetRequest { 707 /** 708 * The name of the receipt rule set to describe. 709 */ 710 RuleSetName: ReceiptRuleSetName; 711 } 712 export interface DescribeReceiptRuleSetResponse { 713 /** 714 * The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created. 715 */ 716 Metadata?: ReceiptRuleSetMetadata; 717 /** 718 * A list of the receipt rules that belong to the specified receipt rule set. 719 */ 720 Rules?: ReceiptRulesList; 721 } 722 export interface Destination { 723 /** 724 * The To: field(s) of the message. 725 */ 726 ToAddresses?: AddressList; 727 /** 728 * The CC: field(s) of the message. 729 */ 730 CcAddresses?: AddressList; 731 /** 732 * The BCC: field(s) of the message. 733 */ 734 BccAddresses?: AddressList; 735 } 736 export type DiagnosticCode = string; 737 export type DimensionName = string; 738 export type DimensionValueSource = "messageTag"|"emailHeader"|string; 739 export type DkimAttributes = {[key: string]: IdentityDkimAttributes}; 740 export type Domain = string; 741 export type DsnAction = "failed"|"delayed"|"delivered"|"relayed"|"expanded"|string; 742 export type DsnStatus = string; 743 export type Enabled = boolean; 744 export interface EventDestination { 745 /** 746 * The name of the event destination. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 64 characters. 747 */ 748 Name: EventDestinationName; 749 /** 750 * Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. 751 */ 752 Enabled?: Enabled; 753 /** 754 * The type of email sending events to publish to the event destination. 755 */ 756 MatchingEventTypes: EventTypes; 757 /** 758 * An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination. 759 */ 760 KinesisFirehoseDestination?: KinesisFirehoseDestination; 761 /** 762 * An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. 763 */ 764 CloudWatchDestination?: CloudWatchDestination; 765 } 766 export type EventDestinationName = string; 767 export type EventDestinations = EventDestination[]; 768 export type EventType = "send"|"reject"|"bounce"|"complaint"|"delivery"|string; 769 export type EventTypes = EventType[]; 770 export type Explanation = string; 771 export interface ExtensionField { 772 /** 773 * The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only. 774 */ 775 Name: ExtensionFieldName; 776 /** 777 * The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n"). 778 */ 779 Value: ExtensionFieldValue; 780 } 781 export type ExtensionFieldList = ExtensionField[]; 782 export type ExtensionFieldName = string; 783 export type ExtensionFieldValue = string; 784 export interface GetIdentityDkimAttributesRequest { 785 /** 786 * A list of one or more verified identities - email addresses, domains, or both. 787 */ 788 Identities: IdentityList; 789 } 790 export interface GetIdentityDkimAttributesResponse { 791 /** 792 * The DKIM attributes for an email address or a domain. 793 */ 794 DkimAttributes: DkimAttributes; 795 } 796 export interface GetIdentityMailFromDomainAttributesRequest { 797 /** 798 * A list of one or more identities. 799 */ 800 Identities: IdentityList; 801 } 802 export interface GetIdentityMailFromDomainAttributesResponse { 803 /** 804 * A map of identities to custom MAIL FROM attributes. 805 */ 806 MailFromDomainAttributes: MailFromDomainAttributes; 807 } 808 export interface GetIdentityNotificationAttributesRequest { 809 /** 810 * A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. 811 */ 812 Identities: IdentityList; 813 } 814 export interface GetIdentityNotificationAttributesResponse { 815 /** 816 * A map of Identity to IdentityNotificationAttributes. 817 */ 818 NotificationAttributes: NotificationAttributes; 819 } 820 export interface GetIdentityPoliciesRequest { 821 /** 822 * The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. 823 */ 824 Identity: Identity; 825 /** 826 * A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies. 827 */ 828 PolicyNames: PolicyNameList; 829 } 830 export interface GetIdentityPoliciesResponse { 831 /** 832 * A map of policy names to policies. 833 */ 834 Policies: PolicyMap; 835 } 836 export interface GetIdentityVerificationAttributesRequest { 837 /** 838 * A list of identities. 839 */ 840 Identities: IdentityList; 841 } 842 export interface GetIdentityVerificationAttributesResponse { 843 /** 844 * A map of Identities to IdentityVerificationAttributes objects. 845 */ 846 VerificationAttributes: VerificationAttributes; 847 } 848 export interface GetSendQuotaResponse { 849 /** 850 * The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota. 851 */ 852 Max24HourSend?: Max24HourSend; 853 /** 854 * The maximum number of emails that Amazon SES can accept from the user's account per second. The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate. 855 */ 856 MaxSendRate?: MaxSendRate; 857 /** 858 * The number of emails sent during the previous 24 hours. 859 */ 860 SentLast24Hours?: SentLast24Hours; 861 } 862 export interface GetSendStatisticsResponse { 863 /** 864 * A list of data points, each of which represents 15 minutes of activity. 865 */ 866 SendDataPoints?: SendDataPointList; 867 } 868 export type HeaderName = string; 869 export type HeaderValue = string; 870 export type Identity = string; 871 export interface IdentityDkimAttributes { 872 /** 873 * True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true. 874 */ 875 DkimEnabled: Enabled; 876 /** 877 * Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.) 878 */ 879 DkimVerificationStatus: VerificationStatus; 880 /** 881 * A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.) For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 882 */ 883 DkimTokens?: VerificationTokenList; 884 } 885 export type IdentityList = Identity[]; 886 export interface IdentityMailFromDomainAttributes { 887 /** 888 * The custom MAIL FROM domain that the identity is configured to use. 889 */ 890 MailFromDomain: MailFromDomainName; 891 /** 892 * The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure. 893 */ 894 MailFromDomainStatus: CustomMailFromStatus; 895 /** 896 * The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email. The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure. 897 */ 898 BehaviorOnMXFailure: BehaviorOnMXFailure; 899 } 900 export interface IdentityNotificationAttributes { 901 /** 902 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications. 903 */ 904 BounceTopic: NotificationTopic; 905 /** 906 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications. 907 */ 908 ComplaintTopic: NotificationTopic; 909 /** 910 * The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications. 911 */ 912 DeliveryTopic: NotificationTopic; 913 /** 914 * Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics. 915 */ 916 ForwardingEnabled: Enabled; 917 /** 918 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications. 919 */ 920 HeadersInBounceNotificationsEnabled?: Enabled; 921 /** 922 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications. 923 */ 924 HeadersInComplaintNotificationsEnabled?: Enabled; 925 /** 926 * Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications. 927 */ 928 HeadersInDeliveryNotificationsEnabled?: Enabled; 929 } 930 export type IdentityType = "EmailAddress"|"Domain"|string; 931 export interface IdentityVerificationAttributes { 932 /** 933 * The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure". 934 */ 935 VerificationStatus: VerificationStatus; 936 /** 937 * The verification token for a domain identity. Null for email address identities. 938 */ 939 VerificationToken?: VerificationToken; 940 } 941 export type InvocationType = "Event"|"RequestResponse"|string; 942 export interface KinesisFirehoseDestination { 943 /** 944 * The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. 945 */ 946 IAMRoleARN: AmazonResourceName; 947 /** 948 * The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events. 949 */ 950 DeliveryStreamARN: AmazonResourceName; 951 } 952 export interface LambdaAction { 953 /** 954 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 955 */ 956 TopicArn?: AmazonResourceName; 957 /** 958 * The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide. 959 */ 960 FunctionArn: AmazonResourceName; 961 /** 962 * The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set. 963 */ 964 InvocationType?: InvocationType; 965 } 966 export type LastAttemptDate = Date; 967 export interface ListConfigurationSetsRequest { 968 /** 969 * A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list. 970 */ 971 NextToken?: NextToken; 972 /** 973 * The number of configuration sets to return. 974 */ 975 MaxItems?: MaxItems; 976 } 977 export interface ListConfigurationSetsResponse { 978 /** 979 * A list of configuration sets. 980 */ 981 ConfigurationSets?: ConfigurationSets; 982 /** 983 * A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets. 984 */ 985 NextToken?: NextToken; 986 } 987 export interface ListIdentitiesRequest { 988 /** 989 * The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed. 990 */ 991 IdentityType?: IdentityType; 992 /** 993 * The token to use for pagination. 994 */ 995 NextToken?: NextToken; 996 /** 997 * The maximum number of identities per page. Possible values are 1-1000 inclusive. 998 */ 999 MaxItems?: MaxItems; 1000 } 1001 export interface ListIdentitiesResponse { 1002 /** 1003 * A list of identities. 1004 */ 1005 Identities: IdentityList; 1006 /** 1007 * The token used for pagination. 1008 */ 1009 NextToken?: NextToken; 1010 } 1011 export interface ListIdentityPoliciesRequest { 1012 /** 1013 * The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. 1014 */ 1015 Identity: Identity; 1016 } 1017 export interface ListIdentityPoliciesResponse { 1018 /** 1019 * A list of names of policies that apply to the specified identity. 1020 */ 1021 PolicyNames: PolicyNameList; 1022 } 1023 export interface ListReceiptFiltersRequest { 1024 } 1025 export interface ListReceiptFiltersResponse { 1026 /** 1027 * A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it. 1028 */ 1029 Filters?: ReceiptFilterList; 1030 } 1031 export interface ListReceiptRuleSetsRequest { 1032 /** 1033 * A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list. 1034 */ 1035 NextToken?: NextToken; 1036 } 1037 export interface ListReceiptRuleSetsResponse { 1038 /** 1039 * The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created. 1040 */ 1041 RuleSets?: ReceiptRuleSetsLists; 1042 /** 1043 * A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time. 1044 */ 1045 NextToken?: NextToken; 1046 } 1047 export interface ListVerifiedEmailAddressesResponse { 1048 /** 1049 * A list of email addresses that have been verified. 1050 */ 1051 VerifiedEmailAddresses?: AddressList; 1052 } 1053 export type MailFromDomainAttributes = {[key: string]: IdentityMailFromDomainAttributes}; 1054 export type MailFromDomainName = string; 1055 export type Max24HourSend = number; 1056 export type MaxItems = number; 1057 export type MaxSendRate = number; 1058 export interface Message { 1059 /** 1060 * The subject of the message: A short summary of the content, which will appear in the recipient's inbox. 1061 */ 1062 Subject: Content; 1063 /** 1064 * The message body. 1065 */ 1066 Body: Body; 1067 } 1068 export type MessageData = string; 1069 export interface MessageDsn { 1070 /** 1071 * The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com. 1072 */ 1073 ReportingMta: ReportingMta; 1074 /** 1075 * When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format. 1076 */ 1077 ArrivalDate?: ArrivalDate; 1078 /** 1079 * Additional X-headers to include in the DSN. 1080 */ 1081 ExtensionFields?: ExtensionFieldList; 1082 } 1083 export type MessageId = string; 1084 export interface MessageTag { 1085 /** 1086 * The name of the tag. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. 1087 */ 1088 Name: MessageTagName; 1089 /** 1090 * The value of the tag. The value must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). Contain less than 256 characters. 1091 */ 1092 Value: MessageTagValue; 1093 } 1094 export type MessageTagList = MessageTag[]; 1095 export type MessageTagName = string; 1096 export type MessageTagValue = string; 1097 export type NextToken = string; 1098 export type NotificationAttributes = {[key: string]: IdentityNotificationAttributes}; 1099 export type NotificationTopic = string; 1100 export type NotificationType = "Bounce"|"Complaint"|"Delivery"|string; 1101 export type Policy = string; 1102 export type PolicyMap = {[key: string]: Policy}; 1103 export type PolicyName = string; 1104 export type PolicyNameList = PolicyName[]; 1105 export interface PutIdentityPolicyRequest { 1106 /** 1107 * The identity to which the policy will apply. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this API, you must own the identity. 1108 */ 1109 Identity: Identity; 1110 /** 1111 * The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores. 1112 */ 1113 PolicyName: PolicyName; 1114 /** 1115 * The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide. 1116 */ 1117 Policy: Policy; 1118 } 1119 export interface PutIdentityPolicyResponse { 1120 } 1121 export interface RawMessage { 1122 /** 1123 * The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail. Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For more information, go to the Amazon SES Developer Guide. 1124 */ 1125 Data: RawMessageData; 1126 } 1127 export type RawMessageData = Buffer|Uint8Array|Blob|string; 1128 export interface ReceiptAction { 1129 /** 1130 * Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS. 1131 */ 1132 S3Action?: S3Action; 1133 /** 1134 * Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). 1135 */ 1136 BounceAction?: BounceAction; 1137 /** 1138 * Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS. 1139 */ 1140 WorkmailAction?: WorkmailAction; 1141 /** 1142 * Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS. 1143 */ 1144 LambdaAction?: LambdaAction; 1145 /** 1146 * Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS. 1147 */ 1148 StopAction?: StopAction; 1149 /** 1150 * Adds a header to the received email. 1151 */ 1152 AddHeaderAction?: AddHeaderAction; 1153 /** 1154 * Publishes the email content within a notification to Amazon SNS. 1155 */ 1156 SNSAction?: SNSAction; 1157 } 1158 export type ReceiptActionsList = ReceiptAction[]; 1159 export interface ReceiptFilter { 1160 /** 1161 * The name of the IP address filter. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. 1162 */ 1163 Name: ReceiptFilterName; 1164 /** 1165 * A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them. 1166 */ 1167 IpFilter: ReceiptIpFilter; 1168 } 1169 export type ReceiptFilterList = ReceiptFilter[]; 1170 export type ReceiptFilterName = string; 1171 export type ReceiptFilterPolicy = "Block"|"Allow"|string; 1172 export interface ReceiptIpFilter { 1173 /** 1174 * Indicates whether to block or allow incoming mail from the specified IP addresses. 1175 */ 1176 Policy: ReceiptFilterPolicy; 1177 /** 1178 * A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317. 1179 */ 1180 Cidr: Cidr; 1181 } 1182 export interface ReceiptRule { 1183 /** 1184 * The name of the receipt rule. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. 1185 */ 1186 Name: ReceiptRuleName; 1187 /** 1188 * If true, the receipt rule is active. The default value is false. 1189 */ 1190 Enabled?: Enabled; 1191 /** 1192 * Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional. 1193 */ 1194 TlsPolicy?: TlsPolicy; 1195 /** 1196 * The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains. 1197 */ 1198 Recipients?: RecipientsList; 1199 /** 1200 * An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. 1201 */ 1202 Actions?: ReceiptActionsList; 1203 /** 1204 * If true, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is false. 1205 */ 1206 ScanEnabled?: Enabled; 1207 } 1208 export type ReceiptRuleName = string; 1209 export type ReceiptRuleNamesList = ReceiptRuleName[]; 1210 export interface ReceiptRuleSetMetadata { 1211 /** 1212 * The name of the receipt rule set. The name must: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). Start and end with a letter or number. Contain less than 64 characters. 1213 */ 1214 Name?: ReceiptRuleSetName; 1215 /** 1216 * The date and time the receipt rule set was created. 1217 */ 1218 CreatedTimestamp?: Timestamp; 1219 } 1220 export type ReceiptRuleSetName = string; 1221 export type ReceiptRuleSetsLists = ReceiptRuleSetMetadata[]; 1222 export type ReceiptRulesList = ReceiptRule[]; 1223 export type Recipient = string; 1224 export interface RecipientDsnFields { 1225 /** 1226 * The email address to which the message was ultimately delivered. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message. Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798. 1227 */ 1228 FinalRecipient?: Address; 1229 /** 1230 * The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464. 1231 */ 1232 Action: DsnAction; 1233 /** 1234 * The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces. 1235 */ 1236 RemoteMta?: RemoteMta; 1237 /** 1238 * The status code that indicates what went wrong. This is required by RFC 3464. 1239 */ 1240 Status: DsnStatus; 1241 /** 1242 * An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter. 1243 */ 1244 DiagnosticCode?: DiagnosticCode; 1245 /** 1246 * The time the final delivery attempt was made, in RFC 822 date-time format. 1247 */ 1248 LastAttemptDate?: LastAttemptDate; 1249 /** 1250 * Additional X-headers to include in the DSN. 1251 */ 1252 ExtensionFields?: ExtensionFieldList; 1253 } 1254 export type RecipientsList = Recipient[]; 1255 export type RemoteMta = string; 1256 export interface ReorderReceiptRuleSetRequest { 1257 /** 1258 * The name of the receipt rule set to reorder. 1259 */ 1260 RuleSetName: ReceiptRuleSetName; 1261 /** 1262 * A list of the specified receipt rule set's receipt rules in the order that you want to put them. 1263 */ 1264 RuleNames: ReceiptRuleNamesList; 1265 } 1266 export interface ReorderReceiptRuleSetResponse { 1267 } 1268 export type ReportingMta = string; 1269 export type RuleOrRuleSetName = string; 1270 export interface S3Action { 1271 /** 1272 * The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 1273 */ 1274 TopicArn?: AmazonResourceName; 1275 /** 1276 * The name of the Amazon S3 bucket to which to save the received email. 1277 */ 1278 BucketName: S3BucketName; 1279 /** 1280 * The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket. 1281 */ 1282 ObjectKeyPrefix?: S3KeyPrefix; 1283 /** 1284 * The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows: To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide. 1285 */ 1286 KmsKeyArn?: AmazonResourceName; 1287 } 1288 export type S3BucketName = string; 1289 export type S3KeyPrefix = string; 1290 export interface SNSAction { 1291 /** 1292 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 1293 */ 1294 TopicArn: AmazonResourceName; 1295 /** 1296 * The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8. 1297 */ 1298 Encoding?: SNSActionEncoding; 1299 } 1300 export type SNSActionEncoding = "UTF-8"|"Base64"|string; 1301 export interface SendBounceRequest { 1302 /** 1303 * The message ID of the message to be bounced. 1304 */ 1305 OriginalMessageId: MessageId; 1306 /** 1307 * The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES. 1308 */ 1309 BounceSender: Address; 1310 /** 1311 * Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information. 1312 */ 1313 Explanation?: Explanation; 1314 /** 1315 * Message-related DSN fields. If not specified, Amazon SES will choose the values. 1316 */ 1317 MessageDsn?: MessageDsn; 1318 /** 1319 * A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list. 1320 */ 1321 BouncedRecipientInfoList: BouncedRecipientInfoList; 1322 /** 1323 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide. 1324 */ 1325 BounceSenderArn?: AmazonResourceName; 1326 } 1327 export interface SendBounceResponse { 1328 /** 1329 * The message ID of the bounce message. 1330 */ 1331 MessageId?: MessageId; 1332 } 1333 export interface SendDataPoint { 1334 /** 1335 * Time of the data point. 1336 */ 1337 Timestamp?: Timestamp; 1338 /** 1339 * Number of emails that have been sent. 1340 */ 1341 DeliveryAttempts?: Counter; 1342 /** 1343 * Number of emails that have bounced. 1344 */ 1345 Bounces?: Counter; 1346 /** 1347 * Number of unwanted emails that were rejected by recipients. 1348 */ 1349 Complaints?: Counter; 1350 /** 1351 * Number of emails rejected by Amazon SES. 1352 */ 1353 Rejects?: Counter; 1354 } 1355 export type SendDataPointList = SendDataPoint[]; 1356 export interface SendEmailRequest { 1357 /** 1358 * The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047. 1359 */ 1360 Source: Address; 1361 /** 1362 * The destination for this email, composed of To:, CC:, and BCC: fields. 1363 */ 1364 Destination: Destination; 1365 /** 1366 * The message to be sent. 1367 */ 1368 Message: Message; 1369 /** 1370 * The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. 1371 */ 1372 ReplyToAddresses?: AddressList; 1373 /** 1374 * The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. 1375 */ 1376 ReturnPath?: Address; 1377 /** 1378 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. 1379 */ 1380 SourceArn?: AmazonResourceName; 1381 /** 1382 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. 1383 */ 1384 ReturnPathArn?: AmazonResourceName; 1385 /** 1386 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. 1387 */ 1388 Tags?: MessageTagList; 1389 /** 1390 * The name of the configuration set to use when you send an email using SendEmail. 1391 */ 1392 ConfigurationSetName?: ConfigurationSetName; 1393 } 1394 export interface SendEmailResponse { 1395 /** 1396 * The unique message identifier returned from the SendEmail action. 1397 */ 1398 MessageId: MessageId; 1399 } 1400 export interface SendRawEmailRequest { 1401 /** 1402 * The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.) By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047. If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. 1403 */ 1404 Source?: Address; 1405 /** 1406 * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. 1407 */ 1408 Destinations?: AddressList; 1409 /** 1410 * The raw text of the message. The client is responsible for ensuring the following: Message must contain a header and a body, separated by a blank line. All required header fields must be present. Each part of a multipart MIME message must be formatted properly. MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide. Must be base64-encoded. 1411 */ 1412 RawMessage: RawMessage; 1413 /** 1414 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. 1415 */ 1416 FromArn?: AmazonResourceName; 1417 /** 1418 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com. Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. 1419 */ 1420 SourceArn?: AmazonResourceName; 1421 /** 1422 * This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com. Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter. For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide. 1423 */ 1424 ReturnPathArn?: AmazonResourceName; 1425 /** 1426 * A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. 1427 */ 1428 Tags?: MessageTagList; 1429 /** 1430 * The name of the configuration set to use when you send an email using SendRawEmail. 1431 */ 1432 ConfigurationSetName?: ConfigurationSetName; 1433 } 1434 export interface SendRawEmailResponse { 1435 /** 1436 * The unique message identifier returned from the SendRawEmail action. 1437 */ 1438 MessageId: MessageId; 1439 } 1440 export type SentLast24Hours = number; 1441 export interface SetActiveReceiptRuleSetRequest { 1442 /** 1443 * The name of the receipt rule set to make active. Setting this value to null disables all email receiving. 1444 */ 1445 RuleSetName?: ReceiptRuleSetName; 1446 } 1447 export interface SetActiveReceiptRuleSetResponse { 1448 } 1449 export interface SetIdentityDkimEnabledRequest { 1450 /** 1451 * The identity for which DKIM signing should be enabled or disabled. 1452 */ 1453 Identity: Identity; 1454 /** 1455 * Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it. 1456 */ 1457 DkimEnabled: Enabled; 1458 } 1459 export interface SetIdentityDkimEnabledResponse { 1460 } 1461 export interface SetIdentityFeedbackForwardingEnabledRequest { 1462 /** 1463 * The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com. 1464 */ 1465 Identity: Identity; 1466 /** 1467 * Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types. 1468 */ 1469 ForwardingEnabled: Enabled; 1470 } 1471 export interface SetIdentityFeedbackForwardingEnabledResponse { 1472 } 1473 export interface SetIdentityHeadersInNotificationsEnabledRequest { 1474 /** 1475 * The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com. 1476 */ 1477 Identity: Identity; 1478 /** 1479 * The notification type for which to enable or disable headers in notifications. 1480 */ 1481 NotificationType: NotificationType; 1482 /** 1483 * Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications. This value can only be set when NotificationType is already set to use a particular Amazon SNS topic. 1484 */ 1485 Enabled: Enabled; 1486 } 1487 export interface SetIdentityHeadersInNotificationsEnabledResponse { 1488 } 1489 export interface SetIdentityMailFromDomainRequest { 1490 /** 1491 * The verified identity for which you want to enable or disable the specified custom MAIL FROM domain. 1492 */ 1493 Identity: Identity; 1494 /** 1495 * The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity. 1496 */ 1497 MailFromDomain?: MailFromDomainName; 1498 /** 1499 * The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email. The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states. 1500 */ 1501 BehaviorOnMXFailure?: BehaviorOnMXFailure; 1502 } 1503 export interface SetIdentityMailFromDomainResponse { 1504 } 1505 export interface SetIdentityNotificationTopicRequest { 1506 /** 1507 * The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. 1508 */ 1509 Identity: Identity; 1510 /** 1511 * The type of notifications that will be published to the specified Amazon SNS topic. 1512 */ 1513 NotificationType: NotificationType; 1514 /** 1515 * The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled. 1516 */ 1517 SnsTopic?: NotificationTopic; 1518 } 1519 export interface SetIdentityNotificationTopicResponse { 1520 } 1521 export interface SetReceiptRulePositionRequest { 1522 /** 1523 * The name of the receipt rule set that contains the receipt rule to reposition. 1524 */ 1525 RuleSetName: ReceiptRuleSetName; 1526 /** 1527 * The name of the receipt rule to reposition. 1528 */ 1529 RuleName: ReceiptRuleName; 1530 /** 1531 * The name of the receipt rule after which to place the specified receipt rule. 1532 */ 1533 After?: ReceiptRuleName; 1534 } 1535 export interface SetReceiptRulePositionResponse { 1536 } 1537 export interface StopAction { 1538 /** 1539 * The scope to which the Stop action applies. That is, what is being stopped. 1540 */ 1541 Scope: StopScope; 1542 /** 1543 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 1544 */ 1545 TopicArn?: AmazonResourceName; 1546 } 1547 export type StopScope = "RuleSet"|string; 1548 export type Timestamp = Date; 1549 export type TlsPolicy = "Require"|"Optional"|string; 1550 export interface UpdateConfigurationSetEventDestinationRequest { 1551 /** 1552 * The name of the configuration set that you want to update. 1553 */ 1554 ConfigurationSetName: ConfigurationSetName; 1555 /** 1556 * The event destination object that you want to apply to the specified configuration set. 1557 */ 1558 EventDestination: EventDestination; 1559 } 1560 export interface UpdateConfigurationSetEventDestinationResponse { 1561 } 1562 export interface UpdateReceiptRuleRequest { 1563 /** 1564 * The name of the receipt rule set to which the receipt rule belongs. 1565 */ 1566 RuleSetName: ReceiptRuleSetName; 1567 /** 1568 * A data structure that contains the updated receipt rule information. 1569 */ 1570 Rule: ReceiptRule; 1571 } 1572 export interface UpdateReceiptRuleResponse { 1573 } 1574 export type VerificationAttributes = {[key: string]: IdentityVerificationAttributes}; 1575 export type VerificationStatus = "Pending"|"Success"|"Failed"|"TemporaryFailure"|"NotStarted"|string; 1576 export type VerificationToken = string; 1577 export type VerificationTokenList = VerificationToken[]; 1578 export interface VerifyDomainDkimRequest { 1579 /** 1580 * The name of the domain to be verified for Easy DKIM signing. 1581 */ 1582 Domain: Domain; 1583 } 1584 export interface VerifyDomainDkimResponse { 1585 /** 1586 * A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain. For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. 1587 */ 1588 DkimTokens: VerificationTokenList; 1589 } 1590 export interface VerifyDomainIdentityRequest { 1591 /** 1592 * The domain to be verified. 1593 */ 1594 Domain: Domain; 1595 } 1596 export interface VerifyDomainIdentityResponse { 1597 /** 1598 * A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification. 1599 */ 1600 VerificationToken: VerificationToken; 1601 } 1602 export interface VerifyEmailAddressRequest { 1603 /** 1604 * The email address to be verified. 1605 */ 1606 EmailAddress: Address; 1607 } 1608 export interface VerifyEmailIdentityRequest { 1609 /** 1610 * The email address to be verified. 1611 */ 1612 EmailAddress: Address; 1613 } 1614 export interface VerifyEmailIdentityResponse { 1615 } 1616 export interface WorkmailAction { 1617 /** 1618 * The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. 1619 */ 1620 TopicArn?: AmazonResourceName; 1621 /** 1622 * The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide. 1623 */ 1624 OrganizationArn: AmazonResourceName; 1625 } 1626 /** 1627 * 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. 1628 */ 1629 export type apiVersion = "2010-12-01"|"latest"|string; 1630 export interface ClientApiVersions { 1631 /** 1632 * 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. 1633 */ 1634 apiVersion?: apiVersion; 1635 } 1636 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1637 } 1638 export = SES;