AbstractAmazonPinpointEmail (AWS Java SDK for Amazon Pinpoint Email 1.12.404 API)

java.lang.Object
- com.amazonaws.services.pinpointemail.AbstractAmazonPinpointEmail

All Implemented Interfaces:

AmazonPinpointEmail

Direct Known Subclasses:

AbstractAmazonPinpointEmailAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonPinpointEmail
extends Object
implements AmazonPinpointEmail
```
Abstract implementation of AmazonPinpointEmail. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.pinpointemail.AmazonPinpointEmail
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonPinpointEmail()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonPinpointEmail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateConfigurationSetResult`	`createConfigurationSet(CreateConfigurationSetRequest request)` Create a configuration set.
`CreateConfigurationSetEventDestinationResult`	`createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)` Create an event destination.
`CreateDedicatedIpPoolResult`	`createDedicatedIpPool(CreateDedicatedIpPoolRequest request)` Create a new pool of dedicated IP addresses.
`CreateDeliverabilityTestReportResult`	`createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest request)` Create a new predictive inbox placement test.
`CreateEmailIdentityResult`	`createEmailIdentity(CreateEmailIdentityRequest request)` Verifies an email identity for use with Amazon Pinpoint.
`DeleteConfigurationSetResult`	`deleteConfigurationSet(DeleteConfigurationSetRequest request)` Delete an existing configuration set.
`DeleteConfigurationSetEventDestinationResult`	`deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)` Delete an event destination.
`DeleteDedicatedIpPoolResult`	`deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest request)` Delete a dedicated IP pool.
`DeleteEmailIdentityResult`	`deleteEmailIdentity(DeleteEmailIdentityRequest request)` Deletes an email identity that you previously verified for use with Amazon Pinpoint.
`GetAccountResult`	`getAccount(GetAccountRequest request)` Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
`GetBlacklistReportsResult`	`getBlacklistReports(GetBlacklistReportsRequest request)` Retrieve a list of the blacklists that your dedicated IP addresses appear on.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetConfigurationSetResult`	`getConfigurationSet(GetConfigurationSetRequest request)` Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
`GetConfigurationSetEventDestinationsResult`	`getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest request)` Retrieve a list of event destinations that are associated with a configuration set.
`GetDedicatedIpResult`	`getDedicatedIp(GetDedicatedIpRequest request)` Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
`GetDedicatedIpsResult`	`getDedicatedIps(GetDedicatedIpsRequest request)` List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
`GetDeliverabilityDashboardOptionsResult`	`getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest request)` Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
`GetDeliverabilityTestReportResult`	`getDeliverabilityTestReport(GetDeliverabilityTestReportRequest request)` Retrieve the results of a predictive inbox placement test.
`GetDomainDeliverabilityCampaignResult`	`getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest request)` Retrieve all the deliverability data for a specific campaign.
`GetDomainStatisticsReportResult`	`getDomainStatisticsReport(GetDomainStatisticsReportRequest request)` Retrieve inbox placement and engagement rates for the domains that you use to send email.
`GetEmailIdentityResult`	`getEmailIdentity(GetEmailIdentityRequest request)` 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.
`ListConfigurationSetsResult`	`listConfigurationSets(ListConfigurationSetsRequest request)` List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
`ListDedicatedIpPoolsResult`	`listDedicatedIpPools(ListDedicatedIpPoolsRequest request)` List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
`ListDeliverabilityTestReportsResult`	`listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest request)` Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
`ListDomainDeliverabilityCampaignsResult`	`listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest request)` Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.
`ListEmailIdentitiesResult`	`listEmailIdentities(ListEmailIdentitiesRequest request)` Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Retrieve a list of the tags (keys and values) that are associated with a specified resource.
`PutAccountDedicatedIpWarmupAttributesResult`	`putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest request)` Enable or disable the automatic warm-up feature for dedicated IP addresses.
`PutAccountSendingAttributesResult`	`putAccountSendingAttributes(PutAccountSendingAttributesRequest request)` Enable or disable the ability of your account to send email.
`PutConfigurationSetDeliveryOptionsResult`	`putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest request)` Associate a configuration set with a dedicated IP pool.
`PutConfigurationSetReputationOptionsResult`	`putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest request)` Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
`PutConfigurationSetSendingOptionsResult`	`putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest request)` Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
`PutConfigurationSetTrackingOptionsResult`	`putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest request)` Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
`PutDedicatedIpInPoolResult`	`putDedicatedIpInPool(PutDedicatedIpInPoolRequest request)` Move a dedicated IP address to an existing dedicated IP pool.
`PutDedicatedIpWarmupAttributesResult`	`putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest request)`
`PutDeliverabilityDashboardOptionResult`	`putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest request)` Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
`PutEmailIdentityDkimAttributesResult`	`putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest request)` Used to enable or disable DKIM authentication for an email identity.
`PutEmailIdentityFeedbackAttributesResult`	`putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest request)` Used to enable or disable feedback forwarding for an identity.
`PutEmailIdentityMailFromAttributesResult`	`putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest request)` Used to enable or disable the custom Mail-From domain configuration for an email identity.
`SendEmailResult`	`sendEmail(SendEmailRequest request)` Sends an email message.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Add one or more tags (keys and values) to a specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove one or more tags (keys and values) from a specified resource.
`UpdateConfigurationSetEventDestinationResult`	`updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)` Update the configuration of an event destination for a configuration set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonPinpointEmail
```
protected AbstractAmazonPinpointEmail()
```
- Method Detail
  - createConfigurationSet
```
public CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    createConfigurationSet in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to create a configuration set.
    
    Returns:
    
    Result of the CreateConfigurationSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConfigurationSetEventDestination
```
public CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    createConfigurationSetEventDestination in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to add an event destination to a configuration set.
    
    Returns:
    
    Result of the CreateConfigurationSetEventDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDedicatedIpPool
```
public CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    createDedicatedIpPool in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to create a new dedicated IP pool.
    
    Returns:
    
    Result of the CreateDedicatedIpPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDeliverabilityTestReport
```
public CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    createDeliverabilityTestReport in interface AmazonPinpointEmail
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the CreateDeliverabilityTestReport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEmailIdentity
```
public CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    createEmailIdentity in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to begin the verification process for an email identity (an email address or domain).
    
    Returns:
    
    Result of the CreateEmailIdentity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConfigurationSet
```
public DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    deleteConfigurationSet in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to delete a configuration set.
    
    Returns:
    
    Result of the DeleteConfigurationSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConfigurationSetEventDestination
```
public DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    deleteConfigurationSetEventDestination in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to delete an event destination from a configuration set.
    
    Returns:
    
    Result of the DeleteConfigurationSetEventDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDedicatedIpPool
```
public DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Delete a dedicated IP pool.
    
    Specified by:
    
    deleteDedicatedIpPool in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to delete a dedicated IP pool.
    
    Returns:
    
    Result of the DeleteDedicatedIpPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEmailIdentity
```
public DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    deleteEmailIdentity in interface AmazonPinpointEmail
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the DeleteEmailIdentity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccount
```
public GetAccountResult getAccount(GetAccountRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
    
    Specified by:
    
    getAccount in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
    
    Returns:
    
    Result of the GetAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBlacklistReports
```
public GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Retrieve a list of the blacklists that your dedicated IP addresses appear on.
    
    Specified by:
    
    getBlacklistReports in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
    
    Returns:
    
    Result of the GetBlacklistReports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getConfigurationSet
```
public GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    getConfigurationSet in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain information about a configuration set.
    
    Returns:
    
    Result of the GetConfigurationSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getConfigurationSetEventDestinations
```
public GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    getConfigurationSetEventDestinations in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain information about the event destinations for a configuration set.
    
    Returns:
    
    Result of the GetConfigurationSetEventDestinations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDedicatedIp
```
public GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    getDedicatedIp in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain more information about a dedicated IP address.
    
    Returns:
    
    Result of the GetDedicatedIp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDedicatedIps
```
public GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
    
    Specified by:
    
    getDedicatedIps in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain more information about dedicated IP pools.
    
    Returns:
    
    Result of the GetDedicatedIps operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeliverabilityDashboardOptions
```
public GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    getDeliverabilityDashboardOptions in interface AmazonPinpointEmail
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the GetDeliverabilityDashboardOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDeliverabilityTestReport
```
public GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Retrieve the results of a predictive inbox placement test.
    
    Specified by:
    
    getDeliverabilityTestReport in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to retrieve the results of a predictive inbox placement test.
    
    Returns:
    
    Result of the GetDeliverabilityTestReport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDomainDeliverabilityCampaign
```
public GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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).
    
    Specified by:
    
    getDomainDeliverabilityCampaign in interface AmazonPinpointEmail
    
    Parameters:
    
    request - Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for ( PutDeliverabilityDashboardOption operation).
    
    Returns:
    
    Result of the GetDomainDeliverabilityCampaign operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDomainStatisticsReport
```
public GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Retrieve inbox placement and engagement rates for the domains that you use to send email.
    
    Specified by:
    
    getDomainStatisticsReport in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain deliverability metrics for a domain.
    
    Returns:
    
    Result of the GetDomainStatisticsReport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEmailIdentity
```
public GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    getEmailIdentity in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to return details about an email identity.
    
    Returns:
    
    Result of the GetEmailIdentity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationSets
```
public ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    listConfigurationSets in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
    
    Returns:
    
    Result of the ListConfigurationSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDedicatedIpPools
```
public ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
    
    Specified by:
    
    listDedicatedIpPools in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to obtain a list of dedicated IP pools.
    
    Returns:
    
    Result of the ListDedicatedIpPools operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeliverabilityTestReports
```
public ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    listDeliverabilityTestReports in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to list all of the predictive inbox placement tests that you've performed.
    
    Returns:
    
    Result of the ListDeliverabilityTestReports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDomainDeliverabilityCampaigns
```
public ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    listDomainDeliverabilityCampaigns in interface AmazonPinpointEmail
    
    Parameters:
    
    request - Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.
    
    Returns:
    
    Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEmailIdentities
```
public ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    listEmailIdentities in interface AmazonPinpointEmail
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the ListEmailIdentities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource 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.
    
    Specified by:
    
    listTagsForResource in interface AmazonPinpointEmail
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAccountDedicatedIpWarmupAttributes
```
public PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Enable or disable the automatic warm-up feature for dedicated IP addresses.
    
    Specified by:
    
    putAccountDedicatedIpWarmupAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to enable or disable the automatic IP address warm-up feature.
    
    Returns:
    
    Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAccountSendingAttributes
```
public PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Enable or disable the ability of your account to send email.
    
    Specified by:
    
    putAccountSendingAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to change the ability of your account to send email.
    
    Returns:
    
    Result of the PutAccountSendingAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putConfigurationSetDeliveryOptions
```
public PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    putConfigurationSetDeliveryOptions in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to associate a configuration set with a dedicated IP pool.
    
    Returns:
    
    Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putConfigurationSetReputationOptions
```
public PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
    
    Specified by:
    
    putConfigurationSetReputationOptions in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to enable or disable tracking of reputation metrics for a configuration set.
    
    Returns:
    
    Result of the PutConfigurationSetReputationOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putConfigurationSetSendingOptions
```
public PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
    
    Specified by:
    
    putConfigurationSetSendingOptions in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
    
    Returns:
    
    Result of the PutConfigurationSetSendingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putConfigurationSetTrackingOptions
```
public PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
    
    Specified by:
    
    putConfigurationSetTrackingOptions in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to add a custom domain for tracking open and click events to a configuration set.
    
    Returns:
    
    Result of the PutConfigurationSetTrackingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putDedicatedIpInPool
```
public PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    putDedicatedIpInPool in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to move a dedicated IP address to a dedicated IP pool.
    
    Returns:
    
    Result of the PutDedicatedIpInPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putDedicatedIpWarmupAttributes
```
public PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Specified by:
    
    putDedicatedIpWarmupAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putDeliverabilityDashboardOption
```
public PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    putDeliverabilityDashboardOption in interface AmazonPinpointEmail
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the PutDeliverabilityDashboardOption operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEmailIdentityDkimAttributes
```
public PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Used to enable or disable DKIM authentication for an email identity.
    
    Specified by:
    
    putEmailIdentityDkimAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to enable or disable DKIM signing of email that you send from an email identity.
    
    Returns:
    
    Result of the PutEmailIdentityDkimAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEmailIdentityFeedbackAttributes
```
public PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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).
    
    Specified by:
    
    putEmailIdentityFeedbackAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to set the attributes that control how bounce and complaint events are processed.
    
    Returns:
    
    Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEmailIdentityMailFromAttributes
```
public PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Used to enable or disable the custom Mail-From domain configuration for an email identity.
    
    Specified by:
    
    putEmailIdentityMailFromAttributes in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to configure the custom MAIL FROM domain for a verified identity.
    
    Returns:
    
    Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendEmail
```
public SendEmailResult sendEmail(SendEmailRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    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.
    Specified by:
    
    sendEmail in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to send an email message.
    
    Returns:
    
    Result of the SendEmail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource 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.
    
    Specified by:
    
    tagResource in interface AmazonPinpointEmail
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Remove one or more tags (keys and values) from a specified resource.
    
    Specified by:
    
    untagResource in interface AmazonPinpointEmail
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConfigurationSetEventDestination
```
public UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    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.
    
    Specified by:
    
    updateConfigurationSetEventDestination in interface AmazonPinpointEmail
    
    Parameters:
    
    request - A request to change the settings for an event destination for a configuration set.
    
    Returns:
    
    Result of the UpdateConfigurationSetEventDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonPinpointEmail
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonPinpointEmail
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonPinpointEmail
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonPinpointEmail
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonPinpointEmail

Field Summary

Fields inherited from interface com.amazonaws.services.pinpointemail.AmazonPinpointEmail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonPinpointEmail

Method Detail

createConfigurationSet

createConfigurationSetEventDestination

createDedicatedIpPool

createDeliverabilityTestReport

createEmailIdentity

deleteConfigurationSet

deleteConfigurationSetEventDestination

deleteDedicatedIpPool

deleteEmailIdentity

getAccount

getBlacklistReports

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

updateConfigurationSetEventDestination

shutdown

getCachedResponseMetadata