AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing SimpleEmailServiceV2

Amazon SES API v2

Amazon SES is an Amazon Web Services 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 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.

Inheritance Hierarchy

Amazon.SimpleEmailV2.IAmazonSimpleEmailServiceV2

Namespace: Amazon.SimpleEmailV2
Assembly: AWSSDK.SimpleEmailV2.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonSimpleEmailServiceV2
         IAmazonService, IDisposable

The IAmazonSimpleEmailServiceV2 type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.SimpleEmailV2.Model.ISimpleEmailV2PaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchGetMetricData(BatchGetMetricDataRequest)

Retrieves batches of metric data collected based on your sending activity.

You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).

Public Method BatchGetMetricDataAsync(BatchGetMetricDataRequest, CancellationToken)

Retrieves batches of metric data collected based on your sending activity.

You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).

Public Method CancelExportJob(CancelExportJobRequest)

Cancels an export job.

Public Method CancelExportJobAsync(CancelExportJobRequest, CancellationToken)

Cancels an export job.

Public Method CreateConfigurationSet(CreateConfigurationSetRequest)

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Public Method CreateConfigurationSetAsync(CreateConfigurationSetRequest, CancellationToken)

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Public Method CreateConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest)

Create 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 EventBridge and associate a rule to send the event to the specified target.

A single configuration set can include more than one event destination.

Public Method CreateConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest, CancellationToken)

Create 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 EventBridge and associate a rule to send the event to the specified target.

A single configuration set can include more than one event destination.

Public Method CreateContact(CreateContactRequest)

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Public Method CreateContactAsync(CreateContactRequest, CancellationToken)

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Public Method CreateContactList(CreateContactListRequest)

Creates a contact list.

Public Method CreateContactListAsync(CreateContactListRequest, CancellationToken)

Creates a contact list.

Public Method CreateCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest)

Creates a new custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateCustomVerificationEmailTemplateAsync(CreateCustomVerificationEmailTemplateRequest, CancellationToken)

Creates a new custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateDedicatedIpPool(CreateDedicatedIpPoolRequest)

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

Public Method CreateDedicatedIpPoolAsync(CreateDedicatedIpPoolRequest, CancellationToken)

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

Public Method CreateDeliverabilityTestReport(CreateDeliverabilityTestReportRequest)

Create a new 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. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Public Method CreateDeliverabilityTestReportAsync(CreateDeliverabilityTestReportRequest, CancellationToken)

Create a new 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. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Public Method CreateEmailIdentity(CreateEmailIdentityRequest)

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

Public Method CreateEmailIdentityAsync(CreateEmailIdentityRequest, CancellationToken)

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

Public Method CreateEmailIdentityPolicy(CreateEmailIdentityPolicyRequest)

Creates the specified sending authorization policy for the given identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateEmailIdentityPolicyAsync(CreateEmailIdentityPolicyRequest, CancellationToken)

Creates the specified sending authorization policy for the given identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateEmailTemplate(CreateEmailTemplateRequest)

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateEmailTemplateAsync(CreateEmailTemplateRequest, CancellationToken)

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method CreateExportJob(CreateExportJobRequest)

Creates an export job for a data source and destination.

You can execute this operation no more than once per second.

Public Method CreateExportJobAsync(CreateExportJobRequest, CancellationToken)

Creates an export job for a data source and destination.

You can execute this operation no more than once per second.

Public Method CreateImportJob(CreateImportJobRequest)

Creates an import job for a data destination.

Public Method CreateImportJobAsync(CreateImportJobRequest, CancellationToken)

Creates an import job for a data destination.

Public Method CreateMultiRegionEndpoint(CreateMultiRegionEndpointRequest)

Creates a multi-region endpoint (global-endpoint).

The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.

Public Method CreateMultiRegionEndpointAsync(CreateMultiRegionEndpointRequest, CancellationToken)

Creates a multi-region endpoint (global-endpoint).

The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.

Public Method CreateTenant(CreateTenantRequest)

Create a tenant.

Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.

Public Method CreateTenantAsync(CreateTenantRequest, CancellationToken)

Create a tenant.

Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.

Public Method CreateTenantResourceAssociation(CreateTenantResourceAssociationRequest)

Associate a resource with a tenant.

Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant.

A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.

Public Method CreateTenantResourceAssociationAsync(CreateTenantResourceAssociationRequest, CancellationToken)

Associate a resource with a tenant.

Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant.

A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.

Public Method DeleteConfigurationSet(DeleteConfigurationSetRequest)

Delete an existing 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.

Public Method DeleteConfigurationSetAsync(DeleteConfigurationSetRequest, CancellationToken)

Delete an existing 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.

Public Method DeleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest)

Delete 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 EventBridge and associate a rule to send the event to the specified target.

Public Method DeleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest, CancellationToken)

Delete 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 EventBridge and associate a rule to send the event to the specified target.

Public Method DeleteContact(DeleteContactRequest)

Removes a contact from a contact list.

Public Method DeleteContactAsync(DeleteContactRequest, CancellationToken)

Removes a contact from a contact list.

Public Method DeleteContactList(DeleteContactListRequest)

Deletes a contact list and all of the contacts on that list.

Public Method DeleteContactListAsync(DeleteContactListRequest, CancellationToken)

Deletes a contact list and all of the contacts on that list.

Public Method DeleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest)

Deletes an existing custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method DeleteCustomVerificationEmailTemplateAsync(DeleteCustomVerificationEmailTemplateRequest, CancellationToken)

Deletes an existing custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method DeleteDedicatedIpPool(DeleteDedicatedIpPoolRequest)

Delete a dedicated IP pool.

Public Method DeleteDedicatedIpPoolAsync(DeleteDedicatedIpPoolRequest, CancellationToken)

Delete a dedicated IP pool.

Public Method DeleteEmailIdentity(DeleteEmailIdentityRequest)

Deletes an email identity. An identity can be either an email address or a domain name.

Public Method DeleteEmailIdentityAsync(DeleteEmailIdentityRequest, CancellationToken)

Deletes an email identity. An identity can be either an email address or a domain name.

Public Method DeleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest)

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method DeleteEmailIdentityPolicyAsync(DeleteEmailIdentityPolicyRequest, CancellationToken)

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method DeleteEmailTemplate(DeleteEmailTemplateRequest)

Deletes an email template.

You can execute this operation no more than once per second.

Public Method DeleteEmailTemplateAsync(DeleteEmailTemplateRequest, CancellationToken)

Deletes an email template.

You can execute this operation no more than once per second.

Public Method DeleteMultiRegionEndpoint(DeleteMultiRegionEndpointRequest)

Deletes a multi-region endpoint (global-endpoint).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.

Public Method DeleteMultiRegionEndpointAsync(DeleteMultiRegionEndpointRequest, CancellationToken)

Deletes a multi-region endpoint (global-endpoint).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.

Public Method DeleteSuppressedDestination(DeleteSuppressedDestinationRequest)

Removes an email address from the suppression list for your account.

Public Method DeleteSuppressedDestinationAsync(DeleteSuppressedDestinationRequest, CancellationToken)

Removes an email address from the suppression list for your account.

Public Method DeleteTenant(DeleteTenantRequest)

Delete an existing tenant.

When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.

Public Method DeleteTenantAsync(DeleteTenantRequest, CancellationToken)

Delete an existing tenant.

When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.

Public Method DeleteTenantResourceAssociation(DeleteTenantResourceAssociationRequest)

Delete an association between a tenant and a resource.

When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.

Public Method DeleteTenantResourceAssociationAsync(DeleteTenantResourceAssociationRequest, CancellationToken)

Delete an association between a tenant and a resource.

When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GetAccount(GetAccountRequest)

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Public Method GetAccountAsync(GetAccountRequest, CancellationToken)

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Public Method GetBlacklistReports(GetBlacklistReportsRequest)

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Public Method GetBlacklistReportsAsync(GetBlacklistReportsRequest, CancellationToken)

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Public Method GetConfigurationSet(GetConfigurationSetRequest)

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

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.

Public Method GetConfigurationSetAsync(GetConfigurationSetRequest, CancellationToken)

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

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.

Public Method GetConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest)

Retrieve a list of event destinations that are associated with a configuration set.

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 EventBridge and associate a rule to send the event to the specified target.

Public Method GetConfigurationSetEventDestinationsAsync(GetConfigurationSetEventDestinationsRequest, CancellationToken)

Retrieve a list of event destinations that are associated with a configuration set.

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 EventBridge and associate a rule to send the event to the specified target.

Public Method GetContact(GetContactRequest)

Returns a contact from a contact list.

Public Method GetContactAsync(GetContactRequest, CancellationToken)

Returns a contact from a contact list.

Public Method GetContactList(GetContactListRequest)

Returns contact list metadata. It does not return any information about the contacts present in the list.

Public Method GetContactListAsync(GetContactListRequest, CancellationToken)

Returns contact list metadata. It does not return any information about the contacts present in the list.

Public Method GetCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest)

Returns the custom email verification template for the template name you specify.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method GetCustomVerificationEmailTemplateAsync(GetCustomVerificationEmailTemplateRequest, CancellationToken)

Returns the custom email verification template for the template name you specify.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method GetDedicatedIp(GetDedicatedIpRequest)

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Public Method GetDedicatedIpAsync(GetDedicatedIpRequest, CancellationToken)

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Public Method GetDedicatedIpPool(GetDedicatedIpPoolRequest)

Retrieve information about the dedicated pool.

Public Method GetDedicatedIpPoolAsync(GetDedicatedIpPoolRequest, CancellationToken)

Retrieve information about the dedicated pool.

Public Method GetDedicatedIps(GetDedicatedIpsRequest)

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

Public Method GetDedicatedIpsAsync(GetDedicatedIpsRequest, CancellationToken)

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

Public Method GetDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest)

Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. 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 Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Public Method GetDeliverabilityDashboardOptionsAsync(GetDeliverabilityDashboardOptionsRequest, CancellationToken)

Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. 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 Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Public Method GetDeliverabilityTestReport(GetDeliverabilityTestReportRequest)

Retrieve the results of a predictive inbox placement test.

Public Method GetDeliverabilityTestReportAsync(GetDeliverabilityTestReportRequest, CancellationToken)

Retrieve the results of a predictive inbox placement test.

Public Method GetDomainDeliverabilityCampaign(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.

Public Method GetDomainDeliverabilityCampaignAsync(GetDomainDeliverabilityCampaignRequest, CancellationToken)

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.

Public Method GetDomainStatisticsReport(GetDomainStatisticsReportRequest)

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Public Method GetDomainStatisticsReportAsync(GetDomainStatisticsReportRequest, CancellationToken)

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Public Method GetEmailIdentity(GetEmailIdentityRequest)

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

Public Method GetEmailIdentityAsync(GetEmailIdentityRequest, CancellationToken)

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

Public Method GetEmailIdentityPolicies(GetEmailIdentityPoliciesRequest)

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method GetEmailIdentityPoliciesAsync(GetEmailIdentityPoliciesRequest, CancellationToken)

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method GetEmailTemplate(GetEmailTemplateRequest)

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.

You can execute this operation no more than once per second.

Public Method GetEmailTemplateAsync(GetEmailTemplateRequest, CancellationToken)

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.

You can execute this operation no more than once per second.

Public Method GetExportJob(GetExportJobRequest)

Provides information about an export job.

Public Method GetExportJobAsync(GetExportJobRequest, CancellationToken)

Provides information about an export job.

Public Method GetImportJob(GetImportJobRequest)

Provides information about an import job.

Public Method GetImportJobAsync(GetImportJobRequest, CancellationToken)

Provides information about an import job.

Public Method GetMessageInsights(GetMessageInsightsRequest)

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.

You can execute this operation no more than once per second.

Public Method GetMessageInsightsAsync(GetMessageInsightsRequest, CancellationToken)

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.

You can execute this operation no more than once per second.

Public Method GetMultiRegionEndpoint(GetMultiRegionEndpointRequest)

Displays the multi-region endpoint (global-endpoint) configuration.

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.

Public Method GetMultiRegionEndpointAsync(GetMultiRegionEndpointRequest, CancellationToken)

Displays the multi-region endpoint (global-endpoint) configuration.

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.

Public Method GetReputationEntity(GetReputationEntityRequest)

Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status.

Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.

Public Method GetReputationEntityAsync(GetReputationEntityRequest, CancellationToken)

Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status.

Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.

Public Method GetSuppressedDestination(GetSuppressedDestinationRequest)

Retrieves information about a specific email address that's on the suppression list for your account.

Public Method GetSuppressedDestinationAsync(GetSuppressedDestinationRequest, CancellationToken)

Retrieves information about a specific email address that's on the suppression list for your account.

Public Method GetTenant(GetTenantRequest)

Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status.

Public Method GetTenantAsync(GetTenantRequest, CancellationToken)

Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status.

Public Method ListConfigurationSets(ListConfigurationSetsRequest)

List all of the configuration sets associated with your account in the current region.

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.

Public Method ListConfigurationSetsAsync(ListConfigurationSetsRequest, CancellationToken)

List all of the configuration sets associated with your account in the current region.

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.

Public Method ListContactLists(ListContactListsRequest)

Lists all of the contact lists available.

If your output includes a "NextToken" field with a string value, this indicates there may be additional contacts on the filtered list - regardless of the number of contacts returned.

Public Method ListContactListsAsync(ListContactListsRequest, CancellationToken)

Lists all of the contact lists available.

If your output includes a "NextToken" field with a string value, this indicates there may be additional contacts on the filtered list - regardless of the number of contacts returned.

Public Method ListContacts(ListContactsRequest)

Lists the contacts present in a specific contact list.

Public Method ListContactsAsync(ListContactsRequest, CancellationToken)

Lists the contacts present in a specific contact list.

Public Method ListCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest)

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method ListCustomVerificationEmailTemplatesAsync(ListCustomVerificationEmailTemplatesRequest, CancellationToken)

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method ListDedicatedIpPools(ListDedicatedIpPoolsRequest)

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

Public Method ListDedicatedIpPoolsAsync(ListDedicatedIpPoolsRequest, CancellationToken)

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

Public Method ListDeliverabilityTestReports(ListDeliverabilityTestReportsRequest)

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

Public Method ListDeliverabilityTestReportsAsync(ListDeliverabilityTestReportsRequest, CancellationToken)

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

Public Method ListDomainDeliverabilityCampaigns(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 for the domain.

Public Method ListDomainDeliverabilityCampaignsAsync(ListDomainDeliverabilityCampaignsRequest, CancellationToken)

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 for the domain.

Public Method ListEmailIdentities(ListEmailIdentitiesRequest)

Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.

Public Method ListEmailIdentitiesAsync(ListEmailIdentitiesRequest, CancellationToken)

Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.

Public Method ListEmailTemplates(ListEmailTemplatesRequest)

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

Public Method ListEmailTemplatesAsync(ListEmailTemplatesRequest, CancellationToken)

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

Public Method ListExportJobs(ListExportJobsRequest)

Lists all of the export jobs.

Public Method ListExportJobsAsync(ListExportJobsRequest, CancellationToken)

Lists all of the export jobs.

Public Method ListImportJobs(ListImportJobsRequest)

Lists all of the import jobs.

Public Method ListImportJobsAsync(ListImportJobsRequest, CancellationToken)

Lists all of the import jobs.

Public Method ListMultiRegionEndpoints(ListMultiRegionEndpointsRequest)

List the multi-region endpoints (global-endpoints).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.

Public Method ListMultiRegionEndpointsAsync(ListMultiRegionEndpointsRequest, CancellationToken)

List the multi-region endpoints (global-endpoints).

Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.

Public Method ListRecommendations(ListRecommendationsRequest)

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

Public Method ListRecommendationsAsync(ListRecommendationsRequest, CancellationToken)

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

Public Method ListReputationEntities(ListReputationEntitiesRequest)

List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix.

Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.

Public Method ListReputationEntitiesAsync(ListReputationEntitiesRequest, CancellationToken)

List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix.

Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.

Public Method ListResourceTenants(ListResourceTenantsRequest)

List all tenants associated with a specific resource.

This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.

Public Method ListResourceTenantsAsync(ListResourceTenantsRequest, CancellationToken)

List all tenants associated with a specific resource.

This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.

Public Method ListSuppressedDestinations(ListSuppressedDestinationsRequest)

Retrieves a list of email addresses that are on the suppression list for your account.

Public Method ListSuppressedDestinationsAsync(ListSuppressedDestinationsRequest, CancellationToken)

Retrieves a list of email addresses that are on the suppression list for your account.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method ListTenantResources(ListTenantResourcesRequest)

List all resources associated with a specific tenant.

This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

Public Method ListTenantResourcesAsync(ListTenantResourcesRequest, CancellationToken)

List all resources associated with a specific tenant.

This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

Public Method ListTenants(ListTenantsRequest)

List all tenants associated with your account in the current Amazon Web Services Region.

This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.

Public Method ListTenantsAsync(ListTenantsRequest, CancellationToken)

List all tenants associated with your account in the current Amazon Web Services Region.

This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.

Public Method PutAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest)

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Public Method PutAccountDedicatedIpWarmupAttributesAsync(PutAccountDedicatedIpWarmupAttributesRequest, CancellationToken)

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Public Method PutAccountDetails(PutAccountDetailsRequest)

Update your Amazon SES account details.

Public Method PutAccountDetailsAsync(PutAccountDetailsRequest, CancellationToken)

Update your Amazon SES account details.

Public Method PutAccountSendingAttributes(PutAccountSendingAttributesRequest)

Enable or disable the ability of your account to send email.

Public Method PutAccountSendingAttributesAsync(PutAccountSendingAttributesRequest, CancellationToken)

Enable or disable the ability of your account to send email.

Public Method PutAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest)

Change the settings for the account-level suppression list.

Public Method PutAccountSuppressionAttributesAsync(PutAccountSuppressionAttributesRequest, CancellationToken)

Change the settings for the account-level suppression list.

Public Method PutAccountVdmAttributes(PutAccountVdmAttributesRequest)

Update your Amazon SES account VDM attributes.

You can execute this operation no more than once per second.

Public Method PutAccountVdmAttributesAsync(PutAccountVdmAttributesRequest, CancellationToken)

Update your Amazon SES account VDM attributes.

You can execute this operation no more than once per second.

Public Method PutConfigurationSetArchivingOptions(PutConfigurationSetArchivingOptionsRequest)

Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.

Public Method PutConfigurationSetArchivingOptionsAsync(PutConfigurationSetArchivingOptionsRequest, CancellationToken)

Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.

Public Method PutConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest)

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

Public Method PutConfigurationSetDeliveryOptionsAsync(PutConfigurationSetDeliveryOptionsRequest, CancellationToken)

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

Public Method PutConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest)

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Public Method PutConfigurationSetReputationOptionsAsync(PutConfigurationSetReputationOptionsRequest, CancellationToken)

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Public Method PutConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest)

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Public Method PutConfigurationSetSendingOptionsAsync(PutConfigurationSetSendingOptionsRequest, CancellationToken)

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Public Method PutConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest)

Specify the account suppression list preferences for a configuration set.

Public Method PutConfigurationSetSuppressionOptionsAsync(PutConfigurationSetSuppressionOptionsRequest, CancellationToken)

Specify the account suppression list preferences for a configuration set.

Public Method PutConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest)

Specify a custom domain to use for open and click tracking elements in email that you send.

Public Method PutConfigurationSetTrackingOptionsAsync(PutConfigurationSetTrackingOptionsRequest, CancellationToken)

Specify a custom domain to use for open and click tracking elements in email that you send.

Public Method PutConfigurationSetVdmOptions(PutConfigurationSetVdmOptionsRequest)

Specify VDM preferences for email that you send using the configuration set.

You can execute this operation no more than once per second.

Public Method PutConfigurationSetVdmOptionsAsync(PutConfigurationSetVdmOptionsRequest, CancellationToken)

Specify VDM preferences for email that you send using the configuration set.

You can execute this operation no more than once per second.

Public Method PutDedicatedIpInPool(PutDedicatedIpInPoolRequest)

Move a dedicated IP address to an existing dedicated IP pool.

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

Public Method PutDedicatedIpInPoolAsync(PutDedicatedIpInPoolRequest, CancellationToken)

Move a dedicated IP address to an existing dedicated IP pool.

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

Public Method PutDedicatedIpPoolScalingAttributes(PutDedicatedIpPoolScalingAttributesRequest)

Used to convert a dedicated IP pool to a different scaling mode.

MANAGED pools cannot be converted to STANDARD scaling mode.

Public Method PutDedicatedIpPoolScalingAttributesAsync(PutDedicatedIpPoolScalingAttributesRequest, CancellationToken)

Used to convert a dedicated IP pool to a different scaling mode.

MANAGED pools cannot be converted to STANDARD scaling mode.

Public Method PutDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest)

Public Method PutDedicatedIpWarmupAttributesAsync(PutDedicatedIpWarmupAttributesRequest, CancellationToken)

Public Method PutDeliverabilityDashboardOption(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. 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 Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Public Method PutDeliverabilityDashboardOptionAsync(PutDeliverabilityDashboardOptionRequest, CancellationToken)

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. 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 Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Public Method PutEmailIdentityConfigurationSetAttributes(PutEmailIdentityConfigurationSetAttributesRequest)

Used to associate a configuration set with an email identity.

Public Method PutEmailIdentityConfigurationSetAttributesAsync(PutEmailIdentityConfigurationSetAttributesRequest, CancellationToken)

Used to associate a configuration set with an email identity.

Public Method PutEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest)

Used to enable or disable DKIM authentication for an email identity.

Public Method PutEmailIdentityDkimAttributesAsync(PutEmailIdentityDkimAttributesRequest, CancellationToken)

Used to enable or disable DKIM authentication for an email identity.

Public Method PutEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest)

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:

  • Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).

  • Update the key length that should be used for Easy DKIM.

  • Change from using no DKIM authentication to using Easy DKIM.

  • Change from using no DKIM authentication to using BYODKIM.

  • Change from using Easy DKIM to using BYODKIM.

  • Change from using BYODKIM to using Easy DKIM.

Public Method PutEmailIdentityDkimSigningAttributesAsync(PutEmailIdentityDkimSigningAttributesRequest, CancellationToken)

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:

  • Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).

  • Update the key length that should be used for Easy DKIM.

  • Change from using no DKIM authentication to using Easy DKIM.

  • Change from using no DKIM authentication to using BYODKIM.

  • Change from using Easy DKIM to using BYODKIM.

  • Change from using BYODKIM to using Easy DKIM.

Public Method PutEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest)

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

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

Public Method PutEmailIdentityFeedbackAttributesAsync(PutEmailIdentityFeedbackAttributesRequest, CancellationToken)

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

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

Public Method PutEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Public Method PutEmailIdentityMailFromAttributesAsync(PutEmailIdentityMailFromAttributesRequest, CancellationToken)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Public Method PutSuppressedDestination(PutSuppressedDestinationRequest)

Adds an email address to the suppression list for your account.

Public Method PutSuppressedDestinationAsync(PutSuppressedDestinationRequest, CancellationToken)

Adds an email address to the suppression list for your account.

Public Method SendBulkEmail(SendBulkEmailRequest)

Composes an email message to multiple destinations.

Public Method SendBulkEmailAsync(SendBulkEmailRequest, CancellationToken)

Composes an email message to multiple destinations.

Public Method SendCustomVerificationEmail(SendCustomVerificationEmailRequest)

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method SendCustomVerificationEmailAsync(SendCustomVerificationEmailRequest, CancellationToken)

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method SendEmail(SendEmailRequest)

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

Public Method SendEmailAsync(SendEmailRequest, CancellationToken)

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

Public Method TagResource(TagResourceRequest)

Add one or more tags (keys and values) to a specified 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 more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Add one or more tags (keys and values) to a specified 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 more specific tag values. A tag value acts as a descriptor within a tag key.

Public Method TestRenderEmailTemplate(TestRenderEmailTemplateRequest)

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

You can execute this operation no more than once per second.

Public Method TestRenderEmailTemplateAsync(TestRenderEmailTemplateRequest, CancellationToken)

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

You can execute this operation no more than once per second.

Public Method UntagResource(UntagResourceRequest)

Remove one or more tags (keys and values) from a specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Remove one or more tags (keys and values) from a specified resource.

Public Method UpdateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest)

Update the configuration of an event destination for a configuration set.

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 EventBridge and associate a rule to send the event to the specified target.

Public Method UpdateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest, CancellationToken)

Update the configuration of an event destination for a configuration set.

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 EventBridge and associate a rule to send the event to the specified target.

Public Method UpdateContact(UpdateContactRequest)

Updates a contact's preferences for a list.

You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed.

Public Method UpdateContactAsync(UpdateContactRequest, CancellationToken)

Updates a contact's preferences for a list.

You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed.

Public Method UpdateContactList(UpdateContactListRequest)

Updates contact list metadata. This operation does a complete replacement.

Public Method UpdateContactListAsync(UpdateContactListRequest, CancellationToken)

Updates contact list metadata. This operation does a complete replacement.

Public Method UpdateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest)

Updates an existing custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateCustomVerificationEmailTemplateAsync(UpdateCustomVerificationEmailTemplateRequest, CancellationToken)

Updates an existing custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest)

Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateEmailIdentityPolicyAsync(UpdateEmailIdentityPolicyRequest, CancellationToken)

Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateEmailTemplate(UpdateEmailTemplateRequest)

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateEmailTemplateAsync(UpdateEmailTemplateRequest, CancellationToken)

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Public Method UpdateReputationEntityCustomerManagedStatus(UpdateReputationEntityCustomerManagedStatusRequest)

Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.

The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity, it will not be allowed to send regardless of the customer-managed status setting. When you reinstate an entity through the customer-managed status, it can continue sending only if the Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.

Public Method UpdateReputationEntityCustomerManagedStatusAsync(UpdateReputationEntityCustomerManagedStatusRequest, CancellationToken)

Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.

The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity, it will not be allowed to send regardless of the customer-managed status setting. When you reinstate an entity through the customer-managed status, it can continue sending only if the Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.

Public Method UpdateReputationEntityPolicy(UpdateReputationEntityPolicyRequest)

Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded.

Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.

Public Method UpdateReputationEntityPolicyAsync(UpdateReputationEntityPolicyRequest, CancellationToken)

Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded.

Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5