com.amazonaws.services.pinpointemail

Interface AmazonPinpointEmail

All Known Subinterfaces:

AmazonPinpointEmailAsync

All Known Implementing Classes:

AbstractAmazonPinpointEmail, AbstractAmazonPinpointEmailAsync, AmazonPinpointEmailAsyncClient, AmazonPinpointEmailClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPinpointEmail

Interface for accessing Pinpoint Email.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPinpointEmail instead.

Amazon Pinpoint Email Service

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConfigurationSetResult	createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Create a configuration set.
CreateConfigurationSetEventDestinationResult	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create an event destination.
CreateDedicatedIpPoolResult	createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest) Create a new pool of dedicated IP addresses.
CreateDeliverabilityTestReportResult	createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest) Create a new predictive inbox placement test.
CreateEmailIdentityResult	createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest) Verifies an email identity for use with Amazon Pinpoint.
DeleteConfigurationSetResult	deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Delete an existing configuration set.
DeleteConfigurationSetEventDestinationResult	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Delete an event destination.
DeleteDedicatedIpPoolResult	deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest) Delete a dedicated IP pool.
DeleteEmailIdentityResult	deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest) Deletes an email identity that you previously verified for use with Amazon Pinpoint.
GetAccountResult	getAccount(GetAccountRequest getAccountRequest) Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
GetBlacklistReportsResult	getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest) 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 getConfigurationSetRequest) 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 getConfigurationSetEventDestinationsRequest) Retrieve a list of event destinations that are associated with a configuration set.
GetDedicatedIpResult	getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest) 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 getDedicatedIpsRequest) List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
GetDeliverabilityDashboardOptionsResult	getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest) Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
GetDeliverabilityTestReportResult	getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) Retrieve the results of a predictive inbox placement test.
GetDomainDeliverabilityCampaignResult	getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest) Retrieve all the deliverability data for a specific campaign.
GetDomainStatisticsReportResult	getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest) Retrieve inbox placement and engagement rates for the domains that you use to send email.
GetEmailIdentityResult	getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest) 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 listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
ListDedicatedIpPoolsResult	listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
ListDeliverabilityTestReportsResult	listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
ListDomainDeliverabilityCampaignsResult	listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.
ListEmailIdentitiesResult	listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest) Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified resource.
PutAccountDedicatedIpWarmupAttributesResult	putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest) Enable or disable the automatic warm-up feature for dedicated IP addresses.
PutAccountSendingAttributesResult	putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) Enable or disable the ability of your account to send email.
PutConfigurationSetDeliveryOptionsResult	putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) Associate a configuration set with a dedicated IP pool.
PutConfigurationSetReputationOptionsResult	putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest) 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 putConfigurationSetSendingOptionsRequest) Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
PutConfigurationSetTrackingOptionsResult	putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest) Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
PutDedicatedIpInPoolResult	putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest) Move a dedicated IP address to an existing dedicated IP pool.
PutDedicatedIpWarmupAttributesResult	putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
PutDeliverabilityDashboardOptionResult	putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest) Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
PutEmailIdentityDkimAttributesResult	putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) Used to enable or disable DKIM authentication for an email identity.
PutEmailIdentityFeedbackAttributesResult	putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest) Used to enable or disable feedback forwarding for an identity.
PutEmailIdentityMailFromAttributesResult	putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest) Used to enable or disable the custom Mail-From domain configuration for an email identity.
SendEmailResult	sendEmail(SendEmailRequest sendEmailRequest) Sends an email message.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add one or more tags (keys and values) to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
UpdateConfigurationSetEventDestinationResult	updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update the configuration of an event destination for a configuration set.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConfigurationSet

CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)

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.

Parameters:

createConfigurationSetRequest - A request to create a configuration set.

Returns:

Result of the CreateConfigurationSet operation returned by the service.

Throws:

AlreadyExistsException - The resource specified in your request already exists.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

LimitExceededException - There are too many instances of the specified resource type.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

createConfigurationSetEventDestination

CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)

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.

Parameters:

createConfigurationSetEventDestinationRequest - A request to add an event destination to a configuration set.

Returns:

Result of the CreateConfigurationSetEventDestination operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

AlreadyExistsException - The resource specified in your request already exists.

LimitExceededException - There are too many instances of the specified resource type.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

createDedicatedIpPool

CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)

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.

Parameters:

createDedicatedIpPoolRequest - A request to create a new dedicated IP pool.

Returns:

Result of the CreateDedicatedIpPool operation returned by the service.

Throws:

AlreadyExistsException - The resource specified in your request already exists.

LimitExceededException - There are too many instances of the specified resource type.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

createDeliverabilityTestReport

CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)

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.

Parameters:

createDeliverabilityTestReportRequest - 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.

Throws:

AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.

SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.

MessageRejectedException - The message can't be sent because it contains invalid content.

MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

LimitExceededException - There are too many instances of the specified resource type.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

createEmailIdentity

CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)

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.

Parameters:

createEmailIdentityRequest - 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.

Throws:

LimitExceededException - There are too many instances of the specified resource type.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

deleteConfigurationSet

DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)

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.

Parameters:

deleteConfigurationSetRequest - A request to delete a configuration set.

Returns:

Result of the DeleteConfigurationSet operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)

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.

Parameters:

deleteConfigurationSetEventDestinationRequest - A request to delete an event destination from a configuration set.

Returns:

Result of the DeleteConfigurationSetEventDestination operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

deleteDedicatedIpPool

DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)

Delete a dedicated IP pool.

Parameters:

deleteDedicatedIpPoolRequest - A request to delete a dedicated IP pool.

Returns:

Result of the DeleteDedicatedIpPool operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

deleteEmailIdentity

DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)

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.

Parameters:

deleteEmailIdentityRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

See Also:

AWS API Documentation

getAccount

GetAccountResult getAccount(GetAccountRequest getAccountRequest)

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Parameters:

getAccountRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getBlacklistReports

GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Parameters:

getBlacklistReportsRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getConfigurationSet

GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest)

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.

Parameters:

getConfigurationSetRequest - A request to obtain information about a configuration set.

Returns:

Result of the GetConfigurationSet operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)

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.

Parameters:

getConfigurationSetEventDestinationsRequest - A request to obtain information about the event destinations for a configuration set.

Returns:

Result of the GetConfigurationSetEventDestinations operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getDedicatedIp

GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest)

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.

Parameters:

getDedicatedIpRequest - A request to obtain more information about a dedicated IP address.

Returns:

Result of the GetDedicatedIp operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getDedicatedIps

GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

Parameters:

getDedicatedIpsRequest - A request to obtain more information about dedicated IP pools.

Returns:

Result of the GetDedicatedIps operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getDeliverabilityDashboardOptions

GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)

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.

Parameters:

getDeliverabilityDashboardOptionsRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

LimitExceededException - There are too many instances of the specified resource type.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getDeliverabilityTestReport

GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)

Retrieve the results of a predictive inbox placement test.

Parameters:

getDeliverabilityTestReportRequest - A request to retrieve the results of a predictive inbox placement test.

Returns:

Result of the GetDeliverabilityTestReport operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getDomainDeliverabilityCampaign

GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)

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).

Parameters:

getDomainDeliverabilityCampaignRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

NotFoundException - The resource you attempted to access doesn't exist.

See Also:

AWS API Documentation

getDomainStatisticsReport

GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Parameters:

getDomainStatisticsReportRequest - A request to obtain deliverability metrics for a domain.

Returns:

Result of the GetDomainStatisticsReport operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

getEmailIdentity

GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest)

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.

Parameters:

getEmailIdentityRequest - A request to return details about an email identity.

Returns:

Result of the GetEmailIdentity operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

listConfigurationSets

ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)

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.

Parameters:

listConfigurationSetsRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

listDedicatedIpPools

ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Parameters:

listDedicatedIpPoolsRequest - A request to obtain a list of dedicated IP pools.

Returns:

Result of the ListDedicatedIpPools operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

listDeliverabilityTestReports

ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)

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.

Parameters:

listDeliverabilityTestReportsRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

listDomainDeliverabilityCampaigns

ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)

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.

Parameters:

listDomainDeliverabilityCampaignsRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

NotFoundException - The resource you attempted to access doesn't exist.

See Also:

AWS API Documentation

listEmailIdentities

ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)

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.

Parameters:

listEmailIdentitiesRequest - 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.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - The input you provided is invalid.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

See Also:

AWS API Documentation

putAccountDedicatedIpWarmupAttributes

PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Parameters:

putAccountDedicatedIpWarmupAttributesRequest - A request to enable or disable the automatic IP address warm-up feature.

Returns:

Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putAccountSendingAttributes

PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)

Enable or disable the ability of your account to send email.

Parameters:

putAccountSendingAttributesRequest - A request to change the ability of your account to send email.

Returns:

Result of the PutAccountSendingAttributes operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putConfigurationSetDeliveryOptions

PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)

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.

Parameters:

putConfigurationSetDeliveryOptionsRequest - A request to associate a configuration set with a dedicated IP pool.

Returns:

Result of the PutConfigurationSetDeliveryOptions operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putConfigurationSetReputationOptions

PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest)

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

Parameters:

putConfigurationSetReputationOptionsRequest - A request to enable or disable tracking of reputation metrics for a configuration set.

Returns:

Result of the PutConfigurationSetReputationOptions operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putConfigurationSetSendingOptions

PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

Parameters:

putConfigurationSetSendingOptionsRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putConfigurationSetTrackingOptions

PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest)

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Parameters:

putConfigurationSetTrackingOptionsRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putDedicatedIpInPool

PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)

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.

Parameters:

putDedicatedIpInPoolRequest - A request to move a dedicated IP address to a dedicated IP pool.

Returns:

Result of the PutDedicatedIpInPool operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putDedicatedIpWarmupAttributes

PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)

Parameters:

putDedicatedIpWarmupAttributesRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putDeliverabilityDashboardOption

PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)

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.

Parameters:

putDeliverabilityDashboardOptionRequest - 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.

Throws:

AlreadyExistsException - The resource specified in your request already exists.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

LimitExceededException - There are too many instances of the specified resource type.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putEmailIdentityDkimAttributes

PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)

Used to enable or disable DKIM authentication for an email identity.

Parameters:

putEmailIdentityDkimAttributesRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putEmailIdentityFeedbackAttributes

PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)

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).

Parameters:

putEmailIdentityFeedbackAttributesRequest - 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.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

putEmailIdentityMailFromAttributes

PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Parameters:

putEmailIdentityMailFromAttributesRequest - A request to configure the custom MAIL FROM domain for a verified identity.

Returns:

Result of the PutEmailIdentityMailFromAttributes operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

sendEmail

SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)

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.

Parameters:

sendEmailRequest - A request to send an email message.

Returns:

Result of the SendEmail operation returned by the service.

Throws:

TooManyRequestsException - Too many requests have been made to the operation.

LimitExceededException - There are too many instances of the specified resource type.

AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.

SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.

MessageRejectedException - The message can't be sent because it contains invalid content.

MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.

NotFoundException - The resource you attempted to access doesn't exist.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove one or more tags (keys and values) from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - The input you provided is invalid.

ConcurrentModificationException - The resource is being modified by another operation or thread.

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)

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.

Parameters:

updateConfigurationSetEventDestinationRequest - A request to change the settings for an event destination for a configuration set.

Returns:

Result of the UpdateConfigurationSetEventDestination operation returned by the service.

Throws:

NotFoundException - The resource you attempted to access doesn't exist.

TooManyRequestsException - Too many requests have been made to the operation.

BadRequestException - The input you provided is invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.