Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

@aws-sdk/client-pinpoint-email

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.

Index

Enumerations

Classes

$Command AccountSuspendedException AlreadyExistsException BadRequestException ConcurrentModificationException CreateConfigurationSetCommand CreateConfigurationSetEventDestinationCommand CreateDedicatedIpPoolCommand CreateDeliverabilityTestReportCommand CreateEmailIdentityCommand DeleteConfigurationSetCommand DeleteConfigurationSetEventDestinationCommand DeleteDedicatedIpPoolCommand DeleteEmailIdentityCommand GetAccountCommand GetBlacklistReportsCommand GetConfigurationSetCommand GetConfigurationSetEventDestinationsCommand GetDedicatedIpCommand GetDedicatedIpsCommand GetDeliverabilityDashboardOptionsCommand GetDeliverabilityTestReportCommand GetDomainDeliverabilityCampaignCommand GetDomainStatisticsReportCommand GetEmailIdentityCommand LimitExceededException ListConfigurationSetsCommand ListDedicatedIpPoolsCommand ListDeliverabilityTestReportsCommand ListDomainDeliverabilityCampaignsCommand ListEmailIdentitiesCommand ListTagsForResourceCommand MailFromDomainNotVerifiedException MessageRejected NotFoundException PinpointEmail PinpointEmailClient PinpointEmailServiceException PutAccountDedicatedIpWarmupAttributesCommand PutAccountSendingAttributesCommand PutConfigurationSetDeliveryOptionsCommand PutConfigurationSetReputationOptionsCommand PutConfigurationSetSendingOptionsCommand PutConfigurationSetTrackingOptionsCommand PutDedicatedIpInPoolCommand PutDedicatedIpWarmupAttributesCommand PutDeliverabilityDashboardOptionCommand PutEmailIdentityDkimAttributesCommand PutEmailIdentityFeedbackAttributesCommand PutEmailIdentityMailFromAttributesCommand SendEmailCommand SendingPausedException TagResourceCommand TooManyRequestsException UntagResourceCommand UpdateConfigurationSetEventDestinationCommand __Client

Interfaces

BlacklistEntry Body ClientDefaults CloudWatchDestination CloudWatchDimensionConfiguration Content CreateConfigurationSetCommandInput CreateConfigurationSetCommandOutput CreateConfigurationSetEventDestinationCommandInput CreateConfigurationSetEventDestinationCommandOutput CreateConfigurationSetEventDestinationRequest CreateConfigurationSetEventDestinationResponse CreateConfigurationSetRequest CreateConfigurationSetResponse CreateDedicatedIpPoolCommandInput CreateDedicatedIpPoolCommandOutput CreateDedicatedIpPoolRequest CreateDedicatedIpPoolResponse CreateDeliverabilityTestReportCommandInput CreateDeliverabilityTestReportCommandOutput CreateDeliverabilityTestReportRequest CreateDeliverabilityTestReportResponse CreateEmailIdentityCommandInput CreateEmailIdentityCommandOutput CreateEmailIdentityRequest CreateEmailIdentityResponse DailyVolume DedicatedIp DeleteConfigurationSetCommandInput DeleteConfigurationSetCommandOutput DeleteConfigurationSetEventDestinationCommandInput DeleteConfigurationSetEventDestinationCommandOutput DeleteConfigurationSetEventDestinationRequest DeleteConfigurationSetEventDestinationResponse DeleteConfigurationSetRequest DeleteConfigurationSetResponse DeleteDedicatedIpPoolCommandInput DeleteDedicatedIpPoolCommandOutput DeleteDedicatedIpPoolRequest DeleteDedicatedIpPoolResponse DeleteEmailIdentityCommandInput DeleteEmailIdentityCommandOutput DeleteEmailIdentityRequest DeleteEmailIdentityResponse DeliverabilityTestReport DeliveryOptions Destination DkimAttributes DomainDeliverabilityCampaign DomainDeliverabilityTrackingOption DomainIspPlacement EmailContent EventDestination EventDestinationDefinition GetAccountCommandInput GetAccountCommandOutput GetAccountRequest GetAccountResponse GetBlacklistReportsCommandInput GetBlacklistReportsCommandOutput GetBlacklistReportsRequest GetBlacklistReportsResponse GetConfigurationSetCommandInput GetConfigurationSetCommandOutput GetConfigurationSetEventDestinationsCommandInput GetConfigurationSetEventDestinationsCommandOutput GetConfigurationSetEventDestinationsRequest GetConfigurationSetEventDestinationsResponse GetConfigurationSetRequest GetConfigurationSetResponse GetDedicatedIpCommandInput GetDedicatedIpCommandOutput GetDedicatedIpRequest GetDedicatedIpResponse GetDedicatedIpsCommandInput GetDedicatedIpsCommandOutput GetDedicatedIpsRequest GetDedicatedIpsResponse GetDeliverabilityDashboardOptionsCommandInput GetDeliverabilityDashboardOptionsCommandOutput GetDeliverabilityDashboardOptionsRequest GetDeliverabilityDashboardOptionsResponse GetDeliverabilityTestReportCommandInput GetDeliverabilityTestReportCommandOutput GetDeliverabilityTestReportRequest GetDeliverabilityTestReportResponse GetDomainDeliverabilityCampaignCommandInput GetDomainDeliverabilityCampaignCommandOutput GetDomainDeliverabilityCampaignRequest GetDomainDeliverabilityCampaignResponse GetDomainStatisticsReportCommandInput GetDomainStatisticsReportCommandOutput GetDomainStatisticsReportRequest GetDomainStatisticsReportResponse GetEmailIdentityCommandInput GetEmailIdentityCommandOutput GetEmailIdentityRequest GetEmailIdentityResponse IdentityInfo InboxPlacementTrackingOption IspPlacement KinesisFirehoseDestination ListConfigurationSetsCommandInput ListConfigurationSetsCommandOutput ListConfigurationSetsRequest ListConfigurationSetsResponse ListDedicatedIpPoolsCommandInput ListDedicatedIpPoolsCommandOutput ListDedicatedIpPoolsRequest ListDedicatedIpPoolsResponse ListDeliverabilityTestReportsCommandInput ListDeliverabilityTestReportsCommandOutput ListDeliverabilityTestReportsRequest ListDeliverabilityTestReportsResponse ListDomainDeliverabilityCampaignsCommandInput ListDomainDeliverabilityCampaignsCommandOutput ListDomainDeliverabilityCampaignsRequest ListDomainDeliverabilityCampaignsResponse ListEmailIdentitiesCommandInput ListEmailIdentitiesCommandOutput ListEmailIdentitiesRequest ListEmailIdentitiesResponse ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceRequest ListTagsForResourceResponse MailFromAttributes Message MessageTag OverallVolume PinpointDestination PinpointEmailClientConfig PinpointEmailClientResolvedConfig PinpointEmailPaginationConfiguration PlacementStatistics PutAccountDedicatedIpWarmupAttributesCommandInput PutAccountDedicatedIpWarmupAttributesCommandOutput PutAccountDedicatedIpWarmupAttributesRequest PutAccountDedicatedIpWarmupAttributesResponse PutAccountSendingAttributesCommandInput PutAccountSendingAttributesCommandOutput PutAccountSendingAttributesRequest PutAccountSendingAttributesResponse PutConfigurationSetDeliveryOptionsCommandInput PutConfigurationSetDeliveryOptionsCommandOutput PutConfigurationSetDeliveryOptionsRequest PutConfigurationSetDeliveryOptionsResponse PutConfigurationSetReputationOptionsCommandInput PutConfigurationSetReputationOptionsCommandOutput PutConfigurationSetReputationOptionsRequest PutConfigurationSetReputationOptionsResponse PutConfigurationSetSendingOptionsCommandInput PutConfigurationSetSendingOptionsCommandOutput PutConfigurationSetSendingOptionsRequest PutConfigurationSetSendingOptionsResponse PutConfigurationSetTrackingOptionsCommandInput PutConfigurationSetTrackingOptionsCommandOutput PutConfigurationSetTrackingOptionsRequest PutConfigurationSetTrackingOptionsResponse PutDedicatedIpInPoolCommandInput PutDedicatedIpInPoolCommandOutput PutDedicatedIpInPoolRequest PutDedicatedIpInPoolResponse PutDedicatedIpWarmupAttributesCommandInput PutDedicatedIpWarmupAttributesCommandOutput PutDedicatedIpWarmupAttributesRequest PutDedicatedIpWarmupAttributesResponse PutDeliverabilityDashboardOptionCommandInput PutDeliverabilityDashboardOptionCommandOutput PutDeliverabilityDashboardOptionRequest PutDeliverabilityDashboardOptionResponse PutEmailIdentityDkimAttributesCommandInput PutEmailIdentityDkimAttributesCommandOutput PutEmailIdentityDkimAttributesRequest PutEmailIdentityDkimAttributesResponse PutEmailIdentityFeedbackAttributesCommandInput PutEmailIdentityFeedbackAttributesCommandOutput PutEmailIdentityFeedbackAttributesRequest PutEmailIdentityFeedbackAttributesResponse PutEmailIdentityMailFromAttributesCommandInput PutEmailIdentityMailFromAttributesCommandOutput PutEmailIdentityMailFromAttributesRequest PutEmailIdentityMailFromAttributesResponse RawMessage ReputationOptions SendEmailCommandInput SendEmailCommandOutput SendEmailRequest SendEmailResponse SendQuota SendingOptions SnsDestination Tag TagResourceCommandInput TagResourceCommandOutput TagResourceRequest TagResourceResponse Template TrackingOptions UntagResourceCommandInput UntagResourceCommandOutput UntagResourceRequest UntagResourceResponse UpdateConfigurationSetEventDestinationCommandInput UpdateConfigurationSetEventDestinationCommandOutput UpdateConfigurationSetEventDestinationRequest UpdateConfigurationSetEventDestinationResponse VolumeStatistics __MetadataBearer

Type Aliases

Functions

SDK - Clients

SDK - Commands

CreateConfigurationSetCommand CreateConfigurationSetCommandInput CreateConfigurationSetCommandOutput CreateConfigurationSetEventDestinationCommand CreateConfigurationSetEventDestinationCommandInput CreateConfigurationSetEventDestinationCommandOutput CreateDedicatedIpPoolCommand CreateDedicatedIpPoolCommandInput CreateDedicatedIpPoolCommandOutput CreateDeliverabilityTestReportCommand CreateDeliverabilityTestReportCommandInput CreateDeliverabilityTestReportCommandOutput CreateEmailIdentityCommand CreateEmailIdentityCommandInput CreateEmailIdentityCommandOutput DeleteConfigurationSetCommand DeleteConfigurationSetCommandInput DeleteConfigurationSetCommandOutput DeleteConfigurationSetEventDestinationCommand DeleteConfigurationSetEventDestinationCommandInput DeleteConfigurationSetEventDestinationCommandOutput DeleteDedicatedIpPoolCommand DeleteDedicatedIpPoolCommandInput DeleteDedicatedIpPoolCommandOutput DeleteEmailIdentityCommand DeleteEmailIdentityCommandInput DeleteEmailIdentityCommandOutput GetAccountCommand GetAccountCommandInput GetAccountCommandOutput GetBlacklistReportsCommand GetBlacklistReportsCommandInput GetBlacklistReportsCommandOutput GetConfigurationSetCommand GetConfigurationSetCommandInput GetConfigurationSetCommandOutput GetConfigurationSetEventDestinationsCommand GetConfigurationSetEventDestinationsCommandInput GetConfigurationSetEventDestinationsCommandOutput GetDedicatedIpCommand GetDedicatedIpCommandInput GetDedicatedIpCommandOutput GetDedicatedIpsCommand GetDedicatedIpsCommandInput GetDedicatedIpsCommandOutput GetDeliverabilityDashboardOptionsCommand GetDeliverabilityDashboardOptionsCommandInput GetDeliverabilityDashboardOptionsCommandOutput GetDeliverabilityTestReportCommand GetDeliverabilityTestReportCommandInput GetDeliverabilityTestReportCommandOutput GetDomainDeliverabilityCampaignCommand GetDomainDeliverabilityCampaignCommandInput GetDomainDeliverabilityCampaignCommandOutput GetDomainStatisticsReportCommand GetDomainStatisticsReportCommandInput GetDomainStatisticsReportCommandOutput GetEmailIdentityCommand GetEmailIdentityCommandInput GetEmailIdentityCommandOutput ListConfigurationSetsCommand ListConfigurationSetsCommandInput ListConfigurationSetsCommandOutput ListDedicatedIpPoolsCommand ListDedicatedIpPoolsCommandInput ListDedicatedIpPoolsCommandOutput ListDeliverabilityTestReportsCommand ListDeliverabilityTestReportsCommandInput ListDeliverabilityTestReportsCommandOutput ListDomainDeliverabilityCampaignsCommand ListDomainDeliverabilityCampaignsCommandInput ListDomainDeliverabilityCampaignsCommandOutput ListEmailIdentitiesCommand ListEmailIdentitiesCommandInput ListEmailIdentitiesCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput PutAccountDedicatedIpWarmupAttributesCommand PutAccountDedicatedIpWarmupAttributesCommandInput PutAccountDedicatedIpWarmupAttributesCommandOutput PutAccountSendingAttributesCommand PutAccountSendingAttributesCommandInput PutAccountSendingAttributesCommandOutput PutConfigurationSetDeliveryOptionsCommand PutConfigurationSetDeliveryOptionsCommandInput PutConfigurationSetDeliveryOptionsCommandOutput PutConfigurationSetReputationOptionsCommand PutConfigurationSetReputationOptionsCommandInput PutConfigurationSetReputationOptionsCommandOutput PutConfigurationSetSendingOptionsCommand PutConfigurationSetSendingOptionsCommandInput PutConfigurationSetSendingOptionsCommandOutput PutConfigurationSetTrackingOptionsCommand PutConfigurationSetTrackingOptionsCommandInput PutConfigurationSetTrackingOptionsCommandOutput PutDedicatedIpInPoolCommand PutDedicatedIpInPoolCommandInput PutDedicatedIpInPoolCommandOutput PutDedicatedIpWarmupAttributesCommand PutDedicatedIpWarmupAttributesCommandInput PutDedicatedIpWarmupAttributesCommandOutput PutDeliverabilityDashboardOptionCommand PutDeliverabilityDashboardOptionCommandInput PutDeliverabilityDashboardOptionCommandOutput PutEmailIdentityDkimAttributesCommand PutEmailIdentityDkimAttributesCommandInput PutEmailIdentityDkimAttributesCommandOutput PutEmailIdentityFeedbackAttributesCommand PutEmailIdentityFeedbackAttributesCommandInput PutEmailIdentityFeedbackAttributesCommandOutput PutEmailIdentityMailFromAttributesCommand PutEmailIdentityMailFromAttributesCommandInput PutEmailIdentityMailFromAttributesCommandOutput SendEmailCommand SendEmailCommandInput SendEmailCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput UpdateConfigurationSetEventDestinationCommand UpdateConfigurationSetEventDestinationCommandInput UpdateConfigurationSetEventDestinationCommandOutput

SDK - Paginators

SDK - Waiters