com.amazonaws.services.pinpointemail.AmazonPinpointEmail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pinpointemail Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.pinpointemail;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.pinpointemail.model.*;
/**
* Interface for accessing Pinpoint Email.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.pinpointemail.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPinpointEmail {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "email";
/**
*
* 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.
*
*
* @param createConfigurationSetRequest
* A request to create a configuration set.
* @return Result of the CreateConfigurationSet operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.CreateConfigurationSet
* @see AWS API Documentation
*/
CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest);
/**
*
* 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.
*
*
* @param createConfigurationSetEventDestinationRequest
* A request to add an event destination to a configuration set.
* @return Result of the CreateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.CreateConfigurationSetEventDestination
* @see AWS API Documentation
*/
CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(
CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest);
/**
*
* 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.
*
*
* @param createDedicatedIpPoolRequest
* A request to create a new dedicated IP pool.
* @return Result of the CreateDedicatedIpPool operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.CreateDedicatedIpPool
* @see AWS API Documentation
*/
CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest);
/**
*
* 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.
*
*
* @param 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.
* @return 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.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.CreateDeliverabilityTestReport
* @see AWS API Documentation
*/
CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest);
/**
*
* 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.
*
*
* @param createEmailIdentityRequest
* A request to begin the verification process for an email identity (an email address or domain).
* @return Result of the CreateEmailIdentity operation returned by the service.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.CreateEmailIdentity
* @see AWS API Documentation
*/
CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest);
/**
*
* 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.
*
*
* @param deleteConfigurationSetRequest
* A request to delete a configuration set.
* @return Result of the DeleteConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.DeleteConfigurationSet
* @see AWS API Documentation
*/
DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest);
/**
*
* 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.
*
*
* @param deleteConfigurationSetEventDestinationRequest
* A request to delete an event destination from a configuration set.
* @return Result of the DeleteConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.DeleteConfigurationSetEventDestination
* @see AWS API Documentation
*/
DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(
DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest);
/**
*
* Delete a dedicated IP pool.
*
*
* @param deleteDedicatedIpPoolRequest
* A request to delete a dedicated IP pool.
* @return Result of the DeleteDedicatedIpPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.DeleteDedicatedIpPool
* @see AWS API Documentation
*/
DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest);
/**
*
* 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.
*
*
* @param 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.
* @return Result of the DeleteEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonPinpointEmail.DeleteEmailIdentity
* @see AWS API Documentation
*/
DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest);
/**
*
* Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current
* AWS Region.
*
*
* @param getAccountRequest
* A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
* @return Result of the GetAccount operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetAccount
* @see AWS API
* Documentation
*/
GetAccountResult getAccount(GetAccountRequest getAccountRequest);
/**
*
* Retrieve a list of the blacklists that your dedicated IP addresses appear on.
*
*
* @param getBlacklistReportsRequest
* A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
* @return Result of the GetBlacklistReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetBlacklistReports
* @see AWS API Documentation
*/
GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest);
/**
*
* 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.
*
*
* @param getConfigurationSetRequest
* A request to obtain information about a configuration set.
* @return Result of the GetConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetConfigurationSet
* @see AWS API Documentation
*/
GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest);
/**
*
* 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.
*
*
* @param getConfigurationSetEventDestinationsRequest
* A request to obtain information about the event destinations for a configuration set.
* @return Result of the GetConfigurationSetEventDestinations operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetConfigurationSetEventDestinations
* @see AWS API Documentation
*/
GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(
GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest);
/**
*
* 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.
*
*
* @param getDedicatedIpRequest
* A request to obtain more information about a dedicated IP address.
* @return Result of the GetDedicatedIp operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetDedicatedIp
* @see AWS
* API Documentation
*/
GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest);
/**
*
* List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
*
*
* @param getDedicatedIpsRequest
* A request to obtain more information about dedicated IP pools.
* @return Result of the GetDedicatedIps operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetDedicatedIps
* @see AWS
* API Documentation
*/
GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest);
/**
*
* 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.
*
*
* @param 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.
* @return Result of the GetDeliverabilityDashboardOptions operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetDeliverabilityDashboardOptions
* @see AWS API Documentation
*/
GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest);
/**
*
* Retrieve the results of a predictive inbox placement test.
*
*
* @param getDeliverabilityTestReportRequest
* A request to retrieve the results of a predictive inbox placement test.
* @return Result of the GetDeliverabilityTestReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetDeliverabilityTestReport
* @see AWS API Documentation
*/
GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest);
/**
*
* 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).
*
*
* @param 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).
* @return Result of the GetDomainDeliverabilityCampaign operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonPinpointEmail.GetDomainDeliverabilityCampaign
* @see AWS API Documentation
*/
GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest);
/**
*
* Retrieve inbox placement and engagement rates for the domains that you use to send email.
*
*
* @param getDomainStatisticsReportRequest
* A request to obtain deliverability metrics for a domain.
* @return Result of the GetDomainStatisticsReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetDomainStatisticsReport
* @see AWS API Documentation
*/
GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest);
/**
*
* 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.
*
*
* @param getEmailIdentityRequest
* A request to return details about an email identity.
* @return Result of the GetEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.GetEmailIdentity
* @see AWS API Documentation
*/
GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest);
/**
*
* 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.
*
*
* @param listConfigurationSetsRequest
* A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
* Region.
* @return Result of the ListConfigurationSets operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.ListConfigurationSets
* @see AWS API Documentation
*/
ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest);
/**
*
* List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
*
*
* @param listDedicatedIpPoolsRequest
* A request to obtain a list of dedicated IP pools.
* @return Result of the ListDedicatedIpPools operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.ListDedicatedIpPools
* @see AWS API Documentation
*/
ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest);
/**
*
* 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.
*
*
* @param listDeliverabilityTestReportsRequest
* A request to list all of the predictive inbox placement tests that you've performed.
* @return Result of the ListDeliverabilityTestReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest);
/**
*
* 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.
*
*
* @param 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.
* @return Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonPinpointEmail.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest);
/**
*
* 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.
*
*
* @param 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.
* @return Result of the ListEmailIdentities operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.ListEmailIdentities
* @see AWS API Documentation
*/
ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonPinpointEmail.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Enable or disable the automatic warm-up feature for dedicated IP addresses.
*
*
* @param putAccountDedicatedIpWarmupAttributesRequest
* A request to enable or disable the automatic IP address warm-up feature.
* @return Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutAccountDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(
PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest);
/**
*
* Enable or disable the ability of your account to send email.
*
*
* @param putAccountSendingAttributesRequest
* A request to change the ability of your account to send email.
* @return Result of the PutAccountSendingAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutAccountSendingAttributes
* @see AWS API Documentation
*/
PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest);
/**
*
* 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.
*
*
* @param putConfigurationSetDeliveryOptionsRequest
* A request to associate a configuration set with a dedicated IP pool.
* @return Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutConfigurationSetDeliveryOptions
* @see AWS API Documentation
*/
PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(
PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest);
/**
*
* Enable or disable collection of reputation metrics for emails that you send using a particular configuration set
* in a specific AWS Region.
*
*
* @param putConfigurationSetReputationOptionsRequest
* A request to enable or disable tracking of reputation metrics for a configuration set.
* @return Result of the PutConfigurationSetReputationOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutConfigurationSetReputationOptions
* @see AWS API Documentation
*/
PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(
PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest);
/**
*
* Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
*
*
* @param putConfigurationSetSendingOptionsRequest
* A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
* configuration set.
* @return Result of the PutConfigurationSetSendingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutConfigurationSetSendingOptions
* @see AWS API Documentation
*/
PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest);
/**
*
* Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
*
*
* @param putConfigurationSetTrackingOptionsRequest
* A request to add a custom domain for tracking open and click events to a configuration set.
* @return Result of the PutConfigurationSetTrackingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(
PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest);
/**
*
* 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.
*
*
*
* @param putDedicatedIpInPoolRequest
* A request to move a dedicated IP address to a dedicated IP pool.
* @return Result of the PutDedicatedIpInPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutDedicatedIpInPool
* @see AWS API Documentation
*/
PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest);
/**
*
*
* @param 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.
* @return Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest);
/**
*
* 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.
*
*
* @param 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.
* @return Result of the PutDeliverabilityDashboardOption operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutDeliverabilityDashboardOption
* @see AWS API Documentation
*/
PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest);
/**
*
* Used to enable or disable DKIM authentication for an email identity.
*
*
* @param putEmailIdentityDkimAttributesRequest
* A request to enable or disable DKIM signing of email that you send from an email identity.
* @return Result of the PutEmailIdentityDkimAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutEmailIdentityDkimAttributes
* @see AWS API Documentation
*/
PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest);
/**
*
* 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).
*
*
* @param putEmailIdentityFeedbackAttributesRequest
* A request to set the attributes that control how bounce and complaint events are processed.
* @return Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutEmailIdentityFeedbackAttributes
* @see AWS API Documentation
*/
PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(
PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest);
/**
*
* Used to enable or disable the custom Mail-From domain configuration for an email identity.
*
*
* @param putEmailIdentityMailFromAttributesRequest
* A request to configure the custom MAIL FROM domain for a verified identity.
* @return Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.PutEmailIdentityMailFromAttributes
* @see AWS API Documentation
*/
PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(
PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest);
/**
*
* 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.
*
*
*
*
* @param sendEmailRequest
* A request to send an email message.
* @return Result of the SendEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.SendEmail
* @see AWS API
* Documentation
*/
SendEmailResult sendEmail(SendEmailRequest sendEmailRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonPinpointEmail.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Remove one or more tags (keys and values) from a specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonPinpointEmail.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateConfigurationSetEventDestinationRequest
* A request to change the settings for an event destination for a configuration set.
* @return Result of the UpdateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonPinpointEmail.UpdateConfigurationSetEventDestination
* @see AWS API Documentation
*/
UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(
UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}