Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/sesv2.ts?docs=full";

§Classes

SESV2

§Interfaces

AccountDetails

An object that contains information about your account details.

BatchGetMetricDataQuery

Represents a single metric data query to include in a batch.

BatchGetMetricDataRequest

Represents a request to retrieve a batch of metric data.

BatchGetMetricDataResponse

Represents the result of processing your metric data batch request

BlacklistEntry

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

Body

Represents the body of the email message.

BulkEmailContent

An object that contains the body of the message. You can specify a template message.

BulkEmailEntry
BulkEmailEntryResult

The result of the SendBulkEmail operation of each specified BulkEmailEntry.

CloudWatchDestination

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

An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.

Contact

A contact is the end-user who is receiving the email.

ContactList

A list that contains contacts that have subscribed to a particular topic or topics.

ContactListDestination

An object that contains details about the action of a contact list.

Content

An object that represents the content of the email, and optionally a character set specification.

CreateConfigurationSetEventDestinationRequest

A request to add an event destination to a configuration set.

CreateConfigurationSetRequest

A request to create a configuration set.

CreateContactListRequest
CreateContactRequest
CreateCustomVerificationEmailTemplateRequest

Represents a request to create a custom verification email template.

CreateDedicatedIpPoolRequest

A request to create a new dedicated IP pool.

CreateDeliverabilityTestReportRequest

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.

CreateDeliverabilityTestReportResponse

Information about the predictive inbox placement test that you created.

CreateEmailIdentityPolicyRequest

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.

CreateEmailIdentityRequest

A request to begin the verification process for an email identity (an email address or domain).

CreateEmailIdentityResponse

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

CreateEmailTemplateRequest

Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.

CreateImportJobRequest

Represents a request to create an import job from a data source for a data destination.

CreateImportJobResponse

An HTTP 200 response if the request succeeds, or an error message if the request fails.

CustomVerificationEmailTemplateMetadata

Contains information about a custom verification email template.

DailyVolume

An object that contains information about the volume of email sent on each day of the analysis period.

DashboardAttributes

An object containing additional settings for your VDM configuration as applicable to the Dashboard.

DashboardOptions

An object containing additional settings for your VDM configuration as applicable to the Dashboard.

DedicatedIp

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

DedicatedIpPool

Contains information about a dedicated IP pool.

DeleteConfigurationSetEventDestinationRequest

A request to delete an event destination from a configuration set.

DeleteConfigurationSetRequest

A request to delete a configuration set.

DeleteContactListRequest
DeleteContactRequest
DeleteCustomVerificationEmailTemplateRequest

Represents a request to delete an existing custom verification email template.

DeleteDedicatedIpPoolRequest

A request to delete a dedicated IP pool.

DeleteEmailIdentityPolicyRequest

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.

DeleteEmailIdentityRequest

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.

DeleteEmailTemplateRequest

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

DeleteSuppressedDestinationRequest

A request to remove an email address from the suppression list for your account.

DeliverabilityTestReport

An object that contains metadata related to a predictive inbox placement test.

DeliveryOptions

Used to associate a configuration set with a dedicated IP pool.

Destination

An object that describes the recipients for an email.

DkimAttributes

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

DkimSigningAttributes

An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM

DomainDeliverabilityCampaign

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

DomainDeliverabilityTrackingOption

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

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

EmailContent

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.

EmailTemplateContent

The content of the email, composed of a subject line, an HTML part, and a text-only part.

EmailTemplateMetadata

Contains information about an email template.

EventDestination

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.

EventDestinationDefinition

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.

FailureInfo

An object that contains the failure details about an import job.

GetAccountResponse

A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.

GetBlacklistReportsRequest

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

GetBlacklistReportsResponse

An object that contains information about blacklist events.

GetConfigurationSetEventDestinationsRequest

A request to obtain information about the event destinations for a configuration set.

GetConfigurationSetEventDestinationsResponse

Information about an event destination for a configuration set.

GetConfigurationSetRequest

A request to obtain information about a configuration set.

GetConfigurationSetResponse

Information about a configuration set.

GetContactListRequest
GetContactListResponse
GetContactRequest
GetContactResponse
GetCustomVerificationEmailTemplateRequest

Represents a request to retrieve an existing custom verification email template.

GetCustomVerificationEmailTemplateResponse

The following elements are returned by the service.

GetDedicatedIpPoolRequest

A request to obtain more information about a dedicated IP pool.

GetDedicatedIpPoolResponse

The following element is returned by the service.

GetDedicatedIpRequest

A request to obtain more information about a dedicated IP address.

GetDedicatedIpResponse

Information about a dedicated IP address.

GetDedicatedIpsRequest

A request to obtain more information about dedicated IP pools.

GetDedicatedIpsResponse

Information about the dedicated IP addresses that are associated with your Amazon Web Services account.

GetDeliverabilityDashboardOptionsResponse

An object that shows the status of the Deliverability dashboard.

GetDeliverabilityTestReportRequest

A request to retrieve the results of a predictive inbox placement test.

GetDeliverabilityTestReportResponse

The results of the predictive inbox placement test.

GetDomainDeliverabilityCampaignRequest

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

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.

GetDomainStatisticsReportRequest

A request to obtain deliverability metrics for a domain.

GetDomainStatisticsReportResponse

An object that includes statistics that are related to the domain that you specified.

GetEmailIdentityPoliciesRequest

A request to return the policies of an email identity.

GetEmailIdentityPoliciesResponse

Identity policies associated with email identity.

GetEmailIdentityRequest

A request to return details about an email identity.

GetEmailIdentityResponse

Details about an email identity.

GetEmailTemplateRequest

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

GetEmailTemplateResponse

The following element is returned by the service.

GetImportJobRequest

Represents a request for information about an import job using the import job ID.

GetImportJobResponse

An HTTP 200 response if the request succeeds, or an error message if the request fails.

GetSuppressedDestinationRequest

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

GetSuppressedDestinationResponse

Information about the suppressed email address.

GuardianAttributes

An object containing additional settings for your VDM configuration as applicable to the Guardian.

GuardianOptions

An object containing additional settings for your VDM configuration as applicable to the Guardian.

IdentityInfo

Information about an email identity.

ImportDataSource

An object that contains details about the data source of the import job.

ImportDestination

An object that contains details about the resource destination the import job is going to target.

ImportJobSummary

A summary of the import job.

InboxPlacementTrackingOption

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

IspPlacement

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

KinesisFirehoseDestination

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.

ListConfigurationSetsRequest

A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web Services Region.

ListConfigurationSetsResponse

A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.

ListContactListsRequest
ListContactListsResponse
ListContactsFilter

A filter that can be applied to a list of contacts.

ListContactsRequest
ListContactsResponse
ListCustomVerificationEmailTemplatesRequest

Represents a request to list the existing custom verification email templates for your account.

ListCustomVerificationEmailTemplatesResponse

The following elements are returned by the service.

ListDedicatedIpPoolsRequest

A request to obtain a list of dedicated IP pools.

ListDedicatedIpPoolsResponse

A list of dedicated IP pools.

ListDeliverabilityTestReportsRequest

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

ListDeliverabilityTestReportsResponse

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

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

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

A request to list all of the email identities associated with your Amazon Web Services 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

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

ListEmailTemplatesRequest

Represents a request to list the email templates present in your Amazon SES account in the current Amazon Web Services Region. For more information, see the Amazon SES Developer Guide.

ListEmailTemplatesResponse

The following elements are returned by the service.

ListImportJobsRequest

Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.

ListImportJobsResponse

An HTTP 200 response if the request succeeds, or an error message if the request fails.

ListManagementOptions

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

ListRecommendationsRequest

Represents a request to list the existing recommendations for your account.

ListRecommendationsResponse

Contains the response to your request to retrieve the list of recommendations for your account.

ListSuppressedDestinationsRequest

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

ListSuppressedDestinationsResponse

A list of suppressed email addresses.

ListTagsForResourceRequest
ListTagsForResourceResponse
MailFromAttributes

A list of attributes that are associated with a MAIL FROM domain.

Message

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

MessageTag

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.

MetricDataError

An error corresponding to the unsuccessful processing of a single metric data query.

MetricDataResult

The result of a single metric data query.

OverallVolume

An object that contains information about email that was sent from the selected domain.

PinpointDestination

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.

PlacementStatistics

An object that contains inbox placement data for an email provider.

PutAccountDedicatedIpWarmupAttributesRequest

A request to enable or disable the automatic IP address warm-up feature.

PutAccountDetailsRequest

A request to submit new account details.

PutAccountSendingAttributesRequest

A request to change the ability of your account to send email.

PutAccountSuppressionAttributesRequest

A request to change your account's suppression preferences.

PutAccountVdmAttributesRequest

A request to submit new account VDM attributes.

PutConfigurationSetDeliveryOptionsRequest

A request to associate a configuration set with a dedicated IP pool.

PutConfigurationSetReputationOptionsRequest

A request to enable or disable tracking of reputation metrics for a configuration set.

PutConfigurationSetSendingOptionsRequest

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

PutConfigurationSetSuppressionOptionsRequest

A request to change the account suppression list preferences for a specific configuration set.

PutConfigurationSetTrackingOptionsRequest

A request to add a custom domain for tracking open and click events to a configuration set.

PutConfigurationSetVdmOptionsRequest

A request to add specific VDM settings to a configuration set.

PutDedicatedIpInPoolRequest

A request to move a dedicated IP address to a dedicated IP pool.

PutDedicatedIpWarmupAttributesRequest

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.

PutDeliverabilityDashboardOptionRequest

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.

PutEmailIdentityConfigurationSetAttributesRequest

A request to associate a configuration set with an email identity.

PutEmailIdentityDkimAttributesRequest

A request to enable or disable DKIM signing of email that you send from an email identity.

PutEmailIdentityDkimSigningAttributesRequest

A request to change the DKIM attributes for an email identity.

PutEmailIdentityDkimSigningAttributesResponse

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

PutEmailIdentityFeedbackAttributesRequest

A request to set the attributes that control how bounce and complaint events are processed.

PutEmailIdentityMailFromAttributesRequest

A request to configure the custom MAIL FROM domain for a verified identity.

PutSuppressedDestinationRequest

A request to add an email destination to the suppression list for your account.

RawMessage

Represents the raw content of an email message.

Recommendation

A recommendation generated for your account.

ReplacementEmailContent

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

ReplacementTemplate

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

ReputationOptions

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.

ReviewDetails

An object that contains information about your account details review.

SendBulkEmailRequest

Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendBulkEmailResponse

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

SendCustomVerificationEmailRequest

Represents a request to send a custom verification email to a specified recipient.

SendCustomVerificationEmailResponse

The following element is returned by the service.

SendEmailRequest

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

SendEmailResponse

A unique message ID that you receive when an email is accepted for sending.

SendingOptions

Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.

SendQuota

An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.

SnsDestination

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

SuppressedDestination

An object that contains information about an email address that is on the suppression list for your account.

SuppressedDestinationAttributes

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

SuppressedDestinationSummary

A summary that describes the suppressed email address.

SuppressionAttributes

An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.

SuppressionListDestination

An object that contains details about the action of suppression list.

SuppressionOptions

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

Tag

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.

TagResourceRequest
Template

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.

TestRenderEmailTemplateRequest

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.

TestRenderEmailTemplateResponse

The following element is returned by the service.

Topic

An interest group, theme, or label within a list. Lists can have multiple topics.

TopicFilter

Used for filtering by a specific topic preference.

TopicPreference

The contact's preference for being opted-in to or opted-out of a topic.

TrackingOptions

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.

UntagResourceRequest
UpdateConfigurationSetEventDestinationRequest

A request to change the settings for an event destination for a configuration set.

UpdateContactListRequest
UpdateContactRequest
UpdateCustomVerificationEmailTemplateRequest

Represents a request to update an existing custom verification email template.

UpdateEmailIdentityPolicyRequest

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.

UpdateEmailTemplateRequest

Represents a request to update an email template. For more information, see the Amazon SES Developer Guide.

VdmAttributes

The VDM attributes that apply to your Amazon SES account.

VdmOptions

An object that defines the VDM settings that apply to emails that you send using the configuration set.

VolumeStatistics

An object that contains information about the amount of email that was delivered to recipients.

§Type Aliases

BehaviorOnMxFailure

The action 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.

BulkEmailStatus
ContactLanguage
ContactListImportAction
DataFormat

The data format of the import job's data source.

DeliverabilityDashboardAccountStatus

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.

DeliverabilityTestStatus

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.

DimensionValueSource

The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. 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. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.

DkimSigningAttributesOrigin
DkimSigningKeyLength
DkimStatus

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

EventType

An email sending event type. For example, email sends, opens, and bounces are all email events.

FeatureStatus
IdentityType
ImportDestinationType

The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

JobStatus

The status of the import job.

ListRecommendationsFilterKey

The ListRecommendations filter type. This can be one of the following:

MailFromDomainStatus

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

MailType
Metric
MetricDimensionName

The BatchGetMetricDataQuery dimension name. This can be one of the following:

MetricNamespace
QueryErrorCode
RecommendationImpact
RecommendationStatus
RecommendationType
ReviewStatus
ScalingMode
SubscriptionStatus
SuppressionListImportAction

The type of action to perform on the address. The following are possible values:

SuppressionListReason

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

TlsPolicy

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.

VerificationStatus
WarmupStatus

The warmup status of a dedicated IP.