@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPinpointEmailAsyncClient extends AmazonPinpointEmailClient implements AmazonPinpointEmailAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint API is available in the US East (N. Virginia) Region at the following endpoint:
email.us-east-1.amazonaws.com
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createConfigurationSet, createConfigurationSetEventDestination, createDedicatedIpPool, createEmailIdentity, deleteConfigurationSet, deleteConfigurationSetEventDestination, deleteDedicatedIpPool, deleteEmailIdentity, getAccount, getCachedResponseMetadata, getConfigurationSet, getConfigurationSetEventDestinations, getDedicatedIp, getDedicatedIps, getEmailIdentity, listConfigurationSets, listDedicatedIpPools, listEmailIdentities, putAccountDedicatedIpWarmupAttributes, putAccountSendingAttributes, putConfigurationSetDeliveryOptions, putConfigurationSetReputationOptions, putConfigurationSetSendingOptions, putConfigurationSetTrackingOptions, putDedicatedIpInPool, putDedicatedIpWarmupAttributes, putEmailIdentityDkimAttributes, putEmailIdentityFeedbackAttributes, putEmailIdentityMailFromAttributes, sendEmail, updateConfigurationSetEventDestination
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createConfigurationSet, createConfigurationSetEventDestination, createDedicatedIpPool, createEmailIdentity, deleteConfigurationSet, deleteConfigurationSetEventDestination, deleteDedicatedIpPool, deleteEmailIdentity, getAccount, getCachedResponseMetadata, getConfigurationSet, getConfigurationSetEventDestinations, getDedicatedIp, getDedicatedIps, getEmailIdentity, listConfigurationSets, listDedicatedIpPools, listEmailIdentities, putAccountDedicatedIpWarmupAttributes, putAccountSendingAttributes, putConfigurationSetDeliveryOptions, putConfigurationSetReputationOptions, putConfigurationSetSendingOptions, putConfigurationSetTrackingOptions, putDedicatedIpInPool, putDedicatedIpWarmupAttributes, putEmailIdentityDkimAttributes, putEmailIdentityFeedbackAttributes, putEmailIdentityMailFromAttributes, sendEmail, updateConfigurationSetEventDestination
public static AmazonPinpointEmailAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request)
AmazonPinpointEmailAsync
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
createConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to create a configuration set.public Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request, AsyncHandler<CreateConfigurationSetRequest,CreateConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsync
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
createConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to create a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConfigurationSetEventDestinationResult> createConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest request)
AmazonPinpointEmailAsync
Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
createConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to add an event destination to a configuration set.public Future<CreateConfigurationSetEventDestinationResult> createConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest request, AsyncHandler<CreateConfigurationSetEventDestinationRequest,CreateConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsync
Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
createConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to add an event destination to a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDedicatedIpPoolResult> createDedicatedIpPoolAsync(CreateDedicatedIpPoolRequest request)
AmazonPinpointEmailAsync
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
createDedicatedIpPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to create a new dedicated IP pool.public Future<CreateDedicatedIpPoolResult> createDedicatedIpPoolAsync(CreateDedicatedIpPoolRequest request, AsyncHandler<CreateDedicatedIpPoolRequest,CreateDedicatedIpPoolResult> asyncHandler)
AmazonPinpointEmailAsync
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
createDedicatedIpPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to create a new dedicated IP pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateEmailIdentityResult> createEmailIdentityAsync(CreateEmailIdentityRequest request)
AmazonPinpointEmailAsync
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
createEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to begin the verification process for an email identity (an email address or domain).public Future<CreateEmailIdentityResult> createEmailIdentityAsync(CreateEmailIdentityRequest request, AsyncHandler<CreateEmailIdentityRequest,CreateEmailIdentityResult> asyncHandler)
AmazonPinpointEmailAsync
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
createEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to begin the verification process for an email identity (an email address or domain).asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest request)
AmazonPinpointEmailAsync
Delete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
deleteConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete a configuration set.public Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest request, AsyncHandler<DeleteConfigurationSetRequest,DeleteConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsync
Delete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
deleteConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConfigurationSetEventDestinationResult> deleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest request)
AmazonPinpointEmailAsync
Delete an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
deleteConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete an event destination from a configuration set.public Future<DeleteConfigurationSetEventDestinationResult> deleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest request, AsyncHandler<DeleteConfigurationSetEventDestinationRequest,DeleteConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsync
Delete an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
deleteConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete an event destination from a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDedicatedIpPoolResult> deleteDedicatedIpPoolAsync(DeleteDedicatedIpPoolRequest request)
AmazonPinpointEmailAsync
Delete a dedicated IP pool.
deleteDedicatedIpPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete a dedicated IP pool.public Future<DeleteDedicatedIpPoolResult> deleteDedicatedIpPoolAsync(DeleteDedicatedIpPoolRequest request, AsyncHandler<DeleteDedicatedIpPoolRequest,DeleteDedicatedIpPoolResult> asyncHandler)
AmazonPinpointEmailAsync
Delete a dedicated IP pool.
deleteDedicatedIpPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete a dedicated IP pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEmailIdentityResult> deleteEmailIdentityAsync(DeleteEmailIdentityRequest request)
AmazonPinpointEmailAsync
Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
deleteEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete an existing email identity. When you delete an identity, you lose the ability to use
Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing
the verification process for the identity again.public Future<DeleteEmailIdentityResult> deleteEmailIdentityAsync(DeleteEmailIdentityRequest request, AsyncHandler<DeleteEmailIdentityRequest,DeleteEmailIdentityResult> asyncHandler)
AmazonPinpointEmailAsync
Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
deleteEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to delete an existing email identity. When you delete an identity, you lose the ability to use
Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing
the verification process for the identity again.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetAccountResult> getAccountAsync(GetAccountRequest request)
AmazonPinpointEmailAsync
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
getAccountAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.public Future<GetAccountResult> getAccountAsync(GetAccountRequest request, AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler)
AmazonPinpointEmailAsync
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
getAccountAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetConfigurationSetResult> getConfigurationSetAsync(GetConfigurationSetRequest request)
AmazonPinpointEmailAsync
Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
getConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about a configuration set.public Future<GetConfigurationSetResult> getConfigurationSetAsync(GetConfigurationSetRequest request, AsyncHandler<GetConfigurationSetRequest,GetConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsync
Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
getConfigurationSetAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetConfigurationSetEventDestinationsResult> getConfigurationSetEventDestinationsAsync(GetConfigurationSetEventDestinationsRequest request)
AmazonPinpointEmailAsync
Retrieve a list of event destinations that are associated with a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
getConfigurationSetEventDestinationsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about the event destinations for a configuration set.public Future<GetConfigurationSetEventDestinationsResult> getConfigurationSetEventDestinationsAsync(GetConfigurationSetEventDestinationsRequest request, AsyncHandler<GetConfigurationSetEventDestinationsRequest,GetConfigurationSetEventDestinationsResult> asyncHandler)
AmazonPinpointEmailAsync
Retrieve a list of event destinations that are associated with a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
getConfigurationSetEventDestinationsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain information about the event destinations for a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDedicatedIpResult> getDedicatedIpAsync(GetDedicatedIpRequest request)
AmazonPinpointEmailAsync
Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
getDedicatedIpAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain more information about a dedicated IP address.public Future<GetDedicatedIpResult> getDedicatedIpAsync(GetDedicatedIpRequest request, AsyncHandler<GetDedicatedIpRequest,GetDedicatedIpResult> asyncHandler)
AmazonPinpointEmailAsync
Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
getDedicatedIpAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain more information about a dedicated IP address.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDedicatedIpsResult> getDedicatedIpsAsync(GetDedicatedIpsRequest request)
AmazonPinpointEmailAsync
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain more information about dedicated IP pools.public Future<GetDedicatedIpsResult> getDedicatedIpsAsync(GetDedicatedIpsRequest request, AsyncHandler<GetDedicatedIpsRequest,GetDedicatedIpsResult> asyncHandler)
AmazonPinpointEmailAsync
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain more information about dedicated IP pools.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEmailIdentityResult> getEmailIdentityAsync(GetEmailIdentityRequest request)
AmazonPinpointEmailAsync
Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
getEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to return details about an email identity.public Future<GetEmailIdentityResult> getEmailIdentityAsync(GetEmailIdentityRequest request, AsyncHandler<GetEmailIdentityRequest,GetEmailIdentityResult> asyncHandler)
AmazonPinpointEmailAsync
Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
getEmailIdentityAsync
in interface AmazonPinpointEmailAsync
request
- A request to return details about an email identity.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConfigurationSetsResult> listConfigurationSetsAsync(ListConfigurationSetsRequest request)
AmazonPinpointEmailAsync
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
listConfigurationSetsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
Region.public Future<ListConfigurationSetsResult> listConfigurationSetsAsync(ListConfigurationSetsRequest request, AsyncHandler<ListConfigurationSetsRequest,ListConfigurationSetsResult> asyncHandler)
AmazonPinpointEmailAsync
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
listConfigurationSetsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
Region.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDedicatedIpPoolsResult> listDedicatedIpPoolsAsync(ListDedicatedIpPoolsRequest request)
AmazonPinpointEmailAsync
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
listDedicatedIpPoolsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain a list of dedicated IP pools.public Future<ListDedicatedIpPoolsResult> listDedicatedIpPoolsAsync(ListDedicatedIpPoolsRequest request, AsyncHandler<ListDedicatedIpPoolsRequest,ListDedicatedIpPoolsResult> asyncHandler)
AmazonPinpointEmailAsync
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
listDedicatedIpPoolsAsync
in interface AmazonPinpointEmailAsync
request
- A request to obtain a list of dedicated IP pools.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEmailIdentitiesResult> listEmailIdentitiesAsync(ListEmailIdentitiesRequest request)
AmazonPinpointEmailAsync
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
listEmailIdentitiesAsync
in interface AmazonPinpointEmailAsync
request
- A request to list all of the email identities associated with your Amazon Pinpoint account. This list
includes identities that you've already verified, identities that are unverified, and identities that were
verified in the past, but are no longer verified.public Future<ListEmailIdentitiesResult> listEmailIdentitiesAsync(ListEmailIdentitiesRequest request, AsyncHandler<ListEmailIdentitiesRequest,ListEmailIdentitiesResult> asyncHandler)
AmazonPinpointEmailAsync
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
listEmailIdentitiesAsync
in interface AmazonPinpointEmailAsync
request
- A request to list all of the email identities associated with your Amazon Pinpoint account. This list
includes identities that you've already verified, identities that are unverified, and identities that were
verified in the past, but are no longer verified.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutAccountDedicatedIpWarmupAttributesResult> putAccountDedicatedIpWarmupAttributesAsync(PutAccountDedicatedIpWarmupAttributesRequest request)
AmazonPinpointEmailAsync
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable the automatic IP address warm-up feature.public Future<PutAccountDedicatedIpWarmupAttributesResult> putAccountDedicatedIpWarmupAttributesAsync(PutAccountDedicatedIpWarmupAttributesRequest request, AsyncHandler<PutAccountDedicatedIpWarmupAttributesRequest,PutAccountDedicatedIpWarmupAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable the automatic IP address warm-up feature.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutAccountSendingAttributesResult> putAccountSendingAttributesAsync(PutAccountSendingAttributesRequest request)
AmazonPinpointEmailAsync
Enable or disable the ability of your account to send email.
putAccountSendingAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the ability of your account to send email.public Future<PutAccountSendingAttributesResult> putAccountSendingAttributesAsync(PutAccountSendingAttributesRequest request, AsyncHandler<PutAccountSendingAttributesRequest,PutAccountSendingAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
Enable or disable the ability of your account to send email.
putAccountSendingAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the ability of your account to send email.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutConfigurationSetDeliveryOptionsResult> putConfigurationSetDeliveryOptionsAsync(PutConfigurationSetDeliveryOptionsRequest request)
AmazonPinpointEmailAsync
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
putConfigurationSetDeliveryOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to associate a configuration set with a dedicated IP pool.public Future<PutConfigurationSetDeliveryOptionsResult> putConfigurationSetDeliveryOptionsAsync(PutConfigurationSetDeliveryOptionsRequest request, AsyncHandler<PutConfigurationSetDeliveryOptionsRequest,PutConfigurationSetDeliveryOptionsResult> asyncHandler)
AmazonPinpointEmailAsync
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
putConfigurationSetDeliveryOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to associate a configuration set with a dedicated IP pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutConfigurationSetReputationOptionsResult> putConfigurationSetReputationOptionsAsync(PutConfigurationSetReputationOptionsRequest request)
AmazonPinpointEmailAsync
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetReputationOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable tracking of reputation metrics for a configuration set.public Future<PutConfigurationSetReputationOptionsResult> putConfigurationSetReputationOptionsAsync(PutConfigurationSetReputationOptionsRequest request, AsyncHandler<PutConfigurationSetReputationOptionsRequest,PutConfigurationSetReputationOptionsResult> asyncHandler)
AmazonPinpointEmailAsync
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetReputationOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable tracking of reputation metrics for a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutConfigurationSetSendingOptionsResult> putConfigurationSetSendingOptionsAsync(PutConfigurationSetSendingOptionsRequest request)
AmazonPinpointEmailAsync
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
configuration set.public Future<PutConfigurationSetSendingOptionsResult> putConfigurationSetSendingOptionsAsync(PutConfigurationSetSendingOptionsRequest request, AsyncHandler<PutConfigurationSetSendingOptionsRequest,PutConfigurationSetSendingOptionsResult> asyncHandler)
AmazonPinpointEmailAsync
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutConfigurationSetTrackingOptionsResult> putConfigurationSetTrackingOptionsAsync(PutConfigurationSetTrackingOptionsRequest request)
AmazonPinpointEmailAsync
Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
putConfigurationSetTrackingOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to add a custom domain for tracking open and click events to a configuration set.public Future<PutConfigurationSetTrackingOptionsResult> putConfigurationSetTrackingOptionsAsync(PutConfigurationSetTrackingOptionsRequest request, AsyncHandler<PutConfigurationSetTrackingOptionsRequest,PutConfigurationSetTrackingOptionsResult> asyncHandler)
AmazonPinpointEmailAsync
Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
putConfigurationSetTrackingOptionsAsync
in interface AmazonPinpointEmailAsync
request
- A request to add a custom domain for tracking open and click events to a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDedicatedIpInPoolResult> putDedicatedIpInPoolAsync(PutDedicatedIpInPoolRequest request)
AmazonPinpointEmailAsync
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool
operation.
putDedicatedIpInPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to move a dedicated IP address to a dedicated IP pool.public Future<PutDedicatedIpInPoolResult> putDedicatedIpInPoolAsync(PutDedicatedIpInPoolRequest request, AsyncHandler<PutDedicatedIpInPoolRequest,PutDedicatedIpInPoolResult> asyncHandler)
AmazonPinpointEmailAsync
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool
operation.
putDedicatedIpInPoolAsync
in interface AmazonPinpointEmailAsync
request
- A request to move a dedicated IP address to a dedicated IP pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDedicatedIpWarmupAttributesResult> putDedicatedIpWarmupAttributesAsync(PutDedicatedIpWarmupAttributesRequest request)
AmazonPinpointEmailAsync
putDedicatedIpWarmupAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you
want to resume the warm-up process for an existing IP address.public Future<PutDedicatedIpWarmupAttributesResult> putDedicatedIpWarmupAttributesAsync(PutDedicatedIpWarmupAttributesRequest request, AsyncHandler<PutDedicatedIpWarmupAttributesRequest,PutDedicatedIpWarmupAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
putDedicatedIpWarmupAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you
want to resume the warm-up process for an existing IP address.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutEmailIdentityDkimAttributesResult> putEmailIdentityDkimAttributesAsync(PutEmailIdentityDkimAttributesRequest request)
AmazonPinpointEmailAsync
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable DKIM signing of email that you send from an email identity.public Future<PutEmailIdentityDkimAttributesResult> putEmailIdentityDkimAttributesAsync(PutEmailIdentityDkimAttributesRequest request, AsyncHandler<PutEmailIdentityDkimAttributesRequest,PutEmailIdentityDkimAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to enable or disable DKIM signing of email that you send from an email identity.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutEmailIdentityFeedbackAttributesResult> putEmailIdentityFeedbackAttributesAsync(PutEmailIdentityFeedbackAttributesRequest request)
AmazonPinpointEmailAsync
Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
putEmailIdentityFeedbackAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to set the attributes that control how bounce and complaint events are processed.public Future<PutEmailIdentityFeedbackAttributesResult> putEmailIdentityFeedbackAttributesAsync(PutEmailIdentityFeedbackAttributesRequest request, AsyncHandler<PutEmailIdentityFeedbackAttributesRequest,PutEmailIdentityFeedbackAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
putEmailIdentityFeedbackAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to set the attributes that control how bounce and complaint events are processed.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutEmailIdentityMailFromAttributesResult> putEmailIdentityMailFromAttributesAsync(PutEmailIdentityMailFromAttributesRequest request)
AmazonPinpointEmailAsync
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to configure the custom MAIL FROM domain for a verified identity.public Future<PutEmailIdentityMailFromAttributesResult> putEmailIdentityMailFromAttributesAsync(PutEmailIdentityMailFromAttributesRequest request, AsyncHandler<PutEmailIdentityMailFromAttributesRequest,PutEmailIdentityMailFromAttributesResult> asyncHandler)
AmazonPinpointEmailAsync
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesAsync
in interface AmazonPinpointEmailAsync
request
- A request to configure the custom MAIL FROM domain for a verified identity.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendEmailResult> sendEmailAsync(SendEmailRequest request)
AmazonPinpointEmailAsync
Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
sendEmailAsync
in interface AmazonPinpointEmailAsync
request
- A request to send an email message.public Future<SendEmailResult> sendEmailAsync(SendEmailRequest request, AsyncHandler<SendEmailRequest,SendEmailResult> asyncHandler)
AmazonPinpointEmailAsync
Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
sendEmailAsync
in interface AmazonPinpointEmailAsync
request
- A request to send an email message.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateConfigurationSetEventDestinationResult> updateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest request)
AmazonPinpointEmailAsync
Update the configuration of an event destination for a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
updateConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the settings for an event destination for a configuration set.public Future<UpdateConfigurationSetEventDestinationResult> updateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest request, AsyncHandler<UpdateConfigurationSetEventDestinationRequest,UpdateConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsync
Update the configuration of an event destination for a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
updateConfigurationSetEventDestinationAsync
in interface AmazonPinpointEmailAsync
request
- A request to change the settings for an event destination for a configuration set.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonPinpointEmail
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.