DataFire integration for Amazon Simple Email Service
npm install @datafire/amazonaws_emailClient library for Amazon Simple Email Service
bash
npm install --save @datafire/amazonaws_email
`
js
let amazonaws_email = require('@datafire/amazonaws_email').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});amazonaws_email.CloneReceiptRuleSet({
"RuleSetName": "",
"OriginalRuleSetName": ""
}).then(data => {
console.log(data);
});
`Description
Amazon Simple Email Service
This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
Actions
$3
js
amazonaws_email.CloneReceiptRuleSet({
"RuleSetName": "",
"OriginalRuleSetName": ""
}, context)
`#### Input
* input
* OriginalRuleSetName required ReceiptRuleSetName
* RuleSetName required ReceiptRuleSetName#### Output
* output CloneReceiptRuleSetResponse
$3
js
amazonaws_email.CreateConfigurationSet({
"ConfigurationSet": {
"Name": ""
}
}, context)
`#### Input
* input
* ConfigurationSet required ConfigurationSet#### Output
* output CreateConfigurationSetResponse
$3
js
amazonaws_email.CreateConfigurationSetEventDestination({
"ConfigurationSetName": "",
"EventDestination": {
"Name": "",
"MatchingEventTypes": []
}
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* EventDestination required EventDestination#### Output
* output CreateConfigurationSetEventDestinationResponse
$3
js
amazonaws_email.CreateConfigurationSetTrackingOptions({
"ConfigurationSetName": "",
"TrackingOptions": {}
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* TrackingOptions required TrackingOptions#### Output
* output CreateConfigurationSetTrackingOptionsResponse
$3
js
amazonaws_email.CreateCustomVerificationEmailTemplate({
"TemplateName": "",
"FromEmailAddress": "",
"TemplateSubject": "",
"TemplateContent": "",
"SuccessRedirectionURL": "",
"FailureRedirectionURL": ""
}, context)
`#### Input
* input
* FailureRedirectionURL required FailureRedirectionURL
* FromEmailAddress required FromAddress
* SuccessRedirectionURL required SuccessRedirectionURL
* TemplateContent required TemplateContent
* TemplateName required TemplateName
* TemplateSubject required Subject#### Output
Output schema unknown
$3
js
amazonaws_email.CreateReceiptFilter({
"Filter": {
"Name": "",
"IpFilter": {
"Policy": "",
"Cidr": ""
}
}
}, context)
`#### Input
* input
* Filter required ReceiptFilter#### Output
* output CreateReceiptFilterResponse
$3
js
amazonaws_email.CreateReceiptRule({
"RuleSetName": "",
"Rule": {
"Name": ""
}
}, context)
`#### Input
* input
* After ReceiptRuleName
* Rule required ReceiptRule
* RuleSetName required ReceiptRuleSetName#### Output
* output CreateReceiptRuleResponse
$3
js
amazonaws_email.CreateReceiptRuleSet({
"RuleSetName": ""
}, context)
`#### Input
* input
* RuleSetName required ReceiptRuleSetName#### Output
* output CreateReceiptRuleSetResponse
$3
js
amazonaws_email.CreateTemplate({
"Template": {
"TemplateName": ""
}
}, context)
`#### Input
* input
* Template required Template#### Output
* output CreateTemplateResponse
$3
js
amazonaws_email.DeleteConfigurationSet({
"ConfigurationSetName": ""
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName#### Output
* output DeleteConfigurationSetResponse
$3
js
amazonaws_email.DeleteConfigurationSetEventDestination({
"ConfigurationSetName": "",
"EventDestinationName": ""
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* EventDestinationName required EventDestinationName#### Output
* output DeleteConfigurationSetEventDestinationResponse
$3
js
amazonaws_email.DeleteConfigurationSetTrackingOptions({
"ConfigurationSetName": ""
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName#### Output
* output DeleteConfigurationSetTrackingOptionsResponse
$3
js
amazonaws_email.DeleteCustomVerificationEmailTemplate({
"TemplateName": ""
}, context)
`#### Input
* input
* TemplateName required TemplateName#### Output
Output schema unknown
$3
js
amazonaws_email.DeleteIdentity({
"Identity": ""
}, context)
`#### Input
* input
* Identity required Identity#### Output
* output DeleteIdentityResponse
$3
js
amazonaws_email.DeleteIdentityPolicy({
"Identity": "",
"PolicyName": ""
}, context)
`#### Input
* input
* Identity required Identity
* PolicyName required PolicyName#### Output
* output DeleteIdentityPolicyResponse
$3
js
amazonaws_email.DeleteReceiptFilter({
"FilterName": ""
}, context)
`#### Input
* input
* FilterName required ReceiptFilterName#### Output
* output DeleteReceiptFilterResponse
$3
js
amazonaws_email.DeleteReceiptRule({
"RuleSetName": "",
"RuleName": ""
}, context)
`#### Input
* input
* RuleName required ReceiptRuleName
* RuleSetName required ReceiptRuleSetName#### Output
* output DeleteReceiptRuleResponse
$3
js
amazonaws_email.DeleteReceiptRuleSet({
"RuleSetName": ""
}, context)
`#### Input
* input
* RuleSetName required ReceiptRuleSetName#### Output
* output DeleteReceiptRuleSetResponse
$3
js
amazonaws_email.DeleteTemplate({
"TemplateName": ""
}, context)
`#### Input
* input
* TemplateName required TemplateName#### Output
* output DeleteTemplateResponse
$3
js
amazonaws_email.DeleteVerifiedEmailAddress({
"EmailAddress": ""
}, context)
`#### Input
* input
* EmailAddress required Address#### Output
Output schema unknown
$3
js
amazonaws_email.DescribeActiveReceiptRuleSet({}, context)
`#### Input
* input
#### Output
* output DescribeActiveReceiptRuleSetResponse
$3
js
amazonaws_email.DescribeConfigurationSet({
"ConfigurationSetName": ""
}, context)
`#### Input
* input
* ConfigurationSetAttributeNames ConfigurationSetAttributeList
* ConfigurationSetName required ConfigurationSetName#### Output
* output DescribeConfigurationSetResponse
$3
js
amazonaws_email.DescribeReceiptRule({
"RuleSetName": "",
"RuleName": ""
}, context)
`#### Input
* input
* RuleName required ReceiptRuleName
* RuleSetName required ReceiptRuleSetName#### Output
* output DescribeReceiptRuleResponse
$3
js
amazonaws_email.DescribeReceiptRuleSet({
"RuleSetName": ""
}, context)
`#### Input
* input
* RuleSetName required ReceiptRuleSetName#### Output
* output DescribeReceiptRuleSetResponse
$3
js
amazonaws_email.GetAccountSendingEnabled({}, context)
`#### Input
* input
#### Output
* output GetAccountSendingEnabledResponse
$3
js
amazonaws_email.GetCustomVerificationEmailTemplate({
"TemplateName": ""
}, context)
`#### Input
* input
* TemplateName required TemplateName#### Output
* output GetCustomVerificationEmailTemplateResponse
$3
js
amazonaws_email.GetIdentityDkimAttributes({
"Identities": []
}, context)
`#### Input
* input
* Identities required IdentityList#### Output
* output GetIdentityDkimAttributesResponse
$3
js
amazonaws_email.GetIdentityMailFromDomainAttributes({
"Identities": []
}, context)
`#### Input
* input
* Identities required IdentityList#### Output
* output GetIdentityMailFromDomainAttributesResponse
$3
js
amazonaws_email.GetIdentityNotificationAttributes({
"Identities": []
}, context)
`#### Input
* input
* Identities required IdentityList#### Output
* output GetIdentityNotificationAttributesResponse
$3
js
amazonaws_email.GetIdentityPolicies({
"Identity": "",
"PolicyNames": []
}, context)
`#### Input
* input
* Identity required Identity
* PolicyNames required PolicyNameList#### Output
* output GetIdentityPoliciesResponse
$3
js
amazonaws_email.GetIdentityVerificationAttributes({
"Identities": []
}, context)
`#### Input
* input
* Identities required IdentityList#### Output
* output GetIdentityVerificationAttributesResponse
$3
js
amazonaws_email.GetSendQuota({}, context)
`#### Input
* input
#### Output
* output GetSendQuotaResponse
$3
js
amazonaws_email.GetSendStatistics({}, context)
`#### Input
* input
#### Output
* output GetSendStatisticsResponse
$3
js
amazonaws_email.GetTemplate({
"TemplateName": ""
}, context)
`#### Input
* input
* TemplateName required TemplateName#### Output
* output GetTemplateResponse
$3
js
amazonaws_email.ListConfigurationSets({}, context)
`#### Input
* input
* MaxItems MaxItems
* NextToken NextToken#### Output
* output ListConfigurationSetsResponse
$3
js
amazonaws_email.ListCustomVerificationEmailTemplates({}, context)
`#### Input
* input
* MaxResults
* NextToken
* MaxResults MaxResults
* NextToken NextToken#### Output
* output ListCustomVerificationEmailTemplatesResponse
$3
js
amazonaws_email.ListIdentities({}, context)
`#### Input
* input
* MaxItems
* NextToken
* IdentityType IdentityType
* MaxItems MaxItems
* NextToken NextToken#### Output
* output ListIdentitiesResponse
$3
js
amazonaws_email.ListIdentityPolicies({
"Identity": ""
}, context)
`#### Input
* input
* Identity required Identity#### Output
* output ListIdentityPoliciesResponse
$3
js
amazonaws_email.ListReceiptFilters({}, context)
`#### Input
* input
#### Output
* output ListReceiptFiltersResponse
$3
js
amazonaws_email.ListReceiptRuleSets({}, context)
`#### Input
* input
* NextToken NextToken#### Output
* output ListReceiptRuleSetsResponse
$3
js
amazonaws_email.ListTemplates({}, context)
`#### Input
* input
* MaxItems MaxItems
* NextToken NextToken#### Output
* output ListTemplatesResponse
$3
js
amazonaws_email.ListVerifiedEmailAddresses({}, context)
`#### Input
* input
#### Output
* output ListVerifiedEmailAddressesResponse
$3
js
amazonaws_email.PutIdentityPolicy({
"Identity": "",
"PolicyName": "",
"Policy": ""
}, context)
`#### Input
* input
* Identity required Identity
* Policy required Policy
* PolicyName required PolicyName#### Output
* output PutIdentityPolicyResponse
$3
js
amazonaws_email.ReorderReceiptRuleSet({
"RuleSetName": "",
"RuleNames": []
}, context)
`#### Input
* input
* RuleNames required ReceiptRuleNamesList
* RuleSetName required ReceiptRuleSetName#### Output
* output ReorderReceiptRuleSetResponse
$3
js
amazonaws_email.SendBounce({
"OriginalMessageId": "",
"BounceSender": "",
"BouncedRecipientInfoList": []
}, context)
`#### Input
* input
* BounceSender required Address
* BounceSenderArn AmazonResourceName
* BouncedRecipientInfoList required BouncedRecipientInfoList
* Explanation Explanation
* MessageDsn MessageDsn
* OriginalMessageId required MessageId#### Output
* output SendBounceResponse
$3
js
amazonaws_email.SendBulkTemplatedEmail({
"Source": "",
"Template": "",
"Destinations": []
}, context)
`#### Input
* input
* ConfigurationSetName ConfigurationSetName
* DefaultTags MessageTagList
* DefaultTemplateData TemplateData
* Destinations required BulkEmailDestinationList
* ReplyToAddresses AddressList
* ReturnPath Address
* ReturnPathArn AmazonResourceName
* Source required Address
* SourceArn AmazonResourceName
* Template required TemplateName
* TemplateArn AmazonResourceName#### Output
* output SendBulkTemplatedEmailResponse
$3
js
amazonaws_email.SendCustomVerificationEmail({
"EmailAddress": "",
"TemplateName": ""
}, context)
`#### Input
* input
* ConfigurationSetName ConfigurationSetName
* EmailAddress required Address
* TemplateName required TemplateName#### Output
* output SendCustomVerificationEmailResponse
$3
js
amazonaws_email.SendEmail({
"Source": "",
"Destination": {},
"Message": {
"Subject": {
"Data": ""
},
"Body": {}
}
}, context)
`#### Input
* input
* ConfigurationSetName ConfigurationSetName
* Destination required Destination
* Message required Message
* ReplyToAddresses AddressList
* ReturnPath Address
* ReturnPathArn AmazonResourceName
* Source required Address
* SourceArn AmazonResourceName
* Tags MessageTagList#### Output
* output SendEmailResponse
$3
js
amazonaws_email.SendRawEmail({
"RawMessage": {
"Data": ""
}
}, context)
`#### Input
* input
* ConfigurationSetName ConfigurationSetName
* Destinations AddressList
* FromArn AmazonResourceName
* RawMessage required RawMessage
* ReturnPathArn AmazonResourceName
* Source Address
* SourceArn AmazonResourceName
* Tags MessageTagList#### Output
* output SendRawEmailResponse
$3
js
amazonaws_email.SendTemplatedEmail({
"Source": "",
"Destination": {},
"Template": "",
"TemplateData": ""
}, context)
`#### Input
* input
* ConfigurationSetName ConfigurationSetName
* Destination required Destination
* ReplyToAddresses AddressList
* ReturnPath Address
* ReturnPathArn AmazonResourceName
* Source required Address
* SourceArn AmazonResourceName
* Tags MessageTagList
* Template required TemplateName
* TemplateArn AmazonResourceName
* TemplateData required TemplateData#### Output
* output SendTemplatedEmailResponse
$3
js
amazonaws_email.SetActiveReceiptRuleSet({}, context)
`#### Input
* input
* RuleSetName ReceiptRuleSetName#### Output
* output SetActiveReceiptRuleSetResponse
$3
js
amazonaws_email.SetIdentityDkimEnabled({
"Identity": "",
"DkimEnabled": true
}, context)
`#### Input
* input
* DkimEnabled required Enabled
* Identity required Identity#### Output
* output SetIdentityDkimEnabledResponse
$3
js
amazonaws_email.SetIdentityFeedbackForwardingEnabled({
"Identity": "",
"ForwardingEnabled": true
}, context)
`#### Input
* input
* ForwardingEnabled required Enabled
* Identity required Identity#### Output
* output SetIdentityFeedbackForwardingEnabledResponse
$3
js
amazonaws_email.SetIdentityHeadersInNotificationsEnabled({
"Identity": "",
"NotificationType": "",
"Enabled": true
}, context)
`#### Input
* input
* Enabled required Enabled
* Identity required Identity
* NotificationType required NotificationType#### Output
* output SetIdentityHeadersInNotificationsEnabledResponse
$3
js
amazonaws_email.SetIdentityMailFromDomain({
"Identity": ""
}, context)
`#### Input
* input
* BehaviorOnMXFailure BehaviorOnMXFailure
* Identity required Identity
* MailFromDomain MailFromDomainName#### Output
* output SetIdentityMailFromDomainResponse
$3
js
amazonaws_email.SetIdentityNotificationTopic({
"Identity": "",
"NotificationType": ""
}, context)
`#### Input
* input
* Identity required Identity
* NotificationType required NotificationType
* SnsTopic NotificationTopic#### Output
* output SetIdentityNotificationTopicResponse
$3
js
amazonaws_email.SetReceiptRulePosition({
"RuleSetName": "",
"RuleName": ""
}, context)
`#### Input
* input
* After ReceiptRuleName
* RuleName required ReceiptRuleName
* RuleSetName required ReceiptRuleSetName#### Output
* output SetReceiptRulePositionResponse
$3
js
amazonaws_email.TestRenderTemplate({
"TemplateName": "",
"TemplateData": ""
}, context)
`#### Input
* input
* TemplateData required TemplateData
* TemplateName required TemplateName#### Output
* output TestRenderTemplateResponse
$3
js
amazonaws_email.UpdateAccountSendingEnabled({}, context)
`#### Input
* input
* Enabled Enabled#### Output
Output schema unknown
$3
js
amazonaws_email.UpdateConfigurationSetEventDestination({
"ConfigurationSetName": "",
"EventDestination": {
"Name": "",
"MatchingEventTypes": []
}
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* EventDestination required EventDestination#### Output
* output UpdateConfigurationSetEventDestinationResponse
$3
js
amazonaws_email.UpdateConfigurationSetReputationMetricsEnabled({
"ConfigurationSetName": "",
"Enabled": true
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* Enabled required Enabled#### Output
Output schema unknown
$3
js
amazonaws_email.UpdateConfigurationSetSendingEnabled({
"ConfigurationSetName": "",
"Enabled": true
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* Enabled required Enabled#### Output
Output schema unknown
$3
js
amazonaws_email.UpdateConfigurationSetTrackingOptions({
"ConfigurationSetName": "",
"TrackingOptions": {}
}, context)
`#### Input
* input
* ConfigurationSetName required ConfigurationSetName
* TrackingOptions required TrackingOptions#### Output
* output UpdateConfigurationSetTrackingOptionsResponse
$3
js
amazonaws_email.UpdateCustomVerificationEmailTemplate({
"TemplateName": ""
}, context)
`#### Input
* input
* FailureRedirectionURL FailureRedirectionURL
* FromEmailAddress FromAddress
* SuccessRedirectionURL SuccessRedirectionURL
* TemplateContent TemplateContent
* TemplateName required TemplateName
* TemplateSubject Subject#### Output
Output schema unknown
$3
js
amazonaws_email.UpdateReceiptRule({
"RuleSetName": "",
"Rule": {
"Name": ""
}
}, context)
`#### Input
* input
* Rule required ReceiptRule
* RuleSetName required ReceiptRuleSetName#### Output
* output UpdateReceiptRuleResponse
$3
js
amazonaws_email.UpdateTemplate({
"Template": {
"TemplateName": ""
}
}, context)
`#### Input
* input
* Template required Template#### Output
* output UpdateTemplateResponse
$3
js
amazonaws_email.VerifyDomainDkim({
"Domain": ""
}, context)
`#### Input
* input
* Domain required Domain#### Output
* output VerifyDomainDkimResponse
$3
js
amazonaws_email.VerifyDomainIdentity({
"Domain": ""
}, context)
`#### Input
* input
* Domain required Domain#### Output
* output VerifyDomainIdentityResponse
$3
js
amazonaws_email.VerifyEmailAddress({
"EmailAddress": ""
}, context)
`#### Input
* input
* EmailAddress required Address#### Output
Output schema unknown
$3
js
amazonaws_email.VerifyEmailIdentity({
"EmailAddress": ""
}, context)
`#### Input
* input
* EmailAddress required Address#### Output
* output VerifyEmailIdentityResponse
Definitions
$3
* AccountSendingPausedException : Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
$3
* AddHeaderAction object: When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
* HeaderName required HeaderName
* HeaderValue required HeaderValue$3
* Address string$3
* AddressList
* items Address$3
* AlreadyExistsException : Indicates that a resource could not be created because of a naming conflict.
* Name RuleOrRuleSetName$3
* AmazonResourceName string$3
* ArrivalDate $3
* BehaviorOnMXFailure (values: UseDefaultValue, RejectMessage)$3
* Body object: Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
* Html Content
* Text Content$3
* BounceAction object: When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
* Message required BounceMessage
* Sender required Address
* SmtpReplyCode required BounceSmtpReplyCode
* StatusCode BounceStatusCode
* TopicArn AmazonResourceName$3
* BounceMessage string$3
* BounceSmtpReplyCode $3
* BounceStatusCode $3
* BounceType (values: DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure)$3
* BouncedRecipientInfo object: Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
* BounceType BounceType
* Recipient required Address
* RecipientArn AmazonResourceName
* RecipientDsnFields RecipientDsnFields$3
* BouncedRecipientInfoList array
* items BouncedRecipientInfo$3
* BulkEmailDestination : An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
* Destination required Destination
* ReplacementTags MessageTagList
* ReplacementTemplateData TemplateData$3
* BulkEmailDestinationList array
* items BulkEmailDestination$3
* BulkEmailDestinationStatus : An object that contains the response from the SendBulkTemplatedEmail operation.
* Error Error
* MessageId MessageId
* Status BulkEmailStatus$3
* BulkEmailDestinationStatusList array
* items BulkEmailDestinationStatus$3
* BulkEmailStatus (values: Success, MessageRejected, MailFromDomainNotVerified, ConfigurationSetDoesNotExist, TemplateDoesNotExist, AccountSuspended, AccountThrottled, AccountDailyQuotaExceeded, InvalidSendingPoolName, AccountSendingPaused, ConfigurationSetSendingPaused, InvalidParameterValue, TransientFailure, Failed)$3
* CannotDeleteException object: Indicates that the delete operation could not be completed.
* Name RuleOrRuleSetName$3
* Charset string$3
* Cidr $3
* CloneReceiptRuleSetRequest : Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* OriginalRuleSetName required ReceiptRuleSetName
* RuleSetName required ReceiptRuleSetName$3
* CloneReceiptRuleSetResponse object: An empty element returned on a successful request.$3
* CloudWatchDestination object: Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, 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.
* DimensionConfigurations required CloudWatchDimensionConfigurations$3
* CloudWatchDimensionConfiguration object: Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
* DefaultDimensionValue required DefaultDimensionValue
* DimensionName required DimensionName
* DimensionValueSource required DimensionValueSource$3
* CloudWatchDimensionConfigurations array
* items CloudWatchDimensionConfiguration$3
* ConfigurationSet : The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.
* Name required ConfigurationSetName$3
* ConfigurationSetAlreadyExistsException object: Indicates that the configuration set could not be created because of a naming conflict.
* ConfigurationSetName ConfigurationSetName$3
* ConfigurationSetAttribute string (values: eventDestinations, trackingOptions, reputationOptions)$3
* ConfigurationSetAttributeList array
* items ConfigurationSetAttribute$3
* ConfigurationSetDoesNotExistException : Indicates that the configuration set does not exist.
* ConfigurationSetName ConfigurationSetName$3
* ConfigurationSetName string$3
* ConfigurationSetSendingPausedException : Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
* ConfigurationSetName ConfigurationSetName$3
* ConfigurationSets array
* items ConfigurationSet$3
* Content : Represents textual data, plus an optional character set specification.
By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
* Charset Charset
* Data required MessageData$3
* Counter integer$3
* CreateConfigurationSetEventDestinationRequest : Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in 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.
* ConfigurationSetName required ConfigurationSetName
* EventDestination required EventDestination$3
* CreateConfigurationSetEventDestinationResponse object: An empty element returned on a successful request.$3
* CreateConfigurationSetRequest object: Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
* ConfigurationSet required ConfigurationSet$3
* CreateConfigurationSetResponse object: An empty element returned on a successful request.$3
* CreateConfigurationSetTrackingOptionsRequest object: Represents a request to create an open and click tracking option object in a configuration set.
* ConfigurationSetName required ConfigurationSetName
* TrackingOptions required TrackingOptions$3
* CreateConfigurationSetTrackingOptionsResponse object: An empty element returned on a successful request.$3
* CreateCustomVerificationEmailTemplateRequest object: Represents a request to create a custom verification email template.
* FailureRedirectionURL required FailureRedirectionURL
* FromEmailAddress required FromAddress
* SuccessRedirectionURL required SuccessRedirectionURL
* TemplateContent required TemplateContent
* TemplateName required TemplateName
* TemplateSubject required Subject$3
* CreateReceiptFilterRequest object: Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* Filter required ReceiptFilter$3
* CreateReceiptFilterResponse object: An empty element returned on a successful request.$3
* CreateReceiptRuleRequest object: Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* After ReceiptRuleName
* Rule required ReceiptRule
* RuleSetName required ReceiptRuleSetName$3
* CreateReceiptRuleResponse object: An empty element returned on a successful request.$3
* CreateReceiptRuleSetRequest object: Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* RuleSetName required ReceiptRuleSetName$3
* CreateReceiptRuleSetResponse object: An empty element returned on a successful request.$3
* CreateTemplateRequest object: Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
* Template required Template$3
* CreateTemplateResponse object$3
* CustomMailFromStatus (values: Pending, Success, Failed, TemporaryFailure)$3
* CustomRedirectDomain string$3
* CustomVerificationEmailInvalidContentException : Indicates that custom verification email template provided content is invalid.$3
* CustomVerificationEmailTemplate object: Contains information about a custom verification email template.
* FailureRedirectionURL FailureRedirectionURL
* FromEmailAddress FromAddress
* SuccessRedirectionURL SuccessRedirectionURL
* TemplateName TemplateName
* TemplateSubject Subject$3
* CustomVerificationEmailTemplateAlreadyExistsException object: Indicates that a custom verification email template with the name you specified already exists.
* CustomVerificationEmailTemplateName TemplateName$3
* CustomVerificationEmailTemplateDoesNotExistException object: Indicates that a custom verification email template with the name you specified does not exist.
* CustomVerificationEmailTemplateName TemplateName$3
* CustomVerificationEmailTemplates array
* items CustomVerificationEmailTemplate$3
* DefaultDimensionValue $3
* DeleteConfigurationSetEventDestinationRequest : Represents a request to delete 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.
* ConfigurationSetName required ConfigurationSetName
* EventDestinationName required EventDestinationName$3
* DeleteConfigurationSetEventDestinationResponse object: An empty element returned on a successful request.$3
* DeleteConfigurationSetRequest object: Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
* ConfigurationSetName required ConfigurationSetName$3
* DeleteConfigurationSetResponse object: An empty element returned on a successful request.$3
* DeleteConfigurationSetTrackingOptionsRequest object: Represents a request to delete open and click tracking options in a configuration set.
* ConfigurationSetName required ConfigurationSetName$3
* DeleteConfigurationSetTrackingOptionsResponse object: An empty element returned on a successful request.$3
* DeleteCustomVerificationEmailTemplateRequest object: Represents a request to delete an existing custom verification email template.
* TemplateName required TemplateName$3
* DeleteIdentityPolicyRequest object: Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
* Identity required Identity
* PolicyName required PolicyName$3
* DeleteIdentityPolicyResponse object: An empty element returned on a successful request.$3
* DeleteIdentityRequest object: Represents a request to delete one of your Amazon SES identities (an email address or domain).
* Identity required Identity$3
* DeleteIdentityResponse object: An empty element returned on a successful request.$3
* DeleteReceiptFilterRequest object: Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* FilterName required ReceiptFilterName$3
* DeleteReceiptFilterResponse object: An empty element returned on a successful request.$3
* DeleteReceiptRuleRequest object: Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* RuleName required ReceiptRuleName
* RuleSetName required ReceiptRuleSetName$3
* DeleteReceiptRuleResponse object: An empty element returned on a successful request.$3
* DeleteReceiptRuleSetRequest object: Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* RuleSetName required ReceiptRuleSetName$3
* DeleteReceiptRuleSetResponse object: An empty element returned on a successful request.$3
* DeleteTemplateRequest object: Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
* TemplateName required TemplateName$3
* DeleteTemplateResponse object$3
* DeleteVerifiedEmailAddressRequest : Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.
* EmailAddress required Address$3
* DescribeActiveReceiptRuleSetRequest object: Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.$3
* DescribeActiveReceiptRuleSetResponse object: Represents the metadata and receipt rules for the receipt rule set that is currently active.
* Metadata ReceiptRuleSetMetadata
* Rules ReceiptRulesList$3
* DescribeConfigurationSetRequest object: Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
* ConfigurationSetAttributeNames ConfigurationSetAttributeList
* ConfigurationSetName required ConfigurationSetName$3
* DescribeConfigurationSetResponse object: Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
* ConfigurationSet ConfigurationSet
* EventDestinations EventDestinations
* ReputationOptions ReputationOptions
* TrackingOptions TrackingOptions$3
* DescribeReceiptRuleRequest object: Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* RuleName required ReceiptRuleName
* RuleSetName required ReceiptRuleSetName$3
* DescribeReceiptRuleResponse object: Represents the details of a receipt rule.
* Rule ReceiptRule$3
* DescribeReceiptRuleSetRequest object: Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
* RuleSetName required ReceiptRuleSetName$3
* DescribeReceiptRuleSetResponse object: Represents the details of the specified receipt rule set.
* Metadata ReceiptRuleSetMetadata
* Rules ReceiptRulesList$3
* Destination object: Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
* BccAddresses AddressList
* CcAddresses AddressList
* ToAddresses AddressList$3
* DiagnosticCode string$3
* DimensionName $3
* DimensionValueSource (values: messageTag, emailHeader, linkTag)$3
* DkimAttributes array
* items
* key Identity
* value IdentityDkimAttributes$3
* Domain $3
* DsnAction (values: failed, delayed, delivered, relayed, expanded)$3
* DsnStatus string$3
* Enabled $3
* Error $3
* EventDestination : Contains information about the event destination that the specified email sending events will be published to.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
* CloudWatchDestination CloudWatchDestination
* Enabled Enabled
* KinesisFirehoseDestination KinesisFirehoseDestination
* MatchingEventTypes required EventTypes
* Name required EventDestinationName
* SNSDestination SNSDestination$3
* EventDestinationAlreadyExistsException object: Indicates that the event destination could not be created because of a naming conflict.
* ConfigurationSetName ConfigurationSetName
* EventDestinationName EventDestinationName$3
* EventDestinationDoesNotExistException object: Indicates that the event destination does not exist.
* ConfigurationSetName ConfigurationSetName
* EventDestinationName EventDestinationName$3
* EventDestinationName string$3
* EventDestinations
* items EventDestination$3
* EventType (values: send, reject, bounce, complaint, delivery, open, click, renderingFailure)$3
* EventTypes array
* items EventType$3
* Explanation $3
* ExtensionField : Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
* Name required ExtensionFieldName
* Value required ExtensionFieldValue$3
* ExtensionFieldList array
* items ExtensionField$3
* ExtensionFieldName $3
* ExtensionFieldValue $3
* FailureRedirectionURL $3
* FromAddress $3
* FromEmailAddressNotVerifiedException : Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
* FromEmailAddress FromAddress$3
* GetAccountSendingEnabledResponse object: Represents a request to return the email sending status for your Amazon SES account.
* Enabled Enabled$3
* GetCustomVerificationEmailTemplateRequest object: Represents a request to retrieve an existing custom verification email template.
* TemplateName required TemplateName$3
* GetCustomVerificationEmailTemplateResponse object: The content of the custom verification email template.
* FailureRedirectionURL FailureRedirectionURL
* FromEmailAddress FromAddress
* SuccessRedirectionURL SuccessRedirectionURL
* TemplateContent TemplateContent
* TemplateName TemplateName
* TemplateSubject Subject$3
* GetIdentityDkimAttributesRequest object: Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
* Identities required IdentityList$3
* GetIdentityDkimAttributesResponse object: Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
* DkimAttributes required DkimAttributes$3
* GetIdentityMailFromDomainAttributesRequest object: Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
* Identities required IdentityList$3
* GetIdentityMailFromDomainAttributesResponse object: Represents the custom MAIL FROM attributes for a list of identities.
* MailFromDomainAttributes required MailFromDomainAttributes$3
* GetIdentityNotificationAttributesRequest object: Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
* Identities required IdentityList$3
* GetIdentityNotificationAttributesResponse object: Represents the notification attributes for a list of identities.
* NotificationAttributes required NotificationAttributes$3
* GetIdentityPoliciesRequest object: Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
* Identity required Identity
* PolicyNames required PolicyNameList$3
* GetIdentityPoliciesResponse object: Represents the requested sending authorization policies.
* Policies required PolicyMap$3
* GetIdentityVerificationAttributesRequest object: Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
* Identities required IdentityList$3
* GetIdentityVerificationAttributesResponse object: The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.
* VerificationAttributes required VerificationAttributes$3
* GetSendQuotaResponse object: Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.
* Max24HourSend Max24HourSend
* MaxSendRate MaxSendRate
* SentLast24Hours SentLast24Hours$3
* GetSendStatisticsResponse object: Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.
* SendDataPoints SendDataPointList$3
* GetTemplateRequest object
* TemplateName required TemplateName$3
* GetTemplateResponse
* Template Template$3
* HeaderName $3
* HeaderValue $3
* HtmlPart $3
* Identity $3
* IdentityDkimAttributes : Represents the DKIM attributes of a verified email address or a domain.
* DkimEnabled required Enabled
* DkimTokens VerificationTokenList
* DkimVerificationStatus required VerificationStatus$3
* IdentityList array
* items Identity$3
* IdentityMailFromDomainAttributes : Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
* BehaviorOnMXFailure required BehaviorOnMXFailure
* MailFromDomain required MailFromDomainName
* MailFromDomainStatus required CustomMailFromStatus$3
* IdentityNotificationAttributes object: Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
* BounceTopic required NotificationTopic
* ComplaintTopic required NotificationTopic
* DeliveryTopic required NotificationTopic
* ForwardingEnabled required Enabled
* HeadersInBounceNotificationsEnabled Enabled
* HeadersInComplaintNotificationsEnabled Enabled
* HeadersInDeliveryNotificationsEnabled Enabled$3
* IdentityType string (values: EmailAddress, Domain)$3
* IdentityVerificationAttributes object: Represents the verification attributes of a single identity.
* VerificationStatus required VerificationStatus
* VerificationToken VerificationToken$3
* InvalidCloudWatchDestinationException object: Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
* ConfigurationSetName ConfigurationSetName
* EventDestinationName EventDestinationName$3
* InvalidConfigurationSetException object: Indicates that the configuration set is invalid. See the error message for details.$3
* InvalidFirehoseDestinationException object: Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
* ConfigurationSetName ConfigurationSetName
* EventDestinationName EventDestinationName$3
* InvalidLambdaFunctionException object: Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
* FunctionArn AmazonResourceName$3
* InvalidPolicyException object: Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.$3
* InvalidRenderingParameterException object: Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
* TemplateName TemplateName$3
* InvalidS3ConfigurationException object`: Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is