@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.
Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.
Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createConfigurationSet, createConfigurationSetEventDestination, createDedicatedIpPool, createDeliverabilityTestReport, createEmailIdentity, deleteConfigurationSet, deleteConfigurationSetEventDestination, deleteDedicatedIpPool, deleteEmailIdentity, getAccount, getBlacklistReports, getCachedResponseMetadata, getConfigurationSet, getConfigurationSetEventDestinations, getDedicatedIp, getDedicatedIps, getDeliverabilityDashboardOptions, getDeliverabilityTestReport, getDomainDeliverabilityCampaign, getDomainStatisticsReport, getEmailIdentity, listConfigurationSets, listDedicatedIpPools, listDeliverabilityTestReports, listDomainDeliverabilityCampaigns, listEmailIdentities, listTagsForResource, putAccountDedicatedIpWarmupAttributes, putAccountSendingAttributes, putConfigurationSetDeliveryOptions, putConfigurationSetReputationOptions, putConfigurationSetSendingOptions, putConfigurationSetTrackingOptions, putDedicatedIpInPool, putDedicatedIpWarmupAttributes, putDeliverabilityDashboardOption, putEmailIdentityDkimAttributes, putEmailIdentityFeedbackAttributes, putEmailIdentityMailFromAttributes, sendEmail, tagResource, untagResource, updateConfigurationSetEventDestinationaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateConfigurationSet, createConfigurationSetEventDestination, createDedicatedIpPool, createDeliverabilityTestReport, createEmailIdentity, deleteConfigurationSet, deleteConfigurationSetEventDestination, deleteDedicatedIpPool, deleteEmailIdentity, getAccount, getBlacklistReports, getCachedResponseMetadata, getConfigurationSet, getConfigurationSetEventDestinations, getDedicatedIp, getDedicatedIps, getDeliverabilityDashboardOptions, getDeliverabilityTestReport, getDomainDeliverabilityCampaign, getDomainStatisticsReport, getEmailIdentity, listConfigurationSets, listDedicatedIpPools, listDeliverabilityTestReports, listDomainDeliverabilityCampaigns, listEmailIdentities, listTagsForResource, putAccountDedicatedIpWarmupAttributes, putAccountSendingAttributes, putConfigurationSetDeliveryOptions, putConfigurationSetReputationOptions, putConfigurationSetSendingOptions, putConfigurationSetTrackingOptions, putDedicatedIpInPool, putDedicatedIpWarmupAttributes, putDeliverabilityDashboardOption, putEmailIdentityDkimAttributes, putEmailIdentityFeedbackAttributes, putEmailIdentityMailFromAttributes, sendEmail, tagResource, untagResource, updateConfigurationSetEventDestinationpublic static AmazonPinpointEmailAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - A request to create a configuration set.public Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request, AsyncHandler<CreateConfigurationSetRequest,CreateConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - A request to add an event destination to a configuration set.public Future<CreateConfigurationSetEventDestinationResult> createConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest request, AsyncHandler<CreateConfigurationSetEventDestinationRequest,CreateConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - A request to create a new dedicated IP pool.public Future<CreateDedicatedIpPoolResult> createDedicatedIpPoolAsync(CreateDedicatedIpPoolRequest request, AsyncHandler<CreateDedicatedIpPoolRequest,CreateDedicatedIpPoolResult> asyncHandler)
AmazonPinpointEmailAsyncCreate 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 AmazonPinpointEmailAsyncrequest - 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<CreateDeliverabilityTestReportResult> createDeliverabilityTestReportAsync(CreateDeliverabilityTestReportRequest request)
AmazonPinpointEmailAsync
Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
messages will be handled by various email providers around the world. When you perform a predictive inbox
placement test, you provide a sample message that contains the content that you plan to send to your customers.
Amazon Pinpoint then sends that message to special email addresses spread across several major email providers.
After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
operation to view the results of the test.
createDeliverabilityTestReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you
predict how your messages will be handled by various email providers around the world. When you perform a
predictive inbox placement test, you provide a sample message that contains the content that you plan to
send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across
several major email providers. After about 24 hours, the test is complete, and you can use the
GetDeliverabilityTestReport operation to view the results of the test.public Future<CreateDeliverabilityTestReportResult> createDeliverabilityTestReportAsync(CreateDeliverabilityTestReportRequest request, AsyncHandler<CreateDeliverabilityTestReportRequest,CreateDeliverabilityTestReportResult> asyncHandler)
AmazonPinpointEmailAsync
Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
messages will be handled by various email providers around the world. When you perform a predictive inbox
placement test, you provide a sample message that contains the content that you plan to send to your customers.
Amazon Pinpoint then sends that message to special email addresses spread across several major email providers.
After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
operation to view the results of the test.
createDeliverabilityTestReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you
predict how your messages will be handled by various email providers around the world. When you perform a
predictive inbox placement test, you provide a sample message that contains the content that you plan to
send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across
several major email providers. After about 24 hours, the test is complete, and you can use the
GetDeliverabilityTestReport operation to view the results of the test.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)
AmazonPinpointEmailAsyncVerifies 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncVerifies 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncDelete 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 AmazonPinpointEmailAsyncrequest - A request to delete a configuration set.public Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest request, AsyncHandler<DeleteConfigurationSetRequest,DeleteConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsyncDelete 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncDelete 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 AmazonPinpointEmailAsyncrequest - A request to delete an event destination from a configuration set.public Future<DeleteConfigurationSetEventDestinationResult> deleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest request, AsyncHandler<DeleteConfigurationSetEventDestinationRequest,DeleteConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsyncDelete 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncDelete a dedicated IP pool.
deleteDedicatedIpPoolAsync in interface AmazonPinpointEmailAsyncrequest - A request to delete a dedicated IP pool.public Future<DeleteDedicatedIpPoolResult> deleteDedicatedIpPoolAsync(DeleteDedicatedIpPoolRequest request, AsyncHandler<DeleteDedicatedIpPoolRequest,DeleteDedicatedIpPoolResult> asyncHandler)
AmazonPinpointEmailAsyncDelete a dedicated IP pool.
deleteDedicatedIpPoolAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncDeletes 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncDeletes 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncObtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
getAccountAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncObtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
getAccountAsync in interface AmazonPinpointEmailAsyncrequest - 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<GetBlacklistReportsResult> getBlacklistReportsAsync(GetBlacklistReportsRequest request)
AmazonPinpointEmailAsyncRetrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReportsAsync in interface AmazonPinpointEmailAsyncrequest - A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.public Future<GetBlacklistReportsResult> getBlacklistReportsAsync(GetBlacklistReportsRequest request, AsyncHandler<GetBlacklistReportsRequest,GetBlacklistReportsResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReportsAsync in interface AmazonPinpointEmailAsyncrequest - A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.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)
AmazonPinpointEmailAsyncGet 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 AmazonPinpointEmailAsyncrequest - A request to obtain information about a configuration set.public Future<GetConfigurationSetResult> getConfigurationSetAsync(GetConfigurationSetRequest request, AsyncHandler<GetConfigurationSetRequest,GetConfigurationSetResult> asyncHandler)
AmazonPinpointEmailAsyncGet 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncRetrieve 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 AmazonPinpointEmailAsyncrequest - A request to obtain information about the event destinations for a configuration set.public Future<GetConfigurationSetEventDestinationsResult> getConfigurationSetEventDestinationsAsync(GetConfigurationSetEventDestinationsRequest request, AsyncHandler<GetConfigurationSetEventDestinationsRequest,GetConfigurationSetEventDestinationsResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncGet 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 AmazonPinpointEmailAsyncrequest - A request to obtain more information about a dedicated IP address.public Future<GetDedicatedIpResult> getDedicatedIpAsync(GetDedicatedIpRequest request, AsyncHandler<GetDedicatedIpRequest,GetDedicatedIpResult> asyncHandler)
AmazonPinpointEmailAsyncGet 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncList the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsAsync in interface AmazonPinpointEmailAsyncrequest - A request to obtain more information about dedicated IP pools.public Future<GetDedicatedIpsResult> getDedicatedIpsAsync(GetDedicatedIpsRequest request, AsyncHandler<GetDedicatedIpsRequest,GetDedicatedIpsResult> asyncHandler)
AmazonPinpointEmailAsyncList the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsAsync in interface AmazonPinpointEmailAsyncrequest - 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<GetDeliverabilityDashboardOptionsResult> getDeliverabilityDashboardOptionsAsync(GetDeliverabilityDashboardOptionsRequest request)
AmazonPinpointEmailAsyncRetrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
getDeliverabilityDashboardOptionsAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other
metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to
perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
public Future<GetDeliverabilityDashboardOptionsResult> getDeliverabilityDashboardOptionsAsync(GetDeliverabilityDashboardOptionsRequest request, AsyncHandler<GetDeliverabilityDashboardOptionsRequest,GetDeliverabilityDashboardOptionsResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
getDeliverabilityDashboardOptionsAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other
metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to
perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
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<GetDeliverabilityTestReportResult> getDeliverabilityTestReportAsync(GetDeliverabilityTestReportRequest request)
AmazonPinpointEmailAsyncRetrieve the results of a predictive inbox placement test.
getDeliverabilityTestReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to retrieve the results of a predictive inbox placement test.public Future<GetDeliverabilityTestReportResult> getDeliverabilityTestReportAsync(GetDeliverabilityTestReportRequest request, AsyncHandler<GetDeliverabilityTestReportRequest,GetDeliverabilityTestReportResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve the results of a predictive inbox placement test.
getDeliverabilityTestReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to retrieve the results of a predictive inbox placement test.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<GetDomainDeliverabilityCampaignResult> getDomainDeliverabilityCampaignAsync(GetDomainDeliverabilityCampaignRequest request)
AmazonPinpointEmailAsync
Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the
campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption operation).
getDomainDeliverabilityCampaignAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only
if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption operation).public Future<GetDomainDeliverabilityCampaignResult> getDomainDeliverabilityCampaignAsync(GetDomainDeliverabilityCampaignRequest request, AsyncHandler<GetDomainDeliverabilityCampaignRequest,GetDomainDeliverabilityCampaignResult> asyncHandler)
AmazonPinpointEmailAsync
Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the
campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption operation).
getDomainDeliverabilityCampaignAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only
if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption operation).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<GetDomainStatisticsReportResult> getDomainStatisticsReportAsync(GetDomainStatisticsReportRequest request)
AmazonPinpointEmailAsyncRetrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to obtain deliverability metrics for a domain.public Future<GetDomainStatisticsReportResult> getDomainStatisticsReportAsync(GetDomainStatisticsReportRequest request, AsyncHandler<GetDomainStatisticsReportRequest,GetDomainStatisticsReportResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReportAsync in interface AmazonPinpointEmailAsyncrequest - A request to obtain deliverability metrics for a 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<GetEmailIdentityResult> getEmailIdentityAsync(GetEmailIdentityRequest request)
AmazonPinpointEmailAsyncProvides 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 AmazonPinpointEmailAsyncrequest - A request to return details about an email identity.public Future<GetEmailIdentityResult> getEmailIdentityAsync(GetEmailIdentityRequest request, AsyncHandler<GetEmailIdentityRequest,GetEmailIdentityResult> asyncHandler)
AmazonPinpointEmailAsyncProvides 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncList 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncList 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncList all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
listDedicatedIpPoolsAsync in interface AmazonPinpointEmailAsyncrequest - A request to obtain a list of dedicated IP pools.public Future<ListDedicatedIpPoolsResult> listDedicatedIpPoolsAsync(ListDedicatedIpPoolsRequest request, AsyncHandler<ListDedicatedIpPoolsRequest,ListDedicatedIpPoolsResult> asyncHandler)
AmazonPinpointEmailAsyncList all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
listDedicatedIpPoolsAsync in interface AmazonPinpointEmailAsyncrequest - 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<ListDeliverabilityTestReportsResult> listDeliverabilityTestReportsAsync(ListDeliverabilityTestReportsRequest request)
AmazonPinpointEmailAsync
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
operation to view the results.
listDeliverabilityTestReportsAsync in interface AmazonPinpointEmailAsyncrequest - A request to list all of the predictive inbox placement tests that you've performed.public Future<ListDeliverabilityTestReportsResult> listDeliverabilityTestReportsAsync(ListDeliverabilityTestReportsRequest request, AsyncHandler<ListDeliverabilityTestReportsRequest,ListDeliverabilityTestReportsResult> asyncHandler)
AmazonPinpointEmailAsync
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
operation to view the results.
listDeliverabilityTestReportsAsync in interface AmazonPinpointEmailAsyncrequest - A request to list all of the predictive inbox placement tests that you've performed.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<ListDomainDeliverabilityCampaignsResult> listDomainDeliverabilityCampaignsAsync(ListDomainDeliverabilityCampaignsRequest request)
AmazonPinpointEmailAsync
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range. This data is available for a domain only if you enabled the Deliverability dashboard (
PutDeliverabilityDashboardOption operation) for the domain.
listDomainDeliverabilityCampaignsAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
specified time range. This data is available for a domain only if you enabled the Deliverability dashboard
(PutDeliverabilityDashboardOption operation) for the domain.public Future<ListDomainDeliverabilityCampaignsResult> listDomainDeliverabilityCampaignsAsync(ListDomainDeliverabilityCampaignsRequest request, AsyncHandler<ListDomainDeliverabilityCampaignsRequest,ListDomainDeliverabilityCampaignsResult> asyncHandler)
AmazonPinpointEmailAsync
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range. This data is available for a domain only if you enabled the Deliverability dashboard (
PutDeliverabilityDashboardOption operation) for the domain.
listDomainDeliverabilityCampaignsAsync in interface AmazonPinpointEmailAsyncrequest - Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
specified time range. This data is available for a domain only if you enabled the Deliverability dashboard
(PutDeliverabilityDashboardOption operation) for the 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<ListEmailIdentitiesResult> listEmailIdentitiesAsync(ListEmailIdentitiesRequest request)
AmazonPinpointEmailAsyncReturns 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncReturns 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 AmazonPinpointEmailAsyncrequest - 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonPinpointEmailAsyncRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
listTagsForResourceAsync in interface AmazonPinpointEmailAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonPinpointEmailAsyncRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
listTagsForResourceAsync in interface AmazonPinpointEmailAsyncasyncHandler - 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)
AmazonPinpointEmailAsyncEnable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesAsync in interface AmazonPinpointEmailAsyncrequest - A request to enable or disable the automatic IP address warm-up feature.public Future<PutAccountDedicatedIpWarmupAttributesResult> putAccountDedicatedIpWarmupAttributesAsync(PutAccountDedicatedIpWarmupAttributesRequest request, AsyncHandler<PutAccountDedicatedIpWarmupAttributesRequest,PutAccountDedicatedIpWarmupAttributesResult> asyncHandler)
AmazonPinpointEmailAsyncEnable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncEnable or disable the ability of your account to send email.
putAccountSendingAttributesAsync in interface AmazonPinpointEmailAsyncrequest - A request to change the ability of your account to send email.public Future<PutAccountSendingAttributesResult> putAccountSendingAttributesAsync(PutAccountSendingAttributesRequest request, AsyncHandler<PutAccountSendingAttributesRequest,PutAccountSendingAttributesResult> asyncHandler)
AmazonPinpointEmailAsyncEnable or disable the ability of your account to send email.
putAccountSendingAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncAssociate 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 AmazonPinpointEmailAsyncrequest - A request to associate a configuration set with a dedicated IP pool.public Future<PutConfigurationSetDeliveryOptionsResult> putConfigurationSetDeliveryOptionsAsync(PutConfigurationSetDeliveryOptionsRequest request, AsyncHandler<PutConfigurationSetDeliveryOptionsRequest,PutConfigurationSetDeliveryOptionsResult> asyncHandler)
AmazonPinpointEmailAsyncAssociate 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetReputationOptionsAsync in interface AmazonPinpointEmailAsyncrequest - A request to enable or disable tracking of reputation metrics for a configuration set.public Future<PutConfigurationSetReputationOptionsResult> putConfigurationSetReputationOptionsAsync(PutConfigurationSetReputationOptionsRequest request, AsyncHandler<PutConfigurationSetReputationOptionsRequest,PutConfigurationSetReputationOptionsResult> asyncHandler)
AmazonPinpointEmailAsyncEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
putConfigurationSetReputationOptionsAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncEnable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptionsAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncEnable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptionsAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncSpecify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
putConfigurationSetTrackingOptionsAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncSpecify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
putConfigurationSetTrackingOptionsAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncMove 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 AmazonPinpointEmailAsyncrequest - A request to move a dedicated IP address to a dedicated IP pool.public Future<PutDedicatedIpInPoolResult> putDedicatedIpInPoolAsync(PutDedicatedIpInPoolRequest request, AsyncHandler<PutDedicatedIpInPoolRequest,PutDedicatedIpInPoolResult> asyncHandler)
AmazonPinpointEmailAsyncMove 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncputDedicatedIpWarmupAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncputDedicatedIpWarmupAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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<PutDeliverabilityDashboardOptionResult> putDeliverabilityDashboardOptionAsync(PutDeliverabilityDashboardOptionRequest request)
AmazonPinpointEmailAsyncEnable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
putDeliverabilityDashboardOptionAsync in interface AmazonPinpointEmailAsyncrequest - Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the
Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains
that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox
placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
public Future<PutDeliverabilityDashboardOptionResult> putDeliverabilityDashboardOptionAsync(PutDeliverabilityDashboardOptionRequest request, AsyncHandler<PutDeliverabilityDashboardOptionRequest,PutDeliverabilityDashboardOptionResult> asyncHandler)
AmazonPinpointEmailAsyncEnable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
putDeliverabilityDashboardOptionAsync in interface AmazonPinpointEmailAsyncrequest - Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the
Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains
that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox
placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
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)
AmazonPinpointEmailAsyncUsed to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncUsed to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncUsed 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncUsed 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 AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncUsed to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesAsync in interface AmazonPinpointEmailAsyncrequest - A request to configure the custom MAIL FROM domain for a verified identity.public Future<PutEmailIdentityMailFromAttributesResult> putEmailIdentityMailFromAttributesAsync(PutEmailIdentityMailFromAttributesRequest request, AsyncHandler<PutEmailIdentityMailFromAttributesRequest,PutEmailIdentityMailFromAttributesResult> asyncHandler)
AmazonPinpointEmailAsyncUsed to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesAsync in interface AmazonPinpointEmailAsyncrequest - 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)
AmazonPinpointEmailAsyncSends 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 AmazonPinpointEmailAsyncrequest - A request to send an email message.public Future<SendEmailResult> sendEmailAsync(SendEmailRequest request, AsyncHandler<SendEmailRequest,SendEmailResult> asyncHandler)
AmazonPinpointEmailAsyncSends 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 AmazonPinpointEmailAsyncrequest - 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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonPinpointEmailAsyncAdd one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
tagResourceAsync in interface AmazonPinpointEmailAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonPinpointEmailAsyncAdd one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
tagResourceAsync in interface AmazonPinpointEmailAsyncasyncHandler - 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonPinpointEmailAsyncRemove one or more tags (keys and values) from a specified resource.
untagResourceAsync in interface AmazonPinpointEmailAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonPinpointEmailAsyncRemove one or more tags (keys and values) from a specified resource.
untagResourceAsync in interface AmazonPinpointEmailAsyncasyncHandler - 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)
AmazonPinpointEmailAsyncUpdate 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 AmazonPinpointEmailAsyncrequest - A request to change the settings for an event destination for a configuration set.public Future<UpdateConfigurationSetEventDestinationResult> updateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest request, AsyncHandler<UpdateConfigurationSetEventDestinationRequest,UpdateConfigurationSetEventDestinationResult> asyncHandler)
AmazonPinpointEmailAsyncUpdate 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 AmazonPinpointEmailAsyncrequest - 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 AmazonPinpointEmailshutdown in class AmazonPinpointEmailClient