@datafire/amazonaws_sesv2
v5.0.0
Published
DataFire integration for Amazon Simple Email Service
Downloads
4
Readme
@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).
- EmailIdentity required
Output
GetAccount
amazonaws_sesv2.GetAccount({}, context)
Input
- input
object
Output
- output GetAccountResponse
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.
- AutoWarmupEnabled
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.
- AdditionalContactEmailAddresses
Output
- output PutAccountDetailsResponse
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.
- SendingEnabled
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.- items SuppressionListReason
- SuppressedReasons
Output
ListConfigurationSets
amazonaws_sesv2.ListConfigurationSets({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
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.- SuppressedReasons
- items SuppressionListReason
- SuppressedReasons
- Tags
array
: An array of objects that define the tags (keys and values) that you want to associate with the configuration set.- items Tag
- 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
- ConfigurationSetName required
Output
DeleteConfigurationSet
amazonaws_sesv2.DeleteConfigurationSet({
"ConfigurationSetName": ""
}, context)
Input
- input
object
- ConfigurationSetName required
string
- ConfigurationSetName required
Output
GetConfigurationSet
amazonaws_sesv2.GetConfigurationSet({
"ConfigurationSetName": ""
}, context)
Input
- input
object
- ConfigurationSetName required
string
- ConfigurationSetName required
Output
- output GetConfigurationSetResponse
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.
- ConfigurationSetName required
Output
GetConfigurationSetEventDestinations
amazonaws_sesv2.GetConfigurationSetEventDestinations({
"ConfigurationSetName": ""
}, context)
Input
- input
object
- ConfigurationSetName required
string
- ConfigurationSetName required
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
- DimensionConfigurations required
- Enabled
- KinesisFirehoseDestination
- DeliveryStreamArn required
- IamRoleArn required
- MatchingEventTypes
- items EventType
- PinpointDestination
- ApplicationArn
- SnsDestination
- TopicArn required
- CloudWatchDestination
- 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.
- ConfigurationSetName required
Output
DeleteConfigurationSetEventDestination
amazonaws_sesv2.DeleteConfigurationSetEventDestination({
"ConfigurationSetName": "",
"EventDestinationName": ""
}, context)
Input
- input
object
- ConfigurationSetName required
string
- EventDestinationName required
string
- ConfigurationSetName required
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
- DimensionConfigurations required
- Enabled
- KinesisFirehoseDestination
- DeliveryStreamArn required
- IamRoleArn required
- MatchingEventTypes
- items EventType
- PinpointDestination
- ApplicationArn
- SnsDestination
- TopicArn required
- CloudWatchDestination
- ConfigurationSetName 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.
- ConfigurationSetName required
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.
- ConfigurationSetName required
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.- items SuppressionListReason
- ConfigurationSetName required
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.
- ConfigurationSetName required
Output
ListContactLists
amazonaws_sesv2.ListContactLists({}, context)
Input
- input
object
- PageSize
integer
- NextToken
string
- PageSize
Output
- output ListContactListsResponse
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.- items Tag
- Topics
array
: An interest group, theme, or label within a list. A contact list can have multiple topics.- items Topic
- ContactListName required
Output
- output CreateContactListResponse
DeleteContactList
amazonaws_sesv2.DeleteContactList({
"ContactListName": ""
}, context)
Input
- input
object
- ContactListName required
string
- ContactListName required
Output
- output DeleteContactListResponse
GetContactList
amazonaws_sesv2.GetContactList({
"ContactListName": ""
}, context)
Input
- input
object
- ContactListName required
string
- ContactListName required
Output
- output GetContactListResponse
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.- items Topic
- ContactListName required
Output
- output UpdateContactListResponse
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
- ContactListName required
Output
- output ListContactsResponse
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.- items TopicPreference
- UnsubscribeAll
boolean
: A boolean value status noting if the contact is unsubscribed from all contact list topics.
- ContactListName required
Output
- output CreateContactResponse
DeleteContact
amazonaws_sesv2.DeleteContact({
"ContactListName": "",
"EmailAddress": ""
}, context)
Input
- input
object
- ContactListName required
string
- EmailAddress required
string
- ContactListName required
Output
- output DeleteContactResponse
GetContact
amazonaws_sesv2.GetContact({
"ContactListName": "",
"EmailAddress": ""
}, context)
Input
- input
object
- ContactListName required
string
- EmailAddress required
string
- ContactListName required
Output
- output GetContactResponse
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.- items TopicPreference
- UnsubscribeAll
boolean
: A boolean value status noting if the contact is unsubscribed from all contact list topics.
- ContactListName required
Output
- output UpdateContactResponse
ListCustomVerificationEmailTemplates
amazonaws_sesv2.ListCustomVerificationEmailTemplates({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
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.
- FailureRedirectionURL required
Output
DeleteCustomVerificationEmailTemplate
amazonaws_sesv2.DeleteCustomVerificationEmailTemplate({
"TemplateName": ""
}, context)
Input
- input
object
- TemplateName required
string
- TemplateName required
Output
GetCustomVerificationEmailTemplate
amazonaws_sesv2.GetCustomVerificationEmailTemplate({
"TemplateName": ""
}, context)
Input
- input
object
- TemplateName required
string
- TemplateName required
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.
- TemplateName required
Output
ListDedicatedIpPools
amazonaws_sesv2.ListDedicatedIpPools({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
Output
- output ListDedicatedIpPoolsResponse
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.- items Tag
- PoolName required
Output
DeleteDedicatedIpPool
amazonaws_sesv2.DeleteDedicatedIpPool({
"PoolName": ""
}, context)
Input
- input
object
- PoolName required
string
- PoolName required
Output
GetDedicatedIps
amazonaws_sesv2.GetDedicatedIps({}, context)
Input
- input
object
- PoolName
string
- NextToken
string
- PageSize
integer
- PoolName
Output
- output GetDedicatedIpsResponse
GetDedicatedIp
amazonaws_sesv2.GetDedicatedIp({
"IP": ""
}, context)
Input
- input
object
- IP required
string
- IP required
Output
- output GetDedicatedIpResponse
PutDedicatedIpInPool
amazonaws_sesv2.PutDedicatedIpInPool({
"IP": "",
"DestinationPoolName": ""
}, context)
Input
- input
object
- IP required
string
- DestinationPoolName required
string
: The name of a dedicated IP pool.
- IP required
Output
- output PutDedicatedIpInPoolResponse
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.
- IP required
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.
- DashboardEnabled required
Output
GetBlacklistReports
amazonaws_sesv2.GetBlacklistReports({
"BlacklistItemNames": []
}, context)
Input
- input
object
- BlacklistItemNames required
array
- BlacklistItemNames required
Output
- output GetBlacklistReportsResponse
GetDomainDeliverabilityCampaign
amazonaws_sesv2.GetDomainDeliverabilityCampaign({
"CampaignId": ""
}, context)
Input
- input
object
- CampaignId required
string
- CampaignId required
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
- StartDate required
Output
GetDomainStatisticsReport
amazonaws_sesv2.GetDomainStatisticsReport({
"Domain": "",
"StartDate": "",
"EndDate": ""
}, context)
Input
- input
object
- Domain required
string
- StartDate required
string
- EndDate required
string
- Domain required
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
- Html
- Subject required
- Charset
- Data required
- Body required
- Template
- TemplateArn
- TemplateData
- TemplateName
- Raw
- 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.- items Tag
- Content required
Output
ListDeliverabilityTestReports
amazonaws_sesv2.ListDeliverabilityTestReports({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
Output
GetDeliverabilityTestReport
amazonaws_sesv2.GetDeliverabilityTestReport({
"ReportId": ""
}, context)
Input
- input
object
- ReportId required
string
- ReportId required
Output
ListEmailIdentities
amazonaws_sesv2.ListEmailIdentities({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
Output
- output ListEmailIdentitiesResponse
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.- items Tag
- DkimSigningAttributes
Output
- output CreateEmailIdentityResponse
DeleteEmailIdentity
amazonaws_sesv2.DeleteEmailIdentity({
"EmailIdentity": ""
}, context)
Input
- input
object
- EmailIdentity required
string
- EmailIdentity required
Output
- output DeleteEmailIdentityResponse
GetEmailIdentity
amazonaws_sesv2.GetEmailIdentity({
"EmailIdentity": ""
}, context)
Input
- input
object
- EmailIdentity required
string
- EmailIdentity required
Output
- output GetEmailIdentityResponse
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.
- EmailIdentity required
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).
- EmailIdentity required
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.
- EmailIdentity required
Output
GetEmailIdentityPolicies
amazonaws_sesv2.GetEmailIdentityPolicies({
"EmailIdentity": ""
}, context)
Input
- input
object
- EmailIdentity required
string
- EmailIdentity required
Output
DeleteEmailIdentityPolicy
amazonaws_sesv2.DeleteEmailIdentityPolicy({
"EmailIdentity": "",
"PolicyName": ""
}, context)
Input
- input
object
- EmailIdentity required
string
- PolicyName required
string
- EmailIdentity required
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.
- EmailIdentity required
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.
- EmailIdentity required
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.
- NextToken
Output
- output ListImportJobsResponse
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
- ContactListDestination
- ImportDataSource required
Output
- output CreateImportJobResponse
GetImportJob
amazonaws_sesv2.GetImportJob({
"JobId": ""
}, context)
Input
- input
object
- JobId required
string
- JobId required
Output
- output GetImportJobResponse
SendBulkEmail
amazonaws_sesv2.SendBulkEmail({
"DefaultContent": {},
"BulkEmailEntries": []
}, context)
Input
- input
object
- BulkEmailEntries required
array
: A list of BulkEmailEntry objects.- items BulkEmailEntry
- 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
- Template
- DefaultEmailTags
array
: A list of message tags.- items MessageTag
- 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.- items EmailAddress
- BulkEmailEntries required
Output
- output SendBulkEmailResponse
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.
- ConfigurationSetName
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
- Html
- Subject required
- Charset
- Data required
- Body required
- Template
- TemplateArn
- TemplateData
- TemplateName
- Raw
- Destination
object
: An object that describes the recipients for an email.- BccAddresses
- items EmailAddress
- CcAddresses
- items EmailAddress
- ToAddresses
- items EmailAddress
- BccAddresses
- EmailTags
array
: A list of message tags.- items MessageTag
- 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.- items EmailAddress
- ConfigurationSetName
Output
- output SendEmailResponse
ListSuppressedDestinations
amazonaws_sesv2.ListSuppressedDestinations({}, context)
Input
- input
object
- Reason
array
- StartDate
string
- EndDate
string
- NextToken
string
- PageSize
integer
- Reason
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.
- EmailAddress required
Output
DeleteSuppressedDestination
amazonaws_sesv2.DeleteSuppressedDestination({
"EmailAddress": ""
}, context)
Input
- input
object
- EmailAddress required
string
- EmailAddress required
Output
GetSuppressedDestination
amazonaws_sesv2.GetSuppressedDestination({
"EmailAddress": ""
}, context)
Input
- input
object
- EmailAddress required
string
- EmailAddress required
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.- items Tag
- ResourceArn required
Output
- output TagResourceResponse
ListTagsForResource
amazonaws_sesv2.ListTagsForResource({
"ResourceArn": ""
}, context)
Input
- input
object
- ResourceArn required
string
- ResourceArn required
Output
- output ListTagsForResourceResponse
UntagResource
amazonaws_sesv2.UntagResource({
"ResourceArn": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceArn required
string
- TagKeys required
array
- ResourceArn required
Output
- output UntagResourceResponse
ListEmailTemplates
amazonaws_sesv2.ListEmailTemplates({}, context)
Input
- input
object
- NextToken
string
- PageSize
integer
- NextToken
Output
- output ListEmailTemplatesResponse
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.
- TemplateContent required
Output
- output CreateEmailTemplateResponse
DeleteEmailTemplate
amazonaws_sesv2.DeleteEmailTemplate({
"TemplateName": ""
}, context)
Input
- input
object
- TemplateName required
string
- TemplateName required
Output
- output DeleteEmailTemplateResponse
GetEmailTemplate
amazonaws_sesv2.GetEmailTemplate({
"TemplateName": ""
}, context)
Input
- input
object
- TemplateName required
string
- TemplateName required
Output
- output GetEmailTemplateResponse
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
- TemplateName required
Output
- output UpdateEmailTemplateResponse
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.
- TemplateName required
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
- AdditionalContactEmailAddresses
array
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
- BlacklistEntries
array
- items BlacklistEntry
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
- BlacklistItemNames
array
- items BlacklistItemName
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
- Html
BulkEmailContent
- BulkEmailContent
object
: An object that contains the body of the message. You can specify a template message.- Template
- TemplateArn
- TemplateData
- TemplateName
- Template
BulkEmailEntry
- BulkEmailEntry
object
- Destination required
- BccAddresses
- items EmailAddress
- CcAddresses
- items EmailAddress
- ToAddresses
- items EmailAddress
- BccAddresses
- ReplacementEmailContent
- ReplacementTemplate
- ReplacementTemplateData
- ReplacementTemplate
- ReplacementTags
- items MessageTag
- Destination required
BulkEmailEntryList
- BulkEmailEntryList
array
: A list of BulkEmailEntry objects.- items BulkEmailEntry
BulkEmailEntryResult
- BulkEmailEntryResult
object
: The result of the SendBulkEmail operation of each specified BulkEmailEntry.- Error
- MessageId
- Status
BulkEmailEntryResultList
- BulkEmailEntryResultList
array
: A list of BulkMailEntry objects.- items BulkEmailEntryResult
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.- DimensionConfigurations required
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
- CloudWatchDimensionConfigurations
array
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
- ConfigurationSetNameList
array
- items ConfigurationSetName
ConflictException
Contact
- Contact
object
: A contact is the end-user who is receiving the email.- EmailAddress
- LastUpdatedTimestamp
- TopicDefaultPreferences
- items TopicPreference
- TopicPreferences
- items TopicPreference
- UnsubscribeAll
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
- DimensionConfigurations required
- Enabled
- KinesisFirehoseDestination
- DeliveryStreamArn required
- IamRoleArn required
- MatchingEventTypes
- items EventType
- PinpointDestination
- ApplicationArn
- SnsDestination
- TopicArn required
- CloudWatchDestination
- EventDestinationName required
- EventDestination 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
- items Tag
- TrackingOptions
- CustomRedirectDomain required
CreateConfigurationSetResponse
- CreateConfigurationSetResponse
object
: An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateContactListRequest
CreateContactListResponse
- CreateContactListResponse
object
CreateContactRequest
- CreateContactRequest
object
- AttributesData
- EmailAddress required
- TopicPreferences
- items TopicPreference
- 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
- items Tag
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
- Html
- Subject required
- Charset
- Data required
- Body required
- Template
- TemplateArn
- TemplateData
- TemplateName
- Raw
- FromEmailAddress required
- ReportName
- Tags
- items Tag
- Content required
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
- items Tag
- DkimSigningAttributes
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
- items DnsToken
- IdentityType
- VerifiedForSendingStatus
- DkimAttributes
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
- TemplateContent required
CreateEmailTemplateResponse
- CreateEmailTemplateResponse
object
: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
CreateImportJobRequest
- CreateImportJobRequest