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.
Readonly
configThe resolved configuration of PinpointEmailClient class. This is resolved and normalized from the constructor configuration interface.
Optional
options: HttpHandlerOptionsOptional
data: CreateConfigurationSetCommandOutputOptional
data: CreateConfigurationSetCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateConfigurationSetEventDestinationCommandOutputOptional
data: CreateConfigurationSetEventDestinationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateDedicatedIpPoolCommandOutputOptional
data: CreateDedicatedIpPoolCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateDeliverabilityTestReportCommandOutputOptional
data: CreateDeliverabilityTestReportCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateEmailIdentityCommandOutputOptional
data: CreateEmailIdentityCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteConfigurationSetCommandOutputOptional
data: DeleteConfigurationSetCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteConfigurationSetEventDestinationCommandOutputOptional
data: DeleteConfigurationSetEventDestinationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteDedicatedIpPoolCommandOutputOptional
data: DeleteDedicatedIpPoolCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteEmailIdentityCommandOutputOptional
data: DeleteEmailIdentityCommandOutputDestroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.
Optional
options: HttpHandlerOptionsOptional
data: GetAccountCommandOutputOptional
data: GetAccountCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetBlacklistReportsCommandOutputOptional
data: GetBlacklistReportsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetConfigurationSetCommandOutputOptional
data: GetConfigurationSetCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetConfigurationSetEventDestinationsCommandOutputOptional
data: GetConfigurationSetEventDestinationsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDedicatedIpCommandOutputOptional
data: GetDedicatedIpCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDedicatedIpsCommandOutputOptional
data: GetDedicatedIpsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDeliverabilityDashboardOptionsCommandOutputOptional
data: GetDeliverabilityDashboardOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDeliverabilityTestReportCommandOutputOptional
data: GetDeliverabilityTestReportCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDomainDeliverabilityCampaignCommandOutputOptional
data: GetDomainDeliverabilityCampaignCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetDomainStatisticsReportCommandOutputOptional
data: GetDomainStatisticsReportCommandOutputOptional
options: HttpHandlerOptionsOptional
data: GetEmailIdentityCommandOutputOptional
data: GetEmailIdentityCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListConfigurationSetsCommandOutputOptional
data: ListConfigurationSetsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListDedicatedIpPoolsCommandOutputOptional
data: ListDedicatedIpPoolsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListDeliverabilityTestReportsCommandOutputOptional
data: ListDeliverabilityTestReportsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListDomainDeliverabilityCampaignsCommandOutputOptional
data: ListDomainDeliverabilityCampaignsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListEmailIdentitiesCommandOutputOptional
data: ListEmailIdentitiesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListTagsForResourceCommandOutputOptional
data: ListTagsForResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutAccountDedicatedIpWarmupAttributesCommandOutputOptional
data: PutAccountDedicatedIpWarmupAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutAccountSendingAttributesCommandOutputOptional
data: PutAccountSendingAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutConfigurationSetDeliveryOptionsCommandOutputOptional
data: PutConfigurationSetDeliveryOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutConfigurationSetReputationOptionsCommandOutputOptional
data: PutConfigurationSetReputationOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutConfigurationSetSendingOptionsCommandOutputOptional
data: PutConfigurationSetSendingOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutConfigurationSetTrackingOptionsCommandOutputOptional
data: PutConfigurationSetTrackingOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutDedicatedIpInPoolCommandOutputOptional
data: PutDedicatedIpInPoolCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutDedicatedIpWarmupAttributesCommandOutputOptional
data: PutDedicatedIpWarmupAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutDeliverabilityDashboardOptionCommandOutputOptional
data: PutDeliverabilityDashboardOptionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutEmailIdentityDkimAttributesCommandOutputOptional
data: PutEmailIdentityDkimAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutEmailIdentityFeedbackAttributesCommandOutputOptional
data: PutEmailIdentityFeedbackAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PutEmailIdentityMailFromAttributesCommandOutputOptional
data: PutEmailIdentityMailFromAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: OutputTypeOptional
data: OutputTypeOptional
options: HttpHandlerOptionsOptional
data: SendEmailCommandOutputOptional
data: SendEmailCommandOutputOptional
options: HttpHandlerOptionsOptional
data: TagResourceCommandOutputOptional
data: TagResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: UntagResourceCommandOutputOptional
data: UntagResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: UpdateConfigurationSetEventDestinationCommandOutputOptional
data: UpdateConfigurationSetEventDestinationCommandOutput
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.