PinpointEmail#
Client#
- class PinpointEmail.Client#
A low-level client representing 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.
import boto3 client = boto3.client('pinpoint-email')
These are the available methods:
- can_paginate
- close
- create_configuration_set
- create_configuration_set_event_destination
- create_dedicated_ip_pool
- create_deliverability_test_report
- create_email_identity
- delete_configuration_set
- delete_configuration_set_event_destination
- delete_dedicated_ip_pool
- delete_email_identity
- get_account
- get_blacklist_reports
- get_configuration_set
- get_configuration_set_event_destinations
- get_dedicated_ip
- get_dedicated_ips
- get_deliverability_dashboard_options
- get_deliverability_test_report
- get_domain_deliverability_campaign
- get_domain_statistics_report
- get_email_identity
- get_paginator
- get_waiter
- list_configuration_sets
- list_dedicated_ip_pools
- list_deliverability_test_reports
- list_domain_deliverability_campaigns
- list_email_identities
- list_tags_for_resource
- put_account_dedicated_ip_warmup_attributes
- put_account_sending_attributes
- put_configuration_set_delivery_options
- put_configuration_set_reputation_options
- put_configuration_set_sending_options
- put_configuration_set_tracking_options
- put_dedicated_ip_in_pool
- put_dedicated_ip_warmup_attributes
- put_deliverability_dashboard_option
- put_email_identity_dkim_attributes
- put_email_identity_feedback_attributes
- put_email_identity_mail_from_attributes
- send_email
- tag_resource
- untag_resource
- update_configuration_set_event_destination
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: