Interface SesAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
This documentation contains reference information related to the following:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SesAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSesAsyncClient
.cloneReceiptRuleSet
(Consumer<CloneReceiptRuleSetRequest.Builder> cloneReceiptRuleSetRequest) Creates a receipt rule set by cloning an existing one.cloneReceiptRuleSet
(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) Creates a receipt rule set by cloning an existing one.static SesAsyncClient
create()
Create aSesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createConfigurationSet
(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Creates a configuration set.createConfigurationSet
(CreateConfigurationSetRequest createConfigurationSetRequest) Creates a configuration set.createConfigurationSetEventDestination
(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Creates a configuration set event destination.createConfigurationSetEventDestination
(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Creates a configuration set event destination.createConfigurationSetTrackingOptions
(Consumer<CreateConfigurationSetTrackingOptionsRequest.Builder> createConfigurationSetTrackingOptionsRequest) Creates an association between a configuration set and a custom domain for open and click event tracking.createConfigurationSetTrackingOptions
(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest) Creates an association between a configuration set and a custom domain for open and click event tracking.createCustomVerificationEmailTemplate
(Consumer<CreateCustomVerificationEmailTemplateRequest.Builder> createCustomVerificationEmailTemplateRequest) Creates a new custom verification email template.createCustomVerificationEmailTemplate
(CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest) Creates a new custom verification email template.createReceiptFilter
(Consumer<CreateReceiptFilterRequest.Builder> createReceiptFilterRequest) Creates a new IP address filter.createReceiptFilter
(CreateReceiptFilterRequest createReceiptFilterRequest) Creates a new IP address filter.createReceiptRule
(Consumer<CreateReceiptRuleRequest.Builder> createReceiptRuleRequest) Creates a receipt rule.createReceiptRule
(CreateReceiptRuleRequest createReceiptRuleRequest) Creates a receipt rule.createReceiptRuleSet
(Consumer<CreateReceiptRuleSetRequest.Builder> createReceiptRuleSetRequest) Creates an empty receipt rule set.createReceiptRuleSet
(CreateReceiptRuleSetRequest createReceiptRuleSetRequest) Creates an empty receipt rule set.default CompletableFuture
<CreateTemplateResponse> createTemplate
(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates an email template.default CompletableFuture
<CreateTemplateResponse> createTemplate
(CreateTemplateRequest createTemplateRequest) Creates an email template.deleteConfigurationSet
(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes a configuration set.deleteConfigurationSet
(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes a configuration set.deleteConfigurationSetEventDestination
(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Deletes a configuration set event destination.deleteConfigurationSetEventDestination
(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes a configuration set event destination.deleteConfigurationSetTrackingOptions
(Consumer<DeleteConfigurationSetTrackingOptionsRequest.Builder> deleteConfigurationSetTrackingOptionsRequest) Deletes an association between a configuration set and a custom domain for open and click event tracking.deleteConfigurationSetTrackingOptions
(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest) Deletes an association between a configuration set and a custom domain for open and click event tracking.deleteCustomVerificationEmailTemplate
(Consumer<DeleteCustomVerificationEmailTemplateRequest.Builder> deleteCustomVerificationEmailTemplateRequest) Deletes an existing custom verification email template.deleteCustomVerificationEmailTemplate
(DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest) Deletes an existing custom verification email template.default CompletableFuture
<DeleteIdentityResponse> deleteIdentity
(Consumer<DeleteIdentityRequest.Builder> deleteIdentityRequest) Deletes the specified identity (an email address or a domain) from the list of verified identities.default CompletableFuture
<DeleteIdentityResponse> deleteIdentity
(DeleteIdentityRequest deleteIdentityRequest) Deletes the specified identity (an email address or a domain) from the list of verified identities.deleteIdentityPolicy
(Consumer<DeleteIdentityPolicyRequest.Builder> deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (an email address or a domain).deleteIdentityPolicy
(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (an email address or a domain).deleteReceiptFilter
(Consumer<DeleteReceiptFilterRequest.Builder> deleteReceiptFilterRequest) Deletes the specified IP address filter.deleteReceiptFilter
(DeleteReceiptFilterRequest deleteReceiptFilterRequest) Deletes the specified IP address filter.deleteReceiptRule
(Consumer<DeleteReceiptRuleRequest.Builder> deleteReceiptRuleRequest) Deletes the specified receipt rule.deleteReceiptRule
(DeleteReceiptRuleRequest deleteReceiptRuleRequest) Deletes the specified receipt rule.deleteReceiptRuleSet
(Consumer<DeleteReceiptRuleSetRequest.Builder> deleteReceiptRuleSetRequest) Deletes the specified receipt rule set and all of the receipt rules it contains.deleteReceiptRuleSet
(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest) Deletes the specified receipt rule set and all of the receipt rules it contains.default CompletableFuture
<DeleteTemplateResponse> deleteTemplate
(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) Deletes an email template.default CompletableFuture
<DeleteTemplateResponse> deleteTemplate
(DeleteTemplateRequest deleteTemplateRequest) Deletes an email template.deleteVerifiedEmailAddress
(Consumer<DeleteVerifiedEmailAddressRequest.Builder> deleteVerifiedEmailAddressRequest) Deprecated.deleteVerifiedEmailAddress
(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) Deprecated.Returns the metadata and receipt rules for the receipt rule set that is currently active.describeActiveReceiptRuleSet
(Consumer<DescribeActiveReceiptRuleSetRequest.Builder> describeActiveReceiptRuleSetRequest) Returns the metadata and receipt rules for the receipt rule set that is currently active.describeActiveReceiptRuleSet
(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) Returns the metadata and receipt rules for the receipt rule set that is currently active.describeConfigurationSet
(Consumer<DescribeConfigurationSetRequest.Builder> describeConfigurationSetRequest) Returns the details of the specified configuration set.describeConfigurationSet
(DescribeConfigurationSetRequest describeConfigurationSetRequest) Returns the details of the specified configuration set.describeReceiptRule
(Consumer<DescribeReceiptRuleRequest.Builder> describeReceiptRuleRequest) Returns the details of the specified receipt rule.describeReceiptRule
(DescribeReceiptRuleRequest describeReceiptRuleRequest) Returns the details of the specified receipt rule.describeReceiptRuleSet
(Consumer<DescribeReceiptRuleSetRequest.Builder> describeReceiptRuleSetRequest) Returns the details of the specified receipt rule set.describeReceiptRuleSet
(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest) Returns the details of the specified receipt rule set.Returns the email sending status of the Amazon SES account for the current Region.getAccountSendingEnabled
(Consumer<GetAccountSendingEnabledRequest.Builder> getAccountSendingEnabledRequest) Returns the email sending status of the Amazon SES account for the current Region.getAccountSendingEnabled
(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest) Returns the email sending status of the Amazon SES account for the current Region.getCustomVerificationEmailTemplate
(Consumer<GetCustomVerificationEmailTemplateRequest.Builder> getCustomVerificationEmailTemplateRequest) Returns the custom email verification template for the template name you specify.getCustomVerificationEmailTemplate
(GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest) Returns the custom email verification template for the template name you specify.getIdentityDkimAttributes
(Consumer<GetIdentityDkimAttributesRequest.Builder> getIdentityDkimAttributesRequest) Returns the current status of Easy DKIM signing for an entity.getIdentityDkimAttributes
(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) Returns the current status of Easy DKIM signing for an entity.getIdentityMailFromDomainAttributes
(Consumer<GetIdentityMailFromDomainAttributesRequest.Builder> getIdentityMailFromDomainAttributesRequest) Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).getIdentityMailFromDomainAttributes
(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest) Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).getIdentityNotificationAttributes
(Consumer<GetIdentityNotificationAttributesRequest.Builder> getIdentityNotificationAttributesRequest) Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.getIdentityNotificationAttributes
(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.getIdentityPolicies
(Consumer<GetIdentityPoliciesRequest.Builder> getIdentityPoliciesRequest) Returns the requested sending authorization policies for the given identity (an email address or a domain).getIdentityPolicies
(GetIdentityPoliciesRequest getIdentityPoliciesRequest) Returns the requested sending authorization policies for the given identity (an email address or a domain).getIdentityVerificationAttributes
(Consumer<GetIdentityVerificationAttributesRequest.Builder> getIdentityVerificationAttributesRequest) Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.getIdentityVerificationAttributes
(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.default CompletableFuture
<GetSendQuotaResponse> Provides the sending limits for the Amazon SES account.default CompletableFuture
<GetSendQuotaResponse> getSendQuota
(Consumer<GetSendQuotaRequest.Builder> getSendQuotaRequest) Provides the sending limits for the Amazon SES account.default CompletableFuture
<GetSendQuotaResponse> getSendQuota
(GetSendQuotaRequest getSendQuotaRequest) Provides the sending limits for the Amazon SES account.Provides sending statistics for the current Amazon Web Services Region.getSendStatistics
(Consumer<GetSendStatisticsRequest.Builder> getSendStatisticsRequest) Provides sending statistics for the current Amazon Web Services Region.getSendStatistics
(GetSendStatisticsRequest getSendStatisticsRequest) Provides sending statistics for the current Amazon Web Services Region.default CompletableFuture
<GetTemplateResponse> getTemplate
(Consumer<GetTemplateRequest.Builder> getTemplateRequest) Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.default CompletableFuture
<GetTemplateResponse> getTemplate
(GetTemplateRequest getTemplateRequest) Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region.listConfigurationSets
(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region.listConfigurationSets
(ListConfigurationSetsRequest listConfigurationSetsRequest) Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region.Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.listCustomVerificationEmailTemplates
(Consumer<ListCustomVerificationEmailTemplatesRequest.Builder> listCustomVerificationEmailTemplatesRequest) Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.listCustomVerificationEmailTemplates
(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest) Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.This is a variant oflistCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.listCustomVerificationEmailTemplatesPaginator
(Consumer<ListCustomVerificationEmailTemplatesRequest.Builder> listCustomVerificationEmailTemplatesRequest) This is a variant oflistCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.listCustomVerificationEmailTemplatesPaginator
(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest) This is a variant oflistCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.default CompletableFuture
<ListIdentitiesResponse> Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.default CompletableFuture
<ListIdentitiesResponse> listIdentities
(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.default CompletableFuture
<ListIdentitiesResponse> listIdentities
(ListIdentitiesRequest listIdentitiesRequest) Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.default ListIdentitiesPublisher
This is a variant oflistIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.default ListIdentitiesPublisher
listIdentitiesPaginator
(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) This is a variant oflistIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.default ListIdentitiesPublisher
listIdentitiesPaginator
(ListIdentitiesRequest listIdentitiesRequest) This is a variant oflistIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.listIdentityPolicies
(Consumer<ListIdentityPoliciesRequest.Builder> listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).listIdentityPolicies
(ListIdentityPoliciesRequest listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain).Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.listReceiptFilters
(Consumer<ListReceiptFiltersRequest.Builder> listReceiptFiltersRequest) Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.listReceiptFilters
(ListReceiptFiltersRequest listReceiptFiltersRequest) Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.listReceiptRuleSets
(Consumer<ListReceiptRuleSetsRequest.Builder> listReceiptRuleSetsRequest) Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.listReceiptRuleSets
(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region.default CompletableFuture
<ListTemplatesResponse> Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.default CompletableFuture
<ListTemplatesResponse> listTemplates
(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.default CompletableFuture
<ListTemplatesResponse> listTemplates
(ListTemplatesRequest listTemplatesRequest) Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.Deprecated.listVerifiedEmailAddresses
(Consumer<ListVerifiedEmailAddressesRequest.Builder> listVerifiedEmailAddressesRequest) Deprecated.listVerifiedEmailAddresses
(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) Deprecated.putConfigurationSetDeliveryOptions
(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest) Adds or updates the delivery options for a configuration set.putConfigurationSetDeliveryOptions
(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) Adds or updates the delivery options for a configuration set.putIdentityPolicy
(Consumer<PutIdentityPolicyRequest.Builder> putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (an email address or a domain).putIdentityPolicy
(PutIdentityPolicyRequest putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (an email address or a domain).reorderReceiptRuleSet
(Consumer<ReorderReceiptRuleSetRequest.Builder> reorderReceiptRuleSetRequest) Reorders the receipt rules within a receipt rule set.reorderReceiptRuleSet
(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest) Reorders the receipt rules within a receipt rule set.default CompletableFuture
<SendBounceResponse> sendBounce
(Consumer<SendBounceRequest.Builder> sendBounceRequest) Generates and sends a bounce message to the sender of an email you received through Amazon SES.default CompletableFuture
<SendBounceResponse> sendBounce
(SendBounceRequest sendBounceRequest) Generates and sends a bounce message to the sender of an email you received through Amazon SES.sendBulkTemplatedEmail
(Consumer<SendBulkTemplatedEmailRequest.Builder> sendBulkTemplatedEmailRequest) Composes an email message to multiple destinations.sendBulkTemplatedEmail
(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest) Composes an email message to multiple destinations.sendCustomVerificationEmail
(Consumer<SendCustomVerificationEmailRequest.Builder> 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.sendCustomVerificationEmail
(SendCustomVerificationEmailRequest 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.default CompletableFuture
<SendEmailResponse> sendEmail
(Consumer<SendEmailRequest.Builder> sendEmailRequest) Composes an email message and immediately queues it for sending.default CompletableFuture
<SendEmailResponse> sendEmail
(SendEmailRequest sendEmailRequest) Composes an email message and immediately queues it for sending.default CompletableFuture
<SendRawEmailResponse> sendRawEmail
(Consumer<SendRawEmailRequest.Builder> sendRawEmailRequest) Composes an email message and immediately queues it for sending.default CompletableFuture
<SendRawEmailResponse> sendRawEmail
(SendRawEmailRequest sendRawEmailRequest) Composes an email message and immediately queues it for sending.sendTemplatedEmail
(Consumer<SendTemplatedEmailRequest.Builder> sendTemplatedEmailRequest) Composes an email message using an email template and immediately queues it for sending.sendTemplatedEmail
(SendTemplatedEmailRequest sendTemplatedEmailRequest) Composes an email message using an email template and immediately queues it for sending.default SesServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationSets the specified receipt rule set as the active receipt rule set.setActiveReceiptRuleSet
(Consumer<SetActiveReceiptRuleSetRequest.Builder> setActiveReceiptRuleSetRequest) Sets the specified receipt rule set as the active receipt rule set.setActiveReceiptRuleSet
(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) Sets the specified receipt rule set as the active receipt rule set.setIdentityDkimEnabled
(Consumer<SetIdentityDkimEnabledRequest.Builder> setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity.setIdentityDkimEnabled
(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity.setIdentityFeedbackForwardingEnabled
(Consumer<SetIdentityFeedbackForwardingEnabledRequest.Builder> setIdentityFeedbackForwardingEnabledRequest) Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.setIdentityFeedbackForwardingEnabled
(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email.setIdentityHeadersInNotificationsEnabled
(Consumer<SetIdentityHeadersInNotificationsEnabledRequest.Builder> setIdentityHeadersInNotificationsEnabledRequest) Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.setIdentityHeadersInNotificationsEnabled
(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest) Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.setIdentityMailFromDomain
(Consumer<SetIdentityMailFromDomainRequest.Builder> setIdentityMailFromDomainRequest) Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).setIdentityMailFromDomain
(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest) Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).setIdentityNotificationTopic
(Consumer<SetIdentityNotificationTopicRequest.Builder> setIdentityNotificationTopicRequest) Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.setIdentityNotificationTopic
(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications.setReceiptRulePosition
(Consumer<SetReceiptRulePositionRequest.Builder> setReceiptRulePositionRequest) Sets the position of the specified receipt rule in the receipt rule set.setReceiptRulePosition
(SetReceiptRulePositionRequest setReceiptRulePositionRequest) Sets the position of the specified receipt rule in the receipt rule set.testRenderTemplate
(Consumer<TestRenderTemplateRequest.Builder> testRenderTemplateRequest) Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.testRenderTemplate
(TestRenderTemplateRequest testRenderTemplateRequest) Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.updateAccountSendingEnabled
(Consumer<UpdateAccountSendingEnabledRequest.Builder> updateAccountSendingEnabledRequest) Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region.updateAccountSendingEnabled
(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest) Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region.updateConfigurationSetEventDestination
(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Updates the event destination of a configuration set.updateConfigurationSetEventDestination
(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Updates the event destination of a configuration set.updateConfigurationSetReputationMetricsEnabled
(Consumer<UpdateConfigurationSetReputationMetricsEnabledRequest.Builder> updateConfigurationSetReputationMetricsEnabledRequest) Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region.updateConfigurationSetReputationMetricsEnabled
(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest) Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region.updateConfigurationSetSendingEnabled
(Consumer<UpdateConfigurationSetSendingEnabledRequest.Builder> updateConfigurationSetSendingEnabledRequest) Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region.updateConfigurationSetSendingEnabled
(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest) Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region.updateConfigurationSetTrackingOptions
(Consumer<UpdateConfigurationSetTrackingOptionsRequest.Builder> updateConfigurationSetTrackingOptionsRequest) Modifies an association between a configuration set and a custom domain for open and click event tracking.updateConfigurationSetTrackingOptions
(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest) Modifies an association between a configuration set and a custom domain for open and click event tracking.updateCustomVerificationEmailTemplate
(Consumer<UpdateCustomVerificationEmailTemplateRequest.Builder> updateCustomVerificationEmailTemplateRequest) Updates an existing custom verification email template.updateCustomVerificationEmailTemplate
(UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest) Updates an existing custom verification email template.updateReceiptRule
(Consumer<UpdateReceiptRuleRequest.Builder> updateReceiptRuleRequest) Updates a receipt rule.updateReceiptRule
(UpdateReceiptRuleRequest updateReceiptRuleRequest) Updates a receipt rule.default CompletableFuture
<UpdateTemplateResponse> updateTemplate
(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) Updates an email template.default CompletableFuture
<UpdateTemplateResponse> updateTemplate
(UpdateTemplateRequest updateTemplateRequest) Updates an email template.verifyDomainDkim
(Consumer<VerifyDomainDkimRequest.Builder> verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain identity.verifyDomainDkim
(VerifyDomainDkimRequest verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain identity.verifyDomainIdentity
(Consumer<VerifyDomainIdentityRequest.Builder> verifyDomainIdentityRequest) Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.verifyDomainIdentity
(VerifyDomainIdentityRequest verifyDomainIdentityRequest) Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it.verifyEmailAddress
(Consumer<VerifyEmailAddressRequest.Builder> verifyEmailAddressRequest) Deprecated.verifyEmailAddress
(VerifyEmailAddressRequest verifyEmailAddressRequest) Deprecated.verifyEmailIdentity
(Consumer<VerifyEmailIdentityRequest.Builder> verifyEmailIdentityRequest) 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.verifyEmailIdentity
(VerifyEmailIdentityRequest verifyEmailIdentityRequest) 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.default SesAsyncWaiter
waiter()
Create an instance ofSesAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cloneReceiptRuleSet
default CompletableFuture<CloneReceiptRuleSetResponse> cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
cloneReceiptRuleSetRequest
- Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CloneReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cloneReceiptRuleSet
default CompletableFuture<CloneReceiptRuleSetResponse> cloneReceiptRuleSet(Consumer<CloneReceiptRuleSetRequest.Builder> cloneReceiptRuleSetRequest) Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CloneReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaCloneReceiptRuleSetRequest.builder()
- Parameters:
cloneReceiptRuleSetRequest
- AConsumer
that will call methods onCloneReceiptRuleSetRequest.Builder
to create a request. Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CloneReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createConfigurationSetRequest
- Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetAlreadyExistsException Indicates that the configuration set could not be created because of a naming conflict.
- InvalidConfigurationSetException Indicates that the configuration set is invalid. See the error message for details.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateConfigurationSetRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetRequest.builder()
- Parameters:
createConfigurationSetRequest
- AConsumer
that will call methods onCreateConfigurationSetRequest.Builder
to create a request. Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetAlreadyExistsException Indicates that the configuration set could not be created because of a naming conflict.
- InvalidConfigurationSetException Indicates that the configuration set is invalid. See the error message for details.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetEventDestination
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createConfigurationSetEventDestinationRequest
- Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationAlreadyExistsException Indicates that the event destination could not be created because of a naming conflict.
- InvalidCloudWatchDestinationException Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
- InvalidFirehoseDestinationException Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
- InvalidSnsDestinationException Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetEventDestination
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetEventDestinationRequest.builder()
- Parameters:
createConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onCreateConfigurationSetEventDestinationRequest.Builder
to create a request. Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationAlreadyExistsException Indicates that the event destination could not be created because of a naming conflict.
- InvalidCloudWatchDestinationException Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
- InvalidFirehoseDestinationException Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
- InvalidSnsDestinationException Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetTrackingOptions
default CompletableFuture<CreateConfigurationSetTrackingOptionsResponse> createConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest) Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
- Parameters:
createConfigurationSetTrackingOptionsRequest
- Represents a request to create an open and click tracking option object in a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsAlreadyExistsException Indicates that the configuration set you specified already contains a TrackingOptions object.
- InvalidTrackingOptionsException Indicates that the custom domain to be used for open and click
tracking redirects is invalid. This error appears most often in the following situations:
-
When the tracking domain you specified is not verified in Amazon SES.
-
When the tracking domain you specified is not a valid domain or subdomain.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetTrackingOptions
default CompletableFuture<CreateConfigurationSetTrackingOptionsResponse> createConfigurationSetTrackingOptions(Consumer<CreateConfigurationSetTrackingOptionsRequest.Builder> createConfigurationSetTrackingOptionsRequest) Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
CreateConfigurationSetTrackingOptionsRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetTrackingOptionsRequest.builder()
- Parameters:
createConfigurationSetTrackingOptionsRequest
- AConsumer
that will call methods onCreateConfigurationSetTrackingOptionsRequest.Builder
to create a request. Represents a request to create an open and click tracking option object in a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsAlreadyExistsException Indicates that the configuration set you specified already contains a TrackingOptions object.
- InvalidTrackingOptionsException Indicates that the custom domain to be used for open and click
tracking redirects is invalid. This error appears most often in the following situations:
-
When the tracking domain you specified is not verified in Amazon SES.
-
When the tracking domain you specified is not a valid domain or subdomain.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomVerificationEmailTemplate
default CompletableFuture<CreateCustomVerificationEmailTemplateResponse> createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest 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.
- Parameters:
createCustomVerificationEmailTemplateRequest
- Represents a request to create a custom verification email template.- Returns:
- A Java Future containing the result of the CreateCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateAlreadyExistsException Indicates that a custom verification email template with the name you specified already exists.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- CustomVerificationEmailInvalidContentException Indicates that custom verification email template provided content is invalid.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomVerificationEmailTemplate
default CompletableFuture<CreateCustomVerificationEmailTemplateResponse> createCustomVerificationEmailTemplate(Consumer<CreateCustomVerificationEmailTemplateRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateCustomVerificationEmailTemplateRequest.Builder
avoiding the need to create one manually viaCreateCustomVerificationEmailTemplateRequest.builder()
- Parameters:
createCustomVerificationEmailTemplateRequest
- AConsumer
that will call methods onCreateCustomVerificationEmailTemplateRequest.Builder
to create a request. Represents a request to create a custom verification email template.- Returns:
- A Java Future containing the result of the CreateCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateAlreadyExistsException Indicates that a custom verification email template with the name you specified already exists.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- CustomVerificationEmailInvalidContentException Indicates that custom verification email template provided content is invalid.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptFilter
default CompletableFuture<CreateReceiptFilterResponse> createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest) Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createReceiptFilterRequest
- Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptFilter
default CompletableFuture<CreateReceiptFilterResponse> createReceiptFilter(Consumer<CreateReceiptFilterRequest.Builder> createReceiptFilterRequest) Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateReceiptFilterRequest.Builder
avoiding the need to create one manually viaCreateReceiptFilterRequest.builder()
- Parameters:
createReceiptFilterRequest
- AConsumer
that will call methods onCreateReceiptFilterRequest.Builder
to create a request. Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptRule
default CompletableFuture<CreateReceiptRuleResponse> createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest) Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createReceiptRuleRequest
- Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidSnsTopicException Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidS3ConfigurationException Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidLambdaFunctionException Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptRule
default CompletableFuture<CreateReceiptRuleResponse> createReceiptRule(Consumer<CreateReceiptRuleRequest.Builder> createReceiptRuleRequest) Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateReceiptRuleRequest.Builder
avoiding the need to create one manually viaCreateReceiptRuleRequest.builder()
- Parameters:
createReceiptRuleRequest
- AConsumer
that will call methods onCreateReceiptRuleRequest.Builder
to create a request. Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidSnsTopicException Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidS3ConfigurationException Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidLambdaFunctionException Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptRuleSet
default CompletableFuture<CreateReceiptRuleSetResponse> createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest) Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createReceiptRuleSetRequest
- Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReceiptRuleSet
default CompletableFuture<CreateReceiptRuleSetResponse> createReceiptRuleSet(Consumer<CreateReceiptRuleSetRequest.Builder> createReceiptRuleSetRequest) Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaCreateReceiptRuleSetRequest.builder()
- Parameters:
createReceiptRuleSetRequest
- AConsumer
that will call methods onCreateReceiptRuleSetRequest.Builder
to create a request. Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest) Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
createTemplateRequest
- Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- InvalidTemplateException Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
CreateTemplateRequest.Builder
avoiding the need to create one manually viaCreateTemplateRequest.builder()
- Parameters:
createTemplateRequest
- AConsumer
that will call methods onCreateTemplateRequest.Builder
to create a request. Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException Indicates that a resource could not be created because of a naming conflict.
- InvalidTemplateException Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
deleteConfigurationSetRequest
- Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteConfigurationSetRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()
- Parameters:
deleteConfigurationSetRequest
- AConsumer
that will call methods onDeleteConfigurationSetRequest.Builder
to create a request. Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetEventDestination
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
deleteConfigurationSetEventDestinationRequest
- Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationDoesNotExistException Indicates that the event destination does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetEventDestination
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetEventDestinationRequest.builder()
- Parameters:
deleteConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onDeleteConfigurationSetEventDestinationRequest.Builder
to create a request. Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationDoesNotExistException Indicates that the event destination does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetTrackingOptions
default CompletableFuture<DeleteConfigurationSetTrackingOptionsResponse> deleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest) Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
- Parameters:
deleteConfigurationSetTrackingOptionsRequest
- Represents a request to delete open and click tracking options in a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsDoesNotExistException Indicates that the TrackingOptions object you specified does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetTrackingOptions
default CompletableFuture<DeleteConfigurationSetTrackingOptionsResponse> deleteConfigurationSetTrackingOptions(Consumer<DeleteConfigurationSetTrackingOptionsRequest.Builder> deleteConfigurationSetTrackingOptionsRequest) Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
This is a convenience which creates an instance of the
DeleteConfigurationSetTrackingOptionsRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetTrackingOptionsRequest.builder()
- Parameters:
deleteConfigurationSetTrackingOptionsRequest
- AConsumer
that will call methods onDeleteConfigurationSetTrackingOptionsRequest.Builder
to create a request. Represents a request to delete open and click tracking options in a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsDoesNotExistException Indicates that the TrackingOptions object you specified does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomVerificationEmailTemplate
default CompletableFuture<DeleteCustomVerificationEmailTemplateResponse> deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest 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.
- Parameters:
deleteCustomVerificationEmailTemplateRequest
- Represents a request to delete an existing custom verification email template.- Returns:
- A Java Future containing the result of the DeleteCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomVerificationEmailTemplate
default CompletableFuture<DeleteCustomVerificationEmailTemplateResponse> deleteCustomVerificationEmailTemplate(Consumer<DeleteCustomVerificationEmailTemplateRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteCustomVerificationEmailTemplateRequest.Builder
avoiding the need to create one manually viaDeleteCustomVerificationEmailTemplateRequest.builder()
- Parameters:
deleteCustomVerificationEmailTemplateRequest
- AConsumer
that will call methods onDeleteCustomVerificationEmailTemplateRequest.Builder
to create a request. Represents a request to delete an existing custom verification email template.- Returns:
- A Java Future containing the result of the DeleteCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentity
default CompletableFuture<DeleteIdentityResponse> deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
- Parameters:
deleteIdentityRequest
- Represents a request to delete one of your Amazon SES identities (an email address or domain).- Returns:
- A Java Future containing the result of the DeleteIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentity
default CompletableFuture<DeleteIdentityResponse> deleteIdentity(Consumer<DeleteIdentityRequest.Builder> deleteIdentityRequest) Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteIdentityRequest.Builder
avoiding the need to create one manually viaDeleteIdentityRequest.builder()
- Parameters:
deleteIdentityRequest
- AConsumer
that will call methods onDeleteIdentityRequest.Builder
to create a request. Represents a request to delete one of your Amazon SES identities (an email address or domain).- Returns:
- A Java Future containing the result of the DeleteIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentityPolicy
default CompletableFuture<DeleteIdentityPolicyResponse> deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.
This operation is for the identity owner only. If you have not verified the identity, it returns 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.
- Parameters:
deleteIdentityPolicyRequest
- Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteIdentityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentityPolicy
default CompletableFuture<DeleteIdentityPolicyResponse> deleteIdentityPolicy(Consumer<DeleteIdentityPolicyRequest.Builder> deleteIdentityPolicyRequest) Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.
This operation is for the identity owner only. If you have not verified the identity, it returns 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.
This is a convenience which creates an instance of the
DeleteIdentityPolicyRequest.Builder
avoiding the need to create one manually viaDeleteIdentityPolicyRequest.builder()
- Parameters:
deleteIdentityPolicyRequest
- AConsumer
that will call methods onDeleteIdentityPolicyRequest.Builder
to create a request. Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteIdentityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptFilter
default CompletableFuture<DeleteReceiptFilterResponse> deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest) Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
deleteReceiptFilterRequest
- Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptFilter
default CompletableFuture<DeleteReceiptFilterResponse> deleteReceiptFilter(Consumer<DeleteReceiptFilterRequest.Builder> deleteReceiptFilterRequest) Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteReceiptFilterRequest.Builder
avoiding the need to create one manually viaDeleteReceiptFilterRequest.builder()
- Parameters:
deleteReceiptFilterRequest
- AConsumer
that will call methods onDeleteReceiptFilterRequest.Builder
to create a request. Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptRule
default CompletableFuture<DeleteReceiptRuleResponse> deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest) Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
deleteReceiptRuleRequest
- Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptRule
default CompletableFuture<DeleteReceiptRuleResponse> deleteReceiptRule(Consumer<DeleteReceiptRuleRequest.Builder> deleteReceiptRuleRequest) Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteReceiptRuleRequest.Builder
avoiding the need to create one manually viaDeleteReceiptRuleRequest.builder()
- Parameters:
deleteReceiptRuleRequest
- AConsumer
that will call methods onDeleteReceiptRuleRequest.Builder
to create a request. Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptRuleSet
default CompletableFuture<DeleteReceiptRuleSetResponse> deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest) Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
deleteReceiptRuleSetRequest
- Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CannotDeleteException Indicates that the delete operation could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReceiptRuleSet
default CompletableFuture<DeleteReceiptRuleSetResponse> deleteReceiptRuleSet(Consumer<DeleteReceiptRuleSetRequest.Builder> deleteReceiptRuleSetRequest) Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaDeleteReceiptRuleSetRequest.builder()
- Parameters:
deleteReceiptRuleSetRequest
- AConsumer
that will call methods onDeleteReceiptRuleSetRequest.Builder
to create a request. Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CannotDeleteException Indicates that the delete operation could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) Deletes an email template.
You can execute this operation no more than once per second.
- Parameters:
deleteTemplateRequest
- Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) Deletes an email template.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DeleteTemplateRequest.Builder
avoiding the need to create one manually viaDeleteTemplateRequest.builder()
- Parameters:
deleteTemplateRequest
- AConsumer
that will call methods onDeleteTemplateRequest.Builder
to create a request. Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVerifiedEmailAddress
default CompletableFuture<DeleteVerifiedEmailAddressResponse> deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) Deprecated. Use the
DeleteIdentity
operation to delete email addresses and domains.- Parameters:
deleteVerifiedEmailAddressRequest
- Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.- Returns:
- A Java Future containing the result of the DeleteVerifiedEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVerifiedEmailAddress
default CompletableFuture<DeleteVerifiedEmailAddressResponse> deleteVerifiedEmailAddress(Consumer<DeleteVerifiedEmailAddressRequest.Builder> deleteVerifiedEmailAddressRequest) Deprecated. Use the
DeleteIdentity
operation to delete email addresses and domains.
This is a convenience which creates an instance of the
DeleteVerifiedEmailAddressRequest.Builder
avoiding the need to create one manually viaDeleteVerifiedEmailAddressRequest.builder()
- Parameters:
deleteVerifiedEmailAddressRequest
- AConsumer
that will call methods onDeleteVerifiedEmailAddressRequest.Builder
to create a request. Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.- Returns:
- A Java Future containing the result of the DeleteVerifiedEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActiveReceiptRuleSet
default CompletableFuture<DescribeActiveReceiptRuleSetResponse> describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
describeActiveReceiptRuleSetRequest
- Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeActiveReceiptRuleSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActiveReceiptRuleSet
default CompletableFuture<DescribeActiveReceiptRuleSetResponse> describeActiveReceiptRuleSet(Consumer<DescribeActiveReceiptRuleSetRequest.Builder> describeActiveReceiptRuleSetRequest) Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DescribeActiveReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaDescribeActiveReceiptRuleSetRequest.builder()
- Parameters:
describeActiveReceiptRuleSetRequest
- AConsumer
that will call methods onDescribeActiveReceiptRuleSetRequest.Builder
to create a request. Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeActiveReceiptRuleSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActiveReceiptRuleSet
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the DescribeActiveReceiptRuleSet operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSet
default CompletableFuture<DescribeConfigurationSetResponse> describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest) Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
describeConfigurationSetRequest
- Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSet
default CompletableFuture<DescribeConfigurationSetResponse> describeConfigurationSet(Consumer<DescribeConfigurationSetRequest.Builder> describeConfigurationSetRequest) Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DescribeConfigurationSetRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSetRequest.builder()
- Parameters:
describeConfigurationSetRequest
- AConsumer
that will call methods onDescribeConfigurationSetRequest.Builder
to create a request. Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReceiptRule
default CompletableFuture<DescribeReceiptRuleResponse> describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest) Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
describeReceiptRuleRequest
- Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReceiptRule
default CompletableFuture<DescribeReceiptRuleResponse> describeReceiptRule(Consumer<DescribeReceiptRuleRequest.Builder> describeReceiptRuleRequest) Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DescribeReceiptRuleRequest.Builder
avoiding the need to create one manually viaDescribeReceiptRuleRequest.builder()
- Parameters:
describeReceiptRuleRequest
- AConsumer
that will call methods onDescribeReceiptRuleRequest.Builder
to create a request. Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReceiptRuleSet
default CompletableFuture<DescribeReceiptRuleSetResponse> describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest) Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
describeReceiptRuleSetRequest
- Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReceiptRuleSet
default CompletableFuture<DescribeReceiptRuleSetResponse> describeReceiptRuleSet(Consumer<DescribeReceiptRuleSetRequest.Builder> describeReceiptRuleSetRequest) Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
DescribeReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaDescribeReceiptRuleSetRequest.builder()
- Parameters:
describeReceiptRuleSetRequest
- AConsumer
that will call methods onDescribeReceiptRuleSetRequest.Builder
to create a request. Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the DescribeReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountSendingEnabled
default CompletableFuture<GetAccountSendingEnabledResponse> getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest) Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
- Parameters:
getAccountSendingEnabledRequest
-- Returns:
- A Java Future containing the result of the GetAccountSendingEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountSendingEnabled
default CompletableFuture<GetAccountSendingEnabledResponse> getAccountSendingEnabled(Consumer<GetAccountSendingEnabledRequest.Builder> getAccountSendingEnabledRequest) Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
GetAccountSendingEnabledRequest.Builder
avoiding the need to create one manually viaGetAccountSendingEnabledRequest.builder()
- Parameters:
getAccountSendingEnabledRequest
- AConsumer
that will call methods onGetAccountSendingEnabledRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountSendingEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountSendingEnabled
Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the GetAccountSendingEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomVerificationEmailTemplate
default CompletableFuture<GetCustomVerificationEmailTemplateResponse> getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest 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.
- Parameters:
getCustomVerificationEmailTemplateRequest
- Represents a request to retrieve an existing custom verification email template.- Returns:
- A Java Future containing the result of the GetCustomVerificationEmailTemplate operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomVerificationEmailTemplate
default CompletableFuture<GetCustomVerificationEmailTemplateResponse> getCustomVerificationEmailTemplate(Consumer<GetCustomVerificationEmailTemplateRequest.Builder> 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.
This is a convenience which creates an instance of the
GetCustomVerificationEmailTemplateRequest.Builder
avoiding the need to create one manually viaGetCustomVerificationEmailTemplateRequest.builder()
- Parameters:
getCustomVerificationEmailTemplateRequest
- AConsumer
that will call methods onGetCustomVerificationEmailTemplateRequest.Builder
to create a request. Represents a request to retrieve an existing custom verification email template.- Returns:
- A Java Future containing the result of the GetCustomVerificationEmailTemplate operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityDkimAttributes
default CompletableFuture<GetIdentityDkimAttributesResponse> getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
-
Whether Easy DKIM signing is enabled or disabled.
-
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
-
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
- Parameters:
getIdentityDkimAttributesRequest
- Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityDkimAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getIdentityDkimAttributes
default CompletableFuture<GetIdentityDkimAttributesResponse> getIdentityDkimAttributes(Consumer<GetIdentityDkimAttributesRequest.Builder> getIdentityDkimAttributesRequest) Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
-
Whether Easy DKIM signing is enabled or disabled.
-
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
-
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
GetIdentityDkimAttributesRequest.Builder
avoiding the need to create one manually viaGetIdentityDkimAttributesRequest.builder()
- Parameters:
getIdentityDkimAttributesRequest
- AConsumer
that will call methods onGetIdentityDkimAttributesRequest.Builder
to create a request. Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityDkimAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getIdentityMailFromDomainAttributes
default CompletableFuture<GetIdentityMailFromDomainAttributesResponse> getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest) Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
- Parameters:
getIdentityMailFromDomainAttributesRequest
- Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityMailFromDomainAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityMailFromDomainAttributes
default CompletableFuture<GetIdentityMailFromDomainAttributesResponse> getIdentityMailFromDomainAttributes(Consumer<GetIdentityMailFromDomainAttributesRequest.Builder> getIdentityMailFromDomainAttributesRequest) Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
This is a convenience which creates an instance of the
GetIdentityMailFromDomainAttributesRequest.Builder
avoiding the need to create one manually viaGetIdentityMailFromDomainAttributesRequest.builder()
- Parameters:
getIdentityMailFromDomainAttributesRequest
- AConsumer
that will call methods onGetIdentityMailFromDomainAttributesRequest.Builder
to create a request. Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityMailFromDomainAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityNotificationAttributes
default CompletableFuture<GetIdentityNotificationAttributesResponse> getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
- Parameters:
getIdentityNotificationAttributesRequest
- Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityNotificationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityNotificationAttributes
default CompletableFuture<GetIdentityNotificationAttributesResponse> getIdentityNotificationAttributes(Consumer<GetIdentityNotificationAttributesRequest.Builder> getIdentityNotificationAttributesRequest) Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
GetIdentityNotificationAttributesRequest.Builder
avoiding the need to create one manually viaGetIdentityNotificationAttributesRequest.builder()
- Parameters:
getIdentityNotificationAttributesRequest
- AConsumer
that will call methods onGetIdentityNotificationAttributesRequest.Builder
to create a request. Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityNotificationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityPolicies
default CompletableFuture<GetIdentityPoliciesResponse> getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest) 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 operation is for the identity owner only. If you have not verified the identity, it returns 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.
- Parameters:
getIdentityPoliciesRequest
- Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityPolicies
default CompletableFuture<GetIdentityPoliciesResponse> getIdentityPolicies(Consumer<GetIdentityPoliciesRequest.Builder> getIdentityPoliciesRequest) 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 operation is for the identity owner only. If you have not verified the identity, it returns 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.
This is a convenience which creates an instance of the
GetIdentityPoliciesRequest.Builder
avoiding the need to create one manually viaGetIdentityPoliciesRequest.builder()
- Parameters:
getIdentityPoliciesRequest
- AConsumer
that will call methods onGetIdentityPoliciesRequest.Builder
to create a request. Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityVerificationAttributes
default CompletableFuture<GetIdentityVerificationAttributesResponse> getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
- Parameters:
getIdentityVerificationAttributesRequest
- Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityVerificationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdentityVerificationAttributes
default CompletableFuture<GetIdentityVerificationAttributesResponse> getIdentityVerificationAttributes(Consumer<GetIdentityVerificationAttributesRequest.Builder> getIdentityVerificationAttributesRequest) Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
This is a convenience which creates an instance of the
GetIdentityVerificationAttributesRequest.Builder
avoiding the need to create one manually viaGetIdentityVerificationAttributesRequest.builder()
- Parameters:
getIdentityVerificationAttributesRequest
- AConsumer
that will call methods onGetIdentityVerificationAttributesRequest.Builder
to create a request. Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the GetIdentityVerificationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendQuota
default CompletableFuture<GetSendQuotaResponse> getSendQuota(GetSendQuotaRequest getSendQuotaRequest) Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
- Parameters:
getSendQuotaRequest
-- Returns:
- A Java Future containing the result of the GetSendQuota operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendQuota
default CompletableFuture<GetSendQuotaResponse> getSendQuota(Consumer<GetSendQuotaRequest.Builder> getSendQuotaRequest) Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
GetSendQuotaRequest.Builder
avoiding the need to create one manually viaGetSendQuotaRequest.builder()
- Parameters:
getSendQuotaRequest
- AConsumer
that will call methods onGetSendQuotaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSendQuota operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendQuota
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the GetSendQuota operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendStatistics
default CompletableFuture<GetSendStatisticsResponse> getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
- Parameters:
getSendStatisticsRequest
-- Returns:
- A Java Future containing the result of the GetSendStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendStatistics
default CompletableFuture<GetSendStatisticsResponse> getSendStatistics(Consumer<GetSendStatisticsRequest.Builder> getSendStatisticsRequest) Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
GetSendStatisticsRequest.Builder
avoiding the need to create one manually viaGetSendStatisticsRequest.builder()
- Parameters:
getSendStatisticsRequest
- AConsumer
that will call methods onGetSendStatisticsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSendStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSendStatistics
Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the GetSendStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemplate
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.
- Parameters:
getTemplateRequest
-- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemplate
default CompletableFuture<GetTemplateResponse> getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) 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.
This is a convenience which creates an instance of the
GetTemplateRequest.Builder
avoiding the need to create one manually viaGetTemplateRequest.builder()
- Parameters:
getTemplateRequest
- AConsumer
that will call methods onGetTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSets
default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns
NextToken
. You can then execute theListConfigurationSets
operation again, passing theNextToken
parameter and the value of the NextToken element to retrieve additional results.- Parameters:
listConfigurationSetsRequest
- Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSets
default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns
NextToken
. You can then execute theListConfigurationSets
operation again, passing theNextToken
parameter and the value of the NextToken element to retrieve additional results.
This is a convenience which creates an instance of the
ListConfigurationSetsRequest.Builder
avoiding the need to create one manually viaListConfigurationSetsRequest.builder()
- Parameters:
listConfigurationSetsRequest
- AConsumer
that will call methods onListConfigurationSetsRequest.Builder
to create a request. Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSets
Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns
NextToken
. You can then execute theListConfigurationSets
operation again, passing theNextToken
parameter and the value of the NextToken element to retrieve additional results.- Returns:
- A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplates
default CompletableFuture<ListCustomVerificationEmailTemplatesResponse> listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest 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.
- Parameters:
listCustomVerificationEmailTemplatesRequest
- Represents a request to list the existing custom verification email templates for your account.For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
- Returns:
- A Java Future containing the result of the ListCustomVerificationEmailTemplates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplates
default CompletableFuture<ListCustomVerificationEmailTemplatesResponse> listCustomVerificationEmailTemplates(Consumer<ListCustomVerificationEmailTemplatesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCustomVerificationEmailTemplatesRequest.Builder
avoiding the need to create one manually viaListCustomVerificationEmailTemplatesRequest.builder()
- Parameters:
listCustomVerificationEmailTemplatesRequest
- AConsumer
that will call methods onListCustomVerificationEmailTemplatesRequest.Builder
to create a request. Represents a request to list the existing custom verification email templates for your account.For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
- Returns:
- A Java Future containing the result of the ListCustomVerificationEmailTemplates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplates
default CompletableFuture<ListCustomVerificationEmailTemplatesResponse> listCustomVerificationEmailTemplates()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.
- Returns:
- A Java Future containing the result of the ListCustomVerificationEmailTemplates operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplatesPaginator
default ListCustomVerificationEmailTemplatesPublisher listCustomVerificationEmailTemplatesPaginator()This is a variant of
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplatesPaginator
default ListCustomVerificationEmailTemplatesPublisher listCustomVerificationEmailTemplatesPaginator(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest) This is a variant of
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.- Parameters:
listCustomVerificationEmailTemplatesRequest
- Represents a request to list the existing custom verification email templates for your account.For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomVerificationEmailTemplatesPaginator
default ListCustomVerificationEmailTemplatesPublisher listCustomVerificationEmailTemplatesPaginator(Consumer<ListCustomVerificationEmailTemplatesRequest.Builder> listCustomVerificationEmailTemplatesRequest) This is a variant of
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListCustomVerificationEmailTemplatesPublisher publisher = client.listCustomVerificationEmailTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomVerificationEmailTemplates(software.amazon.awssdk.services.ses.model.ListCustomVerificationEmailTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListCustomVerificationEmailTemplatesRequest.Builder
avoiding the need to create one manually viaListCustomVerificationEmailTemplatesRequest.builder()
- Parameters:
listCustomVerificationEmailTemplatesRequest
- AConsumer
that will call methods onListCustomVerificationEmailTemplatesRequest.Builder
to create a request. Represents a request to list the existing custom verification email templates for your account.For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentities
default CompletableFuture<ListIdentitiesResponse> listIdentities(ListIdentitiesRequest listIdentitiesRequest) Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used
IdentityType=Domain
in the the original call and received aNextToken
in the response, you should continue providing theIdentityType=Domain
parameter for furtherNextToken
calls; however, if you didn't provide theIdentityType
parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.- Parameters:
listIdentitiesRequest
- Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.- Returns:
- A Java Future containing the result of the ListIdentities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentities
default CompletableFuture<ListIdentitiesResponse> listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used
IdentityType=Domain
in the the original call and received aNextToken
in the response, you should continue providing theIdentityType=Domain
parameter for furtherNextToken
calls; however, if you didn't provide theIdentityType
parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.
This is a convenience which creates an instance of the
ListIdentitiesRequest.Builder
avoiding the need to create one manually viaListIdentitiesRequest.builder()
- Parameters:
listIdentitiesRequest
- AConsumer
that will call methods onListIdentitiesRequest.Builder
to create a request. Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.- Returns:
- A Java Future containing the result of the ListIdentities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentities
Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used
IdentityType=Domain
in the the original call and received aNextToken
in the response, you should continue providing theIdentityType=Domain
parameter for furtherNextToken
calls; however, if you didn't provide theIdentityType
parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.- Returns:
- A Java Future containing the result of the ListIdentities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitiesPaginator
This is a variant of
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListIdentitiesResponse response) { //... }; });
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitiesPaginator
default ListIdentitiesPublisher listIdentitiesPaginator(ListIdentitiesRequest listIdentitiesRequest) This is a variant of
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListIdentitiesResponse response) { //... }; });
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.- Parameters:
listIdentitiesRequest
- Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentitiesPaginator
default ListIdentitiesPublisher listIdentitiesPaginator(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) This is a variant of
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ses.paginators.ListIdentitiesPublisher publisher = client.listIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ses.model.ListIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ses.model.ListIdentitiesResponse response) { //... }; });
Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentities(software.amazon.awssdk.services.ses.model.ListIdentitiesRequest)
operation.
This is a convenience which creates an instance of the
ListIdentitiesRequest.Builder
avoiding the need to create one manually viaListIdentitiesRequest.builder()
- Parameters:
listIdentitiesRequest
- AConsumer
that will call methods onListIdentitiesRequest.Builder
to create a request. Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentityPolicies
default CompletableFuture<ListIdentityPoliciesResponse> listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use
GetIdentityPolicies
.This operation is for the identity owner only. If you have not verified the identity, it returns 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.
- Parameters:
listIdentityPoliciesRequest
- Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListIdentityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentityPolicies
default CompletableFuture<ListIdentityPoliciesResponse> listIdentityPolicies(Consumer<ListIdentityPoliciesRequest.Builder> listIdentityPoliciesRequest) Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use
GetIdentityPolicies
.This operation is for the identity owner only. If you have not verified the identity, it returns 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.
This is a convenience which creates an instance of the
ListIdentityPoliciesRequest.Builder
avoiding the need to create one manually viaListIdentityPoliciesRequest.builder()
- Parameters:
listIdentityPoliciesRequest
- AConsumer
that will call methods onListIdentityPoliciesRequest.Builder
to create a request. Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListIdentityPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptFilters
default CompletableFuture<ListReceiptFiltersResponse> listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest) Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
listReceiptFiltersRequest
- Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListReceiptFilters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptFilters
default CompletableFuture<ListReceiptFiltersResponse> listReceiptFilters(Consumer<ListReceiptFiltersRequest.Builder> listReceiptFiltersRequest) Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
ListReceiptFiltersRequest.Builder
avoiding the need to create one manually viaListReceiptFiltersRequest.builder()
- Parameters:
listReceiptFiltersRequest
- AConsumer
that will call methods onListReceiptFiltersRequest.Builder
to create a request. Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListReceiptFilters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptFilters
Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the ListReceiptFilters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptRuleSets
default CompletableFuture<ListReceiptRuleSetsResponse> listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a
NextToken
that you can provide to the next call toListReceiptRuleSets
to retrieve the additional entries.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
listReceiptRuleSetsRequest
- Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListReceiptRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptRuleSets
default CompletableFuture<ListReceiptRuleSetsResponse> listReceiptRuleSets(Consumer<ListReceiptRuleSetsRequest.Builder> listReceiptRuleSetsRequest) Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a
NextToken
that you can provide to the next call toListReceiptRuleSets
to retrieve the additional entries.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
ListReceiptRuleSetsRequest.Builder
avoiding the need to create one manually viaListReceiptRuleSetsRequest.builder()
- Parameters:
listReceiptRuleSetsRequest
- AConsumer
that will call methods onListReceiptRuleSetsRequest.Builder
to create a request. Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ListReceiptRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReceiptRuleSets
Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a
NextToken
that you can provide to the next call toListReceiptRuleSets
to retrieve the additional entries.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the ListReceiptRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest) 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.
- Parameters:
listTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) 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.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builder
avoiding the need to create one manually viaListTemplatesRequest.builder()
- Parameters:
listTemplatesRequest
- AConsumer
that will call methods onListTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplates
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.
- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVerifiedEmailAddresses
default CompletableFuture<ListVerifiedEmailAddressesResponse> listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) Deprecated. Use the
ListIdentities
operation to list the email addresses and domains associated with your account.- Parameters:
listVerifiedEmailAddressesRequest
-- Returns:
- A Java Future containing the result of the ListVerifiedEmailAddresses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVerifiedEmailAddresses
default CompletableFuture<ListVerifiedEmailAddressesResponse> listVerifiedEmailAddresses(Consumer<ListVerifiedEmailAddressesRequest.Builder> listVerifiedEmailAddressesRequest) Deprecated. Use the
ListIdentities
operation to list the email addresses and domains associated with your account.
This is a convenience which creates an instance of the
ListVerifiedEmailAddressesRequest.Builder
avoiding the need to create one manually viaListVerifiedEmailAddressesRequest.builder()
- Parameters:
listVerifiedEmailAddressesRequest
- AConsumer
that will call methods onListVerifiedEmailAddressesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVerifiedEmailAddresses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVerifiedEmailAddresses
Deprecated. Use the
ListIdentities
operation to list the email addresses and domains associated with your account.- Returns:
- A Java Future containing the result of the ListVerifiedEmailAddresses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetDeliveryOptions
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) Adds or updates the delivery options for a configuration set.
- Parameters:
putConfigurationSetDeliveryOptionsRequest
- A request to modify the delivery options for a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetDeliveryOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- InvalidDeliveryOptionsException Indicates that provided delivery option is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetDeliveryOptions
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> putConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest) Adds or updates the delivery options for a configuration set.
This is a convenience which creates an instance of the
PutConfigurationSetDeliveryOptionsRequest.Builder
avoiding the need to create one manually viaPutConfigurationSetDeliveryOptionsRequest.builder()
- Parameters:
putConfigurationSetDeliveryOptionsRequest
- AConsumer
that will call methods onPutConfigurationSetDeliveryOptionsRequest.Builder
to create a request. A request to modify the delivery options for a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetDeliveryOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- InvalidDeliveryOptionsException Indicates that provided delivery option is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putIdentityPolicy
default CompletableFuture<PutIdentityPolicyResponse> putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This operation is for the identity owner only. If you have not verified the identity, it returns 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.
- Parameters:
putIdentityPolicyRequest
- Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the PutIdentityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidPolicyException Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putIdentityPolicy
default CompletableFuture<PutIdentityPolicyResponse> putIdentityPolicy(Consumer<PutIdentityPolicyRequest.Builder> putIdentityPolicyRequest) Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This operation is for the identity owner only. If you have not verified the identity, it returns 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.
This is a convenience which creates an instance of the
PutIdentityPolicyRequest.Builder
avoiding the need to create one manually viaPutIdentityPolicyRequest.builder()
- Parameters:
putIdentityPolicyRequest
- AConsumer
that will call methods onPutIdentityPolicyRequest.Builder
to create a request. Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the PutIdentityPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidPolicyException Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
reorderReceiptRuleSet
default CompletableFuture<ReorderReceiptRuleSetResponse> reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest) Reorders the receipt rules within a receipt rule set.
All of the rules in the rule set must be represented in this request. That is, it is error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
reorderReceiptRuleSetRequest
- Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ReorderReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
reorderReceiptRuleSet
default CompletableFuture<ReorderReceiptRuleSetResponse> reorderReceiptRuleSet(Consumer<ReorderReceiptRuleSetRequest.Builder> reorderReceiptRuleSetRequest) Reorders the receipt rules within a receipt rule set.
All of the rules in the rule set must be represented in this request. That is, it is error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
ReorderReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaReorderReceiptRuleSetRequest.builder()
- Parameters:
reorderReceiptRuleSetRequest
- AConsumer
that will call methods onReorderReceiptRuleSetRequest.Builder
to create a request. Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the ReorderReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendBounce
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.
You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
sendBounceRequest
- Represents a request to send a bounce message to the sender of an email you received through Amazon SES.- Returns:
- A Java Future containing the result of the SendBounce operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendBounce
default CompletableFuture<SendBounceResponse> sendBounce(Consumer<SendBounceRequest.Builder> sendBounceRequest) Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.
You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
SendBounceRequest.Builder
avoiding the need to create one manually viaSendBounceRequest.builder()
- Parameters:
sendBounceRequest
- AConsumer
that will call methods onSendBounceRequest.Builder
to create a request. Represents a request to send a bounce message to the sender of an email you received through Amazon SES.- Returns:
- A Java Future containing the result of the SendBounce operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendBulkTemplatedEmail
default CompletableFuture<SendBulkTemplatedEmailResponse> sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest) Composes an email message to multiple destinations. The message body is created using an email template.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using CreateTemplate.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
Each
Destination
parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid. -
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the
SendBulkTemplatedEmail
operation several times to send the message to each group. -
The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.
- Parameters:
sendBulkTemplatedEmailRequest
- Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendBulkTemplatedEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendBulkTemplatedEmail
default CompletableFuture<SendBulkTemplatedEmailResponse> sendBulkTemplatedEmail(Consumer<SendBulkTemplatedEmailRequest.Builder> sendBulkTemplatedEmailRequest) Composes an email message to multiple destinations. The message body is created using an email template.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using CreateTemplate.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
Each
Destination
parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid. -
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the
SendBulkTemplatedEmail
operation several times to send the message to each group. -
The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.
This is a convenience which creates an instance of the
SendBulkTemplatedEmailRequest.Builder
avoiding the need to create one manually viaSendBulkTemplatedEmailRequest.builder()
- Parameters:
sendBulkTemplatedEmailRequest
- AConsumer
that will call methods onSendBulkTemplatedEmailRequest.Builder
to create a request. Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendBulkTemplatedEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendCustomVerificationEmail
default CompletableFuture<SendCustomVerificationEmailResponse> sendCustomVerificationEmail(SendCustomVerificationEmailRequest 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.
- Parameters:
sendCustomVerificationEmailRequest
- Represents a request to send a custom verification email to a specified recipient.- Returns:
- A Java Future containing the result of the SendCustomVerificationEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- ProductionAccessNotGrantedException Indicates that the account has not been granted production access.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendCustomVerificationEmail
default CompletableFuture<SendCustomVerificationEmailResponse> sendCustomVerificationEmail(Consumer<SendCustomVerificationEmailRequest.Builder> 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.
This is a convenience which creates an instance of the
SendCustomVerificationEmailRequest.Builder
avoiding the need to create one manually viaSendCustomVerificationEmailRequest.builder()
- Parameters:
sendCustomVerificationEmailRequest
- AConsumer
that will call methods onSendCustomVerificationEmailRequest.Builder
to create a request. Represents a request to send a custom verification email to a specified recipient.- Returns:
- A Java Future containing the result of the SendCustomVerificationEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- ProductionAccessNotGrantedException Indicates that the account has not been granted production access.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendEmail
Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
-
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
-
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the
SendEmail
operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
- Parameters:
sendEmailRequest
- Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendEmail
default CompletableFuture<SendEmailResponse> sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest) Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
-
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
-
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the
SendEmail
operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SendEmailRequest.Builder
avoiding the need to create one manually viaSendEmailRequest.builder()
- Parameters:
sendEmailRequest
- AConsumer
that will call methods onSendEmailRequest.Builder
to create a request. Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendRawEmail
default CompletableFuture<SendRawEmailResponse> sendRawEmail(SendRawEmailRequest sendRawEmailRequest) Composes an email message and immediately queues it for sending.
This operation is more flexible than the
SendEmail
operation. When you use theSendRawEmail
operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.The
SendRawEmail
operation has the following requirements:-
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.
-
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
-
The maximum message size, including attachments, is 10 MB.
-
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
-
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
-
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
-
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the
SendRawEmail
operation:-
Although you can customize the message headers when using the
SendRawEmail
operation, Amazon SES automatically applies its ownMessage-ID
andDate
headers; if you passed these headers when creating the message, they are overwritten by the values that Amazon SES provides. -
If you are using sending authorization to send on behalf of another user,
SendRawEmail
enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parametersSourceArn
,FromArn
, and/orReturnPathArn
, or you can include the following X-headers in the header of your raw email:-
X-SES-SOURCE-ARN
-
X-SES-FROM-ARN
-
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the
SourceIdentityArn
parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
-
-
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
- Parameters:
sendRawEmailRequest
- Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendRawEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendRawEmail
default CompletableFuture<SendRawEmailResponse> sendRawEmail(Consumer<SendRawEmailRequest.Builder> sendRawEmailRequest) Composes an email message and immediately queues it for sending.
This operation is more flexible than the
SendEmail
operation. When you use theSendRawEmail
operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.The
SendRawEmail
operation has the following requirements:-
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.
-
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
-
The maximum message size, including attachments, is 10 MB.
-
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
-
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
-
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
-
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the
SendRawEmail
operation:-
Although you can customize the message headers when using the
SendRawEmail
operation, Amazon SES automatically applies its ownMessage-ID
andDate
headers; if you passed these headers when creating the message, they are overwritten by the values that Amazon SES provides. -
If you are using sending authorization to send on behalf of another user,
SendRawEmail
enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parametersSourceArn
,FromArn
, and/orReturnPathArn
, or you can include the following X-headers in the header of your raw email:-
X-SES-SOURCE-ARN
-
X-SES-FROM-ARN
-
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the
SourceIdentityArn
parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
-
-
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SendRawEmailRequest.Builder
avoiding the need to create one manually viaSendRawEmailRequest.builder()
- Parameters:
sendRawEmailRequest
- AConsumer
that will call methods onSendRawEmailRequest.Builder
to create a request. Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendRawEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendTemplatedEmail
default CompletableFuture<SendTemplatedEmailResponse> sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest) Composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
Calls to the
SendTemplatedEmail
operation may only include oneDestination
parameter. A destination is a set of recipients that receives the same version of the email. TheDestination
parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. -
The
Destination
parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
If your call to the
SendTemplatedEmail
operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
- Parameters:
sendTemplatedEmailRequest
- Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendTemplatedEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendTemplatedEmail
default CompletableFuture<SendTemplatedEmailResponse> sendTemplatedEmail(Consumer<SendTemplatedEmailRequest.Builder> sendTemplatedEmailRequest) Composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
-
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
-
The message must be sent from a verified email address or domain.
-
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
-
The maximum message size is 10 MB.
-
Calls to the
SendTemplatedEmail
operation may only include oneDestination
parameter. A destination is a set of recipients that receives the same version of the email. TheDestination
parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. -
The
Destination
parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
If your call to the
SendTemplatedEmail
operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
This is a convenience which creates an instance of the
SendTemplatedEmailRequest.Builder
avoiding the need to create one manually viaSendTemplatedEmailRequest.builder()
- Parameters:
sendTemplatedEmailRequest
- AConsumer
that will call methods onSendTemplatedEmailRequest.Builder
to create a request. Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SendTemplatedEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MessageRejectedException Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
- MailFromDomainNotVerifiedException Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- ConfigurationSetSendingPausedException Indicates that email sending is disabled for the configuration
set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
- AccountSendingPausedException Indicates that email sending is disabled for your entire Amazon SES
account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
setActiveReceiptRuleSet
default CompletableFuture<SetActiveReceiptRuleSetResponse> setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this operation with
RuleSetName
set to null.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
setActiveReceiptRuleSetRequest
- Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetActiveReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setActiveReceiptRuleSet
default CompletableFuture<SetActiveReceiptRuleSetResponse> setActiveReceiptRuleSet(Consumer<SetActiveReceiptRuleSetRequest.Builder> setActiveReceiptRuleSetRequest) Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this operation with
RuleSetName
set to null.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
SetActiveReceiptRuleSetRequest.Builder
avoiding the need to create one manually viaSetActiveReceiptRuleSetRequest.builder()
- Parameters:
setActiveReceiptRuleSetRequest
- AConsumer
that will call methods onSetActiveReceiptRuleSetRequest.Builder
to create a request. Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetActiveReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setActiveReceiptRuleSet
Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this operation with
RuleSetName
set to null.For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Returns:
- A Java Future containing the result of the SetActiveReceiptRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityDkimEnabled
default CompletableFuture<SetIdentityDkimEnabledResponse> setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example,
user@example.com
), you can only enable DKIM signing if the corresponding domain (in this case,example.com
) has been set up to use Easy DKIM.You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
- Parameters:
setIdentityDkimEnabledRequest
- Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityDkimEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityDkimEnabled
default CompletableFuture<SetIdentityDkimEnabledResponse> setIdentityDkimEnabled(Consumer<SetIdentityDkimEnabledRequest.Builder> setIdentityDkimEnabledRequest) Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example,
user@example.com
), you can only enable DKIM signing if the corresponding domain (in this case,example.com
) has been set up to use Easy DKIM.You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SetIdentityDkimEnabledRequest.Builder
avoiding the need to create one manually viaSetIdentityDkimEnabledRequest.builder()
- Parameters:
setIdentityDkimEnabledRequest
- AConsumer
that will call methods onSetIdentityDkimEnabledRequest.Builder
to create a request. Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityDkimEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityFeedbackForwardingEnabled
default CompletableFuture<SetIdentityFeedbackForwardingEnabledResponse> setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
- Parameters:
setIdentityFeedbackForwardingEnabledRequest
- Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityFeedbackForwardingEnabled operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityFeedbackForwardingEnabled
default CompletableFuture<SetIdentityFeedbackForwardingEnabledResponse> setIdentityFeedbackForwardingEnabled(Consumer<SetIdentityFeedbackForwardingEnabledRequest.Builder> setIdentityFeedbackForwardingEnabledRequest) Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SetIdentityFeedbackForwardingEnabledRequest.Builder
avoiding the need to create one manually viaSetIdentityFeedbackForwardingEnabledRequest.builder()
- Parameters:
setIdentityFeedbackForwardingEnabledRequest
- AConsumer
that will call methods onSetIdentityFeedbackForwardingEnabledRequest.Builder
to create a request. Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityFeedbackForwardingEnabled operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityHeadersInNotificationsEnabled
default CompletableFuture<SetIdentityHeadersInNotificationsEnabledResponse> setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest) Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
- Parameters:
setIdentityHeadersInNotificationsEnabledRequest
- Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityHeadersInNotificationsEnabled operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityHeadersInNotificationsEnabled
default CompletableFuture<SetIdentityHeadersInNotificationsEnabledResponse> setIdentityHeadersInNotificationsEnabled(Consumer<SetIdentityHeadersInNotificationsEnabledRequest.Builder> setIdentityHeadersInNotificationsEnabledRequest) Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SetIdentityHeadersInNotificationsEnabledRequest.Builder
avoiding the need to create one manually viaSetIdentityHeadersInNotificationsEnabledRequest.builder()
- Parameters:
setIdentityHeadersInNotificationsEnabledRequest
- AConsumer
that will call methods onSetIdentityHeadersInNotificationsEnabledRequest.Builder
to create a request. Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityHeadersInNotificationsEnabled operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityMailFromDomain
default CompletableFuture<SetIdentityMailFromDomainResponse> setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest) Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
setIdentityMailFromDomainRequest
- Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityMailFromDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityMailFromDomain
default CompletableFuture<SetIdentityMailFromDomainResponse> setIdentityMailFromDomain(Consumer<SetIdentityMailFromDomainRequest.Builder> setIdentityMailFromDomainRequest) Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
SetIdentityMailFromDomainRequest.Builder
avoiding the need to create one manually viaSetIdentityMailFromDomainRequest.builder()
- Parameters:
setIdentityMailFromDomainRequest
- AConsumer
that will call methods onSetIdentityMailFromDomainRequest.Builder
to create a request. Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityMailFromDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityNotificationTopic
default CompletableFuture<SetIdentityNotificationTopicResponse> setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
- Parameters:
setIdentityNotificationTopicRequest
- Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityNotificationTopic operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setIdentityNotificationTopic
default CompletableFuture<SetIdentityNotificationTopicResponse> setIdentityNotificationTopic(Consumer<SetIdentityNotificationTopicRequest.Builder> setIdentityNotificationTopicRequest) Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
SetIdentityNotificationTopicRequest.Builder
avoiding the need to create one manually viaSetIdentityNotificationTopicRequest.builder()
- Parameters:
setIdentityNotificationTopicRequest
- AConsumer
that will call methods onSetIdentityNotificationTopicRequest.Builder
to create a request. Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetIdentityNotificationTopic operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setReceiptRulePosition
default CompletableFuture<SetReceiptRulePositionResponse> setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest) Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
setReceiptRulePositionRequest
- Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetReceiptRulePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setReceiptRulePosition
default CompletableFuture<SetReceiptRulePositionResponse> setReceiptRulePosition(Consumer<SetReceiptRulePositionRequest.Builder> setReceiptRulePositionRequest) Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
SetReceiptRulePositionRequest.Builder
avoiding the need to create one manually viaSetReceiptRulePositionRequest.builder()
- Parameters:
setReceiptRulePositionRequest
- AConsumer
that will call methods onSetReceiptRulePositionRequest.Builder
to create a request. Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the SetReceiptRulePosition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testRenderTemplate
default CompletableFuture<TestRenderTemplateResponse> testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest) 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.
- Parameters:
testRenderTemplateRequest
-- Returns:
- A Java Future containing the result of the TestRenderTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- InvalidRenderingParameterException Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
- MissingRenderingAttributeException Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testRenderTemplate
default CompletableFuture<TestRenderTemplateResponse> testRenderTemplate(Consumer<TestRenderTemplateRequest.Builder> testRenderTemplateRequest) 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.
This is a convenience which creates an instance of the
TestRenderTemplateRequest.Builder
avoiding the need to create one manually viaTestRenderTemplateRequest.builder()
- Parameters:
testRenderTemplateRequest
- AConsumer
that will call methods onTestRenderTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestRenderTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- InvalidRenderingParameterException Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
- MissingRenderingAttributeException Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountSendingEnabled
default CompletableFuture<UpdateAccountSendingEnabledResponse> updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest) Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
- Parameters:
updateAccountSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.- Returns:
- A Java Future containing the result of the UpdateAccountSendingEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountSendingEnabled
default CompletableFuture<UpdateAccountSendingEnabledResponse> updateAccountSendingEnabled(Consumer<UpdateAccountSendingEnabledRequest.Builder> updateAccountSendingEnabledRequest) Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateAccountSendingEnabledRequest.Builder
avoiding the need to create one manually viaUpdateAccountSendingEnabledRequest.builder()
- Parameters:
updateAccountSendingEnabledRequest
- AConsumer
that will call methods onUpdateAccountSendingEnabledRequest.Builder
to create a request. Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.- Returns:
- A Java Future containing the result of the UpdateAccountSendingEnabled operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetEventDestination
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
- Parameters:
updateConfigurationSetEventDestinationRequest
- Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationDoesNotExistException Indicates that the event destination does not exist.
- InvalidCloudWatchDestinationException Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
- InvalidFirehoseDestinationException Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
- InvalidSnsDestinationException Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetEventDestination
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationSetEventDestinationRequest.builder()
- Parameters:
updateConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onUpdateConfigurationSetEventDestinationRequest.Builder
to create a request. Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- EventDestinationDoesNotExistException Indicates that the event destination does not exist.
- InvalidCloudWatchDestinationException Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
- InvalidFirehoseDestinationException Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
- InvalidSnsDestinationException Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetReputationMetricsEnabled
default CompletableFuture<UpdateConfigurationSetReputationMetricsEnabledResponse> updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest) Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
- Parameters:
updateConfigurationSetReputationMetricsEnabledRequest
- Represents a request to modify the reputation metric publishing settings for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetReputationMetricsEnabled operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetReputationMetricsEnabled
default CompletableFuture<UpdateConfigurationSetReputationMetricsEnabledResponse> updateConfigurationSetReputationMetricsEnabled(Consumer<UpdateConfigurationSetReputationMetricsEnabledRequest.Builder> updateConfigurationSetReputationMetricsEnabledRequest) Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateConfigurationSetReputationMetricsEnabledRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationSetReputationMetricsEnabledRequest.builder()
- Parameters:
updateConfigurationSetReputationMetricsEnabledRequest
- AConsumer
that will call methods onUpdateConfigurationSetReputationMetricsEnabledRequest.Builder
to create a request. Represents a request to modify the reputation metric publishing settings for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetReputationMetricsEnabled operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetSendingEnabled
default CompletableFuture<UpdateConfigurationSetSendingEnabledResponse> updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest) Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
- Parameters:
updateConfigurationSetSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for a specific configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetSendingEnabled operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetSendingEnabled
default CompletableFuture<UpdateConfigurationSetSendingEnabledResponse> updateConfigurationSetSendingEnabled(Consumer<UpdateConfigurationSetSendingEnabledRequest.Builder> updateConfigurationSetSendingEnabledRequest) Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateConfigurationSetSendingEnabledRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationSetSendingEnabledRequest.builder()
- Parameters:
updateConfigurationSetSendingEnabledRequest
- AConsumer
that will call methods onUpdateConfigurationSetSendingEnabledRequest.Builder
to create a request. Represents a request to enable or disable the email sending capabilities for a specific configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetSendingEnabled operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetTrackingOptions
default CompletableFuture<UpdateConfigurationSetTrackingOptionsResponse> updateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest) Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
- Parameters:
updateConfigurationSetTrackingOptionsRequest
- Represents a request to update the tracking options for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsDoesNotExistException Indicates that the TrackingOptions object you specified does not exist.
- InvalidTrackingOptionsException Indicates that the custom domain to be used for open and click
tracking redirects is invalid. This error appears most often in the following situations:
-
When the tracking domain you specified is not verified in Amazon SES.
-
When the tracking domain you specified is not a valid domain or subdomain.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetTrackingOptions
default CompletableFuture<UpdateConfigurationSetTrackingOptionsResponse> updateConfigurationSetTrackingOptions(Consumer<UpdateConfigurationSetTrackingOptionsRequest.Builder> updateConfigurationSetTrackingOptionsRequest) Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
This is a convenience which creates an instance of the
UpdateConfigurationSetTrackingOptionsRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationSetTrackingOptionsRequest.builder()
- Parameters:
updateConfigurationSetTrackingOptionsRequest
- AConsumer
that will call methods onUpdateConfigurationSetTrackingOptionsRequest.Builder
to create a request. Represents a request to update the tracking options for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetTrackingOptions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConfigurationSetDoesNotExistException Indicates that the configuration set does not exist.
- TrackingOptionsDoesNotExistException Indicates that the TrackingOptions object you specified does not exist.
- InvalidTrackingOptionsException Indicates that the custom domain to be used for open and click
tracking redirects is invalid. This error appears most often in the following situations:
-
When the tracking domain you specified is not verified in Amazon SES.
-
When the tracking domain you specified is not a valid domain or subdomain.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomVerificationEmailTemplate
default CompletableFuture<UpdateCustomVerificationEmailTemplateResponse> updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest 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.
- Parameters:
updateCustomVerificationEmailTemplateRequest
- Represents a request to update an existing custom verification email template.- Returns:
- A Java Future containing the result of the UpdateCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- CustomVerificationEmailInvalidContentException Indicates that custom verification email template provided content is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomVerificationEmailTemplate
default CompletableFuture<UpdateCustomVerificationEmailTemplateResponse> updateCustomVerificationEmailTemplate(Consumer<UpdateCustomVerificationEmailTemplateRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateCustomVerificationEmailTemplateRequest.Builder
avoiding the need to create one manually viaUpdateCustomVerificationEmailTemplateRequest.builder()
- Parameters:
updateCustomVerificationEmailTemplateRequest
- AConsumer
that will call methods onUpdateCustomVerificationEmailTemplateRequest.Builder
to create a request. Represents a request to update an existing custom verification email template.- Returns:
- A Java Future containing the result of the UpdateCustomVerificationEmailTemplate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CustomVerificationEmailTemplateDoesNotExistException Indicates that a custom verification email template with the name you specified does not exist.
- FromEmailAddressNotVerifiedException Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
- CustomVerificationEmailInvalidContentException Indicates that custom verification email template provided content is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReceiptRule
default CompletableFuture<UpdateReceiptRuleResponse> updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest) Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
updateReceiptRuleRequest
- Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the UpdateReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidSnsTopicException Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidS3ConfigurationException Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidLambdaFunctionException Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReceiptRule
default CompletableFuture<UpdateReceiptRuleResponse> updateReceiptRule(Consumer<UpdateReceiptRuleRequest.Builder> updateReceiptRuleRequest) Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateReceiptRuleRequest.Builder
avoiding the need to create one manually viaUpdateReceiptRuleRequest.builder()
- Parameters:
updateReceiptRuleRequest
- AConsumer
that will call methods onUpdateReceiptRuleRequest.Builder
to create a request. Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the UpdateReceiptRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidSnsTopicException Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidS3ConfigurationException Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- InvalidLambdaFunctionException Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
- RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.
- RuleDoesNotExistException Indicates that the provided receipt rule does not exist.
- LimitExceededException Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest) Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
updateTemplateRequest
-- Returns:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- InvalidTemplateException Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
UpdateTemplateRequest.Builder
avoiding the need to create one manually viaUpdateTemplateRequest.builder()
- Parameters:
updateTemplateRequest
- AConsumer
that will call methods onUpdateTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TemplateDoesNotExistException Indicates that the Template object you specified does not exist in your Amazon SES account.
- InvalidTemplateException Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyDomainDkim
default CompletableFuture<VerifyDomainDkimResponse> verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain identity.
When you execute the
VerifyDomainDkim
operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using theVerifyDomainIdentity
operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
-
Name: token._domainkey.example.com
-
Type: CNAME
-
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
- Parameters:
verifyDomainDkimRequest
- Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyDomainDkim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
verifyDomainDkim
default CompletableFuture<VerifyDomainDkimResponse> verifyDomainDkim(Consumer<VerifyDomainDkimRequest.Builder> verifyDomainDkimRequest) Returns a set of DKIM tokens for a domain identity.
When you execute the
VerifyDomainDkim
operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using theVerifyDomainIdentity
operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
-
Name: token._domainkey.example.com
-
Type: CNAME
-
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
VerifyDomainDkimRequest.Builder
avoiding the need to create one manually viaVerifyDomainDkimRequest.builder()
- Parameters:
verifyDomainDkimRequest
- AConsumer
that will call methods onVerifyDomainDkimRequest.Builder
to create a request. Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyDomainDkim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
verifyDomainIdentity
default CompletableFuture<VerifyDomainIdentityResponse> verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
- Parameters:
verifyDomainIdentityRequest
- Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyDomainIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyDomainIdentity
default CompletableFuture<VerifyDomainIdentityResponse> verifyDomainIdentity(Consumer<VerifyDomainIdentityRequest.Builder> verifyDomainIdentityRequest) Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
VerifyDomainIdentityRequest.Builder
avoiding the need to create one manually viaVerifyDomainIdentityRequest.builder()
- Parameters:
verifyDomainIdentityRequest
- AConsumer
that will call methods onVerifyDomainIdentityRequest.Builder
to create a request. Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyDomainIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyEmailAddress
default CompletableFuture<VerifyEmailAddressResponse> verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) Deprecated. Use the
VerifyEmailIdentity
operation to verify a new email address.- Parameters:
verifyEmailAddressRequest
- Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyEmailAddress
default CompletableFuture<VerifyEmailAddressResponse> verifyEmailAddress(Consumer<VerifyEmailAddressRequest.Builder> verifyEmailAddressRequest) Deprecated. Use the
VerifyEmailIdentity
operation to verify a new email address.
This is a convenience which creates an instance of the
VerifyEmailAddressRequest.Builder
avoiding the need to create one manually viaVerifyEmailAddressRequest.builder()
- Parameters:
verifyEmailAddressRequest
- AConsumer
that will call methods onVerifyEmailAddressRequest.Builder
to create a request. Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyEmailAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyEmailIdentity
default CompletableFuture<VerifyEmailIdentityResponse> verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) 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 verification email is sent to the specified address.
You can execute this operation no more than once per second.
- Parameters:
verifyEmailIdentityRequest
- Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyEmailIdentity
default CompletableFuture<VerifyEmailIdentityResponse> verifyEmailIdentity(Consumer<VerifyEmailIdentityRequest.Builder> verifyEmailIdentityRequest) 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 verification email is sent to the specified address.
You can execute this operation no more than once per second.
This is a convenience which creates an instance of the
VerifyEmailIdentityRequest.Builder
avoiding the need to create one manually viaVerifyEmailIdentityRequest.builder()
- Parameters:
verifyEmailIdentityRequest
- AConsumer
that will call methods onVerifyEmailIdentityRequest.Builder
to create a request. Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.- Returns:
- A Java Future containing the result of the VerifyEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofSesAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
SesAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSesAsyncClient
.
-