@Generated(value="software.amazon.awssdk:codegen") public interface SESClient extends SdkClient, SdkAutoCloseable
builder()
method.
This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SESClientBuilder |
builder()
Create a builder that can be used to configure and create a
SESClient . |
default CloneReceiptRuleSetResponse |
cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one.
|
default CloneReceiptRuleSetResponse |
cloneReceiptRuleSet(Consumer<CloneReceiptRuleSetRequest.Builder> cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one.
|
static SESClient |
create()
Create a
SESClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CreateConfigurationSetResponse |
createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)
Creates a configuration set.
|
default CreateConfigurationSetResponse |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Creates a configuration set.
|
default CreateConfigurationSetEventDestinationResponse |
createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)
Creates a configuration set event destination.
|
default CreateConfigurationSetEventDestinationResponse |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Creates a configuration set event destination.
|
default CreateConfigurationSetTrackingOptionsResponse |
createConfigurationSetTrackingOptions(Consumer<CreateConfigurationSetTrackingOptionsRequest.Builder> createConfigurationSetTrackingOptionsRequest)
Creates an association between a configuration set and a custom domain for open and click event tracking.
|
default CreateConfigurationSetTrackingOptionsResponse |
createConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest)
Creates an association between a configuration set and a custom domain for open and click event tracking.
|
default CreateReceiptFilterResponse |
createReceiptFilter(Consumer<CreateReceiptFilterRequest.Builder> createReceiptFilterRequest)
Creates a new IP address filter.
|
default CreateReceiptFilterResponse |
createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
|
default CreateReceiptRuleResponse |
createReceiptRule(Consumer<CreateReceiptRuleRequest.Builder> createReceiptRuleRequest)
Creates a receipt rule.
|
default CreateReceiptRuleResponse |
createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
|
default CreateReceiptRuleSetResponse |
createReceiptRuleSet(Consumer<CreateReceiptRuleSetRequest.Builder> createReceiptRuleSetRequest)
Creates an empty receipt rule set.
|
default CreateReceiptRuleSetResponse |
createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
|
default CreateTemplateResponse |
createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates an email template.
|
default CreateTemplateResponse |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates an email template.
|
default DeleteConfigurationSetResponse |
deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)
Deletes a configuration set.
|
default DeleteConfigurationSetResponse |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Deletes a configuration set.
|
default DeleteConfigurationSetEventDestinationResponse |
deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)
Deletes a configuration set event destination.
|
default DeleteConfigurationSetEventDestinationResponse |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Deletes a configuration set event destination.
|
default DeleteConfigurationSetTrackingOptionsResponse |
deleteConfigurationSetTrackingOptions(Consumer<DeleteConfigurationSetTrackingOptionsRequest.Builder> deleteConfigurationSetTrackingOptionsRequest)
Deletes an association between a configuration set and a custom domain for open and click event tracking.
|
default DeleteConfigurationSetTrackingOptionsResponse |
deleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest)
Deletes an association between a configuration set and a custom domain for open and click event tracking.
|
default DeleteIdentityResponse |
deleteIdentity(Consumer<DeleteIdentityRequest.Builder> deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
|
default DeleteIdentityResponse |
deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
|
default DeleteIdentityPolicyResponse |
deleteIdentityPolicy(Consumer<DeleteIdentityPolicyRequest.Builder> deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
default DeleteIdentityPolicyResponse |
deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
default DeleteReceiptFilterResponse |
deleteReceiptFilter(Consumer<DeleteReceiptFilterRequest.Builder> deleteReceiptFilterRequest)
Deletes the specified IP address filter.
|
default DeleteReceiptFilterResponse |
deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
|
default DeleteReceiptRuleResponse |
deleteReceiptRule(Consumer<DeleteReceiptRuleRequest.Builder> deleteReceiptRuleRequest)
Deletes the specified receipt rule.
|
default DeleteReceiptRuleResponse |
deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
|
default DeleteReceiptRuleSetResponse |
deleteReceiptRuleSet(Consumer<DeleteReceiptRuleSetRequest.Builder> deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
|
default DeleteReceiptRuleSetResponse |
deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
|
default DeleteTemplateResponse |
deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
Deletes an email template.
|
default DeleteTemplateResponse |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes an email template.
|
default DeleteVerifiedEmailAddressResponse |
deleteVerifiedEmailAddress(Consumer<DeleteVerifiedEmailAddressRequest.Builder> deleteVerifiedEmailAddressRequest)
Deprecated.
|
default DeleteVerifiedEmailAddressResponse |
deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deprecated.
|
default DescribeActiveReceiptRuleSetResponse |
describeActiveReceiptRuleSet()
Returns the metadata and receipt rules for the receipt rule set that is currently active.
|
default DescribeActiveReceiptRuleSetResponse |
describeActiveReceiptRuleSet(Consumer<DescribeActiveReceiptRuleSetRequest.Builder> describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is currently active.
|
default DescribeActiveReceiptRuleSetResponse |
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is currently active.
|
default DescribeConfigurationSetResponse |
describeConfigurationSet(Consumer<DescribeConfigurationSetRequest.Builder> describeConfigurationSetRequest)
Returns the details of the specified configuration set.
|
default DescribeConfigurationSetResponse |
describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
Returns the details of the specified configuration set.
|
default DescribeReceiptRuleResponse |
describeReceiptRule(Consumer<DescribeReceiptRuleRequest.Builder> describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
|
default DescribeReceiptRuleResponse |
describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
|
default DescribeReceiptRuleSetResponse |
describeReceiptRuleSet(Consumer<DescribeReceiptRuleSetRequest.Builder> describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
|
default DescribeReceiptRuleSetResponse |
describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
|
default GetAccountSendingEnabledResponse |
getAccountSendingEnabled()
Returns the email sending status of the Amazon SES account.
|
default GetAccountSendingEnabledResponse |
getAccountSendingEnabled(Consumer<GetAccountSendingEnabledRequest.Builder> getAccountSendingEnabledRequest)
Returns the email sending status of the Amazon SES account.
|
default GetAccountSendingEnabledResponse |
getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest)
Returns the email sending status of the Amazon SES account.
|
default GetIdentityDkimAttributesResponse |
getIdentityDkimAttributes(Consumer<GetIdentityDkimAttributesRequest.Builder> getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity.
|
default GetIdentityDkimAttributesResponse |
getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity.
|
default GetIdentityMailFromDomainAttributesResponse |
getIdentityMailFromDomainAttributes(Consumer<GetIdentityMailFromDomainAttributesRequest.Builder> getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
|
default GetIdentityMailFromDomainAttributesResponse |
getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
|
default GetIdentityNotificationAttributesResponse |
getIdentityNotificationAttributes(Consumer<GetIdentityNotificationAttributesRequest.Builder> getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity
notification attributes.
|
default GetIdentityNotificationAttributesResponse |
getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity
notification attributes.
|
default GetIdentityPoliciesResponse |
getIdentityPolicies(Consumer<GetIdentityPoliciesRequest.Builder> getIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
default GetIdentityPoliciesResponse |
getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
default 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.
|
default 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.
|
default GetSendQuotaResponse |
getSendQuota()
Provides the sending limits for the Amazon SES account.
|
default GetSendQuotaResponse |
getSendQuota(Consumer<GetSendQuotaRequest.Builder> getSendQuotaRequest)
Provides the sending limits for the Amazon SES account.
|
default GetSendQuotaResponse |
getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Provides the sending limits for the Amazon SES account.
|
default GetSendStatisticsResponse |
getSendStatistics()
Provides sending statistics for the Amazon SES account.
|
default GetSendStatisticsResponse |
getSendStatistics(Consumer<GetSendStatisticsRequest.Builder> getSendStatisticsRequest)
Provides sending statistics for the Amazon SES account.
|
default GetSendStatisticsResponse |
getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Provides sending statistics for the Amazon SES account.
|
default 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 GetTemplateResponse |
getTemplate(GetTemplateRequest getTemplateRequest)
Displays the template object (which includes the Subject line, HTML part and text part) for the template you
specify.
|
default ListConfigurationSetsResponse |
listConfigurationSets()
Provides a list of the configuration sets associated with your Amazon SES account.
|
default ListConfigurationSetsResponse |
listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)
Provides a list of the configuration sets associated with your Amazon SES account.
|
default ListConfigurationSetsResponse |
listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
Provides a list of the configuration sets associated with your Amazon SES account.
|
default ListIdentitiesResponse |
listIdentities()
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of
verification status.
|
default ListIdentitiesResponse |
listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of
verification status.
|
default ListIdentitiesResponse |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of
verification status.
|
default 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).
|
default ListIdentityPoliciesResponse |
listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain).
|
default ListReceiptFiltersResponse |
listReceiptFilters()
Lists the IP address filters associated with your AWS account.
|
default ListReceiptFiltersResponse |
listReceiptFilters(Consumer<ListReceiptFiltersRequest.Builder> listReceiptFiltersRequest)
Lists the IP address filters associated with your AWS account.
|
default ListReceiptFiltersResponse |
listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your AWS account.
|
default ListReceiptRuleSetsResponse |
listReceiptRuleSets()
Lists the receipt rule sets that exist under your AWS account.
|
default ListReceiptRuleSetsResponse |
listReceiptRuleSets(Consumer<ListReceiptRuleSetsRequest.Builder> listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account.
|
default ListReceiptRuleSetsResponse |
listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account.
|
default ListTemplatesResponse |
listTemplates()
Lists the email templates present in your Amazon SES account.
|
default ListTemplatesResponse |
listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
Lists the email templates present in your Amazon SES account.
|
default ListTemplatesResponse |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists the email templates present in your Amazon SES account.
|
default ListVerifiedEmailAddressesResponse |
listVerifiedEmailAddresses()
Deprecated.
|
default ListVerifiedEmailAddressesResponse |
listVerifiedEmailAddresses(Consumer<ListVerifiedEmailAddressesRequest.Builder> listVerifiedEmailAddressesRequest)
Deprecated.
|
default ListVerifiedEmailAddressesResponse |
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Deprecated.
|
default PutIdentityPolicyResponse |
putIdentityPolicy(Consumer<PutIdentityPolicyRequest.Builder> putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
|
default PutIdentityPolicyResponse |
putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
|
default ReorderReceiptRuleSetResponse |
reorderReceiptRuleSet(Consumer<ReorderReceiptRuleSetRequest.Builder> reorderReceiptRuleSetRequest)
Reorders the receipt rules within a receipt rule set.
|
default ReorderReceiptRuleSetResponse |
reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
Reorders the receipt rules within a receipt rule set.
|
default SendBounceResponse |
sendBounce(Consumer<SendBounceRequest.Builder> sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
|
default SendBounceResponse |
sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
|
default SendBulkTemplatedEmailResponse |
sendBulkTemplatedEmail(Consumer<SendBulkTemplatedEmailRequest.Builder> sendBulkTemplatedEmailRequest)
Composes an email message to multiple destinations.
|
default SendBulkTemplatedEmailResponse |
sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest)
Composes an email message to multiple destinations.
|
default SendEmailResponse |
sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest)
Composes an email message and immediately queues it for sending.
|
default SendEmailResponse |
sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message and immediately queues it for sending.
|
default SendRawEmailResponse |
sendRawEmail(Consumer<SendRawEmailRequest.Builder> sendRawEmailRequest)
Composes an email message and immediately queues it for sending.
|
default SendRawEmailResponse |
sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Composes an email message and immediately queues it for sending.
|
default SendTemplatedEmailResponse |
sendTemplatedEmail(Consumer<SendTemplatedEmailRequest.Builder> sendTemplatedEmailRequest)
Composes an email message using an email template and immediately queues it for sending.
|
default SendTemplatedEmailResponse |
sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest)
Composes an email message using an email template and immediately queues it for sending.
|
static ServiceMetadata |
serviceMetadata() |
default SetActiveReceiptRuleSetResponse |
setActiveReceiptRuleSet()
Sets the specified receipt rule set as the active receipt rule set.
|
default SetActiveReceiptRuleSetResponse |
setActiveReceiptRuleSet(Consumer<SetActiveReceiptRuleSetRequest.Builder> setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active receipt rule set.
|
default SetActiveReceiptRuleSetResponse |
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active receipt rule set.
|
default SetIdentityDkimEnabledResponse |
setIdentityDkimEnabled(Consumer<SetIdentityDkimEnabledRequest.Builder> setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity:
|
default SetIdentityDkimEnabledResponse |
setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity:
|
default 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.
|
default 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.
|
default 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.
|
default 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.
|
default 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).
|
default SetIdentityMailFromDomainResponse |
setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
|
default SetIdentityNotificationTopicResponse |
setIdentityNotificationTopic(Consumer<SetIdentityNotificationTopicRequest.Builder> setIdentityNotificationTopicRequest)
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the
Source . |
default SetIdentityNotificationTopicResponse |
setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the
Source . |
default SetReceiptRulePositionResponse |
setReceiptRulePosition(Consumer<SetReceiptRulePositionRequest.Builder> setReceiptRulePositionRequest)
Sets the position of the specified receipt rule in the receipt rule set.
|
default SetReceiptRulePositionResponse |
setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
Sets the position of the specified receipt rule in the receipt rule set.
|
default 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.
|
default 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.
|
default UpdateAccountSendingEnabledResponse |
updateAccountSendingEnabled(Consumer<UpdateAccountSendingEnabledRequest.Builder> updateAccountSendingEnabledRequest)
Enables or disables email sending across your entire Amazon SES account.
|
default UpdateAccountSendingEnabledResponse |
updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest)
Enables or disables email sending across your entire Amazon SES account.
|
default UpdateConfigurationSetEventDestinationResponse |
updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set.
|
default UpdateConfigurationSetEventDestinationResponse |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set.
|
default UpdateConfigurationSetReputationMetricsEnabledResponse |
updateConfigurationSetReputationMetricsEnabled(Consumer<UpdateConfigurationSetReputationMetricsEnabledRequest.Builder> updateConfigurationSetReputationMetricsEnabledRequest)
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set.
|
default UpdateConfigurationSetReputationMetricsEnabledResponse |
updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest)
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set.
|
default UpdateConfigurationSetSendingEnabledResponse |
updateConfigurationSetSendingEnabled(Consumer<UpdateConfigurationSetSendingEnabledRequest.Builder> updateConfigurationSetSendingEnabledRequest)
Enables or disables email sending for messages sent using a specific configuration set.
|
default UpdateConfigurationSetSendingEnabledResponse |
updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest)
Enables or disables email sending for messages sent using a specific configuration set.
|
default UpdateConfigurationSetTrackingOptionsResponse |
updateConfigurationSetTrackingOptions(Consumer<UpdateConfigurationSetTrackingOptionsRequest.Builder> updateConfigurationSetTrackingOptionsRequest)
Modifies an association between a configuration set and a custom domain for open and click event tracking.
|
default UpdateConfigurationSetTrackingOptionsResponse |
updateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest)
Modifies an association between a configuration set and a custom domain for open and click event tracking.
|
default UpdateReceiptRuleResponse |
updateReceiptRule(Consumer<UpdateReceiptRuleRequest.Builder> updateReceiptRuleRequest)
Updates a receipt rule.
|
default UpdateReceiptRuleResponse |
updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
Updates a receipt rule.
|
default UpdateTemplateResponse |
updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
Updates an email template.
|
default UpdateTemplateResponse |
updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates an email template.
|
default VerifyDomainDkimResponse |
verifyDomainDkim(Consumer<VerifyDomainDkimRequest.Builder> verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain.
|
default VerifyDomainDkimResponse |
verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain.
|
default VerifyDomainIdentityResponse |
verifyDomainIdentity(Consumer<VerifyDomainIdentityRequest.Builder> verifyDomainIdentityRequest)
Adds a domain to the list of identities for your Amazon SES account and attempts to verify it.
|
default VerifyDomainIdentityResponse |
verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Adds a domain to the list of identities for your Amazon SES account and attempts to verify it.
|
default VerifyEmailAddressResponse |
verifyEmailAddress(Consumer<VerifyEmailAddressRequest.Builder> verifyEmailAddressRequest)
Deprecated.
|
default VerifyEmailAddressResponse |
verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Deprecated.
|
default VerifyEmailIdentityResponse |
verifyEmailIdentity(Consumer<VerifyEmailIdentityRequest.Builder> verifyEmailIdentityRequest)
Adds an email address to the list of identities for your Amazon SES account and attempts to verify it.
|
default VerifyEmailIdentityResponse |
verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Adds an email address to the list of identities for your Amazon SES account and attempts to verify it.
|
serviceName
close
static final String SERVICE_NAME
static SESClient create()
SESClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static SESClientBuilder builder()
SESClient
.default CloneReceiptRuleSetResponse cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest) throws RuleSetDoesNotExistException, AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CloneReceiptRuleSetResponse cloneReceiptRuleSet(Consumer<CloneReceiptRuleSetRequest.Builder> cloneReceiptRuleSetRequest) throws RuleSetDoesNotExistException, AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) throws ConfigurationSetAlreadyExistsException, InvalidConfigurationSetException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateConfigurationSetResponse createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) throws ConfigurationSetAlreadyExistsException, InvalidConfigurationSetException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationAlreadyExistsException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException, InvalidSNSDestinationException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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 Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the AWS 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.
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 AWS 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.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.SdkServiceException
default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationAlreadyExistsException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException, InvalidSNSDestinationException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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 Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the AWS 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.
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 AWS 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.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.SdkServiceException
default CreateConfigurationSetTrackingOptionsResponse createConfigurationSetTrackingOptions(CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsAlreadyExistsException, InvalidTrackingOptionsException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
createConfigurationSetTrackingOptionsRequest
- Represents a request to create an open and click tracking option object in a configuration set.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.SdkServiceException
default CreateConfigurationSetTrackingOptionsResponse createConfigurationSetTrackingOptions(Consumer<CreateConfigurationSetTrackingOptionsRequest.Builder> createConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsAlreadyExistsException, InvalidTrackingOptionsException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
createConfigurationSetTrackingOptionsRequest
- Represents a request to create an open and click tracking option object in a configuration set.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.SdkServiceException
default CreateReceiptFilterResponse createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest) throws LimitExceededException, AlreadyExistsException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateReceiptFilterResponse createReceiptFilter(Consumer<CreateReceiptFilterRequest.Builder> createReceiptFilterRequest) throws LimitExceededException, AlreadyExistsException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateReceiptRuleResponse createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest) throws InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, AlreadyExistsException, RuleDoesNotExistException, RuleSetDoesNotExistException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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 AWS 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 AWS 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.SdkServiceException
default CreateReceiptRuleResponse createReceiptRule(Consumer<CreateReceiptRuleRequest.Builder> createReceiptRuleRequest) throws InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, AlreadyExistsException, RuleDoesNotExistException, RuleSetDoesNotExistException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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 AWS 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 AWS 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.SdkServiceException
default CreateReceiptRuleSetResponse createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateReceiptRuleSetResponse createReceiptRuleSet(Consumer<CreateReceiptRuleSetRequest.Builder> createReceiptRuleSetRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws AlreadyExistsException, InvalidTemplateException, LimitExceededException, SdkServiceException, SdkClientException, SESException
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
createTemplateRequest
- Represents a request to create an email template. For more information, see the Amazon SES
Developer Guide.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.InvalidTemplateException
- Indicates that a template could not be created because it contained invalid JSON.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.SdkServiceException
default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws AlreadyExistsException, InvalidTemplateException, LimitExceededException, SdkServiceException, SdkClientException, SESException
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
createTemplateRequest
- Represents a request to create an email template. For more information, see the Amazon SES
Developer Guide.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.InvalidTemplateException
- Indicates that a template could not be created because it contained invalid JSON.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.SdkServiceException
default DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteConfigurationSetResponse deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteConfigurationSetTrackingOptionsResponse deleteConfigurationSetTrackingOptions(DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsDoesNotExistException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
deleteConfigurationSetTrackingOptionsRequest
- Represents a request to delete open and click tracking options in a configuration set.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.SdkServiceException
default DeleteConfigurationSetTrackingOptionsResponse deleteConfigurationSetTrackingOptions(Consumer<DeleteConfigurationSetTrackingOptionsRequest.Builder> deleteConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsDoesNotExistException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
deleteConfigurationSetTrackingOptionsRequest
- Represents a request to delete open and click tracking options in a configuration set.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.SdkServiceException
default DeleteIdentityResponse deleteIdentity(DeleteIdentityRequest deleteIdentityRequest) throws SdkServiceException, SdkClientException, SESException
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.
deleteIdentityRequest
- Represents a request to delete one of your Amazon SES identities (an email address or domain).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.SdkServiceException
default DeleteIdentityResponse deleteIdentity(Consumer<DeleteIdentityRequest.Builder> deleteIdentityRequest) throws SdkServiceException, SdkClientException, SESException
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.
deleteIdentityRequest
- Represents a request to delete one of your Amazon SES identities (an email address or domain).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.SdkServiceException
default DeleteIdentityPolicyResponse deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest) throws SdkServiceException, SdkClientException, SESException
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default DeleteIdentityPolicyResponse deleteIdentityPolicy(Consumer<DeleteIdentityPolicyRequest.Builder> deleteIdentityPolicyRequest) throws SdkServiceException, SdkClientException, SESException
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default DeleteReceiptFilterResponse deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteReceiptFilterResponse deleteReceiptFilter(Consumer<DeleteReceiptFilterRequest.Builder> deleteReceiptFilterRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteReceiptRuleResponse deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteReceiptRuleResponse deleteReceiptRule(Consumer<DeleteReceiptRuleRequest.Builder> deleteReceiptRuleRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteReceiptRuleSetResponse deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest) throws CannotDeleteException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteReceiptRuleSetResponse deleteReceiptRuleSet(Consumer<DeleteReceiptRuleSetRequest.Builder> deleteReceiptRuleSetRequest) throws CannotDeleteException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws SdkServiceException, SdkClientException, SESException
Deletes an email template.
You can execute this operation no more than once per second.
deleteTemplateRequest
- Represents a request to delete an email template. For more information, 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.SdkServiceException
default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) throws SdkServiceException, SdkClientException, SESException
Deletes an email template.
You can execute this operation no more than once per second.
deleteTemplateRequest
- Represents a request to delete an email template. For more information, 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.SdkServiceException
default DeleteVerifiedEmailAddressResponse deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the DeleteIdentity
operation to delete email addresses and domains.
deleteVerifiedEmailAddressRequest
- Represents a request to delete an email address from the list of email addresses you have attempted to
verify under your AWS 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.SdkServiceException
default DeleteVerifiedEmailAddressResponse deleteVerifiedEmailAddress(Consumer<DeleteVerifiedEmailAddressRequest.Builder> deleteVerifiedEmailAddressRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the DeleteIdentity
operation to delete email addresses and domains.
deleteVerifiedEmailAddressRequest
- Represents a request to delete an email address from the list of email addresses you have attempted to
verify under your AWS 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.SdkServiceException
default DescribeActiveReceiptRuleSetResponse describeActiveReceiptRuleSet() throws SdkServiceException, SdkClientException, SESException
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.
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.SdkServiceException
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest)
,
AWS API Documentationdefault DescribeActiveReceiptRuleSetResponse describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeActiveReceiptRuleSetResponse describeActiveReceiptRuleSet(Consumer<DescribeActiveReceiptRuleSetRequest.Builder> describeActiveReceiptRuleSetRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeConfigurationSetResponse describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeConfigurationSetResponse describeConfigurationSet(Consumer<DescribeConfigurationSetRequest.Builder> describeConfigurationSetRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeReceiptRuleResponse describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest) throws RuleDoesNotExistException, RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeReceiptRuleResponse describeReceiptRule(Consumer<DescribeReceiptRuleRequest.Builder> describeReceiptRuleRequest) throws RuleDoesNotExistException, RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeReceiptRuleSetResponse describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default DescribeReceiptRuleSetResponse describeReceiptRuleSet(Consumer<DescribeReceiptRuleSetRequest.Builder> describeReceiptRuleSetRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetAccountSendingEnabledResponse getAccountSendingEnabled() throws SdkServiceException, SdkClientException, SESException
Returns the email sending status of the Amazon SES account.
You can execute this operation no more than once per second.
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.SdkServiceException
getAccountSendingEnabled(GetAccountSendingEnabledRequest)
,
AWS
API Documentationdefault GetAccountSendingEnabledResponse getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Returns the email sending status of the Amazon SES account.
You can execute this operation no more than once per second.
getAccountSendingEnabledRequest
- 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.SdkServiceException
default GetAccountSendingEnabledResponse getAccountSendingEnabled(Consumer<GetAccountSendingEnabledRequest.Builder> getAccountSendingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Returns the email sending status of the Amazon SES account.
You can execute this operation no more than once per second.
getAccountSendingEnabledRequest
- 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.SdkServiceException
default GetIdentityDkimAttributesResponse getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityDkimAttributesResponse getIdentityDkimAttributes(Consumer<GetIdentityDkimAttributesRequest.Builder> getIdentityDkimAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityMailFromDomainAttributesResponse getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityMailFromDomainAttributesResponse getIdentityMailFromDomainAttributes(Consumer<GetIdentityMailFromDomainAttributesRequest.Builder> getIdentityMailFromDomainAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityNotificationAttributesResponse getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityNotificationAttributesResponse getIdentityNotificationAttributes(Consumer<GetIdentityNotificationAttributesRequest.Builder> getIdentityNotificationAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default GetIdentityPoliciesResponse getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest) throws SdkServiceException, SdkClientException, SESException
Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default GetIdentityPoliciesResponse getIdentityPolicies(Consumer<GetIdentityPoliciesRequest.Builder> getIdentityPoliciesRequest) throws SdkServiceException, SdkClientException, SESException
Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default GetIdentityVerificationAttributesResponse getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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, if you still want 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, if you still want 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.
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.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.SdkServiceException
default GetIdentityVerificationAttributesResponse getIdentityVerificationAttributes(Consumer<GetIdentityVerificationAttributesRequest.Builder> getIdentityVerificationAttributesRequest) throws SdkServiceException, SdkClientException, SESException
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, if you still want 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, if you still want 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.
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.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.SdkServiceException
default GetSendQuotaResponse getSendQuota() throws SdkServiceException, SdkClientException, SESException
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
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.SdkServiceException
getSendQuota(GetSendQuotaRequest)
,
AWS API
Documentationdefault GetSendQuotaResponse getSendQuota(GetSendQuotaRequest getSendQuotaRequest) throws SdkServiceException, SdkClientException, SESException
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
getSendQuotaRequest
- 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.SdkServiceException
default GetSendQuotaResponse getSendQuota(Consumer<GetSendQuotaRequest.Builder> getSendQuotaRequest) throws SdkServiceException, SdkClientException, SESException
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
getSendQuotaRequest
- 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.SdkServiceException
default GetSendStatisticsResponse getSendStatistics() throws SdkServiceException, SdkClientException, SESException
Provides sending statistics for the Amazon SES account. 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.
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.SdkServiceException
getSendStatistics(GetSendStatisticsRequest)
,
AWS API
Documentationdefault GetSendStatisticsResponse getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest) throws SdkServiceException, SdkClientException, SESException
Provides sending statistics for the Amazon SES account. 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.
getSendStatisticsRequest
- 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.SdkServiceException
default GetSendStatisticsResponse getSendStatistics(Consumer<GetSendStatisticsRequest.Builder> getSendStatisticsRequest) throws SdkServiceException, SdkClientException, SESException
Provides sending statistics for the Amazon SES account. 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.
getSendStatisticsRequest
- 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.SdkServiceException
default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws TemplateDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
getTemplateRequest
- 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.SdkServiceException
default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws TemplateDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
getTemplateRequest
- 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.SdkServiceException
default ListConfigurationSetsResponse listConfigurationSets() throws SdkServiceException, SdkClientException, SESException
Provides a list of the configuration sets associated with your Amazon SES account. 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 will return 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 will
also return a NextToken element. You can then execute the ListConfigurationSets
operation again,
passing the NextToken
parameter and the value of the NextToken element to retrieve additional
results.
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.SdkServiceException
listConfigurationSets(ListConfigurationSetsRequest)
,
AWS
API Documentationdefault ListConfigurationSetsResponse listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) throws SdkServiceException, SdkClientException, SESException
Provides a list of the configuration sets associated with your Amazon SES account. 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 will return 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 will
also return a NextToken element. You can then execute the ListConfigurationSets
operation again,
passing the NextToken
parameter and the value of the NextToken element to retrieve additional
results.
listConfigurationSetsRequest
- Represents a request to list the configuration sets associated with your AWS account. Configuration sets
enable you to publish email sending events. For information about using configuration sets, 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.SdkServiceException
default ListConfigurationSetsResponse listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) throws SdkServiceException, SdkClientException, SESException
Provides a list of the configuration sets associated with your Amazon SES account. 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 will return 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 will
also return a NextToken element. You can then execute the ListConfigurationSets
operation again,
passing the NextToken
parameter and the value of the NextToken element to retrieve additional
results.
listConfigurationSetsRequest
- Represents a request to list the configuration sets associated with your AWS account. Configuration sets
enable you to publish email sending events. For information about using configuration sets, 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.SdkServiceException
default ListIdentitiesResponse listIdentities() throws SdkServiceException, SdkClientException, SESException
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
You can execute this operation no more than once per second.
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.SdkServiceException
listIdentities(ListIdentitiesRequest)
,
AWS API
Documentationdefault ListIdentitiesResponse listIdentities(ListIdentitiesRequest listIdentitiesRequest) throws SdkServiceException, SdkClientException, SESException
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
You can execute this operation no more than once per second.
listIdentitiesRequest
- Represents a request to return a list of all identities (email addresses and domains) that you have
attempted to verify under your AWS account, regardless of verification status.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.SdkServiceException
default ListIdentitiesResponse listIdentities(Consumer<ListIdentitiesRequest.Builder> listIdentitiesRequest) throws SdkServiceException, SdkClientException, SESException
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
You can execute this operation no more than once per second.
listIdentitiesRequest
- Represents a request to return a list of all identities (email addresses and domains) that you have
attempted to verify under your AWS account, regardless of verification status.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.SdkServiceException
default ListIdentityPoliciesResponse listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest) throws SdkServiceException, SdkClientException, SESException
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain). This API returns only a list. If you want the actual policy content, you can use
GetIdentityPolicies
.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default ListIdentityPoliciesResponse listIdentityPolicies(Consumer<ListIdentityPoliciesRequest.Builder> listIdentityPoliciesRequest) throws SdkServiceException, SdkClientException, SESException
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain). This API returns only a list. If you want the actual policy content, you can use
GetIdentityPolicies
.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default ListReceiptFiltersResponse listReceiptFilters() throws SdkServiceException, SdkClientException, SESException
Lists the IP address filters associated with your AWS account.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.SdkServiceException
listReceiptFilters(ListReceiptFiltersRequest)
,
AWS API
Documentationdefault ListReceiptFiltersResponse listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest) throws SdkServiceException, SdkClientException, SESException
Lists the IP address filters associated with your AWS account.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
listReceiptFiltersRequest
- Represents a request to list the IP address filters that exist under your AWS account. You use IP address
filters when you receive email with Amazon SES. For more information, 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.SdkServiceException
default ListReceiptFiltersResponse listReceiptFilters(Consumer<ListReceiptFiltersRequest.Builder> listReceiptFiltersRequest) throws SdkServiceException, SdkClientException, SESException
Lists the IP address filters associated with your AWS account.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
listReceiptFiltersRequest
- Represents a request to list the IP address filters that exist under your AWS account. You use IP address
filters when you receive email with Amazon SES. For more information, 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.SdkServiceException
default ListReceiptRuleSetsResponse listReceiptRuleSets() throws SdkServiceException, SdkClientException, SESException
Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be
retrieved, you will receive a NextToken
that you can provide to the next call to
ListReceiptRuleSets
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.
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.SdkServiceException
listReceiptRuleSets(ListReceiptRuleSetsRequest)
,
AWS API
Documentationdefault ListReceiptRuleSetsResponse listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest) throws SdkServiceException, SdkClientException, SESException
Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be
retrieved, you will receive a NextToken
that you can provide to the next call to
ListReceiptRuleSets
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.
listReceiptRuleSetsRequest
- Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule
sets to receive email with Amazon SES. For more information, 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.SdkServiceException
default ListReceiptRuleSetsResponse listReceiptRuleSets(Consumer<ListReceiptRuleSetsRequest.Builder> listReceiptRuleSetsRequest) throws SdkServiceException, SdkClientException, SESException
Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be
retrieved, you will receive a NextToken
that you can provide to the next call to
ListReceiptRuleSets
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.
listReceiptRuleSetsRequest
- Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule
sets to receive email with Amazon SES. For more information, 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.SdkServiceException
default ListTemplatesResponse listTemplates() throws SdkServiceException, SdkClientException, SESException
Lists the email templates present in your Amazon SES account.
You can execute this operation no more than once per second.
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.SdkServiceException
listTemplates(ListTemplatesRequest)
,
AWS API
Documentationdefault ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws SdkServiceException, SdkClientException, SESException
Lists the email templates present in your Amazon SES account.
You can execute this operation no more than once per second.
listTemplatesRequest
- 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.SdkServiceException
default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws SdkServiceException, SdkClientException, SESException
Lists the email templates present in your Amazon SES account.
You can execute this operation no more than once per second.
listTemplatesRequest
- 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.SdkServiceException
default ListVerifiedEmailAddressesResponse listVerifiedEmailAddresses() throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the ListIdentities
operation to list the email addresses and domains associated with
your 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.SdkServiceException
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)
,
AWS API Documentationdefault ListVerifiedEmailAddressesResponse listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the ListIdentities
operation to list the email addresses and domains associated with
your account.
listVerifiedEmailAddressesRequest
- 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.SdkServiceException
default ListVerifiedEmailAddressesResponse listVerifiedEmailAddresses(Consumer<ListVerifiedEmailAddressesRequest.Builder> listVerifiedEmailAddressesRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the ListIdentities
operation to list the email addresses and domains associated with
your account.
listVerifiedEmailAddressesRequest
- 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.SdkServiceException
default PutIdentityPolicyResponse putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest) throws InvalidPolicyException, SdkServiceException, SdkClientException, SESException
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default PutIdentityPolicyResponse putIdentityPolicy(Consumer<PutIdentityPolicyRequest.Builder> putIdentityPolicyRequest) throws InvalidPolicyException, SdkServiceException, SdkClientException, SESException
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
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.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.SdkServiceException
default ReorderReceiptRuleSetResponse reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest) throws RuleSetDoesNotExistException, RuleDoesNotExistException, SdkServiceException, SdkClientException, SESException
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, this API will return an 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.
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.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.SdkServiceException
default ReorderReceiptRuleSetResponse reorderReceiptRuleSet(Consumer<ReorderReceiptRuleSetRequest.Builder> reorderReceiptRuleSetRequest) throws RuleSetDoesNotExistException, RuleDoesNotExistException, SdkServiceException, SdkClientException, SESException
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, this API will return an 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.
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.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.SdkServiceException
default SendBounceResponse sendBounce(SendBounceRequest sendBounceRequest) throws MessageRejectedException, SdkServiceException, SdkClientException, SESException
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
You cannot use this API 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.
sendBounceRequest
- Represents a request to send a bounce message to the sender of an email you received through Amazon SES.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.SdkServiceException
default SendBounceResponse sendBounce(Consumer<SendBounceRequest.Builder> sendBounceRequest) throws MessageRejectedException, SdkServiceException, SdkClientException, SESException
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
You cannot use this API 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.
sendBounceRequest
- Represents a request to send a bounce message to the sender of an email you received through Amazon SES.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.SdkServiceException
default SendBulkTemplatedEmailResponse sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, TemplateDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the SendBulkTemplatedEmail
operation, your call to the API 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 total size of the message, including attachments, must be less than 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 will be rejected, even
if the message contains other recipients that are valid.
sendBulkTemplatedEmailRequest
- Represents a request to send a templated email to multiple destinations using Amazon SES. For more
information, see the Amazon SES
Developer Guide.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.SdkServiceException
default SendBulkTemplatedEmailResponse sendBulkTemplatedEmail(Consumer<SendBulkTemplatedEmailRequest.Builder> sendBulkTemplatedEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, TemplateDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the SendBulkTemplatedEmail
operation, your call to the API 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 total size of the message, including attachments, must be less than 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 will be rejected, even
if the message contains other recipients that are valid.
sendBulkTemplatedEmailRequest
- Represents a request to send a templated email to multiple destinations using Amazon SES. For more
information, see the Amazon SES
Developer Guide.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.SdkServiceException
default SendEmailResponse sendEmail(SendEmailRequest sendEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message and immediately queues it for sending. In order to send email using the
SendEmail
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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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.
sendEmailRequest
- Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.SdkServiceException
default SendEmailResponse sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message and immediately queues it for sending. In order to send email using the
SendEmail
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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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.
sendEmailRequest
- Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.SdkServiceException
default SendRawEmailResponse sendRawEmail(SendRawEmailRequest sendRawEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message and immediately queues it for sending. When calling this operation, you may specify the
message headers as well as the content. The SendRawEmail
operation is particularly useful for
sending multipart MIME emails (such as those that contain both a plain-text and an HTML version).
In order to send email using the SendRawEmail
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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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 SendRawEmail
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.
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
will automatically apply its own Message-ID
and Date
headers; if you passed these
headers when creating the message, they will be 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 parameters SourceArn
, FromArn
, and/or
ReturnPathArn
to the API, 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
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.
For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn
parameter and not the FromIdentityArn
or ReturnPathIdentityArn
parameters. If you only
specify the SourceIdentityArn
parameter, Amazon SES will set the From and Return Path addresses to
the identity specified in SourceIdentityArn
. For more information about sending authorization, see
the Using Sending
Authorization with Amazon SES in the Amazon SES Developer Guide.
sendRawEmailRequest
- Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.SdkServiceException
default SendRawEmailResponse sendRawEmail(Consumer<SendRawEmailRequest.Builder> sendRawEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message and immediately queues it for sending. When calling this operation, you may specify the
message headers as well as the content. The SendRawEmail
operation is particularly useful for
sending multipart MIME emails (such as those that contain both a plain-text and an HTML version).
In order to send email using the SendRawEmail
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 will result 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 total size of the message, including attachments, must be smaller than 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 will be 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 SendRawEmail
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.
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
will automatically apply its own Message-ID
and Date
headers; if you passed these
headers when creating the message, they will be 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 parameters SourceArn
, FromArn
, and/or
ReturnPathArn
to the API, 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
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.
For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn
parameter and not the FromIdentityArn
or ReturnPathIdentityArn
parameters. If you only
specify the SourceIdentityArn
parameter, Amazon SES will set the From and Return Path addresses to
the identity specified in SourceIdentityArn
. For more information about sending authorization, see
the Using Sending
Authorization with Amazon SES in the Amazon SES Developer Guide.
sendRawEmailRequest
- Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.SdkServiceException
default SendTemplatedEmailResponse sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, TemplateDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the SendTemplatedEmail
operation, your call to the API 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 total size of the message, including attachments, must be less than 10 MB.
Calls to the SendTemplatedEmail
operation may only include one Destination
parameter. A
destination is a set of recipients who will receive the same version of the email. The Destination
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 will be rejected, even
if the message contains other recipients that are valid.
sendTemplatedEmailRequest
- Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES
Developer Guide.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.SdkServiceException
default SendTemplatedEmailResponse sendTemplatedEmail(Consumer<SendTemplatedEmailRequest.Builder> sendTemplatedEmailRequest) throws MessageRejectedException, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException, TemplateDoesNotExistException, ConfigurationSetSendingPausedException, AccountSendingPausedException, SdkServiceException, SdkClientException, SESException
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the SendTemplatedEmail
operation, your call to the API 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 total size of the message, including attachments, must be less than 10 MB.
Calls to the SendTemplatedEmail
operation may only include one Destination
parameter. A
destination is a set of recipients who will receive the same version of the email. The Destination
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 will be rejected, even
if the message contains other recipients that are valid.
sendTemplatedEmailRequest
- Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES
Developer Guide.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.SdkServiceException
default SetActiveReceiptRuleSetResponse setActiveReceiptRuleSet() throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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 API 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.
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.SdkServiceException
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest)
,
AWS
API Documentationdefault SetActiveReceiptRuleSetResponse setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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 API 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.
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.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.SdkServiceException
default SetActiveReceiptRuleSetResponse setActiveReceiptRuleSet(Consumer<SetActiveReceiptRuleSetRequest.Builder> setActiveReceiptRuleSetRequest) throws RuleSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
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 API 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.
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.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.SdkServiceException
default SetIdentityDkimEnabledResponse setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Enables or disables Easy DKIM signing of email sent from an identity:
If Easy DKIM signing is enabled for a domain name identity (such as example.com
), then Amazon SES
will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com
).
If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.
For email addresses (for example, user@example.com
), you can only enable Easy DKIM signing if the
corresponding domain (in this case, example.com
) has been set up for Easy DKIM using the AWS Console
or the VerifyDomainDkim
operation.
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.
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.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.SdkServiceException
default SetIdentityDkimEnabledResponse setIdentityDkimEnabled(Consumer<SetIdentityDkimEnabledRequest.Builder> setIdentityDkimEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Enables or disables Easy DKIM signing of email sent from an identity:
If Easy DKIM signing is enabled for a domain name identity (such as example.com
), then Amazon SES
will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com
).
If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.
For email addresses (for example, user@example.com
), you can only enable Easy DKIM signing if the
corresponding domain (in this case, example.com
) has been set up for Easy DKIM using the AWS Console
or the VerifyDomainDkim
operation.
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.
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.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.SdkServiceException
default SetIdentityFeedbackForwardingEnabledResponse setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default SetIdentityFeedbackForwardingEnabledResponse setIdentityFeedbackForwardingEnabled(Consumer<SetIdentityFeedbackForwardingEnabledRequest.Builder> setIdentityFeedbackForwardingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default SetIdentityHeadersInNotificationsEnabledResponse setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default SetIdentityHeadersInNotificationsEnabledResponse setIdentityHeadersInNotificationsEnabled(Consumer<SetIdentityHeadersInNotificationsEnabledRequest.Builder> setIdentityHeadersInNotificationsEnabledRequest) throws SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default SetIdentityMailFromDomainResponse setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest) throws SdkServiceException, SdkClientException, SESException
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. If you want your emails to 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.
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.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.SdkServiceException
default SetIdentityMailFromDomainResponse setIdentityMailFromDomain(Consumer<SetIdentityMailFromDomainRequest.Builder> setIdentityMailFromDomainRequest) throws SdkServiceException, SdkClientException, SESException
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. If you want your emails to 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.
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.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.SdkServiceException
default SetIdentityNotificationTopicResponse setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest) throws SdkServiceException, SdkClientException, SESException
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the Source
.
Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications.
For more information, see SetIdentityFeedbackForwardingEnabled
.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
setIdentityNotificationTopicRequest
- Represents a request to specify the Amazon SNS topic to which Amazon SES will publish 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.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.SdkServiceException
default SetIdentityNotificationTopicResponse setIdentityNotificationTopic(Consumer<SetIdentityNotificationTopicRequest.Builder> setIdentityNotificationTopicRequest) throws SdkServiceException, SdkClientException, SESException
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the Source
.
Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications.
For more information, see SetIdentityFeedbackForwardingEnabled
.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
setIdentityNotificationTopicRequest
- Represents a request to specify the Amazon SNS topic to which Amazon SES will publish 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.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.SdkServiceException
default SetReceiptRulePositionResponse setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest) throws RuleSetDoesNotExistException, RuleDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default SetReceiptRulePositionResponse setReceiptRulePosition(Consumer<SetReceiptRulePositionRequest.Builder> setReceiptRulePositionRequest) throws RuleSetDoesNotExistException, RuleDoesNotExistException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default TestRenderTemplateResponse testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest) throws TemplateDoesNotExistException, InvalidRenderingParameterException, MissingRenderingAttributeException, SdkServiceException, SdkClientException, SESException
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.
testRenderTemplateRequest
- 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.SdkServiceException
default TestRenderTemplateResponse testRenderTemplate(Consumer<TestRenderTemplateRequest.Builder> testRenderTemplateRequest) throws TemplateDoesNotExistException, InvalidRenderingParameterException, MissingRenderingAttributeException, SdkServiceException, SdkClientException, SESException
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.
testRenderTemplateRequest
- 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.SdkServiceException
default UpdateAccountSendingEnabledResponse updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Enables or disables email sending across your entire Amazon SES account. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account when reputation metrics (such as your bounce on complaint rate) reach certain thresholds.
You can execute this operation no more than once per second.
updateAccountSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for your entire 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.SdkServiceException
default UpdateAccountSendingEnabledResponse updateAccountSendingEnabled(Consumer<UpdateAccountSendingEnabledRequest.Builder> updateAccountSendingEnabledRequest) throws SdkServiceException, SdkClientException, SESException
Enables or disables email sending across your entire Amazon SES account. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account when reputation metrics (such as your bounce on complaint rate) reach certain thresholds.
You can execute this operation no more than once per second.
updateAccountSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for your entire 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.SdkServiceException
default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationDoesNotExistException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException, InvalidSNSDestinationException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) throws ConfigurationSetDoesNotExistException, EventDestinationDoesNotExistException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException, InvalidSNSDestinationException, SdkServiceException, SdkClientException, SESException
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.
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.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.SdkServiceException
default UpdateConfigurationSetReputationMetricsEnabledResponse updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using Amazon CloudWatch, you can create alarms when bounce or complaint rates exceed a certain threshold.
You can execute this operation no more than once per second.
updateConfigurationSetReputationMetricsEnabledRequest
- Represents a request to modify the reputation metric publishing settings for a configuration set.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.SdkServiceException
default UpdateConfigurationSetReputationMetricsEnabledResponse updateConfigurationSetReputationMetricsEnabled(Consumer<UpdateConfigurationSetReputationMetricsEnabledRequest.Builder> updateConfigurationSetReputationMetricsEnabledRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using Amazon CloudWatch, you can create alarms when bounce or complaint rates exceed a certain threshold.
You can execute this operation no more than once per second.
updateConfigurationSetReputationMetricsEnabledRequest
- Represents a request to modify the reputation metric publishing settings for a configuration set.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.SdkServiceException
default UpdateConfigurationSetSendingEnabledResponse updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
Enables or disables email sending for messages sent using a specific configuration set. 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) reach certain thresholds.
You can execute this operation no more than once per second.
updateConfigurationSetSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for a specific configuration set.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.SdkServiceException
default UpdateConfigurationSetSendingEnabledResponse updateConfigurationSetSendingEnabled(Consumer<UpdateConfigurationSetSendingEnabledRequest.Builder> updateConfigurationSetSendingEnabledRequest) throws ConfigurationSetDoesNotExistException, SdkServiceException, SdkClientException, SESException
Enables or disables email sending for messages sent using a specific configuration set. 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) reach certain thresholds.
You can execute this operation no more than once per second.
updateConfigurationSetSendingEnabledRequest
- Represents a request to enable or disable the email sending capabilities for a specific configuration set.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.SdkServiceException
default UpdateConfigurationSetTrackingOptionsResponse updateConfigurationSetTrackingOptions(UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsDoesNotExistException, InvalidTrackingOptionsException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
updateConfigurationSetTrackingOptionsRequest
- Represents a request to update the tracking options for a configuration set.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.SdkServiceException
default UpdateConfigurationSetTrackingOptionsResponse updateConfigurationSetTrackingOptions(Consumer<UpdateConfigurationSetTrackingOptionsRequest.Builder> updateConfigurationSetTrackingOptionsRequest) throws ConfigurationSetDoesNotExistException, TrackingOptionsDoesNotExistException, InvalidTrackingOptionsException, SdkServiceException, SdkClientException, SESException
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 configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
updateConfigurationSetTrackingOptionsRequest
- Represents a request to update the tracking options for a configuration set.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.SdkServiceException
default UpdateReceiptRuleResponse updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest) throws InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, RuleSetDoesNotExistException, RuleDoesNotExistException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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 AWS 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 AWS 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.SdkServiceException
default UpdateReceiptRuleResponse updateReceiptRule(Consumer<UpdateReceiptRuleRequest.Builder> updateReceiptRuleRequest) throws InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, RuleSetDoesNotExistException, RuleDoesNotExistException, LimitExceededException, SdkServiceException, SdkClientException, SESException
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.
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.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 AWS 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 AWS 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.SdkServiceException
default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws TemplateDoesNotExistException, InvalidTemplateException, SdkServiceException, SdkClientException, SESException
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
updateTemplateRequest
- TemplateDoesNotExistException
- Indicates that the Template object you specified does not exist in your Amazon SES account.InvalidTemplateException
- Indicates that a template could not be created because it contained invalid JSON.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.SdkServiceException
default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws TemplateDoesNotExistException, InvalidTemplateException, SdkServiceException, SdkClientException, SESException
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
updateTemplateRequest
- TemplateDoesNotExistException
- Indicates that the Template object you specified does not exist in your Amazon SES account.InvalidTemplateException
- Indicates that a template could not be created because it contained invalid JSON.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.SdkServiceException
default VerifyDomainDkimResponse verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest) throws SdkServiceException, SdkClientException, SESException
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
You can execute this operation no more than once per second.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled
operation.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
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.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.SdkServiceException
default VerifyDomainDkimResponse verifyDomainDkim(Consumer<VerifyDomainDkimRequest.Builder> verifyDomainDkimRequest) throws SdkServiceException, SdkClientException, SESException
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
You can execute this operation no more than once per second.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled
operation.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
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.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.SdkServiceException
default VerifyDomainIdentityResponse verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest) throws SdkServiceException, SdkClientException, SESException
Adds a domain to the list of identities for your Amazon SES account 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.
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.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.SdkServiceException
default VerifyDomainIdentityResponse verifyDomainIdentity(Consumer<VerifyDomainIdentityRequest.Builder> verifyDomainIdentityRequest) throws SdkServiceException, SdkClientException, SESException
Adds a domain to the list of identities for your Amazon SES account 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.
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.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.SdkServiceException
default VerifyEmailAddressResponse verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the VerifyEmailIdentity
operation to verify a new email address.
verifyEmailAddressRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, 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.SdkServiceException
default VerifyEmailAddressResponse verifyEmailAddress(Consumer<VerifyEmailAddressRequest.Builder> verifyEmailAddressRequest) throws SdkServiceException, SdkClientException, SESException
Deprecated. Use the VerifyEmailIdentity
operation to verify a new email address.
verifyEmailAddressRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, 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.SdkServiceException
default VerifyEmailIdentityResponse verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest) throws SdkServiceException, SdkClientException, SESException
Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.
You can execute this operation no more than once per second.
verifyEmailIdentityRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, 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.SdkServiceException
default VerifyEmailIdentityResponse verifyEmailIdentity(Consumer<VerifyEmailIdentityRequest.Builder> verifyEmailIdentityRequest) throws SdkServiceException, SdkClientException, SESException
Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.
You can execute this operation no more than once per second.
verifyEmailIdentityRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, 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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.