@datafire/amazonaws_email

Client library for Amazon Simple Email Service

Installation and Usage

npm install --save @datafire/amazonaws_email

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

CloneReceiptRuleSet

amazonaws_email.CloneReceiptRuleSet({
  "RuleSetName": "",
  "OriginalRuleSetName": ""
}, context)

Input

• input object
  • OriginalRuleSetName required ReceiptRuleSetName
  • RuleSetName required ReceiptRuleSetName

Output

• output CloneReceiptRuleSetResponse

CreateConfigurationSet

amazonaws_email.CreateConfigurationSet({
  "ConfigurationSet": {
    "Name": ""
  }
}, context)

Input

• input object
  • ConfigurationSet required ConfigurationSet

Output

• output CreateConfigurationSetResponse

CreateConfigurationSetEventDestination

amazonaws_email.CreateConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestination": {
    "Name": "",
    "MatchingEventTypes": []
  }
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • EventDestination required EventDestination

Output

• output CreateConfigurationSetEventDestinationResponse

CreateConfigurationSetTrackingOptions

amazonaws_email.CreateConfigurationSetTrackingOptions({
  "ConfigurationSetName": "",
  "TrackingOptions": {}
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • TrackingOptions required TrackingOptions

Output

• output CreateConfigurationSetTrackingOptionsResponse

CreateCustomVerificationEmailTemplate

amazonaws_email.CreateCustomVerificationEmailTemplate({
  "TemplateName": "",
  "FromEmailAddress": "",
  "TemplateSubject": "",
  "TemplateContent": "",
  "SuccessRedirectionURL": "",
  "FailureRedirectionURL": ""
}, context)

Input

• input object
  • FailureRedirectionURL required FailureRedirectionURL
  • FromEmailAddress required FromAddress
  • SuccessRedirectionURL required SuccessRedirectionURL
  • TemplateContent required TemplateContent
  • TemplateName required TemplateName
  • TemplateSubject required Subject

Output

Output schema unknown

CreateReceiptFilter

amazonaws_email.CreateReceiptFilter({
  "Filter": {
    "Name": "",
    "IpFilter": {
      "Policy": "",
      "Cidr": ""
    }
  }
}, context)

Input

• input object
  • Filter required ReceiptFilter

Output

• output CreateReceiptFilterResponse

CreateReceiptRule

amazonaws_email.CreateReceiptRule({
  "RuleSetName": "",
  "Rule": {
    "Name": ""
  }
}, context)

Input

• input object
  • After ReceiptRuleName
  • Rule required ReceiptRule
  • RuleSetName required ReceiptRuleSetName

Output

• output CreateReceiptRuleResponse

CreateReceiptRuleSet

amazonaws_email.CreateReceiptRuleSet({
  "RuleSetName": ""
}, context)

Input

• input object
  • RuleSetName required ReceiptRuleSetName

Output

• output CreateReceiptRuleSetResponse

CreateTemplate

amazonaws_email.CreateTemplate({
  "Template": {
    "TemplateName": ""
  }
}, context)

Input

• input object
  • Template required Template

Output

• output CreateTemplateResponse

DeleteConfigurationSet

amazonaws_email.DeleteConfigurationSet({
  "ConfigurationSetName": ""
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName

Output

• output DeleteConfigurationSetResponse

DeleteConfigurationSetEventDestination

amazonaws_email.DeleteConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestinationName": ""
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • EventDestinationName required EventDestinationName

Output

• output DeleteConfigurationSetEventDestinationResponse

DeleteConfigurationSetTrackingOptions

amazonaws_email.DeleteConfigurationSetTrackingOptions({
  "ConfigurationSetName": ""
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName

Output

• output DeleteConfigurationSetTrackingOptionsResponse

DeleteCustomVerificationEmailTemplate

amazonaws_email.DeleteCustomVerificationEmailTemplate({
  "TemplateName": ""
}, context)

Input

• input object
  • TemplateName required TemplateName

Output

Output schema unknown

DeleteIdentity

amazonaws_email.DeleteIdentity({
  "Identity": ""
}, context)

Input

• input object
  • Identity required Identity

Output

• output DeleteIdentityResponse

DeleteIdentityPolicy

amazonaws_email.DeleteIdentityPolicy({
  "Identity": "",
  "PolicyName": ""
}, context)

Input

• input object
  • Identity required Identity
  • PolicyName required PolicyName

Output

• output DeleteIdentityPolicyResponse

DeleteReceiptFilter

amazonaws_email.DeleteReceiptFilter({
  "FilterName": ""
}, context)

Input

• input object
  • FilterName required ReceiptFilterName

Output

• output DeleteReceiptFilterResponse

DeleteReceiptRule

amazonaws_email.DeleteReceiptRule({
  "RuleSetName": "",
  "RuleName": ""
}, context)

Input

• input object
  • RuleName required ReceiptRuleName
  • RuleSetName required ReceiptRuleSetName

Output

• output DeleteReceiptRuleResponse

DeleteReceiptRuleSet

amazonaws_email.DeleteReceiptRuleSet({
  "RuleSetName": ""
}, context)

Input

• input object
  • RuleSetName required ReceiptRuleSetName

Output

• output DeleteReceiptRuleSetResponse

DeleteTemplate

amazonaws_email.DeleteTemplate({
  "TemplateName": ""
}, context)

Input

• input object
  • TemplateName required TemplateName

Output

• output DeleteTemplateResponse

DeleteVerifiedEmailAddress

amazonaws_email.DeleteVerifiedEmailAddress({
  "EmailAddress": ""
}, context)

Input

• input object
  • EmailAddress required Address

Output

Output schema unknown

DescribeActiveReceiptRuleSet

amazonaws_email.DescribeActiveReceiptRuleSet({}, context)

Input

• input object

Output

• output DescribeActiveReceiptRuleSetResponse

DescribeConfigurationSet

amazonaws_email.DescribeConfigurationSet({
  "ConfigurationSetName": ""
}, context)

Input

• input object
  • ConfigurationSetAttributeNames ConfigurationSetAttributeList
  • ConfigurationSetName required ConfigurationSetName

Output

• output DescribeConfigurationSetResponse

DescribeReceiptRule

amazonaws_email.DescribeReceiptRule({
  "RuleSetName": "",
  "RuleName": ""
}, context)

Input

• input object
  • RuleName required ReceiptRuleName
  • RuleSetName required ReceiptRuleSetName

Output

• output DescribeReceiptRuleResponse

DescribeReceiptRuleSet

amazonaws_email.DescribeReceiptRuleSet({
  "RuleSetName": ""
}, context)

Input

• input object
  • RuleSetName required ReceiptRuleSetName

Output

• output DescribeReceiptRuleSetResponse

GetAccountSendingEnabled

amazonaws_email.GetAccountSendingEnabled({}, context)

Input

• input object

Output

• output GetAccountSendingEnabledResponse

GetCustomVerificationEmailTemplate

amazonaws_email.GetCustomVerificationEmailTemplate({
  "TemplateName": ""
}, context)

Input

• input object
  • TemplateName required TemplateName

Output

• output GetCustomVerificationEmailTemplateResponse

GetIdentityDkimAttributes

amazonaws_email.GetIdentityDkimAttributes({
  "Identities": []
}, context)

Input

• input object
  • Identities required IdentityList

Output

• output GetIdentityDkimAttributesResponse

GetIdentityMailFromDomainAttributes

amazonaws_email.GetIdentityMailFromDomainAttributes({
  "Identities": []
}, context)

Input

• input object
  • Identities required IdentityList

Output

• output GetIdentityMailFromDomainAttributesResponse

GetIdentityNotificationAttributes

amazonaws_email.GetIdentityNotificationAttributes({
  "Identities": []
}, context)

Input

• input object
  • Identities required IdentityList

Output

• output GetIdentityNotificationAttributesResponse

GetIdentityPolicies

amazonaws_email.GetIdentityPolicies({
  "Identity": "",
  "PolicyNames": []
}, context)

Input

• input object
  • Identity required Identity
  • PolicyNames required PolicyNameList

Output

• output GetIdentityPoliciesResponse

GetIdentityVerificationAttributes

amazonaws_email.GetIdentityVerificationAttributes({
  "Identities": []
}, context)

Input

• input object
  • Identities required IdentityList

Output

• output GetIdentityVerificationAttributesResponse

GetSendQuota

amazonaws_email.GetSendQuota({}, context)

Input

• input object

Output

• output GetSendQuotaResponse

GetSendStatistics

amazonaws_email.GetSendStatistics({}, context)

Input

• input object

Output

• output GetSendStatisticsResponse

GetTemplate

amazonaws_email.GetTemplate({
  "TemplateName": ""
}, context)

Input

• input object
  • TemplateName required TemplateName

Output

• output GetTemplateResponse

ListConfigurationSets

amazonaws_email.ListConfigurationSets({}, context)

Input

• input object
  • MaxItems MaxItems
  • NextToken NextToken

Output

• output ListConfigurationSetsResponse

ListCustomVerificationEmailTemplates

amazonaws_email.ListCustomVerificationEmailTemplates({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxResults
  • NextToken NextToken

Output

• output ListCustomVerificationEmailTemplatesResponse

ListIdentities

amazonaws_email.ListIdentities({}, context)

Input

• input object
  • MaxItems string
  • NextToken string
  • IdentityType IdentityType
  • MaxItems MaxItems
  • NextToken NextToken

Output

• output ListIdentitiesResponse

ListIdentityPolicies

amazonaws_email.ListIdentityPolicies({
  "Identity": ""
}, context)

Input

• input object
  • Identity required Identity

Output

• output ListIdentityPoliciesResponse

ListReceiptFilters

amazonaws_email.ListReceiptFilters({}, context)

Input

• input object

Output

• output ListReceiptFiltersResponse

ListReceiptRuleSets

amazonaws_email.ListReceiptRuleSets({}, context)

Input

• input object
  • NextToken NextToken

Output

• output ListReceiptRuleSetsResponse

ListTemplates

amazonaws_email.ListTemplates({}, context)

Input

• input object
  • MaxItems MaxItems
  • NextToken NextToken

Output

• output ListTemplatesResponse

ListVerifiedEmailAddresses

amazonaws_email.ListVerifiedEmailAddresses({}, context)

Input

• input object

Output

• output ListVerifiedEmailAddressesResponse

PutIdentityPolicy

amazonaws_email.PutIdentityPolicy({
  "Identity": "",
  "PolicyName": "",
  "Policy": ""
}, context)

Input

• input object
  • Identity required Identity
  • Policy required Policy
  • PolicyName required PolicyName

Output

• output PutIdentityPolicyResponse

ReorderReceiptRuleSet

amazonaws_email.ReorderReceiptRuleSet({
  "RuleSetName": "",
  "RuleNames": []
}, context)

Input

• input object
  • RuleNames required ReceiptRuleNamesList
  • RuleSetName required ReceiptRuleSetName

Output

• output ReorderReceiptRuleSetResponse

SendBounce

amazonaws_email.SendBounce({
  "OriginalMessageId": "",
  "BounceSender": "",
  "BouncedRecipientInfoList": []
}, context)

Input

• input object
  • BounceSender required Address
  • BounceSenderArn AmazonResourceName
  • BouncedRecipientInfoList required BouncedRecipientInfoList
  • Explanation Explanation
  • MessageDsn MessageDsn
  • OriginalMessageId required MessageId

Output

• output SendBounceResponse

SendBulkTemplatedEmail

amazonaws_email.SendBulkTemplatedEmail({
  "Source": "",
  "Template": "",
  "Destinations": []
}, context)

Input

• input object
  • 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

SendCustomVerificationEmail

amazonaws_email.SendCustomVerificationEmail({
  "EmailAddress": "",
  "TemplateName": ""
}, context)

Input

• input object
  • ConfigurationSetName ConfigurationSetName
  • EmailAddress required Address
  • TemplateName required TemplateName

Output

• output SendCustomVerificationEmailResponse

SendEmail

amazonaws_email.SendEmail({
  "Source": "",
  "Destination": {},
  "Message": {
    "Subject": {
      "Data": ""
    },
    "Body": {}
  }
}, context)

Input

• input object
  • ConfigurationSetName ConfigurationSetName
  • Destination required Destination
  • Message required Message
  • ReplyToAddresses AddressList
  • ReturnPath Address
  • ReturnPathArn AmazonResourceName
  • Source required Address
  • SourceArn AmazonResourceName
  • Tags MessageTagList

Output

• output SendEmailResponse

SendRawEmail

amazonaws_email.SendRawEmail({
  "RawMessage": {
    "Data": ""
  }
}, context)

Input

• input object
  • ConfigurationSetName ConfigurationSetName
  • Destinations AddressList
  • FromArn AmazonResourceName
  • RawMessage required RawMessage
  • ReturnPathArn AmazonResourceName
  • Source Address
  • SourceArn AmazonResourceName
  • Tags MessageTagList

Output

• output SendRawEmailResponse

SendTemplatedEmail

amazonaws_email.SendTemplatedEmail({
  "Source": "",
  "Destination": {},
  "Template": "",
  "TemplateData": ""
}, context)

Input

• input object
  • 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

SetActiveReceiptRuleSet

amazonaws_email.SetActiveReceiptRuleSet({}, context)

Input

• input object
  • RuleSetName ReceiptRuleSetName

Output

• output SetActiveReceiptRuleSetResponse

SetIdentityDkimEnabled

amazonaws_email.SetIdentityDkimEnabled({
  "Identity": "",
  "DkimEnabled": true
}, context)

Input

• input object
  • DkimEnabled required Enabled
  • Identity required Identity

Output

• output SetIdentityDkimEnabledResponse

SetIdentityFeedbackForwardingEnabled

amazonaws_email.SetIdentityFeedbackForwardingEnabled({
  "Identity": "",
  "ForwardingEnabled": true
}, context)

Input

• input object
  • ForwardingEnabled required Enabled
  • Identity required Identity

Output

• output SetIdentityFeedbackForwardingEnabledResponse

SetIdentityHeadersInNotificationsEnabled

amazonaws_email.SetIdentityHeadersInNotificationsEnabled({
  "Identity": "",
  "NotificationType": "",
  "Enabled": true
}, context)

Input

• input object
  • Enabled required Enabled
  • Identity required Identity
  • NotificationType required NotificationType

Output

• output SetIdentityHeadersInNotificationsEnabledResponse

SetIdentityMailFromDomain

amazonaws_email.SetIdentityMailFromDomain({
  "Identity": ""
}, context)

Input

• input object
  • BehaviorOnMXFailure BehaviorOnMXFailure
  • Identity required Identity
  • MailFromDomain MailFromDomainName

Output

• output SetIdentityMailFromDomainResponse

SetIdentityNotificationTopic

amazonaws_email.SetIdentityNotificationTopic({
  "Identity": "",
  "NotificationType": ""
}, context)

Input

• input object
  • Identity required Identity
  • NotificationType required NotificationType
  • SnsTopic NotificationTopic

Output

• output SetIdentityNotificationTopicResponse

SetReceiptRulePosition

amazonaws_email.SetReceiptRulePosition({
  "RuleSetName": "",
  "RuleName": ""
}, context)

Input

• input object
  • After ReceiptRuleName
  • RuleName required ReceiptRuleName
  • RuleSetName required ReceiptRuleSetName

Output

• output SetReceiptRulePositionResponse

TestRenderTemplate

amazonaws_email.TestRenderTemplate({
  "TemplateName": "",
  "TemplateData": ""
}, context)

Input

• input object
  • TemplateData required TemplateData
  • TemplateName required TemplateName

Output

• output TestRenderTemplateResponse

UpdateAccountSendingEnabled

amazonaws_email.UpdateAccountSendingEnabled({}, context)

Input

• input object
  • Enabled Enabled

Output

Output schema unknown

UpdateConfigurationSetEventDestination

amazonaws_email.UpdateConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestination": {
    "Name": "",
    "MatchingEventTypes": []
  }
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • EventDestination required EventDestination

Output

• output UpdateConfigurationSetEventDestinationResponse

UpdateConfigurationSetReputationMetricsEnabled

amazonaws_email.UpdateConfigurationSetReputationMetricsEnabled({
  "ConfigurationSetName": "",
  "Enabled": true
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • Enabled required Enabled

Output

Output schema unknown

UpdateConfigurationSetSendingEnabled

amazonaws_email.UpdateConfigurationSetSendingEnabled({
  "ConfigurationSetName": "",
  "Enabled": true
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • Enabled required Enabled

Output

Output schema unknown

UpdateConfigurationSetTrackingOptions

amazonaws_email.UpdateConfigurationSetTrackingOptions({
  "ConfigurationSetName": "",
  "TrackingOptions": {}
}, context)

Input

• input object
  • ConfigurationSetName required ConfigurationSetName
  • TrackingOptions required TrackingOptions

Output

• output UpdateConfigurationSetTrackingOptionsResponse

UpdateCustomVerificationEmailTemplate

amazonaws_email.UpdateCustomVerificationEmailTemplate({
  "TemplateName": ""
}, context)

Input

• input object
  • FailureRedirectionURL FailureRedirectionURL
  • FromEmailAddress FromAddress
  • SuccessRedirectionURL SuccessRedirectionURL
  • TemplateContent TemplateContent
  • TemplateName required TemplateName
  • TemplateSubject Subject

Output

Output schema unknown

UpdateReceiptRule

amazonaws_email.UpdateReceiptRule({
  "RuleSetName": "",
  "Rule": {
    "Name": ""
  }
}, context)

Input

• input object
  • Rule required ReceiptRule
  • RuleSetName required ReceiptRuleSetName

Output

• output UpdateReceiptRuleResponse

UpdateTemplate

amazonaws_email.UpdateTemplate({
  "Template": {
    "TemplateName": ""
  }
}, context)

Input

• input object
  • Template required Template

Output

• output UpdateTemplateResponse

VerifyDomainDkim

amazonaws_email.VerifyDomainDkim({
  "Domain": ""
}, context)

Input

• input object
  • Domain required Domain

Output

• output VerifyDomainDkimResponse

VerifyDomainIdentity

amazonaws_email.VerifyDomainIdentity({
  "Domain": ""
}, context)

Input

• input object
  • Domain required Domain

Output

• output VerifyDomainIdentityResponse

VerifyEmailAddress

amazonaws_email.VerifyEmailAddress({
  "EmailAddress": ""
}, context)

Input

• input object
  • EmailAddress required Address

Output

Output schema unknown

VerifyEmailIdentity

amazonaws_email.VerifyEmailIdentity({
  "EmailAddress": ""
}, context)

Input

• input object
  • EmailAddress required Address

Output

• output VerifyEmailIdentityResponse

Definitions

AccountSendingPausedException

• AccountSendingPausedException object: 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.

AddHeaderAction

• 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

Address

• Address string

AddressList

• AddressList array
  • items Address

AlreadyExistsException

• AlreadyExistsException object: Indicates that a resource could not be created because of a naming conflict.
  • Name RuleOrRuleSetName

AmazonResourceName

• AmazonResourceName string

ArrivalDate

• ArrivalDate string

BehaviorOnMXFailure

• BehaviorOnMXFailure string (values: UseDefaultValue, RejectMessage)

Body

• 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

BounceAction

• 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

BounceMessage

• BounceMessage string

BounceSmtpReplyCode

• BounceSmtpReplyCode string

BounceStatusCode

• BounceStatusCode string

BounceType

• BounceType string (values: DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure)

BouncedRecipientInfo

• 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

BouncedRecipientInfoList

• BouncedRecipientInfoList array
  • items BouncedRecipientInfo

BulkEmailDestination

• BulkEmailDestination object: 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

BulkEmailDestinationList

• BulkEmailDestinationList array
  • items BulkEmailDestination

BulkEmailDestinationStatus

• BulkEmailDestinationStatus object: An object that contains the response from the SendBulkTemplatedEmail operation.
  • Error Error
  • MessageId MessageId
  • Status BulkEmailStatus

BulkEmailDestinationStatusList

• BulkEmailDestinationStatusList array
  • items BulkEmailDestinationStatus

BulkEmailStatus

• BulkEmailStatus string (values: Success, MessageRejected, MailFromDomainNotVerified, ConfigurationSetDoesNotExist, TemplateDoesNotExist, AccountSuspended, AccountThrottled, AccountDailyQuotaExceeded, InvalidSendingPoolName, AccountSendingPaused, ConfigurationSetSendingPaused, InvalidParameterValue, TransientFailure, Failed)

CannotDeleteException

• CannotDeleteException object: Indicates that the delete operation could not be completed.
  • Name RuleOrRuleSetName

Charset

• Charset string

Cidr

• Cidr string

CloneReceiptRuleSetRequest

• CloneReceiptRuleSetRequest object: 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

CloneReceiptRuleSetResponse

• CloneReceiptRuleSetResponse object: An empty element returned on a successful request.

CloudWatchDestination

• 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

CloudWatchDimensionConfiguration

• 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

CloudWatchDimensionConfigurations

• CloudWatchDimensionConfigurations array
  • items CloudWatchDimensionConfiguration

ConfigurationSet

• ConfigurationSet object: 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

ConfigurationSetAlreadyExistsException

• ConfigurationSetAlreadyExistsException object: Indicates that the configuration set could not be created because of a naming conflict.
  • ConfigurationSetName ConfigurationSetName

ConfigurationSetAttribute

• ConfigurationSetAttribute string (values: eventDestinations, trackingOptions, reputationOptions)

ConfigurationSetAttributeList

• ConfigurationSetAttributeList array
  • items ConfigurationSetAttribute

ConfigurationSetDoesNotExistException

• ConfigurationSetDoesNotExistException object: Indicates that the configuration set does not exist.
  • ConfigurationSetName ConfigurationSetName

ConfigurationSetName

• ConfigurationSetName string

ConfigurationSetSendingPausedException

• ConfigurationSetSendingPausedException object: 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

ConfigurationSets

• ConfigurationSets array
  • items ConfigurationSet

Content

• Content object: 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

Counter

• Counter integer

CreateConfigurationSetEventDestinationRequest

• CreateConfigurationSetEventDestinationRequest object: 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

CreateConfigurationSetEventDestinationResponse

• CreateConfigurationSetEventDestinationResponse object: An empty element returned on a successful request.

CreateConfigurationSetRequest

• 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

CreateConfigurationSetResponse

• CreateConfigurationSetResponse object: An empty element returned on a successful request.

CreateConfigurationSetTrackingOptionsRequest

• CreateConfigurationSetTrackingOptionsRequest object: Represents a request to create an open and click tracking option object in a configuration set.
  • ConfigurationSetName required ConfigurationSetName
  • TrackingOptions required TrackingOptions

CreateConfigurationSetTrackingOptionsResponse

• CreateConfigurationSetTrackingOptionsResponse object: An empty element returned on a successful request.

CreateCustomVerificationEmailTemplateRequest

• 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

CreateReceiptFilterRequest

• 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

CreateReceiptFilterResponse

• CreateReceiptFilterResponse object: An empty element returned on a successful request.

CreateReceiptRuleRequest

• 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

CreateReceiptRuleResponse

• CreateReceiptRuleResponse object: An empty element returned on a successful request.

CreateReceiptRuleSetRequest

• 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

CreateReceiptRuleSetResponse

• CreateReceiptRuleSetResponse object: An empty element returned on a successful request.

CreateTemplateRequest

• CreateTemplateRequest object: Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
  • Template required Template

CreateTemplateResponse

• CreateTemplateResponse object

CustomMailFromStatus

• CustomMailFromStatus string (values: Pending, Success, Failed, TemporaryFailure)

CustomRedirectDomain

• CustomRedirectDomain string

CustomVerificationEmailInvalidContentException

• CustomVerificationEmailInvalidContentException object: Indicates that custom verification email template provided content is invalid.

CustomVerificationEmailTemplate

• CustomVerificationEmailTemplate object: Contains information about a custom verification email template.
  • FailureRedirectionURL FailureRedirectionURL
  • FromEmailAddress FromAddress
  • SuccessRedirectionURL SuccessRedirectionURL
  • TemplateName TemplateName
  • TemplateSubject Subject

CustomVerificationEmailTemplateAlreadyExistsException

• CustomVerificationEmailTemplateAlreadyExistsException object: Indicates that a custom verification email template with the name you specified already exists.
  • CustomVerificationEmailTemplateName TemplateName

CustomVerificationEmailTemplateDoesNotExistException

• CustomVerificationEmailTemplateDoesNotExistException object: Indicates that a custom verification email template with the name you specified does not exist.
  • CustomVerificationEmailTemplateName TemplateName

CustomVerificationEmailTemplates

• CustomVerificationEmailTemplates array
  • items CustomVerificationEmailTemplate

DefaultDimensionValue

• DefaultDimensionValue string

DeleteConfigurationSetEventDestinationRequest

• DeleteConfigurationSetEventDestinationRequest object: 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

DeleteConfigurationSetEventDestinationResponse

• DeleteConfigurationSetEventDestinationResponse object: An empty element returned on a successful request.

DeleteConfigurationSetRequest

• 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

DeleteConfigurationSetResponse

• DeleteConfigurationSetResponse object: An empty element returned on a successful request.

DeleteConfigurationSetTrackingOptionsRequest

• DeleteConfigurationSetTrackingOptionsRequest object: Represents a request to delete open and click tracking options in a configuration set.
  • ConfigurationSetName required ConfigurationSetName

DeleteConfigurationSetTrackingOptionsResponse

• DeleteConfigurationSetTrackingOptionsResponse object: An empty element returned on a successful request.

DeleteCustomVerificationEmailTemplateRequest

• DeleteCustomVerificationEmailTemplateRequest object: Represents a request to delete an existing custom verification email template.
  • TemplateName required TemplateName

DeleteIdentityPolicyRequest

• 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

DeleteIdentityPolicyResponse

• DeleteIdentityPolicyResponse object: An empty element returned on a successful request.

DeleteIdentityRequest

• DeleteIdentityRequest object: Represents a request to delete one of your Amazon SES identities (an email address or domain).
  • Identity required Identity

DeleteIdentityResponse

• DeleteIdentityResponse object: An empty element returned on a successful request.

DeleteReceiptFilterRequest

• 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

DeleteReceiptFilterResponse

• DeleteReceiptFilterResponse object: An empty element returned on a successful request.

DeleteReceiptRuleRequest

• 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

DeleteReceiptRuleResponse

• DeleteReceiptRuleResponse object: An empty element returned on a successful request.

DeleteReceiptRuleSetRequest

• 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

DeleteReceiptRuleSetResponse

• DeleteReceiptRuleSetResponse object: An empty element returned on a successful request.

DeleteTemplateRequest

• DeleteTemplateRequest object: Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
  • TemplateName required TemplateName

DeleteTemplateResponse

• DeleteTemplateResponse object

DeleteVerifiedEmailAddressRequest

• DeleteVerifiedEmailAddressRequest object: 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

DescribeActiveReceiptRuleSetRequest

• 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.

DescribeActiveReceiptRuleSetResponse

• DescribeActiveReceiptRuleSetResponse object: Represents the metadata and receipt rules for the receipt rule set that is currently active.
  • Metadata ReceiptRuleSetMetadata
  • Rules ReceiptRulesList

DescribeConfigurationSetRequest

• 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

DescribeConfigurationSetResponse

• 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

DescribeReceiptRuleRequest

• 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

DescribeReceiptRuleResponse

• DescribeReceiptRuleResponse object: Represents the details of a receipt rule.
  • Rule ReceiptRule

DescribeReceiptRuleSetRequest

• 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

DescribeReceiptRuleSetResponse

• DescribeReceiptRuleSetResponse object: Represents the details of the specified receipt rule set.
  • Metadata ReceiptRuleSetMetadata
  • Rules ReceiptRulesList

Destination

• 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

DiagnosticCode

• DiagnosticCode string

DimensionName

• DimensionName string

DimensionValueSource

• DimensionValueSource string (values: messageTag, emailHeader, linkTag)

DkimAttributes

• DkimAttributes array
  • items object
    • key Identity
    • value IdentityDkimAttributes

Domain

• Domain string

DsnAction

• DsnAction string (values: failed, delayed, delivered, relayed, expanded)

DsnStatus

• DsnStatus string

Enabled

• Enabled boolean

Error

• Error string

EventDestination

• EventDestination object: 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

EventDestinationAlreadyExistsException

• EventDestinationAlreadyExistsException object: Indicates that the event destination could not be created because of a naming conflict.
  • ConfigurationSetName ConfigurationSetName
  • EventDestinationName EventDestinationName

EventDestinationDoesNotExistException

• EventDestinationDoesNotExistException object: Indicates that the event destination does not exist.
  • ConfigurationSetName ConfigurationSetName
  • EventDestinationName EventDestinationName

EventDestinationName

• EventDestinationName string

EventDestinations

• EventDestinations array
  • items EventDestination

EventType

• EventType string (values: send, reject, bounce, complaint, delivery, open, click, renderingFailure)

EventTypes

• EventTypes array
  • items EventType

Explanation

• Explanation string

ExtensionField

• ExtensionField object: 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

ExtensionFieldList

• ExtensionFieldList array
  • items ExtensionField

ExtensionFieldName

• ExtensionFieldName string

ExtensionFieldValue

• ExtensionFieldValue string

FailureRedirectionURL

• FailureRedirectionURL string

FromAddress

• FromAddress string

FromEmailAddressNotVerifiedException

• FromEmailAddressNotVerifiedException object: 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

GetAccountSendingEnabledResponse

• GetAccountSendingEnabledResponse object: Represents a request to return the email sending status for your Amazon SES account.
  • Enabled Enabled

GetCustomVerificationEmailTemplateRequest

• GetCustomVerificationEmailTemplateRequest object: Represents a request to retrieve an existing custom verification email template.
  • TemplateName required TemplateName

GetCustomVerificationEmailTemplateResponse

• GetCustomVerificationEmailTemplateResponse object: The content of the custom verification email template.
  • FailureRedirectionURL FailureRedirectionURL
  • FromEmailAddress FromAddress
  • SuccessRedirectionURL SuccessRedirectionURL
  • TemplateContent TemplateContent
  • TemplateName TemplateName
  • TemplateSubject Subject

GetIdentityDkimAttributesRequest

• 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

GetIdentityDkimAttributesResponse

• 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

GetIdentityMailFromDomainAttributesRequest

• 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

GetIdentityMailFromDomainAttributesResponse

• GetIdentityMailFromDomainAttributesResponse object: Represents the custom MAIL FROM attributes for a list of identities.
  • MailFromDomainAttributes required MailFromDomainAttributes

GetIdentityNotificationAttributesRequest

• 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

GetIdentityNotificationAttributesResponse

• GetIdentityNotificationAttributesResponse object: Represents the notification attributes for a list of identities.
  • NotificationAttributes required NotificationAttributes

GetIdentityPoliciesRequest

• 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

GetIdentityPoliciesResponse

• GetIdentityPoliciesResponse object: Represents the requested sending authorization policies.
  • Policies required PolicyMap

GetIdentityVerificationAttributesRequest

• 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

GetIdentityVerificationAttributesResponse

• 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

GetSendQuotaResponse

• 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

GetSendStatisticsResponse

• 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

GetTemplateRequest

• GetTemplateRequest object
  • TemplateName required TemplateName

GetTemplateResponse

• GetTemplateResponse object
  • Template Template

HeaderName

• HeaderName string

HeaderValue

• HeaderValue string

HtmlPart

• HtmlPart string

Identity

• Identity string

IdentityDkimAttributes

• IdentityDkimAttributes object: Represents the DKIM attributes of a verified email address or a domain.
  • DkimEnabled required Enabled
  • DkimTokens VerificationTokenList
  • DkimVerificationStatus required VerificationStatus

IdentityList

• IdentityList array
  • items Identity

IdentityMailFromDomainAttributes

• IdentityMailFromDomainAttributes object: Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
  • BehaviorOnMXFailure required BehaviorOnMXFailure
  • MailFromDomain required MailFromDomainName
  • MailFromDomainStatus required CustomMailFromStatus

IdentityNotificationAttributes

• 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

IdentityType

• IdentityType string (values: EmailAddress, Domain)

IdentityVerificationAttributes

• IdentityVerificationAttributes object: Represents the verification attributes of a single identity.
  • VerificationStatus required VerificationStatus
  • VerificationToken VerificationToken

InvalidCloudWatchDestinationException

• InvalidCloudWatchDestinationException object: Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
  • ConfigurationSetName ConfigurationSetName
  • EventDestinationName EventDestinationName

InvalidConfigurationSetException

• InvalidConfigurationSetException object: Indicates that the configuration set is invalid. See the error message for details.

InvalidFirehoseDestinationException

• InvalidFirehoseDestinationException object: Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
  • ConfigurationSetName ConfigurationSetName
  • EventDestinationName EventDestinationName

InvalidLambdaFunctionException

• 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

InvalidPolicyException

• InvalidPolicyException object: Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

InvalidRenderingParameterException

• 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

InvalidS3ConfigurationException

• InvalidS3ConfigurationException object: Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is