5.0.0 • Published 6 years ago

@datafire/amazonaws_email v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

@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

Output

CreateConfigurationSet

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

Input

Output

CreateConfigurationSetEventDestination

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

Input

Output

CreateConfigurationSetTrackingOptions

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

Input

Output

CreateCustomVerificationEmailTemplate

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

Input

Output

Output schema unknown

CreateReceiptFilter

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

Input

Output

CreateReceiptRule

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

Input

Output

CreateReceiptRuleSet

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

Input

Output

CreateTemplate

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

Input

Output

DeleteConfigurationSet

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

Input

Output

DeleteConfigurationSetEventDestination

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

Input

Output

DeleteConfigurationSetTrackingOptions

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

Input

Output

DeleteCustomVerificationEmailTemplate

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

Input

Output

Output schema unknown

DeleteIdentity

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

Input

Output

DeleteIdentityPolicy

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

Input

Output

DeleteReceiptFilter

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

Input

Output

DeleteReceiptRule

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

Input

Output

DeleteReceiptRuleSet

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

Input

Output

DeleteTemplate

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

Input

Output

DeleteVerifiedEmailAddress

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

Input

  • input object

Output

Output schema unknown

DescribeActiveReceiptRuleSet

amazonaws_email.DescribeActiveReceiptRuleSet({}, context)

Input

  • input object

Output

DescribeConfigurationSet

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

Input

Output

DescribeReceiptRule

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

Input

Output

DescribeReceiptRuleSet

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

Input

Output

GetAccountSendingEnabled

amazonaws_email.GetAccountSendingEnabled({}, context)

Input

  • input object

Output

GetCustomVerificationEmailTemplate

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

Input

Output

GetIdentityDkimAttributes

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

Input

Output

GetIdentityMailFromDomainAttributes

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

Input

Output

GetIdentityNotificationAttributes

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

Input

Output

GetIdentityPolicies

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

Input

Output

GetIdentityVerificationAttributes

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

Input

Output

GetSendQuota

amazonaws_email.GetSendQuota({}, context)

Input

  • input object

Output

GetSendStatistics

amazonaws_email.GetSendStatistics({}, context)

Input

  • input object

Output

GetTemplate

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

Input

Output

ListConfigurationSets

amazonaws_email.ListConfigurationSets({}, context)

Input

Output

ListCustomVerificationEmailTemplates

amazonaws_email.ListCustomVerificationEmailTemplates({}, context)

Input

Output

ListIdentities

amazonaws_email.ListIdentities({}, context)

Input

Output

ListIdentityPolicies

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

Input

Output

ListReceiptFilters

amazonaws_email.ListReceiptFilters({}, context)

Input

  • input object

Output

ListReceiptRuleSets

amazonaws_email.ListReceiptRuleSets({}, context)

Input

Output

ListTemplates

amazonaws_email.ListTemplates({}, context)

Input

Output

ListVerifiedEmailAddresses

amazonaws_email.ListVerifiedEmailAddresses({}, context)

Input

  • input object

Output

PutIdentityPolicy

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

Input

Output

ReorderReceiptRuleSet

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

Input

Output

SendBounce

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

Input

Output

SendBulkTemplatedEmail

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

Input

Output

SendCustomVerificationEmail

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

Input

Output

SendEmail

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

Input

Output

SendRawEmail

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

Input

Output

SendTemplatedEmail

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

Input

Output

SetActiveReceiptRuleSet

amazonaws_email.SetActiveReceiptRuleSet({}, context)

Input

Output

SetIdentityDkimEnabled

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

Input

Output

SetIdentityFeedbackForwardingEnabled

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

Input

Output

SetIdentityHeadersInNotificationsEnabled

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

Input

Output

SetIdentityMailFromDomain

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

Input

Output

SetIdentityNotificationTopic

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

Input

Output

SetReceiptRulePosition

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

Input

Output

TestRenderTemplate

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

Input

Output

UpdateAccountSendingEnabled

amazonaws_email.UpdateAccountSendingEnabled({}, context)

Input

Output

Output schema unknown

UpdateConfigurationSetEventDestination

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

Input

Output

UpdateConfigurationSetReputationMetricsEnabled

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

Input

Output

Output schema unknown

UpdateConfigurationSetSendingEnabled

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

Input

Output

Output schema unknown

UpdateConfigurationSetTrackingOptions

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

Input

Output

UpdateCustomVerificationEmailTemplate

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

Input

Output

Output schema unknown

UpdateReceiptRule

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

Input

Output

UpdateTemplate

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

Input

Output

VerifyDomainDkim

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

Input

  • input object

Output

VerifyDomainIdentity

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

Input

  • input object

Output

VerifyEmailAddress

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

Input

  • input object

Output

Output schema unknown

VerifyEmailIdentity

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

Input

  • input object

Output

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.

Address

  • Address string

AddressList

AlreadyExistsException

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

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.

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.

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.

BouncedRecipientInfoList

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.

BulkEmailDestinationList

BulkEmailDestinationStatus

  • BulkEmailDestinationStatus object: An object that contains the response from the SendBulkTemplatedEmail operation.

BulkEmailDestinationStatusList

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.

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.

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.

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.

CloudWatchDimensionConfigurations

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.

ConfigurationSetAlreadyExistsException

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

ConfigurationSetAttribute

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

ConfigurationSetAttributeList

ConfigurationSetDoesNotExistException

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

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.

ConfigurationSets

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.

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.

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.

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.

CreateConfigurationSetTrackingOptionsResponse

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

CreateCustomVerificationEmailTemplateRequest

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.

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.

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.

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.

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

CustomVerificationEmailTemplateAlreadyExistsException

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

CustomVerificationEmailTemplateDoesNotExistException

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

CustomVerificationEmailTemplates

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

DescribeReceiptRuleResponse

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

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.

DescribeReceiptRuleSetResponse

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.

DiagnosticCode

  • DiagnosticCode string

DimensionName

  • DimensionName string

DimensionValueSource

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

DkimAttributes

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.

EventDestinationAlreadyExistsException

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

EventDestinationDoesNotExistException

EventDestinationName

  • EventDestinationName string

EventDestinations

EventType

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

EventTypes

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.

ExtensionFieldList

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.

GetAccountSendingEnabledResponse

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

GetCustomVerificationEmailTemplateRequest

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

GetCustomVerificationEmailTemplateResponse

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.

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.

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.

GetIdentityMailFromDomainAttributesResponse

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

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.

GetIdentityNotificationAttributesResponse

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

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.

GetIdentityPoliciesResponse

  • GetIdentityPoliciesResponse object: Represents the requested sending authorization policies.

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.

GetIdentityVerificationAttributesResponse

  • GetIdentityVerificationAttributesResponse object: The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

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.

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.

GetTemplateRequest

GetTemplateResponse

  • GetTemplateResponse object

HeaderName

  • HeaderName string

HeaderValue

  • HeaderValue string

HtmlPart

  • HtmlPart string

Identity

  • Identity string

IdentityDkimAttributes

IdentityList

IdentityMailFromDomainAttributes

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.

IdentityType

  • IdentityType string (values: EmailAddress, Domain)

IdentityVerificationAttributes

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

InvalidCloudWatchDestinationException

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

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.

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.

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.

InvalidS3ConfigurationException

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

6 years ago

4.0.0

7 years ago

3.0.4

7 years ago

3.0.3

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago