Skip to content

Latest commit

 

History

History

amazonaws_sesv2

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_sesv2

Client library for Amazon Simple Email Service

Installation and Usage

npm install --save @datafire/amazonaws_sesv2
let amazonaws_sesv2 = require('@datafire/amazonaws_sesv2').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon SES API v2

Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.

Amazon SES is an AWS service that you can use to send email messages to your customers.

If you're new to Amazon SES API v2, you might find it helpful to also review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

Actions

PutEmailIdentityDkimSigningAttributes

amazonaws_sesv2.PutEmailIdentityDkimSigningAttributes({
  "EmailIdentity": "",
  "SigningAttributesOrigin": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • SigningAttributes object: An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).
      • DomainSigningPrivateKey
      • DomainSigningSelector
    • SigningAttributesOrigin required string (values: AWS_SES, EXTERNAL):

      The method that you want to use to configure DKIM for the identity. There are two possible values:

      • AWS_SES – Configure DKIM for the identity by using Easy DKIM.

      • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

Output

GetAccount

amazonaws_sesv2.GetAccount({}, context)

Input

  • input object

Output

PutAccountDedicatedIpWarmupAttributes

amazonaws_sesv2.PutAccountDedicatedIpWarmupAttributes({}, context)

Input

  • input object
    • AutoWarmupEnabled boolean: Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

Output

PutAccountDetails

amazonaws_sesv2.PutAccountDetails({
  "MailType": "",
  "WebsiteURL": "",
  "UseCaseDescription": ""
}, context)

Input

  • input object
    • AdditionalContactEmailAddresses array: Additional email addresses that you would like to be notified regarding Amazon SES matters.
    • ContactLanguage string (values: EN, JA): The language you would prefer to be contacted with.
    • MailType required string (values: MARKETING, TRANSACTIONAL): The type of email your account will send.
    • ProductionAccessEnabled boolean:

      Indicates whether or not your account should have production access in the current AWS Region.

      If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

      If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

    • UseCaseDescription required string: A description of the types of email that you plan to send.
    • WebsiteURL required string: The URL of your website. This information helps us better understand the type of content that you plan to send.

Output

PutAccountSendingAttributes

amazonaws_sesv2.PutAccountSendingAttributes({}, context)

Input

  • input object
    • SendingEnabled boolean:

      Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.

      If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

Output

PutAccountSuppressionAttributes

amazonaws_sesv2.PutAccountSuppressionAttributes({}, context)

Input

  • input object
    • SuppressedReasons array:

      A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:

      • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

      • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Output

ListConfigurationSets

amazonaws_sesv2.ListConfigurationSets({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

CreateConfigurationSet

amazonaws_sesv2.CreateConfigurationSet({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string:

      The name of a configuration set.

      Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

    • DeliveryOptions object: Used to associate a configuration set with a dedicated IP pool.
      • SendingPoolName
      • TlsPolicy
    • ReputationOptions object: Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
      • LastFreshStart
      • ReputationMetricsEnabled
    • SendingOptions object: Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
      • SendingEnabled
    • SuppressionOptions object: An object that contains information about the suppression list preferences for your account.
    • Tags array: An array of objects that define the tags (keys and values) that you want to associate with the configuration set.
    • TrackingOptions object:

      An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

      These images and links include references to a domain operated by AWS. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

      • CustomRedirectDomain

Output

DeleteConfigurationSet

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

Input

  • input object
    • ConfigurationSetName required string

Output

GetConfigurationSet

amazonaws_sesv2.GetConfigurationSet({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string

Output

PutConfigurationSetDeliveryOptions

amazonaws_sesv2.PutConfigurationSetDeliveryOptions({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • SendingPoolName string: The name of the dedicated IP pool that you want to associate with the configuration set.
    • TlsPolicy string (values: REQUIRE, OPTIONAL): Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

Output

GetConfigurationSetEventDestinations

amazonaws_sesv2.GetConfigurationSetEventDestinations({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string

Output

CreateConfigurationSetEventDestination

amazonaws_sesv2.CreateConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestinationName": "",
  "EventDestination": {}
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • EventDestination required object: An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
      • CloudWatchDestination
      • Enabled
      • KinesisFirehoseDestination
        • DeliveryStreamArn required
        • IamRoleArn required
      • MatchingEventTypes
      • PinpointDestination
        • ApplicationArn
      • SnsDestination
        • TopicArn required
    • EventDestinationName required string:

      The name of an event destination.

      Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Output

DeleteConfigurationSetEventDestination

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

Input

  • input object
    • ConfigurationSetName required string
    • EventDestinationName required string

Output

UpdateConfigurationSetEventDestination

amazonaws_sesv2.UpdateConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestinationName": "",
  "EventDestination": {}
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • EventDestinationName required string
    • EventDestination required object: An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
      • CloudWatchDestination
      • Enabled
      • KinesisFirehoseDestination
        • DeliveryStreamArn required
        • IamRoleArn required
      • MatchingEventTypes
      • PinpointDestination
        • ApplicationArn
      • SnsDestination
        • TopicArn required

Output

PutConfigurationSetReputationOptions

amazonaws_sesv2.PutConfigurationSetReputationOptions({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • ReputationMetricsEnabled boolean: If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

Output

PutConfigurationSetSendingOptions

amazonaws_sesv2.PutConfigurationSetSendingOptions({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • SendingEnabled boolean: If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

Output

PutConfigurationSetSuppressionOptions

amazonaws_sesv2.PutConfigurationSetSuppressionOptions({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • SuppressedReasons array:

      A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

      • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

      • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Output

PutConfigurationSetTrackingOptions

amazonaws_sesv2.PutConfigurationSetTrackingOptions({
  "ConfigurationSetName": ""
}, context)

Input

  • input object
    • ConfigurationSetName required string
    • CustomRedirectDomain string: The domain that you want to use for tracking open and click events.

Output

ListContactLists

amazonaws_sesv2.ListContactLists({}, context)

Input

  • input object
    • PageSize integer
    • NextToken string

Output

CreateContactList

amazonaws_sesv2.CreateContactList({
  "ContactListName": ""
}, context)

Input

  • input object
    • ContactListName required string: The name of the contact list.
    • Description string: A description of what the contact list is about.
    • Tags array: The tags associated with a contact list.
    • Topics array: An interest group, theme, or label within a list. A contact list can have multiple topics.

Output

DeleteContactList

amazonaws_sesv2.DeleteContactList({
  "ContactListName": ""
}, context)

Input

  • input object
    • ContactListName required string

Output

GetContactList

amazonaws_sesv2.GetContactList({
  "ContactListName": ""
}, context)

Input

  • input object
    • ContactListName required string

Output

UpdateContactList

amazonaws_sesv2.UpdateContactList({
  "ContactListName": ""
}, context)

Input

  • input object
    • ContactListName required string
    • Description string: A description of what the contact list is about.
    • Topics array: An interest group, theme, or label within a list. A contact list can have multiple topics.

Output

ListContacts

amazonaws_sesv2.ListContacts({
  "ContactListName": ""
}, context)

Input

  • input object
    • ContactListName required string
    • PageSize integer
    • NextToken string
    • Filter object: A filter that can be applied to a list of contacts.
      • FilteredStatus
      • TopicFilter
        • TopicName
        • UseDefaultIfPreferenceUnavailable

Output

CreateContact

amazonaws_sesv2.CreateContact({
  "ContactListName": "",
  "EmailAddress": ""
}, context)

Input

  • input object
    • ContactListName required string
    • AttributesData string: The attribute data attached to a contact.
    • EmailAddress required string: The contact's email address.
    • TopicPreferences array: The contact's preferences for being opted-in to or opted-out of topics.
    • UnsubscribeAll boolean: A boolean value status noting if the contact is unsubscribed from all contact list topics.

Output

DeleteContact

amazonaws_sesv2.DeleteContact({
  "ContactListName": "",
  "EmailAddress": ""
}, context)

Input

  • input object
    • ContactListName required string
    • EmailAddress required string

Output

GetContact

amazonaws_sesv2.GetContact({
  "ContactListName": "",
  "EmailAddress": ""
}, context)

Input

  • input object
    • ContactListName required string
    • EmailAddress required string

Output

UpdateContact

amazonaws_sesv2.UpdateContact({
  "ContactListName": "",
  "EmailAddress": ""
}, context)

Input

  • input object
    • ContactListName required string
    • EmailAddress required string
    • AttributesData string: The attribute data attached to a contact.
    • TopicPreferences array: The contact's preference for being opted-in to or opted-out of a topic.
    • UnsubscribeAll boolean: A boolean value status noting if the contact is unsubscribed from all contact list topics.

Output

ListCustomVerificationEmailTemplates

amazonaws_sesv2.ListCustomVerificationEmailTemplates({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

CreateCustomVerificationEmailTemplate

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

Input

  • input object
    • FailureRedirectionURL required string: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
    • FromEmailAddress required string: The email address that the custom verification email is sent from.
    • SuccessRedirectionURL required string: The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
    • TemplateContent required string: The content of the custom verification email template.
    • TemplateName required string: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    • TemplateSubject required string: The subject line of the email.

Output

DeleteCustomVerificationEmailTemplate

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

Input

  • input object
    • TemplateName required string

Output

GetCustomVerificationEmailTemplate

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

Input

  • input object
    • TemplateName required string

Output

UpdateCustomVerificationEmailTemplate

amazonaws_sesv2.UpdateCustomVerificationEmailTemplate({
  "TemplateName": "",
  "FromEmailAddress": "",
  "TemplateSubject": "",
  "TemplateContent": "",
  "SuccessRedirectionURL": "",
  "FailureRedirectionURL": ""
}, context)

Input

  • input object
    • TemplateName required string
    • FailureRedirectionURL required string: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
    • FromEmailAddress required string: The email address that the custom verification email is sent from.
    • SuccessRedirectionURL required string: The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
    • TemplateContent required string: The content of the custom verification email template.
    • TemplateSubject required string: The subject line of the email.

Output

ListDedicatedIpPools

amazonaws_sesv2.ListDedicatedIpPools({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

CreateDedicatedIpPool

amazonaws_sesv2.CreateDedicatedIpPool({
  "PoolName": ""
}, context)

Input

  • input object
    • PoolName required string: The name of a dedicated IP pool.
    • Tags array: An object that defines the tags (keys and values) that you want to associate with the pool.

Output

DeleteDedicatedIpPool

amazonaws_sesv2.DeleteDedicatedIpPool({
  "PoolName": ""
}, context)

Input

  • input object
    • PoolName required string

Output

GetDedicatedIps

amazonaws_sesv2.GetDedicatedIps({}, context)

Input

  • input object
    • PoolName string
    • NextToken string
    • PageSize integer

Output

GetDedicatedIp

amazonaws_sesv2.GetDedicatedIp({
  "IP": ""
}, context)

Input

  • input object
    • IP required string

Output

PutDedicatedIpInPool

amazonaws_sesv2.PutDedicatedIpInPool({
  "IP": "",
  "DestinationPoolName": ""
}, context)

Input

  • input object
    • IP required string
    • DestinationPoolName required string: The name of a dedicated IP pool.

Output

PutDedicatedIpWarmupAttributes

amazonaws_sesv2.PutDedicatedIpWarmupAttributes({
  "IP": "",
  "WarmupPercentage": 0
}, context)

Input

  • input object
    • IP required string
    • WarmupPercentage required integer: The warm-up percentage that you want to associate with the dedicated IP address.

Output

GetDeliverabilityDashboardOptions

amazonaws_sesv2.GetDeliverabilityDashboardOptions({}, context)

Input

  • input object

Output

PutDeliverabilityDashboardOption

amazonaws_sesv2.PutDeliverabilityDashboardOption({
  "DashboardEnabled": true
}, context)

Input

  • input object
    • DashboardEnabled required boolean: Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.
    • SubscribedDomains array: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

Output

GetBlacklistReports

amazonaws_sesv2.GetBlacklistReports({
  "BlacklistItemNames": []
}, context)

Input

  • input object
    • BlacklistItemNames required array

Output

GetDomainDeliverabilityCampaign

amazonaws_sesv2.GetDomainDeliverabilityCampaign({
  "CampaignId": ""
}, context)

Input

  • input object
    • CampaignId required string

Output

ListDomainDeliverabilityCampaigns

amazonaws_sesv2.ListDomainDeliverabilityCampaigns({
  "StartDate": "",
  "EndDate": "",
  "SubscribedDomain": ""
}, context)

Input

  • input object
    • StartDate required string
    • EndDate required string
    • SubscribedDomain required string
    • NextToken string
    • PageSize integer

Output

GetDomainStatisticsReport

amazonaws_sesv2.GetDomainStatisticsReport({
  "Domain": "",
  "StartDate": "",
  "EndDate": ""
}, context)

Input

  • input object
    • Domain required string
    • StartDate required string
    • EndDate required string

Output

CreateDeliverabilityTestReport

amazonaws_sesv2.CreateDeliverabilityTestReport({
  "FromEmailAddress": "",
  "Content": {}
}, context)

Input

  • input object
    • Content required object: An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
      • Raw
        • Data required
      • Simple
        • Body required
          • Html
            • Charset
            • Data required
          • Text
            • Charset
            • Data required
        • Subject required
          • Charset
          • Data required
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • FromEmailAddress required string: The email address that the predictive inbox placement test email was sent from.
    • ReportName string: A name that helps you identify a report generated by the Deliverability dashboard.
    • Tags array: An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Output

ListDeliverabilityTestReports

amazonaws_sesv2.ListDeliverabilityTestReports({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

GetDeliverabilityTestReport

amazonaws_sesv2.GetDeliverabilityTestReport({
  "ReportId": ""
}, context)

Input

  • input object
    • ReportId required string

Output

ListEmailIdentities

amazonaws_sesv2.ListEmailIdentities({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

CreateEmailIdentity

amazonaws_sesv2.CreateEmailIdentity({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • DkimSigningAttributes object: An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).
      • DomainSigningPrivateKey
      • DomainSigningSelector
    • EmailIdentity required string: The email address or domain that you want to verify.
    • Tags array: An array of objects that define the tags (keys and values) that you want to associate with the email identity.

Output

DeleteEmailIdentity

amazonaws_sesv2.DeleteEmailIdentity({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string

Output

GetEmailIdentity

amazonaws_sesv2.GetEmailIdentity({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string

Output

PutEmailIdentityDkimAttributes

amazonaws_sesv2.PutEmailIdentityDkimAttributes({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • SigningEnabled boolean:

      Sets the DKIM signing configuration for the identity.

      When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.

Output

PutEmailIdentityFeedbackAttributes

amazonaws_sesv2.PutEmailIdentityFeedbackAttributes({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • EmailForwardingEnabled boolean:

      Sets the feedback forwarding configuration for the identity.

      If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

      You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Output

PutEmailIdentityMailFromAttributes

amazonaws_sesv2.PutEmailIdentityMailFromAttributes({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • BehaviorOnMxFailure string (values: USE_DEFAULT_VALUE, REJECT_MESSAGE):

      The action that you want to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

      These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

    • MailFromDomain string: The domain that you want to use as a MAIL FROM domain.

Output

GetEmailIdentityPolicies

amazonaws_sesv2.GetEmailIdentityPolicies({
  "EmailIdentity": ""
}, context)

Input

  • input object
    • EmailIdentity required string

Output

DeleteEmailIdentityPolicy

amazonaws_sesv2.DeleteEmailIdentityPolicy({
  "EmailIdentity": "",
  "PolicyName": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • PolicyName required string

Output

CreateEmailIdentityPolicy

amazonaws_sesv2.CreateEmailIdentityPolicy({
  "EmailIdentity": "",
  "PolicyName": "",
  "Policy": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • PolicyName required string
    • Policy required string:

      The text of the policy in JSON format. The policy cannot exceed 4 KB.

      For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

Output

UpdateEmailIdentityPolicy

amazonaws_sesv2.UpdateEmailIdentityPolicy({
  "EmailIdentity": "",
  "PolicyName": "",
  "Policy": ""
}, context)

Input

  • input object
    • EmailIdentity required string
    • PolicyName required string
    • Policy required string:

      The text of the policy in JSON format. The policy cannot exceed 4 KB.

      For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

Output

ListImportJobs

amazonaws_sesv2.ListImportJobs({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer
    • ImportDestinationType string (values: SUPPRESSION_LIST, CONTACT_LIST): The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

Output

CreateImportJob

amazonaws_sesv2.CreateImportJob({
  "ImportDestination": {},
  "ImportDataSource": {}
}, context)

Input

  • input object
    • ImportDataSource required object: An object that contains details about the data source of the import job.
      • DataFormat
      • S3Url
    • ImportDestination required object: An object that contains details about the resource destination the import job is going to target.
      • ContactListDestination
        • ContactListImportAction required
        • ContactListName required
      • SuppressionListDestination
        • SuppressionListImportAction required

Output

GetImportJob

amazonaws_sesv2.GetImportJob({
  "JobId": ""
}, context)

Input

  • input object
    • JobId required string

Output

SendBulkEmail

amazonaws_sesv2.SendBulkEmail({
  "DefaultContent": {},
  "BulkEmailEntries": []
}, context)

Input

  • input object
    • BulkEmailEntries required array: A list of BulkEmailEntry objects.
    • ConfigurationSetName string:

      The name of a configuration set.

      Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

    • DefaultContent required object: An object that contains the body of the message. You can specify a template message.
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • DefaultEmailTags array: A list of message tags.
    • FeedbackForwardingEmailAddress string: The address that you want bounce and complaint notifications to be sent to.
    • FeedbackForwardingEmailAddressIdentityArn string:

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].

      For more information about sending authorization, see the Amazon SES Developer Guide.

    • FromEmailAddress string: The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
    • FromEmailAddressIdentityArn string:

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

      For more information about sending authorization, see the Amazon SES Developer Guide.

    • ReplyToAddresses array: The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Output

SendCustomVerificationEmail

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

Input

  • input object
    • ConfigurationSetName string:

      The name of a configuration set.

      Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

    • EmailAddress required string: The email address to verify.
    • TemplateName required string: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

Output

SendEmail

amazonaws_sesv2.SendEmail({
  "Content": {}
}, context)

Input

  • input object
    • ConfigurationSetName string:

      The name of a configuration set.

      Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

    • Content required object: An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
      • Raw
        • Data required
      • Simple
        • Body required
          • Html
            • Charset
            • Data required
          • Text
            • Charset
            • Data required
        • Subject required
          • Charset
          • Data required
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • Destination object: An object that describes the recipients for an email.
    • EmailTags array: A list of message tags.
    • FeedbackForwardingEmailAddress string: The address that you want bounce and complaint notifications to be sent to.
    • FeedbackForwardingEmailAddressIdentityArn string:

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].

      For more information about sending authorization, see the Amazon SES Developer Guide.

    • FromEmailAddress string: The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
    • FromEmailAddressIdentityArn string:

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

      For more information about sending authorization, see the Amazon SES Developer Guide.

      For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

    • ListManagementOptions object: An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
      • ContactListName
      • TopicName
    • ReplyToAddresses array: The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Output

ListSuppressedDestinations

amazonaws_sesv2.ListSuppressedDestinations({}, context)

Input

  • input object
    • Reason array
    • StartDate string
    • EndDate string
    • NextToken string
    • PageSize integer

Output

PutSuppressedDestination

amazonaws_sesv2.PutSuppressedDestination({
  "EmailAddress": "",
  "Reason": ""
}, context)

Input

  • input object
    • EmailAddress required string: The email address that should be added to the suppression list for your account.
    • Reason required string (values: BOUNCE, COMPLAINT):

      The reason that the address was added to the suppression list for your account. The value can be one of the following:

      • COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.

      • BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.

Output

DeleteSuppressedDestination

amazonaws_sesv2.DeleteSuppressedDestination({
  "EmailAddress": ""
}, context)

Input

  • input object
    • EmailAddress required string

Output

GetSuppressedDestination

amazonaws_sesv2.GetSuppressedDestination({
  "EmailAddress": ""
}, context)

Input

  • input object
    • EmailAddress required string

Output

TagResource

amazonaws_sesv2.TagResource({
  "ResourceArn": "",
  "Tags": []
}, context)

Input

  • input object
    • ResourceArn required string: The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
    • Tags required array: A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Output

ListTagsForResource

amazonaws_sesv2.ListTagsForResource({
  "ResourceArn": ""
}, context)

Input

  • input object
    • ResourceArn required string

Output

UntagResource

amazonaws_sesv2.UntagResource({
  "ResourceArn": "",
  "TagKeys": []
}, context)

Input

  • input object
    • ResourceArn required string
    • TagKeys required array

Output

ListEmailTemplates

amazonaws_sesv2.ListEmailTemplates({}, context)

Input

  • input object
    • NextToken string
    • PageSize integer

Output

CreateEmailTemplate

amazonaws_sesv2.CreateEmailTemplate({
  "TemplateName": "",
  "TemplateContent": {}
}, context)

Input

  • input object
    • TemplateContent required object: The content of the email, composed of a subject line, an HTML part, and a text-only part.
      • Html
      • Subject
      • Text
    • TemplateName required string: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

Output

DeleteEmailTemplate

amazonaws_sesv2.DeleteEmailTemplate({
  "TemplateName": ""
}, context)

Input

  • input object
    • TemplateName required string

Output

GetEmailTemplate

amazonaws_sesv2.GetEmailTemplate({
  "TemplateName": ""
}, context)

Input

  • input object
    • TemplateName required string

Output

UpdateEmailTemplate

amazonaws_sesv2.UpdateEmailTemplate({
  "TemplateName": "",
  "TemplateContent": {}
}, context)

Input

  • input object
    • TemplateName required string
    • TemplateContent required object: The content of the email, composed of a subject line, an HTML part, and a text-only part.
      • Html
      • Subject
      • Text

Output

TestRenderEmailTemplate

amazonaws_sesv2.TestRenderEmailTemplate({
  "TemplateName": "",
  "TemplateData": ""
}, context)

Input

  • input object
    • TemplateName required string
    • TemplateData required string: An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

Output

Definitions

AccountDetails

  • AccountDetails object: An object that contains information about your account details.
    • AdditionalContactEmailAddresses
    • ContactLanguage
    • MailType
    • ReviewDetails
      • CaseId
      • Status
    • UseCaseDescription
    • WebsiteURL

AccountSuspendedException

AdditionalContactEmailAddress

  • AdditionalContactEmailAddress string

AdditionalContactEmailAddresses

AlreadyExistsException

AmazonResourceName

  • AmazonResourceName string

AttributesData

  • AttributesData string

BadRequestException

BehaviorOnMxFailure

  • BehaviorOnMxFailure string (values: USE_DEFAULT_VALUE, REJECT_MESSAGE):

    The action that you want to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

    These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

BlacklistEntries

BlacklistEntry

  • BlacklistEntry object: An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
    • Description
    • ListingTime
    • RblName

BlacklistItemName

  • BlacklistItemName string: An IP address that you want to obtain blacklist information for.

BlacklistItemNames

BlacklistReport

  • BlacklistReport object

BlacklistingDescription

  • BlacklistingDescription string: A description of the blacklisting event.

Body

  • Body object: Represents the body of the email message.
    • Html
      • Charset
      • Data required
    • Text
      • Charset
      • Data required

BulkEmailContent

  • BulkEmailContent object: An object that contains the body of the message. You can specify a template message.
    • Template
      • TemplateArn
      • TemplateData
      • TemplateName

BulkEmailEntry

  • BulkEmailEntry object

BulkEmailEntryList

  • BulkEmailEntryList array: A list of BulkEmailEntry objects.

BulkEmailEntryResult

  • BulkEmailEntryResult object: The result of the SendBulkEmail operation of each specified BulkEmailEntry.
    • Error
    • MessageId
    • Status

BulkEmailEntryResultList

BulkEmailStatus

  • BulkEmailStatus string (values: SUCCESS, MESSAGE_REJECTED, MAIL_FROM_DOMAIN_NOT_VERIFIED, CONFIGURATION_SET_NOT_FOUND, TEMPLATE_NOT_FOUND, ACCOUNT_SUSPENDED, ACCOUNT_THROTTLED, ACCOUNT_DAILY_QUOTA_EXCEEDED, INVALID_SENDING_POOL_NAME, ACCOUNT_SENDING_PAUSED, CONFIGURATION_SET_SENDING_PAUSED, INVALID_PARAMETER, TRANSIENT_FAILURE, FAILED)

CampaignId

  • CampaignId string

CaseId

  • CaseId string

Charset

  • Charset string

CloudWatchDestination

  • CloudWatchDestination object: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

CloudWatchDimensionConfiguration

  • CloudWatchDimensionConfiguration object: An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
    • DefaultDimensionValue required
    • DimensionName required
    • DimensionValueSource required

CloudWatchDimensionConfigurations

ConcurrentModificationException

ConfigurationSetName

  • ConfigurationSetName string:

    The name of a configuration set.

    Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

ConfigurationSetNameList

ConflictException

Contact

  • Contact object: A contact is the end-user who is receiving the email.

ContactLanguage

  • ContactLanguage string (values: EN, JA)

ContactList

  • ContactList object: A list that contains contacts that have subscribed to a particular topic or topics.
    • ContactListName
    • LastUpdatedTimestamp

ContactListDestination

  • ContactListDestination object: An object that contains details about the action of a contact list.
    • ContactListImportAction required
    • ContactListName required

ContactListImportAction

  • ContactListImportAction string (values: DELETE, PUT)

ContactListName

  • ContactListName string

Content

  • Content object: An object that represents the content of the email, and optionally a character set specification.
    • Charset
    • Data required

CreateConfigurationSetEventDestinationRequest

  • CreateConfigurationSetEventDestinationRequest object: A request to add an event destination to a configuration set.
    • EventDestination required
      • CloudWatchDestination
      • Enabled
      • KinesisFirehoseDestination
        • DeliveryStreamArn required
        • IamRoleArn required
      • MatchingEventTypes
      • PinpointDestination
        • ApplicationArn
      • SnsDestination
        • TopicArn required
    • EventDestinationName required

CreateConfigurationSetEventDestinationResponse

  • CreateConfigurationSetEventDestinationResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

CreateConfigurationSetRequest

  • CreateConfigurationSetRequest object: A request to create a configuration set.
    • ConfigurationSetName required
    • DeliveryOptions
      • SendingPoolName
      • TlsPolicy
    • ReputationOptions
      • LastFreshStart
      • ReputationMetricsEnabled
    • SendingOptions
      • SendingEnabled
    • SuppressionOptions SuppressionOptions
    • Tags
    • TrackingOptions
      • CustomRedirectDomain required

CreateConfigurationSetResponse

  • CreateConfigurationSetResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

CreateContactListRequest

  • CreateContactListRequest object
    • ContactListName required
    • Description
    • Tags
    • Topics

CreateContactListResponse

  • CreateContactListResponse object

CreateContactRequest

  • CreateContactRequest object
    • AttributesData
    • EmailAddress required
    • TopicPreferences
    • UnsubscribeAll

CreateContactResponse

  • CreateContactResponse object

CreateCustomVerificationEmailTemplateRequest

  • CreateCustomVerificationEmailTemplateRequest object: Represents a request to create a custom verification email template.
    • FailureRedirectionURL required
    • FromEmailAddress required
    • SuccessRedirectionURL required
    • TemplateContent required
    • TemplateName required
    • TemplateSubject required

CreateCustomVerificationEmailTemplateResponse

  • CreateCustomVerificationEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

CreateDedicatedIpPoolRequest

  • CreateDedicatedIpPoolRequest object: A request to create a new dedicated IP pool.
    • PoolName required
    • Tags

CreateDedicatedIpPoolResponse

  • CreateDedicatedIpPoolResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

CreateDeliverabilityTestReportRequest

  • CreateDeliverabilityTestReportRequest object: A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, you can use the GetDeliverabilityTestReport operation to view the results of the test.
    • Content required
      • Raw
        • Data required
      • Simple
        • Body required
          • Html
            • Charset
            • Data required
          • Text
            • Charset
            • Data required
        • Subject required
          • Charset
          • Data required
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • FromEmailAddress required
    • ReportName
    • Tags

CreateDeliverabilityTestReportResponse

  • CreateDeliverabilityTestReportResponse object: Information about the predictive inbox placement test that you created.
    • DeliverabilityTestStatus required
    • ReportId required

CreateEmailIdentityPolicyRequest

  • CreateEmailIdentityPolicyRequest object: Represents a request to create 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.
    • Policy required

CreateEmailIdentityPolicyResponse

  • CreateEmailIdentityPolicyResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

CreateEmailIdentityRequest

  • CreateEmailIdentityRequest object: A request to begin the verification process for an email identity (an email address or domain).
    • DkimSigningAttributes
      • DomainSigningPrivateKey required
      • DomainSigningSelector required
    • EmailIdentity required
    • Tags

CreateEmailIdentityResponse

  • CreateEmailIdentityResponse object:

    If the email identity is a domain, this object contains information about the DKIM verification status for the domain.

    If the email identity is an email address, this object is empty.

    • DkimAttributes
      • SigningAttributesOrigin
      • SigningEnabled
      • Status
      • Tokens
    • IdentityType
    • VerifiedForSendingStatus

CreateEmailTemplateRequest

  • CreateEmailTemplateRequest object: Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
    • TemplateContent required
      • Html
      • Subject
      • Text
    • TemplateName required

CreateEmailTemplateResponse

  • CreateEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

CreateImportJobRequest

  • CreateImportJobRequest object: Represents a request to create an import job from a data source for a data destination.
    • ImportDataSource required
      • DataFormat required
      • S3Url required
    • ImportDestination required
      • ContactListDestination
        • ContactListImportAction required
        • ContactListName required
      • SuppressionListDestination
        • SuppressionListImportAction required

CreateImportJobResponse

  • CreateImportJobResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.
    • JobId

CustomRedirectDomain

  • CustomRedirectDomain string: The domain that you want to use for tracking open and click events.

CustomVerificationEmailTemplateMetadata

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

CustomVerificationEmailTemplatesList

DailyVolume

  • DailyVolume object: An object that contains information about the volume of email sent on each day of the analysis period.
    • DomainIspPlacements
    • StartDate
    • VolumeStatistics
      • InboxRawCount
      • ProjectedInbox
      • ProjectedSpam
      • SpamRawCount

DailyVolumes

DataFormat

  • DataFormat string (values: CSV, JSON): The data format of the import job's data source.

DedicatedIp

  • DedicatedIp object:

    Contains information about a dedicated IP address that is associated with your Amazon SES account.

    To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.

    • Ip required
    • PoolName
    • WarmupPercentage required
    • WarmupStatus required

DedicatedIpList

  • DedicatedIpList array: A list of dedicated IP addresses that are associated with your AWS account.

DefaultDimensionValue

  • DefaultDimensionValue string:

    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

    • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

    • It can contain no more than 256 characters.

DeleteConfigurationSetEventDestinationRequest

  • DeleteConfigurationSetEventDestinationRequest object: A request to delete an event destination from a configuration set.

DeleteConfigurationSetEventDestinationResponse

  • DeleteConfigurationSetEventDestinationResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeleteConfigurationSetRequest

  • DeleteConfigurationSetRequest object: A request to delete a configuration set.

DeleteConfigurationSetResponse

  • DeleteConfigurationSetResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeleteContactListRequest

  • DeleteContactListRequest object

DeleteContactListResponse

  • DeleteContactListResponse object

DeleteContactRequest

  • DeleteContactRequest object

DeleteContactResponse

  • DeleteContactResponse object

DeleteCustomVerificationEmailTemplateRequest

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

DeleteCustomVerificationEmailTemplateResponse

  • DeleteCustomVerificationEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

DeleteDedicatedIpPoolRequest

  • DeleteDedicatedIpPoolRequest object: A request to delete a dedicated IP pool.

DeleteDedicatedIpPoolResponse

  • DeleteDedicatedIpPoolResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeleteEmailIdentityPolicyRequest

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

DeleteEmailIdentityPolicyResponse

  • DeleteEmailIdentityPolicyResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeleteEmailIdentityRequest

  • DeleteEmailIdentityRequest object: A request to delete an existing email identity. When you delete an identity, you lose the ability to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.

DeleteEmailIdentityResponse

  • DeleteEmailIdentityResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeleteEmailTemplateRequest

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

DeleteEmailTemplateResponse

  • DeleteEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

DeleteSuppressedDestinationRequest

  • DeleteSuppressedDestinationRequest object: A request to remove an email address from the suppression list for your account.

DeleteSuppressedDestinationResponse

  • DeleteSuppressedDestinationResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

DeliverabilityDashboardAccountStatus

  • DeliverabilityDashboardAccountStatus string (values: ACTIVE, PENDING_EXPIRATION, DISABLED): The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

DeliverabilityTestReport

  • DeliverabilityTestReport object: An object that contains metadata related to a predictive inbox placement test.
    • CreateDate
    • DeliverabilityTestStatus
    • FromEmailAddress
    • ReportId
    • ReportName
    • Subject

DeliverabilityTestReports

DeliverabilityTestStatus

  • DeliverabilityTestStatus string (values: IN_PROGRESS, COMPLETED): The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

DeliverabilityTestSubject

  • DeliverabilityTestSubject string: The subject line for an email that you submitted in a predictive inbox placement test.

DeliveryOptions

  • DeliveryOptions object: Used to associate a configuration set with a dedicated IP pool.
    • SendingPoolName
    • TlsPolicy

Description

  • Description string

Destination

DimensionName

  • DimensionName string:

    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

    • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • It can contain no more than 256 characters.

DimensionValueSource

  • DimensionValueSource string (values: MESSAGE_TAG, EMAIL_HEADER, LINK_TAG): The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. If you want to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. If you want to use your own email headers, choose emailHeader. If you want to use link tags, choose linkTags.

DisplayName

  • DisplayName string

DkimAttributes

  • DkimAttributes object:

    An object that contains information about the DKIM authentication status for an email identity.

    Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

    • SigningAttributesOrigin
    • SigningEnabled
    • Status
    • Tokens

DkimSigningAttributes

  • DkimSigningAttributes object: An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).
    • DomainSigningPrivateKey required
    • DomainSigningSelector required

DkimSigningAttributesOrigin

  • DkimSigningAttributesOrigin string (values: AWS_SES, EXTERNAL)

DkimStatus

  • DkimStatus string (values: PENDING, SUCCESS, FAILED, TEMPORARY_FAILURE, NOT_STARTED):

    The DKIM authentication status of the identity. The status can be one of the following:

    • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

    • SUCCESS – The verification process completed successfully.

    • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

    • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

    • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

DnsToken

  • DnsToken string

DnsTokenList

Domain

  • Domain string

DomainDeliverabilityCampaign

  • DomainDeliverabilityCampaign object: An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).
    • CampaignId
    • DeleteRate
    • Esps
    • FirstSeenDateTime
    • FromAddress
    • ImageUrl
    • InboxCount
    • LastSeenDateTime
    • ProjectedVolume
    • ReadDeleteRate
    • ReadRate
    • SendingIps
      • items Ip
    • SpamCount
    • Subject

DomainDeliverabilityCampaignList

DomainDeliverabilityTrackingOption

  • DomainDeliverabilityTrackingOption object: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
    • Domain
    • InboxPlacementTrackingOption
    • SubscriptionStartDate

DomainDeliverabilityTrackingOptions

  • DomainDeliverabilityTrackingOptions array: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

DomainIspPlacement

  • DomainIspPlacement object: An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
    • InboxPercentage
    • InboxRawCount
    • IspName
    • SpamPercentage
    • SpamRawCount

DomainIspPlacements

EmailAddress

  • EmailAddress string

EmailAddressList

EmailContent

  • EmailContent object: An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
    • Raw
      • Data required
    • Simple
      • Body required
        • Html
          • Charset
          • Data required
        • Text
          • Charset
          • Data required
      • Subject required
        • Charset
        • Data required
    • Template
      • TemplateArn
      • TemplateData
      • TemplateName

EmailTemplateContent

  • EmailTemplateContent object: The content of the email, composed of a subject line, an HTML part, and a text-only part.
    • Html
    • Subject
    • Text

EmailTemplateData

  • EmailTemplateData string: An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

EmailTemplateHtml

  • EmailTemplateHtml string: The HTML body of the email.

EmailTemplateMetadata

  • EmailTemplateMetadata object: Contains information about an email template.
    • CreatedTimestamp
    • TemplateName

EmailTemplateMetadataList

  • EmailTemplateMetadataList array: A list of the EmailTemplateMetadata object.

EmailTemplateName

  • EmailTemplateName string: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

EmailTemplateSubject

  • EmailTemplateSubject string: The subject line of the email.

EmailTemplateText

  • EmailTemplateText string: The email body that will be visible to recipients whose email clients do not display HTML.

Enabled

  • Enabled boolean

EnabledWrapper

  • EnabledWrapper boolean

ErrorMessage

  • ErrorMessage string

Esp

  • Esp string

Esps

  • Esps array

EventDestination

  • EventDestination object: In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
    • CloudWatchDestination
    • Enabled
    • KinesisFirehoseDestination
      • DeliveryStreamArn required
      • IamRoleArn required
    • MatchingEventTypes required
    • Name required
    • PinpointDestination
      • ApplicationArn
    • SnsDestination
      • TopicArn required

EventDestinationDefinition

  • EventDestinationDefinition object: An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
    • CloudWatchDestination
    • Enabled
    • KinesisFirehoseDestination
      • DeliveryStreamArn required
      • IamRoleArn required
    • MatchingEventTypes
    • PinpointDestination
      • ApplicationArn
    • SnsDestination
      • TopicArn required

EventDestinationName

  • EventDestinationName string:

    The name of an event destination.

    Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

EventDestinations

EventType

  • EventType string (values: SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION): An email sending event type. For example, email sends, opens, and bounces are all email events.

EventTypes

FailedRecordsCount

  • FailedRecordsCount integer

FailedRecordsS3Url

  • FailedRecordsS3Url string

FailureInfo

  • FailureInfo object: An object that contains the failure details about an import job.
    • ErrorMessage
    • FailedRecordsS3Url

FailureRedirectionURL

  • FailureRedirectionURL string: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

FeedbackId

  • FeedbackId string

GeneralEnforcementStatus

  • GeneralEnforcementStatus string

GetAccountRequest

  • GetAccountRequest object: A request to obtain information about the email-sending capabilities of your Amazon SES account.

GetAccountResponse

  • GetAccountResponse object: A list of details about the email-sending capabilities of your Amazon SES account in the current AWS Region.
    • DedicatedIpAutoWarmupEnabled
    • Details
      • AdditionalContactEmailAddresses
      • ContactLanguage
      • MailType
      • ReviewDetails
        • CaseId
        • Status
      • UseCaseDescription
      • WebsiteURL
    • EnforcementStatus
    • ProductionAccessEnabled
    • SendQuota
      • Max24HourSend
      • MaxSendRate
      • SentLast24Hours
    • SendingEnabled
    • SuppressionAttributes

GetBlacklistReportsRequest

  • GetBlacklistReportsRequest object: A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.

GetBlacklistReportsResponse

  • GetBlacklistReportsResponse object: An object that contains information about blacklist events.
    • BlacklistReport required

GetConfigurationSetEventDestinationsRequest

  • GetConfigurationSetEventDestinationsRequest object: A request to obtain information about the event destinations for a configuration set.

GetConfigurationSetEventDestinationsResponse

  • GetConfigurationSetEventDestinationsResponse object: Information about an event destination for a configuration set.

GetConfigurationSetRequest

  • GetConfigurationSetRequest object: A request to obtain information about a configuration set.

GetConfigurationSetResponse

  • GetConfigurationSetResponse object: Information about a configuration set.
    • ConfigurationSetName
    • DeliveryOptions
      • SendingPoolName
      • TlsPolicy
    • ReputationOptions
      • LastFreshStart
      • ReputationMetricsEnabled
    • SendingOptions
      • SendingEnabled
    • SuppressionOptions
    • Tags
    • TrackingOptions
      • CustomRedirectDomain required

GetContactListRequest

  • GetContactListRequest object

GetContactListResponse

  • GetContactListResponse object
    • ContactListName
    • CreatedTimestamp
    • Description
    • LastUpdatedTimestamp
    • Tags
    • Topics

GetContactRequest

  • GetContactRequest object

GetContactResponse

  • GetContactResponse object
    • AttributesData
    • ContactListName
    • CreatedTimestamp
    • EmailAddress
    • LastUpdatedTimestamp
    • TopicDefaultPreferences
    • TopicPreferences
    • UnsubscribeAll

GetCustomVerificationEmailTemplateRequest

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

GetCustomVerificationEmailTemplateResponse

  • GetCustomVerificationEmailTemplateResponse object: The following elements are returned by the service.
    • FailureRedirectionURL
    • FromEmailAddress
    • SuccessRedirectionURL
    • TemplateContent
    • TemplateName
    • TemplateSubject

GetDedicatedIpRequest

  • GetDedicatedIpRequest object: A request to obtain more information about a dedicated IP address.

GetDedicatedIpResponse

  • GetDedicatedIpResponse object: Information about a dedicated IP address.
    • DedicatedIp
      • Ip required
      • PoolName
      • WarmupPercentage required
      • WarmupStatus required

GetDedicatedIpsRequest

  • GetDedicatedIpsRequest object: A request to obtain more information about dedicated IP pools.

GetDedicatedIpsResponse

  • GetDedicatedIpsResponse object: Information about the dedicated IP addresses that are associated with your AWS account.

GetDeliverabilityDashboardOptionsRequest

  • GetDeliverabilityDashboardOptionsRequest object:

    Retrieve information about the status of the Deliverability dashboard for your AWS account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.

    When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

GetDeliverabilityDashboardOptionsResponse

GetDeliverabilityTestReportRequest

  • GetDeliverabilityTestReportRequest object: A request to retrieve the results of a predictive inbox placement test.

GetDeliverabilityTestReportResponse

  • GetDeliverabilityTestReportResponse object: The results of the predictive inbox placement test.
    • DeliverabilityTestReport required
      • CreateDate
      • DeliverabilityTestStatus
      • FromEmailAddress
      • ReportId
      • ReportName
      • Subject
    • IspPlacements required
    • Message
    • OverallPlacement required
      • DkimPercentage
      • InboxPercentage
      • MissingPercentage
      • SpamPercentage
      • SpfPercentage
    • Tags

GetDomainDeliverabilityCampaignRequest

  • GetDomainDeliverabilityCampaignRequest object: Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

GetDomainDeliverabilityCampaignResponse

  • GetDomainDeliverabilityCampaignResponse object: An object that contains all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
    • DomainDeliverabilityCampaign required
      • CampaignId
      • DeleteRate
      • Esps
      • FirstSeenDateTime
      • FromAddress
      • ImageUrl
      • InboxCount
      • LastSeenDateTime
      • ProjectedVolume
      • ReadDeleteRate
      • ReadRate
      • SendingIps
        • items Ip
      • SpamCount
      • Subject

GetDomainStatisticsReportRequest

  • GetDomainStatisticsReportRequest object: A request to obtain deliverability metrics for a domain.

GetDomainStatisticsReportResponse

  • GetDomainStatisticsReportResponse object: An object that includes statistics that are related to the domain that you specified.
    • DailyVolumes required
    • OverallVolume required
      • DomainIspPlacements
      • ReadRatePercent
      • VolumeStatistics
        • InboxRawCount
        • ProjectedInbox
        • ProjectedSpam
        • SpamRawCount

GetEmailIdentityPoliciesRequest

  • GetEmailIdentityPoliciesRequest object: A request to return the policies of an email identity.

GetEmailIdentityPoliciesResponse

  • GetEmailIdentityPoliciesResponse object: Identity policies associated with email identity.
    • Policies

GetEmailIdentityRequest

  • GetEmailIdentityRequest object: A request to return details about an email identity.

GetEmailIdentityResponse

  • GetEmailIdentityResponse object: Details about an email identity.
    • DkimAttributes
      • SigningAttributesOrigin
      • SigningEnabled
      • Status
      • Tokens
    • FeedbackForwardingStatus
    • IdentityType
    • MailFromAttributes
      • BehaviorOnMxFailure required
      • MailFromDomain required
      • MailFromDomainStatus required
    • Policies
    • Tags
    • VerifiedForSendingStatus

GetEmailTemplateRequest

  • GetEmailTemplateRequest object: Represents a request to display the template object (which includes the subject line, HTML part and text part) for the template you specify.

GetEmailTemplateResponse

  • GetEmailTemplateResponse object: The following element is returned by the service.
    • TemplateContent required
      • Html
      • Subject
      • Text
    • TemplateName required

GetImportJobRequest

  • GetImportJobRequest object: Represents a request for information about an import job using the import job ID.

GetImportJobResponse

  • GetImportJobResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.
    • CompletedTimestamp
    • CreatedTimestamp
    • FailedRecordsCount
    • FailureInfo
      • ErrorMessage
      • FailedRecordsS3Url
    • ImportDataSource
      • DataFormat required
      • S3Url required
    • ImportDestination
      • ContactListDestination
        • ContactListImportAction required
        • ContactListName required
      • SuppressionListDestination
        • SuppressionListImportAction required
    • JobId
    • JobStatus
    • ProcessedRecordsCount

GetSuppressedDestinationRequest

  • GetSuppressedDestinationRequest object: A request to retrieve information about an email address that's on the suppression list for your account.

GetSuppressedDestinationResponse

  • GetSuppressedDestinationResponse object: Information about the suppressed email address.
    • SuppressedDestination required
      • Attributes
        • FeedbackId
        • MessageId
      • EmailAddress required
      • LastUpdateTime required
      • Reason required

Identity

  • Identity string

IdentityInfo

  • IdentityInfo object: Information about an email identity.
    • IdentityName
    • IdentityType
    • SendingEnabled

IdentityInfoList

IdentityType

  • IdentityType string (values: EMAIL_ADDRESS, DOMAIN, MANAGED_DOMAIN):

    The email identity type. The identity type can be one of the following:

    • EMAIL_ADDRESS – The identity is an email address.

    • DOMAIN – The identity is a domain.

ImageUrl

  • ImageUrl string

ImportDataSource

  • ImportDataSource object: An object that contains details about the data source of the import job.
    • DataFormat required
    • S3Url required

ImportDestination

  • ImportDestination object: An object that contains details about the resource destination the import job is going to target.
    • ContactListDestination
      • ContactListImportAction required
      • ContactListName required
    • SuppressionListDestination
      • SuppressionListImportAction required

ImportDestinationType

  • ImportDestinationType string (values: SUPPRESSION_LIST, CONTACT_LIST): The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

ImportJobSummary

ImportJobSummaryList

  • ImportJobSummaryList array: A list of the import job summaries.

InboxPlacementTrackingOption

  • InboxPlacementTrackingOption object: An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain.

InvalidNextTokenException

Ip

  • Ip string: An IPv4 address.

IpList

  • IpList array
    • items Ip

IspName

  • IspName string: The name of an email provider.

IspNameList

IspPlacement

  • IspPlacement object: An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
    • IspName
    • PlacementStatistics
      • DkimPercentage
      • InboxPercentage
      • MissingPercentage
      • SpamPercentage
      • SpfPercentage

IspPlacements

JobId

  • JobId string: A string that represents the import job ID.

JobStatus

  • JobStatus string (values: CREATED, PROCESSING, COMPLETED, FAILED): The status of the import job.

KinesisFirehoseDestination

  • KinesisFirehoseDestination object: An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
    • DeliveryStreamArn required
    • IamRoleArn required

LastFreshStart

  • LastFreshStart string: The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

LimitExceededException

ListConfigurationSetsRequest

  • ListConfigurationSetsRequest object: A request to obtain a list of configuration sets for your Amazon SES account in the current AWS Region.

ListConfigurationSetsResponse

  • ListConfigurationSetsResponse object: A list of configuration sets in your Amazon SES account in the current AWS Region.

ListContactListsRequest

  • ListContactListsRequest object

ListContactListsResponse

  • ListContactListsResponse object

ListContactsFilter

  • ListContactsFilter object: A filter that can be applied to a list of contacts.
    • FilteredStatus
    • TopicFilter
      • TopicName
      • UseDefaultIfPreferenceUnavailable

ListContactsRequest

  • ListContactsRequest object
    • Filter
      • FilteredStatus
      • TopicFilter
        • TopicName
        • UseDefaultIfPreferenceUnavailable

ListContactsResponse

  • ListContactsResponse object

ListCustomVerificationEmailTemplatesRequest

  • ListCustomVerificationEmailTemplatesRequest object: Represents a request to list the existing custom verification email templates for your account.

ListCustomVerificationEmailTemplatesResponse

  • ListCustomVerificationEmailTemplatesResponse object: The following elements are returned by the service.

ListDedicatedIpPoolsRequest

  • ListDedicatedIpPoolsRequest object: A request to obtain a list of dedicated IP pools.

ListDedicatedIpPoolsResponse

  • ListDedicatedIpPoolsResponse object: A list of dedicated IP pools.
    • DedicatedIpPools
    • NextToken

ListDeliverabilityTestReportsRequest

  • ListDeliverabilityTestReportsRequest object: A request to list all of the predictive inbox placement tests that you've performed.

ListDeliverabilityTestReportsResponse

  • ListDeliverabilityTestReportsResponse object: A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

ListDomainDeliverabilityCampaignsRequest

  • ListDomainDeliverabilityCampaignsRequest object: Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard.

ListDomainDeliverabilityCampaignsResponse

  • ListDomainDeliverabilityCampaignsResponse object: An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.

ListEmailIdentitiesRequest

  • ListEmailIdentitiesRequest object: A request to list all of the email identities associated with your AWS account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

ListEmailIdentitiesResponse

  • ListEmailIdentitiesResponse object: A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.

ListEmailTemplatesRequest

  • ListEmailTemplatesRequest object: Represents a request to list the email templates present in your Amazon SES account in the current AWS Region. For more information, see the Amazon SES Developer Guide.

ListEmailTemplatesResponse

  • ListEmailTemplatesResponse object: The following elements are returned by the service.

ListImportJobsRequest

  • ListImportJobsRequest object: Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.
    • ImportDestinationType

ListImportJobsResponse

  • ListImportJobsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

ListManagementOptions

  • ListManagementOptions object: An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
    • ContactListName required
    • TopicName

ListOfContactLists

ListOfContacts

  • ListOfContacts array

ListOfDedicatedIpPools

  • ListOfDedicatedIpPools array: A list of dedicated IP pools that are associated with your AWS account.

ListSuppressedDestinationsRequest

  • ListSuppressedDestinationsRequest object: A request to obtain a list of email destinations that are on the suppression list for your account.

ListSuppressedDestinationsResponse

  • ListSuppressedDestinationsResponse object: A list of suppressed email addresses.

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags required

MailFromAttributes

  • MailFromAttributes object: A list of attributes that are associated with a MAIL FROM domain.
    • BehaviorOnMxFailure required
    • MailFromDomain required
    • MailFromDomainStatus required

MailFromDomainName

  • MailFromDomainName string: The domain that you want to use as a MAIL FROM domain.

MailFromDomainNotVerifiedException

MailFromDomainStatus

  • MailFromDomainStatus string (values: PENDING, SUCCESS, FAILED, TEMPORARY_FAILURE):

    The status of the MAIL FROM domain. This status can have the following values:

    • PENDING – Amazon SES hasn't started searching for the MX record yet.

    • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

    • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

    • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

MailType

  • MailType string (values: MARKETING, TRANSACTIONAL)

Max24HourSend

  • Max24HourSend number

MaxItems

  • MaxItems integer

MaxSendRate

  • MaxSendRate number

Message

  • Message object: Represents the email message that you're sending. The Message object consists of a subject line and a message body.
    • Body required
      • Html
        • Charset
        • Data required
      • Text
        • Charset
        • Data required
    • Subject required
      • Charset
      • Data required

MessageContent

  • MessageContent string: The body of an email message.

MessageData

  • MessageData string

MessageRejected

MessageTag

  • MessageTag object: Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
    • Name required
    • Value required

MessageTagList

  • MessageTagList array: A list of message tags.

MessageTagName

  • MessageTagName string:

    The name of the message tag. The message tag name has to meet the following criteria:

    • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

    • It can contain no more than 256 characters.

MessageTagValue

  • MessageTagValue string:

    The value of the message tag. The message tag value has to meet the following criteria:

    • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

    • It can contain no more than 256 characters.

NextToken

  • NextToken string

NotFoundException

OutboundMessageId

  • OutboundMessageId string

OverallVolume

  • OverallVolume object: An object that contains information about email that was sent from the selected domain.
    • DomainIspPlacements
    • ReadRatePercent
    • VolumeStatistics
      • InboxRawCount
      • ProjectedInbox
      • ProjectedSpam
      • SpamRawCount

Percentage

  • Percentage number: An object that contains information about inbox placement percentages.

Percentage100Wrapper

  • Percentage100Wrapper integer

PinpointDestination

  • PinpointDestination object: An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
    • ApplicationArn

PlacementStatistics

  • PlacementStatistics object: An object that contains inbox placement data for an email provider.
    • DkimPercentage
    • InboxPercentage
    • MissingPercentage
    • SpamPercentage
    • SpfPercentage

Policy

  • Policy string:

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

PolicyMap

  • PolicyMap object: An object that contains mapping between PolicyName and Policy text.

PolicyName

  • PolicyName string:

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

PoolName

  • PoolName string: The name of a dedicated IP pool.

PrivateKey

  • PrivateKey string

ProcessedRecordsCount

  • ProcessedRecordsCount integer

PutAccountDedicatedIpWarmupAttributesRequest

  • PutAccountDedicatedIpWarmupAttributesRequest object: A request to enable or disable the automatic IP address warm-up feature.
    • AutoWarmupEnabled

PutAccountDedicatedIpWarmupAttributesResponse

  • PutAccountDedicatedIpWarmupAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutAccountDetailsRequest

  • PutAccountDetailsRequest object: A request to submit new account details.
    • AdditionalContactEmailAddresses
    • ContactLanguage
    • MailType required
    • ProductionAccessEnabled
    • UseCaseDescription required
    • WebsiteURL required

PutAccountDetailsResponse

  • PutAccountDetailsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutAccountSendingAttributesRequest

  • PutAccountSendingAttributesRequest object: A request to change the ability of your account to send email.
    • SendingEnabled

PutAccountSendingAttributesResponse

  • PutAccountSendingAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutAccountSuppressionAttributesRequest

  • PutAccountSuppressionAttributesRequest object: A request to change your account's suppression preferences.

PutAccountSuppressionAttributesResponse

  • PutAccountSuppressionAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutConfigurationSetDeliveryOptionsRequest

  • PutConfigurationSetDeliveryOptionsRequest object: A request to associate a configuration set with a dedicated IP pool.
    • SendingPoolName
    • TlsPolicy

PutConfigurationSetDeliveryOptionsResponse

  • PutConfigurationSetDeliveryOptionsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutConfigurationSetReputationOptionsRequest

  • PutConfigurationSetReputationOptionsRequest object: A request to enable or disable tracking of reputation metrics for a configuration set.
    • ReputationMetricsEnabled

PutConfigurationSetReputationOptionsResponse

  • PutConfigurationSetReputationOptionsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutConfigurationSetSendingOptionsRequest

  • PutConfigurationSetSendingOptionsRequest object: A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration set.
    • SendingEnabled

PutConfigurationSetSendingOptionsResponse

  • PutConfigurationSetSendingOptionsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutConfigurationSetSuppressionOptionsRequest

  • PutConfigurationSetSuppressionOptionsRequest object: A request to change the account suppression list preferences for a specific configuration set.

PutConfigurationSetSuppressionOptionsResponse

  • PutConfigurationSetSuppressionOptionsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutConfigurationSetTrackingOptionsRequest

  • PutConfigurationSetTrackingOptionsRequest object: A request to add a custom domain for tracking open and click events to a configuration set.
    • CustomRedirectDomain

PutConfigurationSetTrackingOptionsResponse

  • PutConfigurationSetTrackingOptionsResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutDedicatedIpInPoolRequest

  • PutDedicatedIpInPoolRequest object: A request to move a dedicated IP address to a dedicated IP pool.
    • DestinationPoolName required

PutDedicatedIpInPoolResponse

  • PutDedicatedIpInPoolResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutDedicatedIpWarmupAttributesRequest

  • PutDedicatedIpWarmupAttributesRequest object: A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.
    • WarmupPercentage required

PutDedicatedIpWarmupAttributesResponse

  • PutDedicatedIpWarmupAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutDeliverabilityDashboardOptionRequest

  • PutDeliverabilityDashboardOptionRequest object:

    Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.

    When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

PutDeliverabilityDashboardOptionResponse

  • PutDeliverabilityDashboardOptionResponse object: A response that indicates whether the Deliverability dashboard is enabled.

PutEmailIdentityDkimAttributesRequest

  • PutEmailIdentityDkimAttributesRequest object: A request to enable or disable DKIM signing of email that you send from an email identity.
    • SigningEnabled

PutEmailIdentityDkimAttributesResponse

  • PutEmailIdentityDkimAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutEmailIdentityDkimSigningAttributesRequest

  • PutEmailIdentityDkimSigningAttributesRequest object: A request to change the DKIM attributes for an email identity.
    • SigningAttributes
      • DomainSigningPrivateKey required
      • DomainSigningSelector required
    • SigningAttributesOrigin required

PutEmailIdentityDkimSigningAttributesResponse

  • PutEmailIdentityDkimSigningAttributesResponse object:

    If the action is successful, the service sends back an HTTP 200 response.

    The following data is returned in JSON format by the service.

PutEmailIdentityFeedbackAttributesRequest

  • PutEmailIdentityFeedbackAttributesRequest object: A request to set the attributes that control how bounce and complaint events are processed.
    • EmailForwardingEnabled

PutEmailIdentityFeedbackAttributesResponse

  • PutEmailIdentityFeedbackAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutEmailIdentityMailFromAttributesRequest

  • PutEmailIdentityMailFromAttributesRequest object: A request to configure the custom MAIL FROM domain for a verified identity.
    • BehaviorOnMxFailure
    • MailFromDomain

PutEmailIdentityMailFromAttributesResponse

  • PutEmailIdentityMailFromAttributesResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

PutSuppressedDestinationRequest

  • PutSuppressedDestinationRequest object: A request to add an email destination to the suppression list for your account.
    • EmailAddress required
    • Reason required

PutSuppressedDestinationResponse

  • PutSuppressedDestinationResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

RawMessage

  • RawMessage object: Represents the raw content of an email message.
    • Data required

RawMessageData

  • RawMessageData string:

    The raw email message. The message has to meet the following criteria:

    • The message has to contain a header and a body, separated by one blank line.

    • All of the required header fields must be present in the message.

    • Each part of a multipart MIME message must be formatted properly.

    • Attachments must be in a file format that the Amazon SES API v2 supports.

    • The entire message must be Base64 encoded.

    • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

    • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

RblName

  • RblName string: The name of a blacklist that an IP address was found on.

RenderedEmailTemplate

  • RenderedEmailTemplate string: The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

ReplacementEmailContent

  • ReplacementEmailContent object: The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The ReplacementTemplate can be specified within this object.
    • ReplacementTemplate
      • ReplacementTemplateData

ReplacementTemplate

  • ReplacementTemplate object: An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry.
    • ReplacementTemplateData

ReportId

  • ReportId string: A unique string that identifies a Deliverability dashboard report.

ReportName

  • ReportName string: A name that helps you identify a report generated by the Deliverability dashboard.

ReputationOptions

  • ReputationOptions object: Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
    • LastFreshStart
    • ReputationMetricsEnabled

ReviewDetails

  • ReviewDetails object: An object that contains information about your account details review.
    • CaseId
    • Status

ReviewStatus

  • ReviewStatus string (values: PENDING, FAILED, GRANTED, DENIED)

S3Url

  • S3Url string: An Amazon S3 URL in the format s3://<bucket_name>/<object>.

Selector

  • Selector string

SendBulkEmailRequest

  • SendBulkEmailRequest object: Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
    • BulkEmailEntries required
    • ConfigurationSetName
    • DefaultContent required
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • DefaultEmailTags
    • FeedbackForwardingEmailAddress
    • FeedbackForwardingEmailAddressIdentityArn
    • FromEmailAddress
    • FromEmailAddressIdentityArn
    • ReplyToAddresses

SendBulkEmailResponse

  • SendBulkEmailResponse object: The following data is returned in JSON format by the service.

SendCustomVerificationEmailRequest

  • SendCustomVerificationEmailRequest object: Represents a request to send a custom verification email to a specified recipient.
    • ConfigurationSetName
    • EmailAddress required
    • TemplateName required

SendCustomVerificationEmailResponse

  • SendCustomVerificationEmailResponse object: The following element is returned by the service.
    • MessageId

SendEmailRequest

  • SendEmailRequest object: Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
    • ConfigurationSetName
    • Content required
      • Raw
        • Data required
      • Simple
        • Body required
          • Html
            • Charset
            • Data required
          • Text
            • Charset
            • Data required
        • Subject required
          • Charset
          • Data required
      • Template
        • TemplateArn
        • TemplateData
        • TemplateName
    • Destination
    • EmailTags
    • FeedbackForwardingEmailAddress
    • FeedbackForwardingEmailAddressIdentityArn
    • FromEmailAddress
    • FromEmailAddressIdentityArn
    • ListManagementOptions
      • ContactListName required
      • TopicName
    • ReplyToAddresses

SendEmailResponse

  • SendEmailResponse object: A unique message ID that you receive when an email is accepted for sending.
    • MessageId

SendQuota

  • SendQuota object: An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current AWS Region.
    • Max24HourSend
    • MaxSendRate
    • SentLast24Hours

SendingOptions

  • SendingOptions object: Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
    • SendingEnabled

SendingPausedException

SendingPoolName

  • SendingPoolName string: The name of the dedicated IP pool that you want to associate with the configuration set.

SentLast24Hours

  • SentLast24Hours number

SnsDestination

  • SnsDestination object: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
    • TopicArn required

Subject

  • Subject string

SubscriptionStatus

  • SubscriptionStatus string (values: OPT_IN, OPT_OUT)

SuccessRedirectionURL

  • SuccessRedirectionURL string: The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

SuppressedDestination

  • SuppressedDestination object: An object that contains information about an email address that is on the suppression list for your account.
    • Attributes
      • FeedbackId
      • MessageId
    • EmailAddress required
    • LastUpdateTime required
    • Reason required

SuppressedDestinationAttributes

  • SuppressedDestinationAttributes object: An object that contains additional attributes that are related an email address that is on the suppression list for your account.
    • FeedbackId
    • MessageId

SuppressedDestinationSummaries

SuppressedDestinationSummary

  • SuppressedDestinationSummary object: A summary that describes the suppressed email address.
    • EmailAddress required
    • LastUpdateTime required
    • Reason required

SuppressionAttributes

  • SuppressionAttributes object: An object that contains information about the email address suppression preferences for your account in the current AWS Region.

SuppressionListDestination

  • SuppressionListDestination object: An object that contains details about the action of suppression list.
    • SuppressionListImportAction required

SuppressionListImportAction

  • SuppressionListImportAction string (values: DELETE, PUT):

    The type of action that you want to perform on the address. Acceptable values:

    • PUT: add the addresses to the suppression list.

    • DELETE: remove the address from the suppression list.

SuppressionListReason

  • SuppressionListReason string (values: BOUNCE, COMPLAINT):

    The reason that the address was added to the suppression list for your account. The value can be one of the following:

    • COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.

    • BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.

SuppressionListReasons

SuppressionOptions

  • SuppressionOptions object: An object that contains information about the suppression list preferences for your account.

Tag

  • Tag object:

    An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

    Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

    • Tag keys and values are case sensitive.

    • For each associated resource, each tag key must be unique and it can have only one value.

    • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

    • You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.

    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Template

  • Template object: An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.
    • TemplateArn
    • TemplateData
    • TemplateName

TemplateContent

  • TemplateContent string: The content of the custom verification email template.

TestRenderEmailTemplateRequest

  • TestRenderEmailTemplateRequest object: >Represents a request to create a preview of the MIME content of an email when provided with a template and a set of replacement data.
    • TemplateData required

TestRenderEmailTemplateResponse

  • TestRenderEmailTemplateResponse object: The following element is returned by the service.
    • RenderedTemplate required

Timestamp

  • Timestamp string

TlsPolicy

  • TlsPolicy string (values: REQUIRE, OPTIONAL): Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

TooManyRequestsException

Topic

  • Topic object: An interest group, theme, or label within a list. Lists can have multiple topics.
    • DefaultSubscriptionStatus required
    • Description
    • DisplayName required
    • TopicName required

TopicFilter

  • TopicFilter object: Used for filtering by a specific topic preference.
    • TopicName
    • UseDefaultIfPreferenceUnavailable

TopicName

  • TopicName string

TopicPreference

  • TopicPreference object: The contact's preference for being opted-in to or opted-out of a topic.
    • SubscriptionStatus required
    • TopicName required

TopicPreferenceList

Topics

  • Topics array

TrackingOptions

  • TrackingOptions object:

    An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

    These images and links include references to a domain operated by AWS. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

    • CustomRedirectDomain required

UnsubscribeAll

  • UnsubscribeAll boolean

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateConfigurationSetEventDestinationRequest

  • UpdateConfigurationSetEventDestinationRequest object: A request to change the settings for an event destination for a configuration set.
    • EventDestination required
      • CloudWatchDestination
      • Enabled
      • KinesisFirehoseDestination
        • DeliveryStreamArn required
        • IamRoleArn required
      • MatchingEventTypes
      • PinpointDestination
        • ApplicationArn
      • SnsDestination
        • TopicArn required

UpdateConfigurationSetEventDestinationResponse

  • UpdateConfigurationSetEventDestinationResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

UpdateContactListRequest

  • UpdateContactListRequest object
    • Description
    • Topics

UpdateContactListResponse

  • UpdateContactListResponse object

UpdateContactRequest

  • UpdateContactRequest object

UpdateContactResponse

  • UpdateContactResponse object

UpdateCustomVerificationEmailTemplateRequest

  • UpdateCustomVerificationEmailTemplateRequest object: Represents a request to update an existing custom verification email template.
    • FailureRedirectionURL required
    • FromEmailAddress required
    • SuccessRedirectionURL required
    • TemplateContent required
    • TemplateSubject required

UpdateCustomVerificationEmailTemplateResponse

  • UpdateCustomVerificationEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

UpdateEmailIdentityPolicyRequest

  • UpdateEmailIdentityPolicyRequest object: Represents a request to update 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.
    • Policy required

UpdateEmailIdentityPolicyResponse

  • UpdateEmailIdentityPolicyResponse object: An HTTP 200 response if the request succeeds, or an error message if the request fails.

UpdateEmailTemplateRequest

  • UpdateEmailTemplateRequest object: Represents a request to update an email template. For more information, see the Amazon SES Developer Guide.
    • TemplateContent required
      • Html
      • Subject
      • Text

UpdateEmailTemplateResponse

  • UpdateEmailTemplateResponse object: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

UseCaseDescription

  • UseCaseDescription string

UseDefaultIfPreferenceUnavailable

  • UseDefaultIfPreferenceUnavailable boolean

Volume

  • Volume integer: An object that contains information about inbox placement volume.

VolumeStatistics

  • VolumeStatistics object: An object that contains information about the amount of email that was delivered to recipients.
    • InboxRawCount
    • ProjectedInbox
    • ProjectedSpam
    • SpamRawCount

WarmupStatus

  • WarmupStatus string (values: IN_PROGRESS, DONE): The warmup status of a dedicated IP.

WebsiteURL

  • WebsiteURL string