@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSimpleEmailServiceV2Client extends AmazonWebServiceClient implements AmazonSimpleEmailServiceV2
Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.
Amazon SES is an AWS service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to also review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonSimpleEmailServiceV2ClientBuilder builder()
public CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest request)
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.
createConfigurationSet
in interface AmazonSimpleEmailServiceV2
createConfigurationSetRequest
- A request to create a configuration set.AlreadyExistsException
- The resource specified in your request already exists.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.LimitExceededException
- There are too many instances of the specified resource type.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)
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 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.
A single configuration set can include more than one event destination.
createConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
createConfigurationSetEventDestinationRequest
- A request to add an event destination to a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.AlreadyExistsException
- The resource specified in your request already exists.LimitExceededException
- There are too many instances of the specified resource type.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest request)
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS 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.
createDedicatedIpPool
in interface AmazonSimpleEmailServiceV2
createDedicatedIpPoolRequest
- A request to create a new dedicated IP pool.AlreadyExistsException
- The resource specified in your request already exists.LimitExceededException
- There are too many instances of the specified resource type.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest request)
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.
createDeliverabilityTestReport
in interface AmazonSimpleEmailServiceV2
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.AccountSuspendedException
- The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException
- The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException
- The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException
- The message can't be sent because the sending domain isn't verified.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.LimitExceededException
- There are too many instances of the specified resource type.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest request)
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
that you want to use for DKIM authentication) and a private key.
createEmailIdentity
in interface AmazonSimpleEmailServiceV2
createEmailIdentityRequest
- A request to begin the verification process for an email identity (an email address or domain).AlreadyExistsException
- The resource specified in your request already exists.LimitExceededException
- There are too many instances of the specified resource type.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest request)
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.
deleteConfigurationSet
in interface AmazonSimpleEmailServiceV2
deleteConfigurationSetRequest
- A request to delete a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)
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 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.
deleteConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
deleteConfigurationSetEventDestinationRequest
- A request to delete an event destination from a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest request)
Delete a dedicated IP pool.
deleteDedicatedIpPool
in interface AmazonSimpleEmailServiceV2
deleteDedicatedIpPoolRequest
- A request to delete a dedicated IP pool.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest request)
Deletes an email identity. An identity can be either an email address or a domain name.
deleteEmailIdentity
in interface AmazonSimpleEmailServiceV2
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.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.public DeleteSuppressedDestinationResult deleteSuppressedDestination(DeleteSuppressedDestinationRequest request)
Removes an email address from the suppression list for your account.
deleteSuppressedDestination
in interface AmazonSimpleEmailServiceV2
deleteSuppressedDestinationRequest
- A request to remove an email address from the suppression list for your account.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.TooManyRequestsException
- Too many requests have been made to the operation.public GetAccountResult getAccount(GetAccountRequest request)
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current AWS Region.
getAccount
in interface AmazonSimpleEmailServiceV2
getAccountRequest
- A request to obtain information about the email-sending capabilities of your Amazon SES account.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest request)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReports
in interface AmazonSimpleEmailServiceV2
getBlacklistReportsRequest
- A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest request)
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.
getConfigurationSet
in interface AmazonSimpleEmailServiceV2
getConfigurationSetRequest
- A request to obtain information about a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest request)
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 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.
getConfigurationSetEventDestinations
in interface AmazonSimpleEmailServiceV2
getConfigurationSetEventDestinationsRequest
- A request to obtain information about the event destinations for a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest request)
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.
getDedicatedIp
in interface AmazonSimpleEmailServiceV2
getDedicatedIpRequest
- A request to obtain more information about a dedicated IP address.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest request)
List the dedicated IP addresses that are associated with your AWS account.
getDedicatedIps
in interface AmazonSimpleEmailServiceV2
getDedicatedIpsRequest
- A request to obtain more information about dedicated IP pools.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest request)
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 AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
getDeliverabilityDashboardOptions
in interface AmazonSimpleEmailServiceV2
getDeliverabilityDashboardOptionsRequest
- Retrieve information about the status of the Deliverability dashboard for your AWS account. When the
Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for
your domains. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
TooManyRequestsException
- Too many requests have been made to the operation.LimitExceededException
- There are too many instances of the specified resource type.BadRequestException
- The input you provided is invalid.public GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest request)
Retrieve the results of a predictive inbox placement test.
getDeliverabilityTestReport
in interface AmazonSimpleEmailServiceV2
getDeliverabilityTestReportRequest
- A request to retrieve the results of a predictive inbox placement test.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest request)
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.
getDomainDeliverabilityCampaign
in interface AmazonSimpleEmailServiceV2
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).TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.NotFoundException
- The resource you attempted to access doesn't exist.public GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest request)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReport
in interface AmazonSimpleEmailServiceV2
getDomainStatisticsReportRequest
- A request to obtain deliverability metrics for a domain.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest request)
Provides information about a specific identity, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
getEmailIdentity
in interface AmazonSimpleEmailServiceV2
getEmailIdentityRequest
- A request to return details about an email identity.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public GetSuppressedDestinationResult getSuppressedDestination(GetSuppressedDestinationRequest request)
Retrieves information about a specific email address that's on the suppression list for your account.
getSuppressedDestination
in interface AmazonSimpleEmailServiceV2
getSuppressedDestinationRequest
- A request to retrieve information about an email address that's on the suppression list for your account.BadRequestException
- The input you provided is invalid.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.public ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest request)
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.
listConfigurationSets
in interface AmazonSimpleEmailServiceV2
listConfigurationSetsRequest
- A request to obtain a list of configuration sets for your Amazon SES account in the current AWS Region.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest request)
List all of the dedicated IP pools that exist in your AWS account in the current Region.
listDedicatedIpPools
in interface AmazonSimpleEmailServiceV2
listDedicatedIpPoolsRequest
- A request to obtain a list of dedicated IP pools.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest request)
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.
listDeliverabilityTestReports
in interface AmazonSimpleEmailServiceV2
listDeliverabilityTestReportsRequest
- A request to list all of the predictive inbox placement tests that you've performed.TooManyRequestsException
- Too many requests have been made to the operation.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest request)
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.
listDomainDeliverabilityCampaigns
in interface AmazonSimpleEmailServiceV2
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.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.NotFoundException
- The resource you attempted to access doesn't exist.public ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest request)
Returns a list of all of the email identities that are associated with your AWS 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.
listEmailIdentities
in interface AmazonSimpleEmailServiceV2
listEmailIdentitiesRequest
- A request to list all of the email identities associated with your AWS account. This list includes
identities that you've already verified, identities that are unverified, and identities that were verified
in the past, but are no longer verified.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public ListSuppressedDestinationsResult listSuppressedDestinations(ListSuppressedDestinationsRequest request)
Retrieves a list of email addresses that are on the suppression list for your account.
listSuppressedDestinations
in interface AmazonSimpleEmailServiceV2
listSuppressedDestinationsRequest
- A request to obtain a list of email destinations that are on the suppression list for your account.BadRequestException
- The input you provided is invalid.TooManyRequestsException
- Too many requests have been made to the operation.InvalidNextTokenException
- The specified request includes an invalid or expired token.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AmazonSimpleEmailServiceV2
listTagsForResourceRequest
- BadRequestException
- The input you provided is invalid.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.public PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest request)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributes
in interface AmazonSimpleEmailServiceV2
putAccountDedicatedIpWarmupAttributesRequest
- A request to enable or disable the automatic IP address warm-up feature.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest request)
Enable or disable the ability of your account to send email.
putAccountSendingAttributes
in interface AmazonSimpleEmailServiceV2
putAccountSendingAttributesRequest
- A request to change the ability of your account to send email.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutAccountSuppressionAttributesResult putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest request)
Change the settings for the account-level suppression list.
putAccountSuppressionAttributes
in interface AmazonSimpleEmailServiceV2
putAccountSuppressionAttributesRequest
- A request to change your account's suppression preferences.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest request)
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.
putConfigurationSetDeliveryOptions
in interface AmazonSimpleEmailServiceV2
putConfigurationSetDeliveryOptionsRequest
- A request to associate a configuration set with a dedicated IP pool.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest request)
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetReputationOptions
in interface AmazonSimpleEmailServiceV2
putConfigurationSetReputationOptionsRequest
- A request to enable or disable tracking of reputation metrics for a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest request)
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptions
in interface AmazonSimpleEmailServiceV2
putConfigurationSetSendingOptionsRequest
- A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration
set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutConfigurationSetSuppressionOptionsResult putConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest request)
Specify the account suppression list preferences for a configuration set.
putConfigurationSetSuppressionOptions
in interface AmazonSimpleEmailServiceV2
putConfigurationSetSuppressionOptionsRequest
- A request to change the account suppression list preferences for a specific configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest request)
Specify a custom domain to use for open and click tracking elements in email that you send.
putConfigurationSetTrackingOptions
in interface AmazonSimpleEmailServiceV2
putConfigurationSetTrackingOptionsRequest
- A request to add a custom domain for tracking open and click events to a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest request)
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 AWS account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool
operation.
putDedicatedIpInPool
in interface AmazonSimpleEmailServiceV2
putDedicatedIpInPoolRequest
- A request to move a dedicated IP address to a dedicated IP pool.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest request)
putDedicatedIpWarmupAttributes
in interface AmazonSimpleEmailServiceV2
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.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest request)
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 AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
putDeliverabilityDashboardOption
in interface AmazonSimpleEmailServiceV2
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.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
AlreadyExistsException
- The resource specified in your request already exists.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.LimitExceededException
- There are too many instances of the specified resource type.BadRequestException
- The input you provided is invalid.public PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest request)
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributes
in interface AmazonSimpleEmailServiceV2
putEmailIdentityDkimAttributesRequest
- A request to enable or disable DKIM signing of email that you send from an email identity.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutEmailIdentityDkimSigningAttributesResult putEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest request)
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).
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.
putEmailIdentityDkimSigningAttributes
in interface AmazonSimpleEmailServiceV2
putEmailIdentityDkimSigningAttributesRequest
- A request to change the DKIM attributes for an email identity.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest request)
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).
putEmailIdentityFeedbackAttributes
in interface AmazonSimpleEmailServiceV2
putEmailIdentityFeedbackAttributesRequest
- A request to set the attributes that control how bounce and complaint events are processed.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest request)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributes
in interface AmazonSimpleEmailServiceV2
putEmailIdentityMailFromAttributesRequest
- A request to configure the custom MAIL FROM domain for a verified identity.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public PutSuppressedDestinationResult putSuppressedDestination(PutSuppressedDestinationRequest request)
Adds an email address to the suppression list for your account.
putSuppressedDestination
in interface AmazonSimpleEmailServiceV2
putSuppressedDestinationRequest
- A request to add an email destination to the suppression list for your account.BadRequestException
- The input you provided is invalid.TooManyRequestsException
- Too many requests have been made to the operation.public SendEmailResult sendEmail(SendEmailRequest request)
Sends an email message. You can use the Amazon SES API v2 to send two 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.
sendEmail
in interface AmazonSimpleEmailServiceV2
sendEmailRequest
- A request to send an email message.TooManyRequestsException
- Too many requests have been made to the operation.LimitExceededException
- There are too many instances of the specified resource type.AccountSuspendedException
- The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException
- The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException
- The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException
- The message can't be sent because the sending domain isn't verified.NotFoundException
- The resource you attempted to access doesn't exist.BadRequestException
- The input you provided is invalid.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonSimpleEmailServiceV2
tagResourceRequest
- BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.public UntagResourceResult untagResource(UntagResourceRequest request)
Remove one or more tags (keys and values) from a specified resource.
untagResource
in interface AmazonSimpleEmailServiceV2
untagResourceRequest
- BadRequestException
- The input you provided is invalid.ConcurrentModificationException
- The resource is being modified by another operation or thread.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.public UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)
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 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.
updateConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
updateConfigurationSetEventDestinationRequest
- A request to change the settings for an event destination for a configuration set.NotFoundException
- The resource you attempted to access doesn't exist.TooManyRequestsException
- Too many requests have been made to the operation.BadRequestException
- The input you provided is invalid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonSimpleEmailServiceV2
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.